@bubblydoo/uxp-toolkit 0.0.4 → 0.0.5

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @bubblydoo/uxp-toolkit@0.0.4 build /home/runner/work/uxp-toolkit/uxp-toolkit/packages/uxp-toolkit
+> @bubblydoo/uxp-toolkit@0.0.5 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 19.84 KB
-ESM ⚡️ Build success in 28ms
+ESM dist/index.js 18.29 KB
+ESM ⚡️ Build success in 29ms
 DTS Build start
-DTS ⚡️ Build success in 2388ms
-DTS dist/index.d.ts 10.96 KB
+DTS ⚡️ Build success in 2357ms
+DTS dist/index.d.ts 11.44 KB

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @bubblydoo/uxp-toolkit
 
+## 0.0.5
+
+### Patch Changes
+
+- c98453b: Get all layers with one batchPlay command
+  Add utLayersToText helper
+
 ## 0.0.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -97,12 +97,6 @@ declare function suspendHistory<T>(document: Document, historyStateName: string,
 type CombinedFn<T> = (executionContext: ExtendedExecutionContext, suspendHistoryContext: SuspendHistoryContext) => Promise<T>;
 declare const executeAsModalAndSuspendHistory: <T>(commandName: string, document: Document, fn: CombinedFn<T>) => Promise<T>;
 
