@adobe/aio-lib-photoshop-api v1.1.0

Adobe Photoshop API Library

Rest API

The Rest API is documented at:

• Public Documentation

Installing

$ npm install @adobe/aio-lib-photoshop-api

Usage

1) Initialize the SDK

const sdk = require('@adobe/aio-lib-photoshop-api')

async function sdkTest() {
  try {
    //initialize sdk
    const client = await sdk.init('<ims org id>', '<api key>', '<valid auth token>')
  } catch (e) {
    console.error(e)
  }
}

2) Remove the background of a photo

This is the example of using the storage type of http://host/input.jpg (External) and call the service to cutout the background, ask for JPEG output, and store the result in Adobe Creative Cloud file storage path/output.jpg.

const sdk = require('@adobe/aio-lib-photoshop-api')

async function sdkTest() {
  try {
    // initialize sdk
    const client = await sdk.init('<ims org id>', '<api key>', '<valid auth token>')

    // call methods
    const result = await client.createCutout({
      href: 'http://host/input.jpg',
      storage: sdk.Storage.EXTERNAL
    }, {
      href: 'path/output.png',
      storage: sdk.Storage.ADOBE,
      type: sdk.MimeType.PNG
    })
  } catch (e) {
    console.error(e)
  }
}

Usage with Adobe I/O Files access

1) Initialize the SDK with Adobe I/O Files access

Configuring the SDK like this will make plain paths reference locations in Adobe I/O Files.

const libFiles = require('@adobe/aio-lib-files')
const sdk = require('@adobe/aio-lib-photoshop-api')

async function sdkTest() {
  try {
    // initialize sdk
    const files = await libFiles.init();
    const client = await sdk.init('<ims org id>', '<api key>', '<valid auth token>', files)
  } catch (e) {
    console.error(e)
  }
}

2) Remove the background of a photo

This will automatically detect the storage type of http://host/input.jpg (e.g. Azure, External) and call the service to cutout the background, ask for JPEG output, and store the result in Adobe I/O Files under path/output.jpg.

const libFiles = require('@adobe/aio-lib-files')
const sdk = require('@adobe/aio-lib-photoshop-api')

async function sdkTest() {
  try {
    // initialize sdk
    const files = await libFiles.init();
    const client = await sdk.init('<ims org id>', '<api key>', '<valid auth token>', files)

    // call methods
    // auto cutout...
    const result = await client.createCutout('http://host/input.jpg', 'path/output.jpg')
    console.log(result)

    // equivalent call without FileResolver...
    const result = await client.createCutout({
      href: 'http://host/input.jpg',
      storage: sdk.Storage.EXTERNAL
    }, {
      href: 'path/output.png',
      storage: sdk.Storage.AIO,
      type: sdk.MimeType.PNG
    })
  } catch (e) {
    console.error(e)
  }
}

Classes

Functions

Typedefs

FileResolver

Resolves the storage and mime type of files referenced in the API.

The storage type storage type is resolved for input and output files using the following heuristic:

• If the storage type is provided, it is used as-is
• If a URL is provided, the hostname is inspected to determine Azure, Dropbox, or External (default)
• If a path is provided, the path resolved to Adobe I/O Files if an instance is provided to the constructor, otherwise it's Creative Cloud

Path resolution can be overridden by the defaultAdobeCloudPaths option.

The mime-type is resolved based on the extension of the pathname of the URL or the path. If no extension can be found or the extension is unknown, the default image/png is selected.

Kind: global class

• FileResolver
  • new FileResolver([files], [options])
  • .presignExpiryInSeconds : number
  • .defaultPathStorage : Storage
  • .resolveInput(input) ⇒ Input
  • .resolveInputs(inputs) ⇒ Array.<Input>
  • .resolveInputsDocumentOptions(options) ⇒ CreateDocumentOptions | ModifyDocumentOptions | ReplaceSmartObjectOptions
  • .resolveInputsPhotoshopActionsOptions(options) ⇒ ApplyPhotoshopActionsOptions
  • .resolveOutput(output) ⇒ Output
  • .resolveOutputs(outputs) ⇒ Array.<Output>

new FileResolver(files, options)

