• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Blob.md

  Line 10 in 4751009

  ## size

  (probably number)

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Blob.md

  Line 17 in 4751009

  ## type

• parameter types in

  uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Blob.md

  Lines 32 to 41 in 4751009

  	## slice(start, end, contentType)
  	Return a new Blob containing the specified subset of the Blob's data
  	**Returns**: `Blob` - a new Blob object containing the specified subset of the data contained within the Blob on which this method was called
  	| Param | Type | Description |
  	| --- | --- | --- |
  	| start | `*` | index into the Blob indicating the first byte to include in the new Blob |
  	| end | `*` | index into the Blob indicating the first byte that will NOT be included in the new Blob |
  	| contentType | `*` | content type to assign to the new Blob |

Originally posted by @pklaschka in #61 (comment)

Will unblock animations, accessibility, proper z-index support for OS controls like text fields and scroll bars.

Building extensions in Photoshop often requires to make operations as fast as possible.
While javascript API already offers some of the functionality, all of the functionality required is already available by running actions in batchPlay.

It would be great to get a javascript library with all functionality working as a wrapper on top of batchPlay, while still having access to low-level predefined batchPlay actions.

This would allow developers that don't need advanced functionality leverage power of batchPlay by using js wrapper directly and developers that do need advanced and fast operations chained together use pre-defined batchPlay actions directly and chan them in the necessary order without using javascript library methods directly.

As a more concrete example.
PS UXP JS library could expose builder methods that would allow to build ActionDescriptors for batchPlay like Layer.ActionDescriptors.rename(parameters) could return a descriptor that would rename a layer based on some parameters.
Or there could be Channels.ActionDescriptors.invert() or maybe even Calculations.ActionDescriptors.calculate(properties) or even prepared descriptors for Adjustment Layers and operations on them.

Then javascript UXP library could be using same low-level descriptors to have a more high-level set of methods like
renameLayer() could be internally using Layer.ActionDescriptors.rename(). And while low-lever descriptors are exposed, advanced users would be able to leverage them too directly.

• get/manipulate/set pixel data
• Render host images in UXP UI
• Stream host images to disk/network

Issue in /src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md

It happens in a few instances on the page that object parameters use = instead of :, e.g.

const folder = await fs.getFolder({initialDomain = domains.userDocuments}); // ❌
const folder = await fs.getFolder({initialDomain: domains.userDocuments});  // ✅

Use RS3 in your UXP plugins. Useful for plugins that are using React and rendering complex UI.

Enable UXP plugins to launch app associated with a specific file type.

This is not intended to enable intraprocess communication with spawned children, or allow control over the spawned application.

Issue in /src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/localFileSystem.md

Getting access to the file system API should be changed from
require('uxp').uxp.storage.localFileSystem
to
require('uxp').storage.localFileSystem

I'm not sure if this is actually for this UXP version, but I think the addition of the FileSystem APIs needs to be in this changelog (as at least from a 3P perspective, this is in "the new release").

Originally posted by @pklaschka in #61 (comment)

This issue serves to track all items that came up in the code review of #61 which were deemed out of scope for that PR (and/or not fixable in time for the release) but should be fixed in the near future:

• #70
• #71
• #72
• #73
• #74
• #75
• #76
• #77
• #78
• #79
• #80
• #81
• #82
• #83
• #84
• #85
• #86

Basic support for CSS Grid support. The spec is large, so this will require iteration to build out support.

note there are several unclosed tags (pattern <sp-...><sp-...> below) in docs as noted in AdobeDocs/uxp-photoshop#205 as shown at: https://developer.adobe.com/photoshop/uxp/uxp/reference-spectrum/User%20Interface/sp-textfield/#variants-and-states

