@bubblydoo/uxp-toolkit 0.0.5 → 0.0.7

package/src/commands-library/expandFolder.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+import type { PsLayerRef } from "../ut-tree/psLayerRef";
+
+export function createExpandFolderCommand(layerRef: PsLayerRef) {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'set',
+      _target: {
+        _ref: [
+          { _property: 'layerSectionExpanded' },
+          { _ref: 'layer', _id: layerRef.id },
+          { _ref: 'document', _id: layerRef.docId }
+        ],
+      },
+      to: true,
+    },
+    schema: z.unknown(),
+  });
+}

package/src/commands-library/exportLUTs.ts

@@ -0,0 +1,45 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export type LUTExportFormat = 'CUBE' | 'ICC' | '3DL' | 'CSP';
+
+export interface ExportLUTsOptions {
+  description?: string;
+  gridPoints?: number;
+  copyright?: string;
+  exportFormats?: LUTExportFormat[];
+  lowercaseExtension?: boolean;
+}
+
+export function createExportLUTsCommand(
+  path: string,
+  options: ExportLUTsOptions = {}
+) {
+  const {
+    description = 'Exported LUT',
+    gridPoints = 32,
+    copyright = 'Copyright',
+    exportFormats = ['CUBE', 'ICC', '3DL', 'CSP'] as LUTExportFormat[],
+    lowercaseExtension = false,
+  } = options;
+
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'export',
+      using: {
+        _obj: '$lut ',
+        $fpth: path,
+        $dscr: description,
+        $gPts: gridPoints,
+        copyright: copyright,
+        $wICC: exportFormats.includes('ICC'),
+        $w3DL: exportFormats.includes('3DL'),
+        $wCUB: exportFormats.includes('CUBE'),
+        $wCSP: exportFormats.includes('CSP'),
+        $lcFE: lowercaseExtension,
+      },
+    },
+    schema: z.unknown(),
+  });
+}

package/src/commands-library/hasVectorMask.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export function createHasVectorMaskCommand(layerId: number) {
+  return createCommand({
+    modifying: false,
+    descriptor: {
+      _obj: 'get',
+      _target: [
+        {
+          _property: 'hasVectorMask',
+        },
+        {
+          _ref: 'layer',
+          _id: layerId,
+        },
+      ],
+    },
+    schema: z.object({
+      hasVectorMask: z.boolean(),
+    }),
+  });
+}

package/src/commands-library/index.ts

@@ -0,0 +1,29 @@
+// Layer selection and manipulation
+export * from './selectLayer';
+export * from './addLayerToSelection';
+export * from './expandFolder';
+
+// Layer operations
+export * from './getLayer';
+export * from './renameLayer';
+export * from './rasterizeLayerStyle';
+export * from './rasterizeVectorMask';
+
+// Layer mask operations
+export * from './applyLayerMask';
+export * from './removeLayerMask';
+export * from './loadLayerMaskAsSelection';
+export * from './hasVectorMask';
+
+// Document operations
+export * from './getDocument';
+export * from './multiGetDocument';
+export * from './convertMode';
+
+// Color and LUT operations
+export * from './createColorLookupAdjustmentLayer';
+export * from './set3DLUTColorLookup';
+export * from './exportLUTs';
+
+// Other
+export * from './renderGrid';

package/src/commands-library/loadLayerMaskAsSelection.ts

@@ -0,0 +1,31 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export function createLoadLayerMaskAsSelectionCommand(layerId: number) {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'set',
+      _target: [
+        {
+          _ref: 'channel',
+          _property: 'selection',
+        },
+      ],
+      to: {
+        _ref: [
+          {
+            _ref: 'channel',
+            _enum: 'channel',
+            _value: 'mask',
+          },
+          {
+            _ref: 'layer',
+            _id: layerId,
+          },
+        ],
+      },
+    },
+    schema: z.unknown(),
+  });
+}

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/rasterizeLayerStyle.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+import type { PsLayerRef } from "../ut-tree/psLayerRef";
+
+export function createRasterizeLayerStyleCommand(psLayerRef: PsLayerRef) {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'rasterizeLayer',
+      _target: [{ _ref: 'layer', _id: psLayerRef.id }, { _ref: 'document', _id: psLayerRef.docId }],
+      what: { _enum: 'rasterizeItem', _value: 'layerStyle' },
+    },
+    schema: z.unknown(),
+  });
+}