Construct a file resolver

fileResolver.presignExpiryInSeconds : number

Expiry time of presigned urls in seconds

Kind: instance property of FileResolver

fileResolver.defaultPathStorage : Storage

Plain paths can reference either Adobe Creative Cloud or Adobe I/O Files.

If an instance of files is provided, the default is considered to be Adobe I/O Files, otherwise it's Creative Cloud. The default can be overridden using the options

Kind: instance property of FileResolver

fileResolver.resolveInput(input) ⇒ Input

Resolve input file from href to an object with href and storage

Kind: instance method of FileResolver
Returns: Input - resolved input

fileResolver.resolveInputs(inputs) ⇒ Array.<Input>

Resolve input files from hrefs to an array of objects with href and storage

Kind: instance method of FileResolver
Returns: Array.<Input> - resolved files

fileResolver.resolveInputsDocumentOptions(options) ⇒ CreateDocumentOptions | ModifyDocumentOptions | ReplaceSmartObjectOptions

Resolve the font and layer inputs in the document options

Kind: instance method of FileResolver
Returns: CreateDocumentOptions | ModifyDocumentOptions | ReplaceSmartObjectOptions - Document options

fileResolver.resolveInputsPhotoshopActionsOptions(options) ⇒ ApplyPhotoshopActionsOptions

Resolve the actions, fonts, and custom presets options

Kind: instance method of FileResolver
Returns: ApplyPhotoshopActionsOptions - Photoshop Actions options

fileResolver.resolveOutput(output) ⇒ Output

Resolve output from href to an object with href, storage, and type

Kind: instance method of FileResolver
Returns: Output - resolved files

fileResolver.resolveOutputs(outputs) ⇒ Array.<Output>

Resolve outputs from href to an object with href, storage, and type

Kind: instance method of FileResolver
Returns: Array.<Output> - resolved files

PhotoshopAPI

This class provides methods to call your PhotoshopAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid values for orgId, apiKey and accessToken

Kind: global class

• PhotoshopAPI
  • .orgId : string
  • .apiKey : string
  • .accessToken : string
  • .init(orgId, apiKey, accessToken, [files], [options]) ⇒ Promise.<PhotoshopAPI>
  • .createCutout(input, output) ⇒ Job
  • .createMask(input, output) ⇒ Job
  • .straighten(input, outputs) ⇒ Job
  • .autoTone(input, output) ⇒ Job
  • .editPhoto(input, output, options) ⇒ Job
  • .applyPreset(input, preset, output) ⇒ Job
  • .applyPresetXmp(input, output, xmp) ⇒ Job
  • .createDocument(outputs, options) ⇒ Job
  • .getDocumentManifest(input, [options]) ⇒ Job
  • .modifyDocument(input, outputs, options) ⇒ Job
  • .createRendition(input, outputs) ⇒ Job
  • .replaceSmartObject(input, outputs, options) ⇒ Job
  • .applyPhotoshopActions(input, outputs, options) ⇒ Job
  • .applyPhotoshopActionsJson(input, outputs, options) ⇒ Job

photoshopAPI.orgId : string

The IMS organization id

Kind: instance property of PhotoshopAPI

photoshopAPI.apiKey : string

The api key from your integration

Kind: instance property of PhotoshopAPI

photoshopAPI.accessToken : string

The access token from your integration

Kind: instance property of PhotoshopAPI

photoshopAPI.init(orgId, apiKey, accessToken, files, options) ⇒ Promise.<PhotoshopAPI>

Initializes the PhotoshopAPI object and returns it.

Kind: instance method of PhotoshopAPI
Returns: Promise.<PhotoshopAPI> - a PhotoshopAPI object

photoshopAPI.createCutout(input, output) ⇒ Job

Create a cutout mask, and apply it to the input

Kind: instance method of PhotoshopAPI
Returns: Job - Auto cutout job

photoshopAPI.createMask(input, output) ⇒ Job

Create a cutout mask

Kind: instance method of PhotoshopAPI
Returns: Job - Auto masking job

photoshopAPI.straighten(input, outputs) ⇒ Job

Straighten photo

Kind: instance method of PhotoshopAPI
Returns: Job - Auto straighten job

