@bubblydoo/uxp-toolkit 0.0.9 → 0.0.10

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @bubblydoo/uxp-toolkit@0.0.9 build /home/runner/work/uxp-toolkit/uxp-toolkit/packages/uxp-toolkit
+> @bubblydoo/uxp-toolkit@0.0.10 build /home/runner/work/uxp-toolkit/uxp-toolkit/packages/uxp-toolkit
 > tsup
 
 CLI Building entry: src/index.ts, src/commands-library/index.ts
@@ -8,12 +8,12 @@
 CLI Using tsup config: /home/runner/work/uxp-toolkit/uxp-toolkit/packages/uxp-toolkit/tsup.config.ts
 CLI Target: es2022
 ESM Build start
-ESM dist/index.js                  15.75 KB
+ESM dist/index.js                  15.95 KB
 ESM dist/chunk-JBXCIUBZ.js         5.14 KB
 ESM dist/commands-library/index.js 8.76 KB
-ESM ⚡️ Build success in 35ms
+ESM ⚡️ Build success in 34ms
 DTS Build start
-DTS ⚡️ Build success in 3679ms
-DTS dist/index.d.ts                  7.92 KB
+DTS ⚡️ Build success in 3797ms
+DTS dist/index.d.ts                  6.57 KB
 DTS dist/commands-library/index.d.ts 4.43 KB
 DTS dist/psLayerRef-CGbTO4a5.d.ts    2.86 KB

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @bubblydoo/uxp-toolkit
 
+## 0.0.10
+
+### Patch Changes
+
+- 11de737: Updated uxp types and docs
+
 ## 0.0.9
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,58 +1,15 @@
 import { c as createModifyingBatchPlayContext, P as PsLayerRef } from './psLayerRef-CGbTO4a5.js';
 export { C as CorrectBatchPlayOptions, U as UTCommandBase, a as UTCommandModifying, b as UTCommandNonModifying, d as UTCommandResult, e as batchPlay, f as batchPlayCommand, g as batchPlayCommands, h as createCommand, i as createMultiGetDocumentCommand } from './psLayerRef-CGbTO4a5.js';
 import * as photoshop from 'photoshop';
-import { Document, Layer } from 'photoshop';
+import { ExecutionContext, ExecuteAsModalOptions, Document, Layer } from 'photoshop';
 import ErrorStackParser from 'error-stack-parser';
+import { Entry, File, Folder } from 'uxp';
 import { z } from 'zod';
 
