@bubblydoo/uxp-toolkit 0.0.5 → 0.0.6

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @bubblydoo/uxp-toolkit@0.0.5 build /home/runner/work/uxp-toolkit/uxp-toolkit/packages/uxp-toolkit
+> @bubblydoo/uxp-toolkit@0.0.6 build /home/runner/work/uxp-toolkit/uxp-toolkit/packages/uxp-toolkit
 > tsup
 
 CLI Building entry: src/index.ts
@@ -8,8 +8,8 @@
 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 18.29 KB
-ESM ⚡️ Build success in 29ms
+ESM dist/index.js 20.97 KB
+ESM ⚡️ Build success in 28ms
 DTS Build start
-DTS ⚡️ Build success in 2357ms
-DTS dist/index.d.ts 11.44 KB
+DTS ⚡️ Build success in 2406ms
+DTS dist/index.d.ts 11.62 KB

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @bubblydoo/uxp-toolkit
 
+## 0.0.6
+
+### Patch Changes
+
+- 31534d4: Fix layer descriptors exorts
+
 ## 0.0.5
 
 ### Patch Changes

package/dist/index.d.ts

@@ -200,7 +200,7 @@ declare const uxpEntrypointsSchema: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 
-declare function createGetLayerPropertiesCommand(docId: number): UTCommandNonModifying<{
+declare function createMultiGetDocumentCommand(docId: number): UTCommandNonModifying<{
     list: {
         name: string;
         layerID: number;
@@ -224,6 +224,7 @@ declare function createGetLayerPropertiesCommand(docId: number): UTCommandNonMod
         }[]> | undefined;
     }[];
 }>;
+
 declare const getDocumentLayerDescriptors: (documentId: number) => Promise<{
     docId: number;
     name: string;
@@ -247,6 +248,7 @@ declare const getDocumentLayerDescriptors: (documentId: number) => Promise<{
         enabled: boolean;
     }[]> | undefined;
 }[]>;
+type LayerDescriptor = Awaited<ReturnType<typeof getDocumentLayerDescriptors>>[number];
 
 declare function getLayerEffects(layerRef: PsLayerRef): Promise<Record<string, boolean>>;
 
@@ -267,6 +269,7 @@ type UTLayerBuilder = {
 type UTLayer = Readonly<Omit<UTLayerBuilder, "layers">> & {
     layers?: UTLayer[];
 };
+declare function photoshopLayerDescriptorsToUTLayers(layers: LayerDescriptor[]): UTLayer[];
 
 type UTLayerWithoutChildren = Omit<UTLayer, "layers">;
 declare function utLayersToTree(layer: UTLayer[]): Tree<UTLayerWithoutChildren>;
@@ -287,4 +290,4 @@ declare function parseUxpErrorSourcemaps(error: Error, opts?: {
 }): Promise<BasicStackFrame[]>;
 declare function getBasicStackFrameAbsoluteFilePath(frame: BasicStackFrame): Promise<string>;
 
-export { type BasicStackFrame, type CorrectBatchPlayOptions, type CorrectExecuteAsModalOptions, type CorrectExecutionContext, type ExtendedExecutionContext, type LayerRef, type PsLayerRef, type SuspendHistoryContext, type Tree, type UTCommandBase, type UTCommandModifying, type UTCommandNonModifying, type UTCommandResult, type UTLayer, type UTLayerPickKeys, type UTLayerWithoutChildren, batchPlay, batchPlayCommand, batchPlayCommands, copyToClipboard, createCommand, createGetBackgroundLayerCommand, createGetDocumentCommand, createGetDocumentHasBackgroundLayerCommand, createGetLayerPropertiesCommand, createModifyingBatchPlayContext, createRenameLayerCommand, executeAsModal, executeAsModalAndSuspendHistory, flattenTree, getBasicStackFrameAbsoluteFilePath, getFlattenedDomLayersList, getLayerEffects, getDocumentLayerDescriptors as getLayerPropertiesFromUtTree, mapTree, mapTreeRef, openFileByPath, parseUxpErrorSourcemaps, photoshopDomLayersToTree, photoshopGetApplicationInfo, readFromClipboard, suspendHistory, utLayerToDomLayer, utLayersToDomLayers, utLayersToTree, utLayersToText as utTreeToText, uxpEntrypointsSchema };
+export { type BasicStackFrame, type CorrectBatchPlayOptions, type CorrectExecuteAsModalOptions, type CorrectExecutionContext, type ExtendedExecutionContext, type LayerRef, type PsLayerRef, type SuspendHistoryContext, type Tree, type UTCommandBase, type UTCommandModifying, type UTCommandNonModifying, type UTCommandResult, type UTLayer, type UTLayerPickKeys, type UTLayerWithoutChildren, batchPlay, batchPlayCommand, batchPlayCommands, copyToClipboard, createCommand, createGetBackgroundLayerCommand, createGetDocumentCommand, createGetDocumentHasBackgroundLayerCommand, createModifyingBatchPlayContext, createMultiGetDocumentCommand, createRenameLayerCommand, executeAsModal, executeAsModalAndSuspendHistory, flattenTree, getBasicStackFrameAbsoluteFilePath, getDocumentLayerDescriptors, getFlattenedDomLayersList, getLayerEffects, mapTree, mapTreeRef, openFileByPath, parseUxpErrorSourcemaps, photoshopDomLayersToTree, photoshopGetApplicationInfo, photoshopLayerDescriptorsToUTLayers, readFromClipboard, suspendHistory, utLayerToDomLayer, utLayersToDomLayers, utLayersToTree, utLayersToText as utTreeToText, uxpEntrypointsSchema };

package/dist/index.js

@@ -354,9 +354,9 @@ var uxpEntrypointsSchema = z6.object({
   })
 });
 