photoshopAPI.autoTone(input, output) ⇒ Job

Automatically tone photo

Kind: instance method of PhotoshopAPI
Returns: Job - Auto tone job

photoshopAPI.editPhoto(input, output, options) ⇒ Job

Apply a set of edit parameters on an image

Kind: instance method of PhotoshopAPI
Returns: Job - Edit photo job

photoshopAPI.applyPreset(input, preset, output) ⇒ Job

Apply a preset on an image

Kind: instance method of PhotoshopAPI
Returns: Job - Apply preset job

photoshopAPI.applyPresetXmp(input, output, xmp) ⇒ Job

Apply a preset on an image

Kind: instance method of PhotoshopAPI
Returns: Job - Apply preset job

photoshopAPI.createDocument(outputs, options) ⇒ Job

Create a new psd, optionally with layers, and then generate renditions and/or save as a psd

Kind: instance method of PhotoshopAPI
Returns: Job - Create document job

photoshopAPI.getDocumentManifest(input, options) ⇒ Job

Extract and return a psd file's layer information

Kind: instance method of PhotoshopAPI
Returns: Job - Get document manifest job

photoshopAPI.modifyDocument(input, outputs, options) ⇒ Job

Apply (optional) psd edits and then generate renditions and/or save a new psd

Kind: instance method of PhotoshopAPI
Returns: Job - Modify document job

photoshopAPI.createRendition(input, outputs) ⇒ Job

Create renditions

Kind: instance method of PhotoshopAPI
Returns: Job - Create rendition job

photoshopAPI.replaceSmartObject(input, outputs, options) ⇒ Job

Apply psd edits for replacing embedded smart object and then generate renditions and/or save a new psd

Kind: instance method of PhotoshopAPI
Returns: Job - Replace smart object job

photoshopAPI.applyPhotoshopActions(input, outputs, options) ⇒ Job

Apply Photoshop Actions and then generate renditions and/or save a new image

Kind: instance method of PhotoshopAPI
Returns: Job - Photoshop Actions job

photoshopAPI.applyPhotoshopActionsJson(input, outputs, options) ⇒ Job

Apply JSON-formatted Photoshop Actions and then generate renditions and/or save a new image

Kind: instance method of PhotoshopAPI
Returns: Job - Photoshop Actions job

Job

Abstraction around the Photoshop Services Jobs

Kind: global class

• Job
  • new Job(response, getJobStatus)
  • .url : string
  • .jobId : string
  • .outputs : Array.<JobOutput>
  • .isDone() ⇒ boolean
  • .poll() ⇒ Job
  • .pollUntilDone([pollTimeMs]) ⇒ Job

new Job(response, getJobStatus)

Construct a job with the ability to acquire status updates

job.url : string

URL to request a status update of the job

Kind: instance property of Job

job.jobId : string

Job identifier

Kind: instance property of Job

job.outputs : Array.<JobOutput>

Status of each output sub job

Kind: instance property of Job

job.isDone() ⇒ boolean

Check if the job is done

A job is marked done when it has either the succeeded or failed status.

Kind: instance method of Job
Returns: boolean - True if the job is done, or false if it is still pending/running

job.poll() ⇒ Job

Poll for job status

Kind: instance method of Job
Returns: Job - Job instance

job.pollUntilDone(pollTimeMs) ⇒ Job

Poll job until done

Kind: instance method of Job
Returns: Job - Job instance

Storage

Storage types

Kind: global enum
Read only: true
Properties

MimeType

Mime types

Kind: global enum
Read only: true
Properties

PngCompression

Compression level for PNG: small, medium or large.

Kind: global enum
Read only: true
Properties

Colorspace

Color space

Kind: global enum
Read only: true
Properties

StandardIccProfileNames

Standard ICC profile names

Kind: global enum
Read only: true
Properties

CreateMaskType

Type of mask to create

Kind: global enum
Read only: true
Properties

WhiteBalance

White balance enum

Kind: global enum
Read only: true
Properties

ManageMissingFonts

Action to take if there are one or more missing fonts in the document

Kind: global enum
Read only: true
Properties

BackgroundFill

Background fill

