@bubblydoo/uxp-toolkit 0.0.8 → 0.0.10

package/src/ut-tree/utLayersToText.test.ts

@@ -1,59 +1,59 @@
-import { expect, it } from "vitest";
-import { utLayersToText } from "./utLayersToText";
+import { expect, it } from 'vitest';
+import { utLayersToText } from './utLayersToText';
 
-it("converts a single layer to text", () => {
+it('converts a single layer to text', () => {
   expect(utLayersToText([
     {
-      name: "circle",
+      name: 'circle',
       effects: {},
-      blendMode: "normal",
+      blendMode: 'normal',
       isClippingMask: false,
-      kind: "pixel",
+      kind: 'pixel',
       visible: true,
     },
-  ])).toMatchInlineSnapshot(`"◯ circle"`)
+  ])).toMatchInlineSnapshot(`"◯ circle"`);
 });
 
-it("converts a nested layer to text", () => {
+it('converts a nested layer to text', () => {
   expect(utLayersToText([
     {
-      name: "group",
+      name: 'group',
       effects: {},
-      blendMode: "passThrough",
+      blendMode: 'passThrough',
       isClippingMask: false,
-      kind: "group",
+      kind: 'group',
       visible: true,
       layers: [
         {
-          name: "circle",
+          name: 'circle',
           effects: {},
-          blendMode: "normal",
+          blendMode: 'normal',
           isClippingMask: false,
-          kind: "pixel",
+          kind: 'pixel',
           visible: true,
         },
         {
-          name: "square",
+          name: 'square',
           effects: {},
-          blendMode: "normal",
+          blendMode: 'normal',
           isClippingMask: false,
-          kind: "pixel",
+          kind: 'pixel',
           visible: true,
         },
         {
-          name: "other",
+          name: 'other',
           effects: {},
-          blendMode: "passThrough",
+          blendMode: 'passThrough',
           isClippingMask: false,
-          kind: "group",
+          kind: 'group',
           visible: true,
           layers: [
             {
-              name: "nested",
+              name: 'nested',
               effects: {},
-              blendMode: "normal",
+              blendMode: 'normal',
               isClippingMask: false,
-              kind: "pixel",
+              kind: 'pixel',
               visible: true,
             },
           ],
@@ -66,29 +66,29 @@ it("converts a nested layer to text", () => {
     ◯    square
     ◯    ▾ other
     ◯      nested"
-  `)
+  `);
 });
 
-it("converts a nested layer with a clipping mask to text", () => {
+it('converts a nested layer with a clipping mask to text', () => {
   expect(utLayersToText([
     {
-      name: "clipper",
+      name: 'clipper',
       effects: {},
-      blendMode: "normal",
+      blendMode: 'normal',
       isClippingMask: true,
-      kind: "pixel",
+      kind: 'pixel',
       visible: true,
     },
     {
-      name: "circle",
+      name: 'circle',
       effects: {},
-      blendMode: "normal",
+      blendMode: 'normal',
       isClippingMask: false,
-      kind: "pixel",
+      kind: 'pixel',
       visible: true,
     },
   ])).toMatchInlineSnapshot(`
     "◯ ⬐ clipper
     ◯ circle"
-  `)
+  `);
 });

package/src/ut-tree/utLayersToText.ts

@@ -1,32 +1,32 @@
-import type { UTLayerPickKeys } from "../util/utLayerPickKeysType";
-import type { UTLayer } from "./photoshopLayerDescriptorsToUTLayers";
+import type { UTLayerPickKeys } from '../util/utLayerPickKeysType';
+import type { UTLayer } from './photoshopLayerDescriptorsToUTLayers';
 
-const VISIBLE_ICON = "◯";
-const INVISIBLE_ICON = "⊘";
-const CLIPPING_MASK_ICON = "⬐";
-const GROUP_ICON = "▾";
-const EFFECTS_ICON = "ƒ";
-const BLEND_ICON = "⁕"
+const VISIBLE_ICON = '◯';
+const INVISIBLE_ICON = '⊘';
+const CLIPPING_MASK_ICON = '⬐';
+const GROUP_ICON = '▾';
+const EFFECTS_ICON = 'ƒ';
+const BLEND_ICON = '⁕';
 
-type MinimalUTLayer = UTLayerPickKeys<"effects" | "visible" | "isClippingMask" | "kind" | "blendMode" | "name">;
+type MinimalUTLayer = UTLayerPickKeys<'effects' | 'visible' | 'isClippingMask' | 'kind' | 'blendMode' | 'name'>;
 
 export function utLayersToText(tree: MinimalUTLayer[], depth = 0): string {
   return tree.map((layer) => {
-    const prefix = " ".repeat(depth * 2);
+    const prefix = ' '.repeat(depth * 2);
     const name = layer.name;
-    const effects = Object.keys(layer.effects).length > 0 ? EFFECTS_ICON : "";
-    const blend = isSpecialBlendMode(layer) ? BLEND_ICON : "";
-    const clippingMask = layer.isClippingMask ? CLIPPING_MASK_ICON : "";
-    const group = layer.kind === "group" ? GROUP_ICON : "";
+    const effects = Object.keys(layer.effects).length > 0 ? EFFECTS_ICON : '';
+    const blend = isSpecialBlendMode(layer) ? BLEND_ICON : '';
+    const clippingMask = layer.isClippingMask ? CLIPPING_MASK_ICON : '';
+    const group = layer.kind === 'group' ? GROUP_ICON : '';
     const visible = layer.visible ? VISIBLE_ICON : INVISIBLE_ICON;
-    const line = [visible, prefix, clippingMask, group, name, effects, blend].filter(Boolean).join(" ");
+    const line = [visible, prefix, clippingMask, group, name, effects, blend].filter(Boolean).join(' ');
     if (layer.layers) {
-      return line + "\n" + utLayersToText(layer.layers, depth + 1);
+      return `${line}\n${utLayersToText(layer.layers, depth + 1)}`;
     }
     return line;
-  }).join("\n");
+  }).join('\n');
 }
 
-function isSpecialBlendMode(layer: Pick<UTLayer, "kind" | "blendMode">): boolean {
-  return layer.kind === "group" ? layer.blendMode !== "passThrough" : layer.blendMode !== "normal";
+function isSpecialBlendMode(layer: Pick<UTLayer, 'kind' | 'blendMode'>): boolean {
+  return layer.kind === 'group' ? layer.blendMode !== 'passThrough' : layer.blendMode !== 'normal';
 }

package/src/ut-tree/utLayersToTree.ts

@@ -1,10 +1,10 @@
-import type { Tree } from "../general-tree/treeTypes";
-import type { UTLayer } from "./photoshopLayerDescriptorsToUTLayers";
+import type { Tree } from '../general-tree/treeTypes';
+import type { UTLayer } from './photoshopLayerDescriptorsToUTLayers';
 
-export type UTLayerWithoutChildren = Omit<UTLayer, "layers">;
+export type UTLayerWithoutChildren = Omit<UTLayer, 'layers'>;
 
 export function utLayersToTree(layer: UTLayer[]): Tree<UTLayerWithoutChildren> {
-  return layer.map((layer) => ({
+  return layer.map(layer => ({
     ref: {
       name: layer.name,
       docId: layer.docId,

package/src/util/utLayerPickKeysType.ts

@@ -1,5 +1,5 @@
-import type { UTLayer } from "../ut-tree/photoshopLayerDescriptorsToUTLayers";
+import type { UTLayer } from '../ut-tree/photoshopLayerDescriptorsToUTLayers';
 
-export type UTLayerPickKeys<TKey extends keyof Omit<UTLayer, "layers">> = Pick<Omit<UTLayer, "layers">, TKey> & {
+export type UTLayerPickKeys<TKey extends keyof Omit<UTLayer, 'layers'>> = Pick<Omit<UTLayer, 'layers'>, TKey> & {
   layers?: UTLayerPickKeys<TKey>[];
-}
+};

package/src/util/utLayerToLayer.ts

@@ -1,39 +1,40 @@
-import type { Layer as DomLayer } from "photoshop/dom/Layer";
-import type { UTLayer } from "../ut-tree/photoshopLayerDescriptorsToUTLayers";
-import { app } from "photoshop";
-import { getFlattenedDomLayersList } from "../dom/getFlattenedDomLayersList";
+import type { Layer as DomLayer } from 'photoshop';
+import type { UTLayer } from '../ut-tree/photoshopLayerDescriptorsToUTLayers';
+import { app } from 'photoshop';
+import { getFlattenedDomLayersList } from '../dom/getFlattenedDomLayersList';
 
 export function utLayerToDomLayer(layer: UTLayer): DomLayer {
-  const doc = app.documents.find((d) => d.id === layer.docId);
+  const doc = app.documents.find(d => d.id === layer.docId);
   if (!doc) {
     throw new Error(`Document with id ${layer.docId} not found.`);
   }
   const allLayers = getFlattenedDomLayersList(doc.layers);
-  const domLayer = allLayers.find((l) => l.id === layer.id);
+  const domLayer = allLayers.find(l => l.id === layer.id);
   if (!domLayer) {
     throw new Error(
-      `Layer with id ${layer.id} not found in document ${layer.docId}.`
+      `Layer with id ${layer.id} not found in document ${layer.docId}.`,
     );
   }
   return domLayer;
 }
 
 export function utLayersToDomLayers(layers: UTLayer[]): DomLayer[] {
-  if (layers.length === 0) return [];
+  if (layers.length === 0)
+    return [];
   const docId = layers[0]!.docId;
-  if (!layers.every((l) => l.docId === docId)) {
-    throw new Error("All layers must be from the same document.");
+  if (!layers.every(l => l.docId === docId)) {
+    throw new Error('All layers must be from the same document.');
   }
-  const doc = app.documents.find((d) => d.id === docId);
+  const doc = app.documents.find(d => d.id === docId);
   if (!doc) {
     throw new Error(`Document with id ${docId} not found.`);
   }
   const allLayers = getFlattenedDomLayersList(doc.layers);
   return layers.map((l) => {
-    const domLayer = allLayers.find((dl) => dl.id === l.id);
+    const domLayer = allLayers.find(dl => dl.id === l.id);
     if (!domLayer) {
       throw new Error(
-        `Layer with id ${l.id} not found in document ${docId}.`
+        `Layer with id ${l.id} not found in document ${docId}.`,
       );
     }
     return domLayer;

package/test/index.ts

@@ -1,14 +1,14 @@
-import { applicationInfoTest } from "../src/other/applicationInfo.uxp-test";
-import { renameLayerTest } from "../src/commands-library/renameLayer.uxp-test";
-import { suspendHistoryErrorTest } from "./meta-tests/suspendHistory.uxp-test";
-import { executeAsModalErrorTest } from "./meta-tests/executeAsModal.uxp-test";
-import { suspendHistoryTest } from "../src/core/suspendHistory.uxp-test";
-import { sourcemapsTest } from "../src/error-sourcemaps/sourcemaps.uxp-test";
-import { clipboardTest } from "../src/other/clipboard.uxp-test";
-import { photoshopLayerDescriptorsToUTLayersTest, photoshopLayerDescriptorsToUTLayersTest2 } from "../src/ut-tree/photoshopLayerDescriptorsToUTLayers.uxp-test";
-import { metadataStorageTest } from "../src/metadata-storage/metadataStorage.uxp-test";
-import { builtinModulesTest } from "./meta-tests/builtinModules.uxp-test";
-import { backgroundLayerTest } from "../src/ut-tree/hasBackgroundLayer.uxp-test";
+import { renameLayerTest } from '../src/commands-library/renameLayer.uxp-test';
+import { suspendHistoryTest } from '../src/core/suspendHistory.uxp-test';
+import { sourcemapsTest } from '../src/error-sourcemaps/sourcemaps.uxp-test';
+import { metadataStorageTest } from '../src/metadata-storage/metadataStorage.uxp-test';
+import { applicationInfoTest } from '../src/other/applicationInfo.uxp-test';
+import { clipboardTest } from '../src/other/clipboard.uxp-test';
+import { backgroundLayerTest } from '../src/ut-tree/hasBackgroundLayer.uxp-test';
+import { photoshopLayerDescriptorsToUTLayersTest, photoshopLayerDescriptorsToUTLayersTest2 } from '../src/ut-tree/photoshopLayerDescriptorsToUTLayers.uxp-test';
+import { builtinModulesTest } from './meta-tests/builtinModules.uxp-test';
+import { executeAsModalErrorTest } from './meta-tests/executeAsModal.uxp-test';
+import { suspendHistoryErrorTest } from './meta-tests/suspendHistory.uxp-test';
 
 export const tests = [
   applicationInfoTest,

package/test/meta-tests/builtinModules.uxp-test.ts

@@ -1,42 +1,44 @@
-import type { Test } from "@bubblydoo/uxp-test-framework";
-import { expect } from "chai";
+import type { Test } from '@bubblydoo/uxp-test-framework';
+import { expect } from 'chai';
 
 export const builtinModulesTest: Test = {
-  name: "meta: some builtin modules should be available",
+  name: 'meta: some builtin modules should be available',
   async run() {
     const testModules = [
-      "photoshop",
-      "uxp",
-      "fs",
-      "os",
-      "path",
-      "process",
-      "shell",
-      "http",
-      "https",
-      "url",
-      "util",
-      "crypto",
-      "stream",
-      "zlib",
+      'photoshop',
+      'uxp',
+      'fs',
+      'os',
+      'path',
+      'process',
+      'shell',
+      'http',
+      'https',
+      'url',
+      'util',
+      'crypto',
+      'stream',
+      'zlib',
     ];
     const successModules = testModules.filter(module => doesImportExist(module));
     expect(successModules).to.deep.eq([
-      "photoshop",
-      "uxp",
-      "fs",
-      "os",
-      "path",
-      "process",
-    ]); 
+      'photoshop',
+      'uxp',
+      'fs',
+      'os',
+      'path',
+      'process',
+    ]);
   },
 };
 
 function doesImportExist(module: string) {
   try {
+    // eslint-disable-next-line ts/no-require-imports
     require(module);
     return true;
-  } catch {
+  }
+  catch {
     return false;
   }
-}
+}

package/test/meta-tests/executeAsModal.uxp-test.ts

@@ -1,37 +1,39 @@
-import { core } from "photoshop";
-import type { Test } from "@bubblydoo/uxp-test-framework";
-import { expect } from "chai";
+import type { Test } from '@bubblydoo/uxp-test-framework';
+import { expect } from 'chai';
+import { core } from 'photoshop';
 
 export const executeAsModalErrorTest: Test = {
-  name: "meta: executeAsModal should throw correctly",
+  name: 'meta: executeAsModal should throw correctly',
   async run() {
     let threw = false;
     try {
       await core.executeAsModal(
         async () => {
-          throw new Error("Uncaught error");
+          throw new Error('Uncaught error');
         },
         {
-          commandName: "Test",
-        }
+          commandName: 'Test',
+        },
       );
-    } catch (e) {
+    }
+    catch (_e) {
       threw = true;
     }
+    // eslint-disable-next-line ts/no-unused-expressions
     expect(threw).to.be.true;
   },
 };
 
 export const executeAsModalReturnTest: Test = {
-  name: "meta: executeAsModal should return correctly",
+  name: 'meta: executeAsModal should return correctly',
   async run() {
     const result = await core.executeAsModal(
       async () => {
-        return 'test'
+        return 'test';
       },
       {
-        commandName: "Test",
-      }
+        commandName: 'Test',
+      },
     );
     expect(result).to.equal('test');
   },

package/test/meta-tests/suspendHistory.uxp-test.ts

@@ -1,27 +1,28 @@
-import { app } from "photoshop";
-import type { Test } from "@bubblydoo/uxp-test-framework";
-import { expect } from "chai";
+import type { Test } from '@bubblydoo/uxp-test-framework';
+import { expect } from 'chai';
+import { app } from 'photoshop';
 
 export const suspendHistoryErrorTest: Test = {
-  name: "meta: suspendHistory should throw correctly",
+  name: 'meta: suspendHistory should throw correctly',
   async run() {
     const document = app.activeDocument;
     if (!document) {
-      throw new Error("No active document");
+      throw new Error('No active document');
     }
 
     let threw = false;
     try {
       await document.suspendHistory(
         async (context) => {
-          throw new Error("Uncaught error");
+          throw new Error('Uncaught error');
         },
-        "Test"
+        'Test',
       );
-    } catch (e) {
+    }
+    catch (_e) {
       threw = true;
     }
+    // eslint-disable-next-line ts/no-unused-expressions
     expect(threw).to.be.true;
   },
 };
-

package/tsconfig.json

@@ -1,13 +1,13 @@
 {
   "extends": "@bubblydoo/tsconfig/tsconfig.base.json",
   "compilerOptions": {
-    "allowJs": true,
     "moduleDetection": "force",
-    "verbatimModuleSyntax": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
     "rootDir": ".",
-    "typeRoots": ["./node_modules/@adobe-uxp-types", "./node_modules/@types"]
+    "typeRoots": ["./node_modules/@adobe-uxp-types", "./node_modules/@types"],
+    "allowJs": true,
+    "noImplicitOverride": true,
+    "noUncheckedIndexedAccess": true,
+    "verbatimModuleSyntax": true
   },
   "include": ["src", "test"]
 }

package/tsup.config.ts

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

package/typedoc.json

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

package/uxp-tests.json

@@ -11,4 +11,4 @@
     "hotReloadPort": 8081,
     "enableTsconfigPathsPlugin": true
   }
-}
+}

package/vitest-photoshop-alias-plugin.ts

@@ -1,12 +1,12 @@
-import { Plugin } from "vitest/config";
-import dedent from "dedent";
+import type { Plugin } from 'vitest/config';
+import dedent from 'dedent';
 
 const nativeModules = [
-  "photoshop",
-  "uxp",
+  'photoshop',
+  'uxp',
 ];
 
-const pluginPrefix = "photoshop-builtin"
+const pluginPrefix = 'photoshop-builtin';
 
 const minimalModules = {
   photoshop: dedent`
@@ -18,24 +18,26 @@ export const app = UNIMPLEMENTED;
 export const entrypoints = UNIMPLEMENTED;
 export const storage = UNIMPLEMENTED;
   `,
-}
+};
 
-export const vitestPhotoshopAliasPlugin = (): Plugin => ({
-  name: "vitest-photoshop-alias",
-  resolveId(id) {
-    if (nativeModules.includes(id)) {
-      return `${id}?${pluginPrefix}`
-    }
-  },
-  load(id) {
-    if (id.endsWith(`?${pluginPrefix}`)) {
-      const origModuleId = id.replace(`?${pluginPrefix}`, "");
-      const mod = dedent`
+export function vitestPhotoshopAliasPlugin(): Plugin {
+  return {
+    name: 'vitest-photoshop-alias',
+    resolveId(id) {
+      if (nativeModules.includes(id)) {
+        return `${id}?${pluginPrefix}`;
+      }
+    },
+    load(id) {
+      if (id.endsWith(`?${pluginPrefix}`)) {
+        const origModuleId = id.replace(`?${pluginPrefix}`, '');
+        const mod = dedent`
         // This is a photoshop builtin module, not available in Vitest. This is an alias to provide minimal compatibility.
         const UNIMPLEMENTED = { __vitest_photoshop_alias_unimplemented__: true };
         ${minimalModules[origModuleId]}
       `;
-      return mod;
-    }
-  }
-});
+        return mod;
+      }
+    },
+  };
+}

package/vitest.config.ts

@@ -1,16 +1,16 @@
-import { defineConfig } from "vitest/config";
-import { vitestPhotoshopAliasPlugin } from "./vitest-photoshop-alias-plugin";
+import { defineConfig } from 'vitest/config';
+import { vitestPhotoshopAliasPlugin } from './vitest-photoshop-alias-plugin';
 
 export default defineConfig({
   test: {
-    include: ["src/**/*.test.ts"],
-    reporters: process.env.CI ? ["default", "junit"] : ["default"],
+    include: ['src/**/*.test.ts'],
+    reporters: process.env.CI ? ['default', 'junit'] : ['default'],
     outputFile: {
-      junit: "./test-results/junit.xml",
+      junit: './test-results/junit.xml',
     },
     typecheck: {
       enabled: true,
-      include: ["src/**/*.test-d.ts"],
+      include: ['src/**/*.test-d.ts'],
     },
   },
   plugins: [vitestPhotoshopAliasPlugin()],