-// src/ut-tree/getLayerProperties.ts
+// src/commands-library/multiGetDocument.ts
 import { z as z7 } from "zod";
-function createGetLayerPropertiesCommand(docId) {
+function createMultiGetDocumentCommand(docId) {
   return createCommand({
     modifying: false,
     descriptor: {
@@ -400,9 +400,11 @@ function createGetLayerPropertiesCommand(docId) {
     })
   });
 }
+
+// src/ut-tree/getDocumentLayerDescriptors.ts
 var getDocumentLayerDescriptors = async (documentId) => {
   const [layersResult, documentHasBackgroundLayerResult] = await batchPlayCommands([
-    createGetLayerPropertiesCommand(documentId),
+    createMultiGetDocumentCommand(documentId),
     createGetDocumentHasBackgroundLayerCommand(documentId)
   ]);
   const backgroundLayerResult = documentHasBackgroundLayerResult.hasBackgroundLayer ? await batchPlayCommand(createGetBackgroundLayerCommand(documentId)) : null;
@@ -429,6 +431,114 @@ async function getLayerEffects(layerRef) {
   return effects;
 }
 
+// src/ut-tree/photoshopLayerDescriptorsToUTLayers.ts
+var layerKindMap = /* @__PURE__ */ new Map([
+  [1, "pixel"],
+  [2, "adjustment-layer"],
+  // All adjustment layers
+  [3, "text"],
+  [4, "curves"],
+  [5, "smartObject"],
+  [6, "video"],
+  [7, "group"],
+  [8, "threeD"],
+  [9, "gradientFill"],
+  [10, "pattern"],
+  [11, "solidColor"],
+  [12, "background"]
+  // according to the internet but the actual value is undefined
+]);
+var blendModes = [
+  "normal",
+  "dissolve",
+  "darken",
+  "multiply",
+  "colorBurn",
+  "linearBurn",
+  "darkerColor",
+  "lighten",
+  "screen",
+  "colorDodge",
+  "linearDodge",
+  "lighterColor",
+  "overlay",
+  "softLight",
+  "hardLight",
+  "vividLight",
+  "linearLight",
+  "pinLight",
+  "hardMix",
+  "difference",
+  "exclusion",
+  "blendSubtraction",
+  "blendDivide",
+  "hue",
+  "saturation",
+  "color",
+  "luminosity",
+  "passThrough"
+];
+var getLayerKind = (layer) => {
+  const kind = layerKindMap.get(layer.layerKind);
+  if (!kind) {
+    throw new Error(`Unknown layer kind: ${layer.layerKind}`);
+  }
+  return kind;
+};
+var getBlendMode = (layer) => {
+  const mode = layer.mode._value;
+  if (!blendModes.includes(mode)) {
+    throw new Error(`Unknown blend mode: ${mode}`);
+  }
+  return mode;
+};
+function photoshopLayerDescriptorsToUTLayers(layers) {
+  const root = [];
+  const stack = [{ layers: root }];
+  for (const layer of layers) {
+    const sectionType = determineLayerSection(layer);
+    if (sectionType === "end") {
+      if (stack.length > 1) {
+        stack.pop();
+      }
+      continue;
+    }
+    const node = {
+      name: layer.name,
+      docId: layer.docId,
+      id: layer.layerID,
+      visible: layer.visible,
+      kind: getLayerKind(layer),
+      blendMode: getBlendMode(layer),
+      isClippingMask: layer.group,
+      effects: getEffects(layer),
+      background: layer.background
+    };
+    const current = stack[stack.length - 1];
+    current.layers.push(node);
+    if (sectionType === "start") {
+      node.layers = [];
+      stack.push({ layers: node.layers });
+    }
+  }
+  return root;
+}
+var determineLayerSection = (layer) => {
+  const section = layer.layerSection._value;
+  const isGroupEnd = layer.name === "</Layer group>" || layer.name === "</Layer set>" || section === "layerSectionEnd";
+  const isGroupStart = section === "layerSectionStart";
+  return isGroupStart ? "start" : isGroupEnd ? "end" : "normal";
+};
+function getEffects(layer) {
+  const effects = {};
+  if (layer.layerEffects) {
+    for (const effect in layer.layerEffects) {
+      effects[effect] = Array.isArray(layer.layerEffects[effect]) ? layer.layerEffects[effect].some((e) => e.enabled) : !!layer.layerEffects[effect]?.enabled;
+    }
+  }
+  return effects;
+}
+
 // src/ut-tree/utLayersToTree.ts
 function utLayersToTree(layer) {
   return layer.map((layer2) => ({
@@ -627,22 +737,23 @@ export {
   createGetBackgroundLayerCommand,
   createGetDocumentCommand,
   createGetDocumentHasBackgroundLayerCommand,
-  createGetLayerPropertiesCommand,
   createModifyingBatchPlayContext,
+  createMultiGetDocumentCommand,
   createRenameLayerCommand,
   executeAsModal,
   executeAsModalAndSuspendHistory,
   flattenTree,
   getBasicStackFrameAbsoluteFilePath,
+  getDocumentLayerDescriptors,
   getFlattenedDomLayersList,
   getLayerEffects,
-  getDocumentLayerDescriptors as getLayerPropertiesFromUtTree,
   mapTree,
   mapTreeRef,
   openFileByPath,
   parseUxpErrorSourcemaps,
   photoshopDomLayersToTree,
   photoshopGetApplicationInfo,
+  photoshopLayerDescriptorsToUTLayers,
   readFromClipboard,
   suspendHistory,
   utLayerToDomLayer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bubblydoo/uxp-toolkit",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "license": "MIT",
   "type": "module",
   "author": "Hans Otto Wirtz <hansottowirtz@gmail.com>",
@@ -39,8 +39,8 @@
     "typescript": "^5.8.3",
     "vitest": "^4.0.18",
     "zod": "^4.3.6",
-    "@bubblydoo/uxp-test-framework": "0.0.5",
-    "@bubblydoo/tsconfig": "0.0.3"
+    "@bubblydoo/tsconfig": "0.0.3",
+    "@bubblydoo/uxp-test-framework": "0.0.6"
   },
   "scripts": {
     "build": "tsup",

package/src/{ut-tree/getLayerProperties.ts → commands-library/multiGetDocument.ts}

@@ -1,9 +1,7 @@
 import { z } from "zod";
-import { batchPlayCommand, batchPlayCommands, createCommand } from "../core/command";
-import { createGetDocumentHasBackgroundLayerCommand } from "../commands-library/getDocument";
-import { createGetBackgroundLayerCommand } from "../commands-library/getLayer";
+import { createCommand } from "../core/command";
 
-export function createGetLayerPropertiesCommand(docId: number) {
+export function createMultiGetDocumentCommand(docId: number) {
   return createCommand({
     modifying: false,
     descriptor: {
@@ -47,28 +45,3 @@ export function createGetLayerPropertiesCommand(docId: number) {
     })
   });
 }
-
-// get layer properties like name and layerID for all layers in the document (by index)
-export const getDocumentLayerDescriptors = async (documentId: number) => {
-  const [layersResult, documentHasBackgroundLayerResult] = await batchPlayCommands([
-    createGetLayerPropertiesCommand(documentId),
-    createGetDocumentHasBackgroundLayerCommand(documentId),
-  ]);
-
-  const backgroundLayerResult = documentHasBackgroundLayerResult.hasBackgroundLayer ? await batchPlayCommand(createGetBackgroundLayerCommand(documentId)) : null;
-
-  const list = [...layersResult.list].reverse();
-  if (backgroundLayerResult) {
-    list.push(backgroundLayerResult);
-  }
-
-  // Reverse to get bottom-up order
-  return list.map((layerProp) => {
-    return {
-      ...layerProp,
-      docId: documentId,
-    };
-  });
-};
-
-export type LayerDescriptor = Awaited<ReturnType<typeof getDocumentLayerDescriptors>>[number];

package/src/commands-library/renameLayer.uxp-test.ts

@@ -1,6 +1,6 @@
 import { executeAsModal } from "../core/executeAsModal";
 import { openFileByPath } from "../filesystem/openFileByPath";
-import { getDocumentLayerDescriptors } from "../ut-tree/getLayerProperties";
+import { getDocumentLayerDescriptors } from "../ut-tree/getDocumentLayerDescriptors";
 import type { Test } from "@bubblydoo/uxp-test-framework";
 import { expect } from "chai";
 import { app } from "photoshop";

package/src/index.ts

@@ -28,7 +28,10 @@ export { executeAsModalAndSuspendHistory } from "./core-wrappers/executeAsModalA
 
 // Commands library
 export { createRenameLayerCommand } from "./commands-library/renameLayer";
-export { createGetDocumentCommand, createGetDocumentHasBackgroundLayerCommand } from "./commands-library/getDocument";
+export {
+  createGetDocumentCommand,
+  createGetDocumentHasBackgroundLayerCommand,
+} from "./commands-library/getDocument";
 export { createGetBackgroundLayerCommand } from "./commands-library/getLayer";
 
 // DOM – layers
@@ -51,12 +54,13 @@ export { copyToClipboard, readFromClipboard } from "./other/clipboard";
 export { uxpEntrypointsSchema } from "./other/uxpEntrypoints";
 
 // UT tree – layer descriptors & Photoshop tree
-export {
-  createGetLayerPropertiesCommand,
-  getDocumentLayerDescriptors as getLayerPropertiesFromUtTree,
-} from "./ut-tree/getLayerProperties";
+export { createMultiGetDocumentCommand } from "./commands-library/multiGetDocument";
+export { getDocumentLayerDescriptors } from "./ut-tree/getDocumentLayerDescriptors";
 export { getLayerEffects } from "./ut-tree/getLayerEffects";
-export { type UTLayer } from "./ut-tree/photoshopLayerDescriptorsToUTLayers";
+export {
+  type UTLayer,
+  photoshopLayerDescriptorsToUTLayers,
+} from "./ut-tree/photoshopLayerDescriptorsToUTLayers";
 export { type PsLayerRef } from "./ut-tree/psLayerRef";
 export {
   utLayersToTree,

package/src/ut-tree/getDocumentLayerDescriptors.ts

@@ -0,0 +1,29 @@
+import { batchPlayCommand, batchPlayCommands } from "../core/command";
+import { createMultiGetDocumentCommand } from "../commands-library/multiGetDocument";
+import { createGetDocumentHasBackgroundLayerCommand } from "../commands-library/getDocument";
+import { createGetBackgroundLayerCommand } from "../commands-library/getLayer";
+
+// get layer properties like name and layerID for all layers in the document (by index)
+export const getDocumentLayerDescriptors = async (documentId: number) => {
+  const [layersResult, documentHasBackgroundLayerResult] = await batchPlayCommands([
+    createMultiGetDocumentCommand(documentId),
+    createGetDocumentHasBackgroundLayerCommand(documentId),
+  ]);
+
+  const backgroundLayerResult = documentHasBackgroundLayerResult.hasBackgroundLayer ? await batchPlayCommand(createGetBackgroundLayerCommand(documentId)) : null;
+
+  const list = [...layersResult.list].reverse();
+  if (backgroundLayerResult) {
+    list.push(backgroundLayerResult);
+  }
+
+  // Reverse to get bottom-up order
+  return list.map((layerProp) => {
+    return {
+      ...layerProp,
+      docId: documentId,
+    };
+  });
+};
+
+export type LayerDescriptor = Awaited<ReturnType<typeof getDocumentLayerDescriptors>>[number];

package/src/ut-tree/photoshopLayerDescriptorsToUTLayers.ts

@@ -1,4 +1,4 @@
-import type { LayerDescriptor } from "./getLayerProperties";
+import type { LayerDescriptor } from "./getDocumentLayerDescriptors";
 
 type UTLayerKind = "pixel" | "adjustment-layer" | "text" | "curves" | "smartObject" | "video" | "group" | "threeD" | "gradientFill" | "pattern" | "solidColor" | "background";
 

package/src/ut-tree/photoshopLayerDescriptorsToUTLayers.uxp-test.ts

@@ -2,7 +2,7 @@ import type { Test } from "@bubblydoo/uxp-test-framework";
 import { photoshopLayerDescriptorsToUTLayers } from "./photoshopLayerDescriptorsToUTLayers";
 import { openFileByPath } from "../filesystem/openFileByPath";
 import { expect } from "chai";
-import { getDocumentLayerDescriptors } from "./getLayerProperties";
+import { getDocumentLayerDescriptors } from "./getDocumentLayerDescriptors";
 
 export const photoshopLayerDescriptorsToUTLayersTest: Test = {
   name: "photoshopLayerDescriptorsToUTLayers",