Kind: global enum
Read only: true
Properties

LayerType

Layer type

Kind: global enum
Read only: true
Properties

BlendMode

Blend modes

Kind: global enum
Read only: true
Properties

TextOrientation

Text orientation

Kind: global enum
Read only: true
Properties

ParagraphAlignment

Paragraph alignment

Kind: global enum
Read only: true
Properties

HorizontalAlignment

Horizontal alignment

Kind: global enum
Read only: true
Properties

VerticalAlignment

Vertical alignment

Kind: global enum
Read only: true
Properties

JobOutputStatus

Output status

Kind: global enum
Read only: true
Properties

shouldRetryFetch(response) ⇒ boolean

Determine if we should retry fetch due to Server errors (server busy or other application errors)

Kind: global function
Returns: boolean - true if we should retry or false if not

nodeFetchRetry(options) ⇒ function

Fetch a URL, with retry options provided or default retry options otherwise By default retries will happen for 14 seconds (3 retries at 1, 2 and then 4 seconds -- there cannot be enough time for anotehr retry after that) Retry will occur if error code 429 or >= 500 occurs.

Kind: global function
Returns: function - Wrapped node fetch retry function which takes our preferred default options

getFetchOptions(options) ⇒ *

Parse through options object and determine correct parameters to Swagger for desired fetch approach

Kind: global function
Returns: * - Swagger options object with relevant settings for fetch module

init(orgId, apiKey, accessToken, files, options) ⇒ Promise.<PhotoshopAPI>

Returns a Promise that resolves with a new PhotoshopAPI object.

Kind: global function
Returns: Promise.<PhotoshopAPI> - a Promise with a PhotoshopAPI object

FileResolverOptions : object

File resolver options

Kind: global typedef
Properties

PhotoshopAPIOptions : object

Photoshop API options

Kind: global typedef
Properties

Input : object

A reference to an input file

Kind: global typedef
Properties

IccProfile : object

Either referencing a standard profile from StandardIccProfileNames in profileName, or a custom profile through input.

Kind: global typedef
Properties

Output : object

A reference to an output file, including output options

Kind: global typedef
Properties

EditPhotoOptions : object

Set of edit parameters to apply to an image

Kind: global typedef
Properties

Bounds : object

Layer bounds (in pixels)

Kind: global typedef
Properties

LayerMask : object

Mask applied to an layer

Kind: global typedef
Properties

BlendOptions : object

Layer blend options

Kind: global typedef
Properties

BrightnessContrast : object

Adjustment layer brightness and contrast settings

Kind: global typedef
Properties

Exposure : object

Adjustment layer exposure settings

Kind: global typedef
Properties

HueSaturationChannel : object

Master channel hue and saturation settings

Kind: global typedef
Properties

HueSaturation : object

Adjustment layer hue and saturation settings

Kind: global typedef
Properties

ColorBalance : object

Adjustment layer color balance settings

Kind: global typedef
Properties

AdjustmentLayer : object

Adjustment layer settings

Kind: global typedef
Properties

FontColorRgb : object

Font color settings for RGB mode (16-bit)

Kind: global typedef
Properties

FontColorCmyk : object

Font color settings for CMYK mode (16-bit)

Kind: global typedef
Properties

FontColorGray : object

Font color settings for Gray mode (16-bit)

Kind: global typedef
Properties

FontColor : object

Font color settings

Kind: global typedef
Properties

CharacterStyle : object

Character style settings

Kind: global typedef
Properties

ParagraphStyle : object

Paragraph style

Kind: global typedef
Properties

TextLayer : object

Text layer settings

Kind: global typedef
Properties

SmartObject : object

Smart object settings

Kind: global typedef
Properties

FillLayer : object

Fill layer settings

Kind: global typedef
Properties

LayerReference : object

Layer reference

Kind: global typedef
Properties

AddLayerPosition : object

Position where to add the layer in the layer hierarchy

Kind: global typedef
Properties

MoveLayerPosition : object

Position where to move the layer to in the layer hierarchy

Kind: global typedef
Properties

Layer : object

Layer to add, replace, move or delete when manipulating a Photoshop document, or retrieved from the manifest

Kind: global typedef
Properties