uxp-photoshop currently has (this issue exists in):
3 "name": "uxp-documentation",
4 "version": "0.0.17",
5 "license": "Apache-2.0",
6 "repository": {
7 "type": "git",
8 "url": "https://github.com/AdobeDocs/uxp"

in ./src/pages/uxp/reference-spectrum/Typography/sp-detail.md
1 in line 16: <sp-detail>A NICE DIVIDER<sp-detail>

in ./src/pages/uxp/reference-spectrum/User Interface/sp-textfield.md
2 in line 33: <sp-textfield disabled placeholder="Phone Number"><sp-textfield>
2 in line 41: <sp-textfield valid placeholder="Phone Number"><sp-textfield>
2 in line 49: <sp-textfield invalid placeholder="Phone Number"><sp-textfield>
2 in line 57: <sp-textfield quiet placeholder="Phone Number"><sp-textfield>
2 in line 65: <sp-textfield type="number" placeholder="Age"><sp-textfield>
2 in line 73: <sp-textfield type="search" placeholder="Age"><sp-textfield>
2 in line 81: <sp-textfield type="password" placeholder="Age"><sp-textfield>

Is this a JSON-serialized string? Or maybe a construct like type JSON = string | boolean | number | JSON[] | null | { [key: string | number]: JSON}?

Information not suitable for 3P as it would require deep knowledge of the architecture of various CC apps (which might be present with experienced 3P devs, but not with beginners)

Reported as part of the code review in #61

Enable use of the system webview to render high-fidelity web content.

First release will be limited to transient surfaces such as modal dialogs.

Missing type information, according to https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset should be DOMStringMap (assuming that we're compatible with these specs)

Originally posted by @pklaschka in #61 (comment)

Enable plugins (with plugin consent) to communicate with each other.

Feature detection instead of version detection. Check if an API is supported before using it. Also returns information about the API.

Expected Behaviour

In uxp/src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md, the documentation should reflect the APIs behavior, which (tested in both PS and XD in their current versions) differs between docs and actual behavior. The old XD docs actually document the correct behavior.

const file = await fs.getFileForSaving("output.txt", { types: [ "txt" ]});
if (!file) {
    // file picker was cancelled
    return;
}
await file.write("It was a dark and stormy night");

Actual Behaviour

Issues with the current documentation:

• suggestedName argument is not mentioned at all, but is required (also in the code example)
• the return type is documented as File, but there's no mention that the function is async => it would probably be the easiest to document the return type as Promise<File>.
• code example contains a syntax error (= has to be : in the options object)
• code example destructures a file array where there is simply no array

=> Overall, without looking back at adobexdplatform.com (or my old code based on the info from there), there would have been no way for me to discover the actual working solution from either the docs or anywhere else (there's also no way to discover correct arguments via dev tools, etc., after all, meaning the only option would have been a lot of trial and error).

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Platform and Version

(both Windows 10)

• XD, 42.0.22
• PS, 22.4.3

Sample Code that illustrates the problem

// from docs example
const [file] = await fs.getFileForSaving({ types = [ "txt" ]}); // syntax error 😜 

// docs without syntax error
const [file] = await fs.getFileForSaving({ types: [ "txt" ]}); // doesn't work, fails silently

// works
const file = await fs.getFileForSaving({ types: [ "txt" ]}); // works

Logs taken while reproducing the problem

n/a

Such as create and the like.

Ex: input → sp-textfield

Support for loading DLLs/external object libraries.

Since UXP-specific, without a description, exposing this to 3P doesn't make a lot of sense. Don't get me wrong: I think if it makes sense we should expose this to 3P, but exposing it without any information doesn't add a lot of value.

Originally posted by @pklaschka in #61 (comment)

Part of RS3 Support

Issue in /src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md

In createPersistentToken() it's said that it returns a String, very much like createSessionToken().
However createPersistentToken() is asynchronous, and it returns a Promise. In the doc it should be made clearer, with the use of await.
Besides, is it as designed that creating a session token is a synch operation and a permanent one is async?
Thanks!

Davide

[DevEx]

Supporting dropping of files on UXP panels.

Issue in /src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/File.md

In this section of the page it says: "See readOnly and readWrite." Those links are 404

Enables smaller and larger control sizes to be specified for Spectrum UXP components.

Currently, the storage options are tough to discover unless you know what you're looking for.

With Photoshop as an example:

Here:
https://www.adobe.io/photoshop/uxp/uxp/reference-js/Modules/uxp/Persistent%20File%20Storage/

And here:
https://www.adobe.io/photoshop/uxp/uxp/reference-js/Modules/uxp/Key-Value%20Storage/SecureStorage/

And:
https://www.adobe.io/photoshop/uxp/uxp/reference-js/Global%20Members/Data%20Storage/

Generic support for communicating with native plugins built with SDKs. Support for determining which plugins are installed.

Are we sure we don't have types for this? Maybe document: Document and textContent: string? 🤔

From this request:
https://forums.creativeclouddeveloper.com/t/build-ccx-file-from-the-command-line/4120

Notes:

• React version & vanilla version
• React version would have a webpack step that generates the ccx file
• Vanilla version would have a simple package.json that does this
• All that need to happen is zip a dist folder, rename it to ccx

bytesWritten and buffer in

1. uxp/src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystem.md

   Lines 203 to 206 in 4751009

   	## write(fd, buffer, offset, length, position, callback)
   	Writes data in chunks to the file it refers to the file descriptor
   	**Returns**: `Promise<Object>` - { bytesWritten, buffer }

2. uxp/src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystem.md

   Lines 165 to 182 in 4751009

   	## read(fd, buffer, offset, length, position, callback)
   	Reads data in chunks from the file it refers to the file descriptor
   	**Throws**:
   	- `Error` if invalid file descriptor is passed.
   	if invalid parameter format or value is passed.
   	| Param | Type | Description |
   	| --- | --- | --- |
   	| fd | `int` | a file descriptor obtained from fs.open |
   	| buffer | `ArrayBuffer` | the buffer where read bytes are written to |
   	| offset | `int` | the offset to the buffer where read bytes are written from |
   	| length | `int` | the length to read |
   	| position | `int` | the position of the file to read from. if -1, the current file position to read from. when the bytes are read, the current file position advances by size of the read bytes. if the value is greater than or equal to 0, it specifies a file position to read from. after the bytes are read, a current file position stayed the same |
   	| callback | `function` | if not provided, this function will return Promise object |
   	**Returns**: `Promise<Object>` - { bytesRead, buffer }

It isn't clear what kind of information is in the array. Even if we don't have a perfect type definition, specifiying that this is an Array<object> (or maybe Array<any>) already increases the understanding that one can get just from reading/scanning this).

It would be great to get channels support in Photoshop UXP

Add more detail at:

Originally posted by @pklaschka in #61 (comment)

• uxp/src/pages/uxp/reference-js/Modules/uxp/Plugin Manager/Plugin.md

  Lines 50 to 55 in 4751009

  	## showPanel(panelId)
  	Show panel with the given ID. This api may be routed to the host app which can chose to disallow it. Used for commmunicating with other plugins (IPC : Inter Plugin Communication)
  	Note: There is API to hide a panel, panels can be shown but can not be hid.
  	**Returns**: `Promise`

  Promise of/for what? void?

• uxp/src/pages/uxp/reference-js/Modules/uxp/Plugin Manager/Plugin.md

  Lines 65 to 69 in 4751009

  	## invokeCommand(commandId, ...params)
  	Invoke command with given ID. This api may be routed to the host app which can chose to disallow it.
  	Used for commmunicating with other plugins (IPC : Inter Plugin Communication)
  	**Returns**: `Promise`

  Promise of/for what? void?

• uxp/src/pages/uxp/reference-js/Modules/uxp/Plugin Manager/Plugin.md

  Lines 65 to 74 in 4751009

  	## invokeCommand(commandId, ...params)
  	Invoke command with given ID. This api may be routed to the host app which can chose to disallow it.
  	Used for commmunicating with other plugins (IPC : Inter Plugin Communication)
  	**Returns**: `Promise`
  	| Param | Type | Description |
  	| --- | --- | --- |
  	| commandId | `String` | id of the command to be invoked |
  	| ...params | | command arguments to be passed to invokeCommand |

  It isn't clear how parameters work in this context

Originally opened as part of the code review of #61

Support rendering tables using HTML elements and CSS. This will require multiple versions of iteration.

Promises have to be for/of some type (that type can be void). This type should be explicityly mentioned (e.g., Promise<void>, Promise<string>, etc.)

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 19 to 23 in 4751009

  	## setContent(data)
  	Set data to clipboard.
  	Note: This is a non-standard API.
  	**Returns**: `Promise`

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 37 to 41 in 4751009

  	## getContent()
  	Get data from clipboard.
  	Note: This is a non-standard API.
  	**Returns**: `Promise`

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 50 to 53 in 4751009

  	## write(text)
  	Write data to clipboard.This can be used to implement cut and copy functionality.
  	**Returns**: `Promise`

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 69 to 72 in 4751009

  	## writeText(text)
  	Write text to clipboard.This can be used to implement cut and copy text functionality.
  	**Returns**: `Promise`

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 88 to 91 in 4751009

  	## read()
  	Read data from clipboard.
  	**Returns**: `Promise`

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 102 to 105 in 4751009

  	## readText()
  	Read text from clipboard.
  	**Returns**: `Promise`

• uxp/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md

  Lines 116 to 120 in 4751009

  	## clearContent()
  	Clear clipboard content.
  	Note: Nonstandard: This method is non-standard.
  	**Returns**: `Promise`

Originally posted by @pklaschka in #61 (comment)

Issue in /src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md
Typo link

Orignal code... Removed some part to reduce verbosity

const folder = await fs.getFolder();
const myNovel = (await fs.getEntries());

The correct code

const folder = await fs.getFolder();
const myNovel = (await folder.getEntries());

Given that these docs also get deployed for other host apps, linking to one specific host app is probelmatic.

It's not easy to solve this, but we should keep this in mind if an opportunity opens up to solve these kinds of issues.

It would be great to get paths support in Photoshop UXP