@bubblydoo/photoshop-mcp 0.0.2

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/dialog.d.ts

@@ -0,0 +1,26 @@
+/**
+ * FIXME: Is this namespace documented anywhere?
+ */
+export const dialog = {
+  showOpenDialog: (options: {
+    openFile?: boolean;
+    openDirectory?: boolean;
+    defaultPath?: string;
+    multipleSelections?: boolean;
+    title?: string;
+    buttonLabel?: string;
+    filters?: string[];
+    showHiddenFiles?: boolean;
+    initialLocation?: string;
+  }) => Promise<URL>,
+
+  showSaveDialog: (options: {
+    defaultPath?: string;
+    title?: string;
+    buttonLabel?: string;
+    filters: string[];
+    showHiddenFiles?: boolean;
+    suggestedName?: string;
+    initialLocation?: string;
+  }) => Promise<URL>,
+};

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/entrypoints.d.ts

@@ -0,0 +1,385 @@
+/**
+ * Represents a horizontal divider between two menu items.
+ */
+export type MenuSeparator = '-';
+
+interface PluginConfig {
+  /**
+   * This is called after plugin is loaded.
+   * 'this' can be used to access UxpPluginInfo object.
+   * If 'plugin' object is defined, 'create' must be defined.
+   * To signal failure, throw an exception.
+   */
+  create?: (this: UxpPluginInfo) => Promise<void>;
+
+  /**
+   * This is called before plugin is unloaded.
+   * 'this' can be used to access UxpPluginInfo object.
+   */
+  destroy?: (this: UxpPluginInfo) => Promise<void>;
+}
+
+interface PanelConfig {
+  /**
+   * This is called when a panel is created.
+   * 'this' can be used to access UxpPanelInfo object.
+   * This function can return a promise.
+   * To signal failure, throw an exception or return a rejected promise.
+   * This has a default Timeout of 300 MSec from manifest v5 onwards.
+   * Parameters : create(event) {}, till Manifest Version V4 create(rootNode) {}, from v5 onwards
+   */
+  create?: (this: UxpPanelInfo) => Promise<void>;
+
+  /**
+   * This is called when a panel is shown.
+   * 'this' can be used to access UxpPanelInfo object.
+   * This function can return a promise.
+   * To signal failure, throw an exception or return a rejected promise.
+   * This has a default Timeout of 300 MSec from manifest v5 onwards.
+   * Parameters : show(event) {}, till Manifest Version V4 show(rootNode, data) {}, from v5 onwards
+   */
+  show?: (this: UxpPanelInfo) => Promise<void>;
+
+  /**
+   * This is called when a panel is hidden.
+   * 'this' can be used to access UxpPanelInfo object.
+   * This function can return a promise.
+   * To signal failure, throw an exception or return a rejected promise.
+   * This has a default Timeout of 300 MSec from manifest v5 onwards.
+   * Parameters : hide(event) {}, till Manifest Version V4 hide(rootNode, data) {}, from v5 onwards
+   */
+  hide?: (this: UxpPanelInfo) => Promise<void>;
+
+  /**
+   * This is called when a panel is going to be destroyed.
+   * 'this' can be used to access UxpPanelInfo object.
+   * To signal failure, throw an exception.
+   * Parameters : destroy(event) {}, till Manifest Version V4 destroy(rootNode) {}, from v5 onwards
+   */
+  destroy?: (this: UxpPanelInfo) => Promise<void>;
+
+  /**
+   * This is called when a panel menu item is invoked.
+   * Menu id is passed as the first argument to this function.
+   * 'this' can be used to access UxpPanelInfo object.
+   * This function can return a promise.
+   * To signal failure, throw an exception or return a rejected promise.
+   * @param menuId
+   */
+  invokeMenu?: (this: UxpPanelInfo, menuId: string) => Promise<void>;
+
+  /**
+   * Array of menu items.
+   * Each menu item can be a string or an object with properties defined below.
+   * Menu items are displayed in the same order as specified in this array.
+   * For specifying a separator, a value of "-" or menu item with label "-" can be used at required place in the
+   * array.
+   */
+  menuItems?: (MenuItem | MenuSeparator)[];
+}
+
+interface CommandConfig {
+  /**
+   * This is called when the command is invoked via menu entry.
+   * 'this' can be used to access UxpCommandInfo object.
+   * This function can return a promise.
+   * To signal failure, throw an exception or return a rejected promise.
+   * Parameters : run(event) {}, till Manifest Version V4 run(executionContext, ...arguments) {}, from v5 onwards
+   */
+  run?: (this: UxpCommandInfo) => Promise<void>;
+
+  /**
+   * For future use.
+   */
+  cancel?: () => Promise<void>;
+}
+
+/**
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/EntryPoints/
+ */
+interface Entrypoints {
+  /**
+   * This can be an object or a function.
+   * If this is a function, it is assumed as the 'create' handler
+   */
+  plugin?: PluginConfig | PluginConfig['create'];
+  /**
+   * This contains a list of key-value pairs where each key is a panel id (string) and value is the data for the
+   * panel whose type can be object/function.
+   * If a function, it is assumed to be the 'show' method.
+   * If an object, it can contain following properties but it is must to define either of 'create' or 'show'.
+   */
+  panels?: {
+    [key: string]: PanelConfig | PanelConfig['show'];
+  };
+  /**
+   * This object contains a list of key-value pairs where each key is the command id and value is command's data
+   * whose type can be an object or function.
+   * If a function, it is assumed to be 'run' method.
+   * If an objet, it can contain following properties but 'run' is must to specify.
+   */
+  commands?: {
+    [key: string]: CommandConfig | CommandConfig['run'];
+  };
+}
+
+interface MenuItem {
+  /**
+   * Identifier of the menu item.
+   */
+  id: string;
+  /**
+   * Display text for the menu item. Should be localized.
+   * If label is not specified, id is used as label.
+   * FIXME: does label localization even work?
+   */
+  label?: string;
+  /**
+   * Enabled/disabled state for the menu item. Default - true.
+   */
+  enabled?: boolean;
+  /**
+   * Checked state for the menu item. Default - false.
+   */
+  checked?: boolean;
+  /**
+   * Submenu for this menu item again as an array of 'menuItems'.
+   * 'id' of submenus should still be unique across panel.
+   */
+  submenu?: MenuItem[];
+}
+
+/**
+ * This is a public object which is passed as parameter in plugin.create() and plugin.destroy() entrypoint events.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/UxpPluginInfo/#uxpplugininfo
+ */
+interface UxpPluginInfo {
+  /**
+   * Get plugin ID.
+   */
+  id: string;
+  /**
+   * Get plugin version.
+   */
+  version: string;
+  /**
+   * Get plugin name.
+   */
+  name: string;
+  /**
+   * Get plugin manifest.
+   */
+  manifest: never;
+
+  /**
+   * Check if the plugin is First Party Plugin.
+   */
+  isFirstParty: () => void;
+}
+
+/**
+ * Class describing a single menu item of a panel.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/UxpMenuItem/
+ */
+interface UxpMenuItem {
+  /**
+   * Get menu item id.
+   */
+  id: string;
+  /**
+   * Get menu item label, localized string.
+   */
+  label: string;
+  /**
+   * Get menu item enable state.
+   */
+  enabled: boolean;
+  /**
+   * Get menu item checked state.
+   */
+  checked: boolean;
+  /**
+   * Get menu submenu.
+   */
+  submenu: UxpMenuItems;
+  /**
+   * Get menu parent.
+   */
+  parent: UxpMenuItems;
+
+  /**
+   * Remove the menu item.
+   */
+  remove: () => void;
+}
+
+/**
+ * Class describing the menu of a panel.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/UxpMenuItems/
+ */
+interface UxpMenuItems {
+  /**
+   * Get number of menu items.
+   */
+  size: number;
+
+  /**
+   * Get menu item with specified ID.
+   * @param id
+   * @return Menu item with specified ID.
+   */
+  getItem: (id: string) => UxpMenuItem;
+
+  /**
+   * Get menu item at specified index.
+   * @param index
+   * @return Menu item at specified index.
+   */
+  getItemAt: (index: number) => UxpMenuItem;
+
+  /**
+   * Inserts/replaces the menu item at the specified index with the new menu item.
+   * - index < size of menuItems array : Replaces the existing menu item.
+   * - index = size of menuItems array : Inserts menu item at end.
+   * - index > size of menuItems array : Throws invalid index exception.
+   * @param index
+   * @param newItem
+   */
+  insertAt: (index: number, newItem: MenuItem | MenuSeparator) => void;
+
+  /**
+   * Removes menu item from specified index.
+   * @param index
+   */
+  removeAt: (index: number) => void;
+}
+
+/**
+ * Class describing a panel of the plugin.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/UxpPanelInfo/#uxppanelinfo
+ */
+interface UxpPanelInfo {
+  /**
+   * Get panel id.
+   */
+  id: string;
+  /**
+   * Get panel label, localized string.
+   */
+  label: string;
+  /**
+   * Get panel description, localized string.
+   */
+  description: string;
+  /**
+   * Get panel shortcut.
+   */
+  shortcut: {
+    shortcutKey: string;
+    commandKey: boolean;
+    altKey: boolean;
+    shiftKey: boolean;
+    ctrlKey: boolean;
+  };
+  /**
+   * Get panel title, localized string.
+   */
+  title: string;
+  /**
+   * Get panel icons.
+   */
+  icons: {
+    path: string;
+    scale: number[];
+    theme: string[];
+    species: string[];
+  }[];
+  /**
+   * Get panel minimum size.
+   */
+  minimumSize: {
+    width: number;
+    height: number;
+  };
+  /**
+   * Get panel maximum size.
+   */
+  maximumSize: {
+    width: number;
+    height: number;
+  };
+  /**
+   * Get panel preferred docked size.
+   */
+  preferredDockedSize: {
+    width: number;
+    height: number;
+  };
+  /**
+   * Get panel preferred floating size.
+   */
+  preferredFloatingSize: {
+    width: number;
+    height: number;
+  };
+  /**
+   * Get panel menu items.
+   */
+  menuItems: UxpMenuItems;
+}
+
+/**
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/UxpCommandInfo/#uxpcommandinfo
+ */
+interface UxpCommandInfo {
+  /**
+   * Get command id.
+   */
+  id: string;
+  /**
+   * Get command label, localized string.
+   */
+  label: string;
+  /**
+   * Get command description, localized string.
+   */
+  description: string;
+  /**
+   * Get command shortcut.
+   */
+  shortcut: {
+    shortcutKey: string;
+    commandKey: boolean;
+    altKey: boolean;
+    shiftKey: boolean;
+    ctrlKey: boolean;
+  };
+}
+
+/**
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry%20Points/
+ */
+interface Entrypoints {
+  /**
+   * Get command with specified ID.
+   * @param id Command ID.
+   * @return Command object for a valid ID null for an invalid ID.
+   */
+  getCommand: (id: string) => UxpCommandInfo;
+
+  /**
+   * Get panel with specified ID.
+   * @param id Panel ID.
+   * @return Panel object for a valid ID null for an invalid ID.
+   */
+  getPanel: (id: string) => UxpPanelInfo;
+
+  /**
+   * API for plugin to add handlers and menu items for entrypoints defined in manifest.
+   * This API can only be called once and there after other apis can be used to modify menu items.
+   * The function throws in case of any error in entrypoints data or if its called more than once.
+   * @param entrypoints Describes your plugin's entrypoint functions and properties.
+   */
+  setup: (entrypoints: Entrypoints) => void;
+}
+export const entrypoints: Entrypoints;

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/host.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Includes useful information about the operating environment the plugin finds itself executing in.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Host%20Information/Host/
+ */
+interface Host {
+  /**
+   * Allows you to obtain the language and region used to render the user interface for the host application.
+   * This property is useful in that it allows you to localize and internationalize your plugin's content to match
+   * that of the host application.
+   * @return The locale for the user interface. For example, en_US.
+   */
+  uiLocale: string;
+  /**
+   * Indicates the name of the hosting application.
+   * This is useful if your plugin needs to adapt its behavior based upon the hosting application.
+   * @return The name of the hosting application. For example, Photoshop.
+   */
+  name: string;
+  /**
+   * Indicates the version of the hosting application.
+   * This is useful if your plugin needs to adapt its behavior depending upon the version of the host application.
+   * This may be due to new APIs being introduced in a given version, or to work around a bug in a specific version.
+   * @return The version of the hosting application. For example, 22.0.0.
+   */
+  version: string;
+}
+
+export const host: Host;

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/os.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/os/OS/
+ */
+export interface OS {
+  /**
+   * Gets the platform we are running on (eg. "win32", "win10", "darwin").
+   * @return The string representing the platform.
+   */
+  platform: () => string;
+
+  /**
+   * Gets the release number of the os (eg. "10.0.1.1032").
+   * @return The string representing the release.
+   */
+  release: () => string;
+
+  /**
+   * Gets the platform architecture we are running on (eg. "x32, x64, x86_64 etc").
+   * @return The string representing the architecture.
+   */
+  arch: () => string;
+
+  /**
+   * Gets the platform cpu information we are running on (eg. "{'Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz', 2900}").
+   * @return The array of objects containing information about each logical CPU core.
+   * Currently only model and speed properties are supported.
+   * Times property is not supported.
+   * Access to CPU information, such as model string and frequency, is limited on UWP.
+   * "ARM based architecture" or "X86 based architecture" is returned as a 'model' value on UWP.
+   * 0 is returned as a 'speed' value on UWP.
+   */
+  cpus: () => {
+    model: string;
+    speed: number;
+  }[];
+
+  /**
+   * Gets the total amount of system memory in bytes.
+   * @return The total amount of system memory in bytes as an integer.
+   */
+  totalmem: () => number;
+
+  /**
+   * Gets the total amount of free system memory in bytes.
+   * @return The total amount of free system memory in bytes as an integer.
+   */
+  freemem: () => number;
+
+  /**
+   * Gets the home directory path of the user.
+   * @return The home directory path of the user.
+   */
+  homedir: () => string;
+}
+
+export const os: OS;

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/other.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Event interface received when handling a 'uxpcommand' event.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/guides/how-to/#how-to-get-notified-that-your-panel-is-opening-or-closing
+ */
+export interface UxpCommandEvent extends Event {
+  commandId: string;
+}

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/shell.d.ts

