UXP Toolkit
    Preparing search index...

    Module @bubblydoo/uxp-toolkit - v0.0.17

    @bubblydoo/uxp-toolkit

    NPM Version

    Typed helpers for Adobe Photoshop UXP plugins: safer batchPlay, command builders, and utilities around layer/document workflows.

    pnpm add @bubblydoo/uxp-toolkit
    

    Optional type packages:

    pnpm add -D @adobe-uxp-types/uxp @adobe-uxp-types/photoshop
    
    import { createCommand, batchPlayCommand } from '@bubblydoo/uxp-toolkit';
    import { z } from 'zod';

    const result = await batchPlayCommand(createCommand({
    modifying: false,
    descriptor: {
    _obj: 'get',
    _target: [{ _ref: 'layer', _id: 123 }],
    },
    schema: z.object({ name: z.string() }),
    }));
    • The package is built around schema-validated command output, so batchPlay results become explicit types instead of ad-hoc any.
    • @bubblydoo/uxp-toolkit/commands exposes prebuilt command descriptors for common Photoshop actions.
    • Utilities such as layer-tree conversion and sourcemap parsing target practical pain points in large UXP plugins.

    Interfaces

    LayerRef
    PsLayerRef
    SuspendHistoryContext
    UTCommandBase
    UTCommandModifying
    UTCommandNonModifying

    Type Aliases

    BasicStackFrame
    ExtendedExecutionContext
    LayerDescriptor
    Tree
    UTCommandResult
    UTLayer
    UTLayerPickKeys
    UTLayerWithoutChildren

    Variables

    uxpEntrypointsSchema

    Functions

    batchPlay
    batchPlayCommand
    batchPlayCommands
    copyToClipboard
    createCommand
    createModifyingBatchPlayContext
    createMultiGetDocumentCommand
    executeAsModal
    executeAsModalAndSuspendHistory
    flattenTree
    getBasicStackFrameAbsoluteFilePath
    getDocumentLayerDescriptors
    getFlattenedDomLayersList
    getLayerEffects
    isFile
    isFolder
    mapTree
    mapTreeRef
    openFileByPath
    parseUxpErrorSourcemaps
    photoshopDomLayersToTree
    photoshopGetApplicationInfo
    photoshopLayerDescriptorsToUTLayers
    readFromClipboard
    suspendHistory
    utLayersToDomLayers
    utLayersToText
    utLayersToTree
    utLayerToDomLayer