package/src/commands-library/rasterizeVectorMask.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export function createRasterizeVectorMaskCommand() {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'rasterizeLayer',
+      _target: [
+        {
+          _ref: 'layer',
+          _enum: 'ordinal',
+          _value: 'targetEnum',
+        },
+      ],
+      what: {
+        _enum: 'rasterizeItem',
+        _value: 'vectorMask',
+      },
+    },
+    schema: z.unknown(),
+  });
+}

package/src/commands-library/removeLayerMask.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export function createDeleteChannelCommand() {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'delete',
+      _target: [
+        {
+          _ref: 'channel',
+          _enum: 'ordinal',
+          _value: 'targetEnum',
+        },
+      ],
+    },
+    schema: z.unknown(),
+  });
+}

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/commands-library/renderGrid.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export function createRenderGridCommand(gridPoints: number) {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: '$3grd',
+      $grdP: gridPoints,
+    },
+    schema: z.unknown(),
+  });
+}

package/src/commands-library/selectLayer.ts

@@ -0,0 +1,26 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+import type { PsLayerRef } from "../ut-tree/psLayerRef";
+
+export function createSelectLayerCommand(layerRef: PsLayerRef) {
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'select',
+      _target: [
+        {
+          _ref: 'layer',
+          _id: layerRef.id,
+        },
+        {
+          _ref: 'document',
+          _id: layerRef.docId,
+        },
+      ],
+      makeVisible: false,
+      layerID: [layerRef.id],
+      _isCommand: false,
+    },
+    schema: z.unknown(),
+  });
+}

package/src/commands-library/set3DLUTColorLookup.ts

@@ -0,0 +1,61 @@
+import { z } from "zod";
+import { createCommand } from "../core/command";
+
+export type LUTFormatType = 'LUTFormatCUBE' | 'LUTFormat3DL' | 'LUTFormatCSP';
+
+export interface Set3DLUTColorLookupOptions {
+  lutPath: string;
+  lutFormat?: LUTFormatType;
+  profileBase64?: string;
+  lutFileDataBase64?: string;
+}
+
+export function createSet3DLUTColorLookupCommand(options: Set3DLUTColorLookupOptions) {
+  const {
+    lutPath,
+    lutFormat = 'LUTFormatCUBE',
+    profileBase64,
+    lutFileDataBase64,
+  } = options;
+
+  return createCommand({
+    modifying: true,
+    descriptor: {
+      _obj: 'set',
+      _target: [
+        {
+          _enum: 'ordinal',
+          _ref: 'adjustmentLayer',
+          _value: 'targetEnum',
+        },
+      ],
+      to: {
+        _obj: 'colorLookup',
+        lookupType: {
+          _enum: 'colorLookupType',
+          _value: '3DLUT',
+        },
+        name: lutPath,
+        LUTFormat: {
+          _enum: 'LUTFormatType',
+          _value: lutFormat,
+        },
+        ...(profileBase64 && {
+          profile: {
+            _data: profileBase64,
+            _rawData: 'base64',
+          },
+        }),
+        ...(lutFileDataBase64 && {
+          LUT3DFileData: {
+            _data: lutFileDataBase64,
+            _rawData: 'base64',
+          },
+        }),
+        LUT3DFileName: lutPath,
+      },
+      _isCommand: true,
+    },
+    schema: z.unknown(),
+  });
+}

package/src/index.ts

@@ -26,11 +26,6 @@ export {
 // Core wrappers
 export { executeAsModalAndSuspendHistory } from "./core-wrappers/executeAsModalAndSuspendHistory";
 
-// Commands library
-export { createRenameLayerCommand } from "./commands-library/renameLayer";
-export { createGetDocumentCommand, createGetDocumentHasBackgroundLayerCommand } from "./commands-library/getDocument";
-export { createGetBackgroundLayerCommand } from "./commands-library/getLayer";
-
 // DOM – layers
 export { getFlattenedDomLayersList } from "./dom/getFlattenedDomLayersList";
 export { photoshopDomLayersToTree } from "./dom/photoshopDomLayersToTree";
@@ -51,12 +46,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, type LayerDescriptor } 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",

package/tsup.config.ts

@@ -1,9 +1,9 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  entry: ["src/index.ts"],
-  format: "esm",
-  dts: true,
-  external: ["photoshop", "uxp"],
-  outDir: "dist",
-});
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts", "src/commands-library/index.ts"],
+  format: "esm",
+  dts: true,
+  external: ["photoshop", "uxp"],
+  outDir: "dist",
+});