@@ -0,0 +1,54 @@
+/**
+ * To get an instance: require("uxp").shell.
+ * These APIs require UXP Manifest v5 configurations.
+ * @see https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/shell/Shell/
+ */
+interface Shell {
+  /**
+   * Opens the given file or folder path in the system default application.
+   *
+   * Note: UWP can access only files in the UWP App sandbox.
+   *
+   * @param path String representing the path to open.
+   * @param developerText Information from the plugin developer to be displayed on the user consent dialog.
+   * Message should be localised in current host UI locale.
+   * @returns Promise that resolves with "" if succeeded or String containing the error message if failed.
+   *
+   * @example
+   * ```js
+   * // for MacOS
+   * shell.openPath("/Users/[username]/Downloads");
+   * shell.openPath("/Users/[username]/sample.txt");
+   * // for Windows
+   * shell.openPath("C:\\Users\\[username]\\Downloads");
+   * shell.openPath("C:\\Users\\[username]\\AppData\\Local\\...\\sample.txt");
+   * ```
+   */
+  openPath: (path: string, developerText?: string) => Promise<string>;
+
+  /**
+   * Opens the url in the dedicated system applications for the scheme.
+   *
+   * Note: File scheme is not allowed for openExternal. Use openPath for those cases.
+   *
+   * @param url String representing the URL to open.
+   * @param developerText Information from the plugin developer to be displayed on the user consent dialog.
+   * Message should be localised in current host UI locale.
+   * @returns Promise that resolves with "" if succeeded or String containing the error message if failed.
+   *
+   * @example
+   * ```js
+   * shell.openExternal("https://www.adobe.com/");
+   * shell.openExternal("https://www.adobe.com/", "develop message for the user consent dialog");
+   * ```
+   *
+   * @example
+   * ```js
+   * shell.openExternal("maps://?address=345+Park+Ave+San+Jose"); // for MacOS
+   * shell.openExternal("bingmaps:?q=345+Park+Ave+San+Jose, +95110"); // for Windows
+   * ```
+   */
+  openExternal: (url: string | URL, developerText?: string) => void;
+}
+
+export const shell: Shell;