-interface CorrectExecutionContext {
-    /**
-     * True if user has cancelled the modal interaction.
-     *
-     * User can cancel by hitting the Escape key, or by pressing the "Cancel" button in the progress bar.
-     */
-    isCancelled: boolean;
-    /**
-     * If assigned a method, it will be called when user cancels the modal interaction.
-     */
-    onCancel: () => void;
-    /**
-     * Call this to customize the progress bar.
-     */
-    reportProgress: (info: {
-        value: number;
-        commandName?: string;
-    }) => void;
-    /**
-     * Use the methods in here to control Photoshop state
-     */
-    hostControl: {
-        /**
-         * Call to suspend history on a target document, returns the suspension ID which can be used for resumeHistory
-         */
-        suspendHistory: (info: {
-            documentID: number;
-            name: string;
-        }) => Promise<number>;
-        /**
-         * Call to resume history on a target document
-         */
-        resumeHistory: (suspensionID: number, commit: boolean) => Promise<void>;
-        /** Register a document to be closed when the modal scope exits. See below for details. */
-        registerAutoCloseDocument: (documentID: number) => Promise<void>;
-        /** Unregister a document from being closed when the modal scope exits */
-        unregisterAutoCloseDocument: (documentID: number) => Promise<void>;
-    };
-}
-interface CorrectExecuteAsModalOptions {
-    commandName: string;
-    interactive?: boolean;
-    timeOut?: number;
-}
-type ExtendedExecutionContext = Omit<CorrectExecutionContext, 'onCancel'> & ReturnType<typeof createModifyingBatchPlayContext> & {
+type ExtendedExecutionContext = Omit<ExecutionContext, 'onCancel'> & ReturnType<typeof createModifyingBatchPlayContext> & {
     signal: AbortSignal;
 };
-type OptionsWithoutCommandName = Omit<CorrectExecuteAsModalOptions, 'commandName'>;
+type OptionsWithoutCommandName = Omit<ExecuteAsModalOptions, 'commandName'>;
 declare function executeAsModal<T>(commandName: string, fn: (executionContext: ExtendedExecutionContext) => Promise<T>, opts?: OptionsWithoutCommandName): Promise<T>;
 
 interface SuspendHistoryContext {
@@ -78,6 +35,9 @@ declare function parseUxpErrorSourcemaps(error: Error, opts?: {
 }): Promise<BasicStackFrame[]>;
 declare function getBasicStackFrameAbsoluteFilePath(frame: BasicStackFrame): Promise<string>;
 
+declare function isFile(entry: Entry): entry is File;
+declare function isFolder(entry: Entry): entry is Folder;
+
 declare function openFileByPath(path: string): Promise<photoshop.Document>;
 
 declare function flattenTree<T>(tree: Tree<T>): Tree<T>[0][];
@@ -190,4 +150,4 @@ declare function utLayersToTree(layer: UTLayer[]): Tree<UTLayerWithoutChildren>;
 declare function utLayerToDomLayer(layer: UTLayer): Layer;
 declare function utLayersToDomLayers(layers: UTLayer[]): Layer[];
 
-export { type BasicStackFrame, type CorrectExecuteAsModalOptions, type CorrectExecutionContext, type ExtendedExecutionContext, type LayerDescriptor, type LayerRef, PsLayerRef, type SuspendHistoryContext, type Tree, type UTLayer, type UTLayerPickKeys, type UTLayerWithoutChildren, copyToClipboard, createModifyingBatchPlayContext, executeAsModal, executeAsModalAndSuspendHistory, flattenTree, getBasicStackFrameAbsoluteFilePath, getDocumentLayerDescriptors, getFlattenedDomLayersList, getLayerEffects, mapTree, mapTreeRef, openFileByPath, parseUxpErrorSourcemaps, photoshopDomLayersToTree, photoshopGetApplicationInfo, photoshopLayerDescriptorsToUTLayers, readFromClipboard, suspendHistory, utLayerToDomLayer, utLayersToDomLayers, utLayersToTree, utLayersToText as utTreeToText, uxpEntrypointsSchema };
+export { type BasicStackFrame, type ExtendedExecutionContext, type LayerDescriptor, type LayerRef, PsLayerRef, type SuspendHistoryContext, type Tree, type UTLayer, type UTLayerPickKeys, type UTLayerWithoutChildren, copyToClipboard, createModifyingBatchPlayContext, executeAsModal, executeAsModalAndSuspendHistory, flattenTree, getBasicStackFrameAbsoluteFilePath, getDocumentLayerDescriptors, getFlattenedDomLayersList, getLayerEffects, isFile, isFolder, mapTree, mapTreeRef, openFileByPath, parseUxpErrorSourcemaps, photoshopDomLayersToTree, photoshopGetApplicationInfo, photoshopLayerDescriptorsToUTLayers, readFromClipboard, suspendHistory, utLayerToDomLayer, utLayersToDomLayers, utLayersToTree, utLayersToText as utTreeToText, uxpEntrypointsSchema };

package/dist/index.js

@@ -12,11 +12,10 @@ import {
 
 // src/core/executeAsModal.ts
 import { core } from "photoshop";
-var originalExecuteAsModal = core.executeAsModal;
 async function executeAsModal(commandName, fn, opts) {
   let error;
   let result;
-  await originalExecuteAsModal(async (executionContext) => {
+  await core.executeAsModal(async (executionContext) => {
     const abortController = new AbortController();
     executionContext.onCancel = () => {
       abortController.abort();
@@ -206,13 +205,24 @@ var UTStacktraceParsingError = class extends UTError {
   }
 };
 
+// src/filesystem/isFileOrFolder.ts
+function isFile(entry) {
+  return entry.isFile === true;
+}
+function isFolder(entry) {
+  return entry.isFolder === true;
+}
+
 // src/filesystem/openFileByPath.ts
 import { app } from "photoshop";
 import { storage as storage2 } from "uxp";
 async function openFileByPath(path) {
   const fs = storage2.localFileSystem;
-  const file = await fs.getEntryWithUrl(path);
-  const doc = await executeAsModal("Open file", () => app.open(file));
+  const entry = await fs.getEntryWithUrl(path);
+  if (!isFile(entry)) {
+    throw new Error("Entry is not a file");
+  }
+  const doc = await executeAsModal("Open file", () => app.open(entry));
   return doc;
 }
 
@@ -560,6 +570,8 @@ export {
   getDocumentLayerDescriptors,
   getFlattenedDomLayersList,
   getLayerEffects,
+  isFile,
+  isFolder,
   mapTree,
   mapTreeRef,
   openFileByPath,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bubblydoo/uxp-toolkit",
   "type": "module",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "author": "Hans Otto Wirtz <hansottowirtz@gmail.com>",
   "license": "MIT",
   "homepage": "https://github.com/bubblydoo/uxp-toolkit/tree/main/packages/uxp-toolkit",
@@ -41,16 +41,17 @@
     "typescript": "^5.8.3",
     "vitest": "^4.0.18",
     "zod": "^4.3.6",
-    "@adobe-uxp-types/photoshop": "0.1.0",
-    "@adobe-uxp-types/uxp": "0.1.0",
+    "@adobe-uxp-types/photoshop": "0.1.1",
+    "@adobe-uxp-types/uxp": "0.1.1",
     "@bubblydoo/tsconfig": "0.0.3",
-    "@bubblydoo/uxp-test-framework": "0.0.9"
+    "@bubblydoo/uxp-test-framework": "0.0.10"
   },
   "scripts": {
     "build": "tsup",
     "test": "vitest run",
     "uxp-test:build": "uxp-test build",
     "uxp-test:dev": "uxp-test dev",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "docs-json": "typedoc --json docs.json"
   }
 }

package/src/core/executeAsModal.ts

@@ -1,75 +1,17 @@
+import type { ExecuteAsModalOptions, ExecutionContext } from 'photoshop';
 import { core } from 'photoshop';
 import { createModifyingBatchPlayContext } from './command';
 
-// copied from devtools:
-// hostControl: {suspendHistory: ƒ, resumeHistory: ƒ, registerAutoCloseDocument: ƒ, unregisterAutoCloseDocument: ƒ}
-// mode: "action"
-// uiMode: "never"
-// finalizeArguments: ƒ ()
-// isCancelled: undefined
-// onCancel: undefined
-// reject: ƒ ()
-// reportProgress: ƒ ()
-// resolve: ƒ ()
-
-export interface CorrectExecutionContext {
-  /**
-   * True if user has cancelled the modal interaction.
-   *
-   * User can cancel by hitting the Escape key, or by pressing the "Cancel" button in the progress bar.
-   */
-  isCancelled: boolean;
-  /**
-   * If assigned a method, it will be called when user cancels the modal interaction.
-   */
-  onCancel: () => void;
-  /**
-   * Call this to customize the progress bar.
-   */
-  reportProgress: (info: {
-    value: number;
-    commandName?: string;
-  }) => void;
-  /**
-   * Use the methods in here to control Photoshop state
-   */
-  hostControl: {
-    /**
-     * Call to suspend history on a target document, returns the suspension ID which can be used for resumeHistory
-     */
-    suspendHistory: (info: {
-      documentID: number;
-      name: string;
-    }) => Promise<number>;
-    /**
-     * Call to resume history on a target document
-     */
-    resumeHistory: (suspensionID: number, commit: boolean) => Promise<void>;
-    /** Register a document to be closed when the modal scope exits. See below for details. */
-    registerAutoCloseDocument: (documentID: number) => Promise<void>;
-    /** Unregister a document from being closed when the modal scope exits */
-    unregisterAutoCloseDocument: (documentID: number) => Promise<void>;
-  };
-}
-
-export interface CorrectExecuteAsModalOptions {
-  commandName: string;
-  interactive?: boolean;
-  timeOut?: number;
-}
-
-export type ExtendedExecutionContext = Omit<CorrectExecutionContext, 'onCancel'> & ReturnType<typeof createModifyingBatchPlayContext> & {
+export type ExtendedExecutionContext = Omit<ExecutionContext, 'onCancel'> & ReturnType<typeof createModifyingBatchPlayContext> & {
   signal: AbortSignal;
 };
 
-const originalExecuteAsModal: <T>(fn: (executionContext: CorrectExecutionContext) => Promise<void>, opts: CorrectExecuteAsModalOptions) => Promise<T> = core.executeAsModal as any;
-
-type OptionsWithoutCommandName = Omit<CorrectExecuteAsModalOptions, 'commandName'>;
+type OptionsWithoutCommandName = Omit<ExecuteAsModalOptions, 'commandName'>;
 
 export async function executeAsModal<T>(commandName: string, fn: (executionContext: ExtendedExecutionContext) => Promise<T>, opts?: OptionsWithoutCommandName): Promise<T> {
   let error: unknown;
   let result: T;
-  await originalExecuteAsModal(async (executionContext) => {
+  await core.executeAsModal(async (executionContext) => {
     const abortController = new AbortController();
     executionContext.onCancel = () => {
       abortController.abort();

package/src/error-sourcemaps/sourcemaps.ts

@@ -1,3 +1,4 @@
+import type { File } from 'uxp';
 import ErrorStackParser from 'error-stack-parser';
 import { SourceMapConsumer } from 'source-map-js';
 import { storage } from 'uxp';
@@ -14,9 +15,9 @@ export async function parseUxpErrorSourcemaps(error: Error, opts: { unsourcemapp
 
   const unsourcemappedHeaderLines = opts.unsourcemappedHeaderLines ?? 0;
 
-  const loadedFilesCache: Record<string, storage.File> = {};
+  const loadedFilesCache: Record<string, File> = {};
 
-  const fs = (storage as any).localFileSystem;
+  const fs = storage.localFileSystem;
   const parsedMappedError: BasicStackFrame[] = [];
   for (const frame of parsedError) {
     if (!frame.fileName || !frame.lineNumber || !frame.columnNumber) {
@@ -26,7 +27,7 @@ export async function parseUxpErrorSourcemaps(error: Error, opts: { unsourcemapp
     const entryPath = `plugin:${frame.fileName}`;
     const file
       = loadedFilesCache[entryPath]
-        ?? ((await fs.getEntryWithUrl(entryPath)) as storage.File);
+        ?? ((await fs.getEntryWithUrl(entryPath)) as File);
     loadedFilesCache[entryPath] = file;
     if (!file.isFile) {
       parsedMappedError.push(frame);
@@ -35,7 +36,7 @@ export async function parseUxpErrorSourcemaps(error: Error, opts: { unsourcemapp
     const sourcemapFileEntryPath = `${entryPath}.map`;
     const sourcemapFile
       = loadedFilesCache[sourcemapFileEntryPath]
-        ?? ((await fs.getEntryWithUrl(sourcemapFileEntryPath)) as storage.File);
+        ?? ((await fs.getEntryWithUrl(sourcemapFileEntryPath)) as File);
     loadedFilesCache[sourcemapFileEntryPath] = sourcemapFile;
     if (!sourcemapFile.isFile) {
       parsedMappedError.push(frame);
@@ -82,9 +83,7 @@ function parseErrorIntoBasicStackFrames(error: Error): BasicStackFrame[] {
 }
 
 export async function getBasicStackFrameAbsoluteFilePath(frame: BasicStackFrame): Promise<string> {
-  const pluginFolder = await (
-    storage as any
-  ).localFileSystem.getPluginFolder();
+  const pluginFolder = await storage.localFileSystem.getPluginFolder();
   const absoluteFileName = pathResolve(
     pluginFolder.nativePath,
     'index.js',

package/src/filesystem/isFileOrFolder.ts

@@ -0,0 +1,9 @@
+import type { Entry, File, Folder } from 'uxp';
+
+export function isFile(entry: Entry): entry is File {
+  return entry.isFile === true;
+}
+
+export function isFolder(entry: Entry): entry is Folder {
+  return entry.isFolder === true;
+}

package/src/filesystem/openFileByPath.ts

@@ -1,10 +1,14 @@
 import { app } from 'photoshop';
 import { storage } from 'uxp';
 import { executeAsModal } from '../core/executeAsModal';
+import { isFile } from './isFileOrFolder';
 
 export async function openFileByPath(path: string) {
-  const fs = (storage as any).localFileSystem;
-  const file = (await fs.getEntryWithUrl(path)) as storage.File;
-  const doc = await executeAsModal('Open file', () => app.open(file as any));
+  const fs = storage.localFileSystem;
+  const entry = await fs.getEntryWithUrl(path);
+  if (!isFile(entry)) {
+    throw new Error('Entry is not a file');
+  }
+  const doc = await executeAsModal('Open file', () => app.open(entry));
   return doc;
 }

package/src/index.ts

@@ -18,8 +18,6 @@ export {
 
 // Core – execution context
 export {
-  type CorrectExecuteAsModalOptions,
-  type CorrectExecutionContext,
   executeAsModal,
   type ExtendedExecutionContext,
 } from './core/executeAsModal';
@@ -40,6 +38,7 @@ export {
   parseUxpErrorSourcemaps,
 } from './error-sourcemaps/sourcemaps';
 // Filesystem
+export { isFile, isFolder } from './filesystem/isFileOrFolder';
 export { openFileByPath } from './filesystem/openFileByPath';
 // General tree
 export { flattenTree } from './general-tree/flattenTree';

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.jsonc"],
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}