ps-scripting-es5shim

ECMAScript 5 compatibility shims for Adobe Photoshop JavaScript engine.

Testing Requiered! Not for production yet.

Installation

For production:

npm install ps-scripting-es5shim --production

Usage

All polyfills are independant, and could be used standalone.

Basic usage

Include full bundle in your code like this:

#include './node_modules/ps-scripting-es5shim/bundle/main.bundle.js'

If you need a specific polyfill (for example Array.forEach and Object.create):

#includepath './node_modules/ps-scripting-es5shim/lib'
#include './Array/forEach.js'
#include './Object/create.js'

Using with webpack as bundler

content of webpack.config.js:

var webpack = require("webpack");

module.exports = {
  entry: {
    main: ['./polyfill.js','./index.js'], // polyfill file must be the first file
  },
  output: {
    path: __dirname + '/your_folder_for_bundles',
    filename: '[name].bundle.js',
  },


  module: {

  },
  // and you can use compression (well, almost can)
  plugins: [
    new webpack.optimize.UglifyJsPlugin({
      comments: false, 
      compress: false // must be false, because code may become so ugly that Photoshop will throw error :)
    })
  ]
};

content of polyfill.js:

//if you want to include all shims
require('ps-scripting-es5shim');

//if only specific polyfill required
require('ps-scripting-es5shim/lib/Array/forEach.js');
require('ps-scripting-es5shim/lib/Object/create.js');

Array, String and Function notes

All polyfills could be used in your code.

Object notes

Because it is impossible to emulate property descriptors in ES3 engine, the following functions are just a mocks and you should avoid to use them in your code if it is possible, only shim thirdparty libraries:

defineProperty, defineProperties

Supports only data descriptor. Writable, enumerable and configurable properties of descriptor are ignored. If you try to define set or get propperty this methods will throw an error.

getOwnPropertyDescriptor

Supports only data descriptor. Configurable property of descriptor is always TRUE. Enumerable and writable properties of descriptor will be always TRUE on user defined objects, but may vary on build in.

freeze, preventExtensions, seal

Only validate input parameter and return input if it is an object.

isExtensible, isFrozen, isSealed

Validates input and returns TRUE, FALSE, FALSE, respectively if input parametr is an object.

These functions you can use in your code:

create

Support of property descriptor is in the same level as in defineProperty. Although, you can use this function in your code like this:

var obj1 = {a : 1};
var obj2 = Object.create(obj1, {b : {value : 2}});

or like that:

var obj1 = {a : 1};
var obj2 = Object.create(obj1);
obj2.b = 2;

getOwnPropertyNames

This function uses reflection interface, that ExtendScript provides (see JavaScript Tools Guide), to get own properties of an object (enumerable or not). But ther is no guarantee that the order of enumeration will be the same as in for in loop.

keys

Use for in loop along with hasOwnProperty function to get own enumerable properties in object.

getPrototypeOf

Use build in __proto__ property as return value.

Tests

Application | Scripting engine | OS | Basic tests ------------ | ------------- | ------------- | ------------- Adobe Photoshop CS2 | ??? | Windows XP 5.1 Service Pack 3 | FAIL! Adobe Photoshop 12.0.3 | 4.1.26 | Windows XP 5.1 Service Pack 3 | OK! Adobe Photoshop 13.0 | 4.2.12 | Windows XP 5.1 Service Pack 3 | OK! Adobe Photoshop 13.0 | 4.2.12 | Windows 7/64 6.1 Service Pack 1 | OK! Adobe Photoshop 15.0 | 4.5.5 | Windows 7/64 6.1 Service Pack 1 | OK! Adobe Photoshop 16.1.2 | 4.5.6 | Macintosh OS 10.11.6/64 | OK! Adobe Photoshop 17.0.1 | 4.5.6 | Macintosh OS 10.11.6/64 | OK! Adobe Illustrator CS2 | ??? | Windows XP 5.1 Service Pack 3 | FAIL! Adobe Illustrator 15 | 4.1.21 | Windows XP 5.1 Service Pack 3 | OK! Adobe Illustrator 16.032 | 4.2.12 | Windows XP 5.1 Service Pack 3 | OK! Adobe Illustrator 17.1.0 | 4.5.5 | Macintosh OS 10.11.6/64 | OK! Adobe Illustrator 18.0.0 | 4.5.5 | Macintosh OS 10.11.6/64 | OK! Adobe Illustrator 18.1.1 | 4.5.5 | Macintosh OS 10.11.6/64 | OK! Adobe Illustrator 18.1.1 | 4.5.5 | Windows/64 10.0 Enterprise VM | OK! Adobe Illustrator 19.1.0 | 4.5.6 | Macintosh OS 10.11.6/64 | OK! Adobe Illustrator 19.2.1 | 4.5.6 | Windows/64 10.0 Enterprise VM | OK! Adobe Illustrator 20.0.0 | 4.5.6 | Windows/64 10.0 Enterprise VM | OK! Adobe Illustrator 20.1.0 | 4.5.6 | Macintosh OS 10.11.6/64 | OK! Adobe Bridge CS6 | 4.2.12 | Windows XP 5.1 Service Pack 3 | OK! Adobe Bridge CS5 | 4.1.23 | Windows XP 5.1 Service Pack 3 | OK!