-declare const getLayerProperties$1: (document: Document) => Promise<{
-    name: string;
-    layerID: number;
-    visible?: boolean | undefined;
-}[]>;
-
 type PsLayerRef = {
     id: number;
     docId: number;
@@ -110,6 +104,39 @@ type PsLayerRef = {
 
 declare function createRenameLayerCommand(layerRef: PsLayerRef, newName: string): UTCommandModifying<unknown>;
 
+declare function createGetDocumentCommand(documentId: number): UTCommandNonModifying<{
+    title: string;
+    documentID: number;
+    visible: boolean;
+    hasBackgroundLayer: boolean;
+}>;
+declare function createGetDocumentHasBackgroundLayerCommand(documentId: number): UTCommandNonModifying<{
+    hasBackgroundLayer: boolean;
+}>;
+
+declare function createGetBackgroundLayerCommand(docId: number): UTCommandNonModifying<{
+    name: string;
+    visible: boolean;
+    group: boolean;
+    layerSection: {
+        _value: "layerSectionStart" | "layerSectionEnd" | "layerSectionContent";
+        _enum: "layerSectionType";
+    };
+    layerKind: number;
+    itemIndex: number;
+    background: boolean;
+    mode: {
+        _enum: "blendMode";
+        _value: string;
+    };
+    layerID: number;
+    layerEffects?: Record<string, {
+        enabled?: boolean | undefined;
+    } | {
+        enabled: boolean;
+    }[]> | undefined;
+}>;
+
 declare const getFlattenedDomLayersList: (layers: Layer[]) => Layer[];
 
 type Tree<TRef = unknown> = {
@@ -173,69 +200,54 @@ declare const uxpEntrypointsSchema: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 
-declare const layerDescriptorSchema: z.ZodObject<{
-    name: z.ZodString;
-    layerID: z.ZodNumber;
-    mode: z.ZodObject<{
-        _enum: z.ZodLiteral<"blendMode">;
-        _value: z.ZodString;
-    }, z.core.$strip>;
-    background: z.ZodBoolean;
-    itemIndex: z.ZodNumber;
-    visible: z.ZodBoolean;
-    layerKind: z.ZodNumber;
-    layerSection: z.ZodObject<{
-        _value: z.ZodEnum<{
-            layerSectionStart: "layerSectionStart";
-            layerSectionEnd: "layerSectionEnd";
-            layerSectionContent: "layerSectionContent";
-        }>;
-        _enum: z.ZodLiteral<"layerSectionType">;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-type LayerDescriptor = z.infer<typeof layerDescriptorSchema> & {
-    docId: number;
-};
-declare const getFlattenedLayerDescriptorsList: (documentId: number) => Promise<{
-    docId: number;
-    name: string;
-    layerID: number;
-    mode: {
-        _enum: "blendMode";
-        _value: string;
-    };
-    background: boolean;
-    itemIndex: number;
-    visible: boolean;
-    layerKind: number;
-    layerSection: {
-        _value: "layerSectionStart" | "layerSectionEnd" | "layerSectionContent";
-        _enum: "layerSectionType";
-    };
-}[]>;
-
 declare function createGetLayerPropertiesCommand(docId: number): UTCommandNonModifying<{
     list: {
         name: string;
         layerID: number;
-        visible?: boolean | undefined;
+        visible: boolean;
+        group: boolean;
+        layerSection: {
+            _value: "layerSectionStart" | "layerSectionEnd" | "layerSectionContent";
+            _enum: "layerSectionType";
+        };
+        layerKind: number;
+        itemIndex: number;
+        background: boolean;
+        mode: {
+            _enum: "blendMode";
+            _value: string;
+        };
+        layerEffects?: Record<string, {
+            enabled?: boolean | undefined;
+        } | {
+            enabled: boolean;
+        }[]> | undefined;
     }[];
 }>;
-declare const getLayerProperties: (documentId: number) => Promise<{
+declare const getDocumentLayerDescriptors: (documentId: number) => Promise<{
+    docId: number;
     name: string;
     layerID: number;
-    visible?: boolean | undefined;
-}[]>;
-
-declare function createGetLayerCommand(layerRef: PsLayerRef): UTCommandNonModifying<{
-    layerID: number;
-    group?: boolean | undefined;
+    visible: boolean;
+    group: boolean;
+    layerSection: {
+        _value: "layerSectionStart" | "layerSectionEnd" | "layerSectionContent";
+        _enum: "layerSectionType";
+    };
+    layerKind: number;
+    itemIndex: number;
+    background: boolean;
+    mode: {
+        _enum: "blendMode";
+        _value: string;
+    };
     layerEffects?: Record<string, {
         enabled?: boolean | undefined;
     } | {
         enabled: boolean;
     }[]> | undefined;
-}>;
+}[]>;
+
 declare function getLayerEffects(layerRef: PsLayerRef): Promise<Record<string, boolean>>;
 
 type UTLayerKind = "pixel" | "adjustment-layer" | "text" | "curves" | "smartObject" | "video" | "group" | "threeD" | "gradientFill" | "pattern" | "solidColor" | "background";
@@ -249,16 +261,23 @@ type UTLayerBuilder = {
     blendMode: UTBlendMode;
     effects: Record<string, boolean>;
     isClippingMask: boolean;
+    background: boolean;
     layers?: UTLayerBuilder[];
 };
 type UTLayer = Readonly<Omit<UTLayerBuilder, "layers">> & {
     layers?: UTLayer[];
 };
-declare const photoshopLayerDescriptorsToUTLayers: (layers: LayerDescriptor[]) => Promise<UTLayer[]>;
 
 type UTLayerWithoutChildren = Omit<UTLayer, "layers">;
 declare function utLayersToTree(layer: UTLayer[]): Tree<UTLayerWithoutChildren>;
 
+type UTLayerPickKeys<TKey extends keyof Omit<UTLayer, "layers">> = Pick<Omit<UTLayer, "layers">, TKey> & {
+    layers?: UTLayerPickKeys<TKey>[];
+};
+
+type MinimalUTLayer = UTLayerPickKeys<"effects" | "visible" | "isClippingMask" | "kind" | "blendMode" | "name">;
+declare function utLayersToText(tree: MinimalUTLayer[], depth?: number): string;
+
 declare function utLayerToDomLayer(layer: UTLayer): Layer;
 declare function utLayersToDomLayers(layers: UTLayer[]): Layer[];
 
@@ -268,4 +287,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 LayerDescriptor, type LayerRef, type PsLayerRef, type SuspendHistoryContext, type Tree, type UTCommandBase, type UTCommandModifying, type UTCommandNonModifying, type UTCommandResult, type UTLayer, type UTLayerWithoutChildren, batchPlay, batchPlayCommand, batchPlayCommands, copyToClipboard, createCommand, createGetLayerCommand as createGetLayerEffectsCommand, createGetLayerPropertiesCommand, createModifyingBatchPlayContext, createRenameLayerCommand, executeAsModal, executeAsModalAndSuspendHistory, flattenTree, getBasicStackFrameAbsoluteFilePath, getFlattenedDomLayersList, getFlattenedLayerDescriptorsList, getLayerEffects, getLayerProperties$1 as getLayerProperties, getLayerProperties as getLayerPropertiesFromUtTree, mapTree, mapTreeRef, openFileByPath, parseUxpErrorSourcemaps, photoshopDomLayersToTree, photoshopGetApplicationInfo, photoshopLayerDescriptorsToUTLayers, readFromClipboard, suspendHistory, utLayerToDomLayer, utLayersToDomLayers, utLayersToTree, 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, 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 };