@canva/platform 2.0.0 → 2.1.1-beta.1

package/lib/cjs/sdk/platform/beta.js

@@ -0,0 +1,28 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "notification", {
+    enumerable: true,
+    get: function() {
+        return notification;
+    }
+});
+_export_star(require("./public"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+var _window___canva___sdkRegistration, _window___canva__;
+(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('platform', '2.1.1', 'beta');
+const { canva_sdk } = window;
+const notification = canva_sdk.platform.v2.notification;

package/lib/cjs/sdk/platform/fake/create.js

@@ -0,0 +1,32 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "createFakePlatformClients", {
+    enumerable: true,
+    get: function() {
+        return createFakePlatformClients;
+    }
+});
+const _fake_app_process_client = require("./fake_app_process_client");
+const _fake_feature_support_client = require("./fake_feature_support_client");
+const _fake_notification_client = require("./fake_notification_client");
+const _fake_platform_client = require("./fake_platform_client");
+function createFakePlatformClients() {
+    const appProcess = new _fake_app_process_client.FakeAppProcessClient();
+    const platform = new _fake_platform_client.FakePlatformClient();
+    const features = new _fake_feature_support_client.FakeFeatureSupportClient();
+    const notification = new _fake_notification_client.FakeNotificationClient();
+    const i18n = undefined;
+    return {
+        platform: {
+            v2: {
+                platform,
+                appProcess,
+                i18n,
+                features,
+                notification
+            }
+        }
+    };
+}

package/lib/cjs/sdk/platform/fake/fake_app_process_client.js

@@ -0,0 +1,41 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "FakeAppProcessClient", {
+    enumerable: true,
+    get: function() {
+        return FakeAppProcessClient;
+    }
+});
+class FakeAppProcessClient {
+    async requestClose(target, params) {
+        await Promise.resolve();
+    }
+    registerOnStateChange(target, callback) {
+        return async ()=>{
+            await Promise.resolve();
+        };
+    }
+    registerOnMessage(callback) {
+        return async ()=>{
+            await Promise.resolve();
+        };
+    }
+    broadcastMessage(message) {}
+    constructor(){
+        this.current = {
+            getInfo: ()=>({
+                    processId: 'test-process-id',
+                    surface: 'object_panel'
+                }),
+            requestClose: async (params)=>{
+                await Promise.resolve();
+            },
+            setOnDispose: (callback)=>async ()=>{
+                    await Promise.resolve();
+                },
+            registerOnStateChangeInternal: (callback)=>()=>Promise.resolve()
+        };
+    }
+}

package/lib/cjs/sdk/platform/fake/fake_feature_support_client.js

@@ -0,0 +1,19 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "FakeFeatureSupportClient", {
+    enumerable: true,
+    get: function() {
+        return FakeFeatureSupportClient;
+    }
+});
+class FakeFeatureSupportClient {
+    isSupported(...features) {
+        return true;
+    }
+    registerOnSupportChange(onSupportChange) {
+        onSupportChange();
+        return ()=>{};
+    }
+}

package/lib/cjs/sdk/platform/fake/fake_notification_client.js

@@ -0,0 +1,17 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "FakeNotificationClient", {
+    enumerable: true,
+    get: function() {
+        return FakeNotificationClient;
+    }
+});
+class FakeNotificationClient {
+    async addToast(options) {
+        return {
+            status: 'completed'
+        };
+    }
+}

package/lib/cjs/sdk/platform/fake/fake_platform_client.js

@@ -0,0 +1,23 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "FakePlatformClient", {
+    enumerable: true,
+    get: function() {
+        return FakePlatformClient;
+    }
+});
+class FakePlatformClient {
+    async requestOpenExternalUrl(options) {
+        await Promise.resolve();
+        return {
+            status: 'completed'
+        };
+    }
+    getPlatformInfo() {
+        return {
+            canAcceptPayments: true
+        };
+    }
+}

package/lib/cjs/sdk/platform/public.js

@@ -15,19 +15,15 @@ _export(exports, {
     features: function() {
         return features;
     },
-    requestOpenExternalUrl: function() {
-        return requestOpenExternalUrl;
-    },
     getPlatformInfo: function() {
         return getPlatformInfo;
+    },
+    requestOpenExternalUrl: function() {
+        return requestOpenExternalUrl;
     }
 });
 const { canva_sdk } = window;
 const appProcess = canva_sdk.platform.v2.appProcess;
 const features = canva_sdk.platform.v2.features;
-function requestOpenExternalUrl(request) {
-    return canva_sdk.platform.v2.platform.requestOpenExternalUrl(request);
-}
-function getPlatformInfo() {
-    return canva_sdk.platform.v2.platform.getPlatformInfo();
-}
+const requestOpenExternalUrl = canva_sdk.platform.v2.platform.requestOpenExternalUrl;
+const getPlatformInfo = canva_sdk.platform.v2.platform.getPlatformInfo;

package/lib/cjs/sdk/platform/{index.js → test/beta.js}

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./public"), exports);
+_export_star(require("./index"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
@@ -16,6 +16,3 @@ function _export_star(from, to) {
     });
     return from;
 }
-var _window___canva___sdkRegistration, _window___canva__;
-(_window___canva__ =
-window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('platform', '2.0.0', 'ga');

package/lib/cjs/sdk/platform/test/index.js

@@ -0,0 +1,16 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "initTestEnvironment", {
+    enumerable: true,
+    get: function() {
+        return initTestEnvironment;
+    }
+});
+const _create = require('../fake/create');
+const _canva_sdk = require('../../utils/canva_sdk');
+function initTestEnvironment() {
+    (0, _canva_sdk.assertIsTestCanvaSdk)();
+    (0, _canva_sdk.injectFakeAPIClients)((0, _create.createFakePlatformClients)());
+}

package/lib/cjs/sdk/utils/canva_sdk.js

@@ -0,0 +1,65 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    assertIsTestCanvaSdk: function() {
+        return assertIsTestCanvaSdk;
+    },
+    bindMethodsToClients: function() {
+        return bindMethodsToClients;
+    },
+    getCanvaSdk: function() {
+        return getCanvaSdk;
+    },
+    injectFakeAPIClients: function() {
+        return injectFakeAPIClients;
+    }
+});
+function getCanvaSdk() {
+    return window.canva_sdk;
+}
+function assertIsTestCanvaSdk() {
+    var _window___canva__;
+    if ((_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : _window___canva__.uiKit) {
+        var _getCanvaSdk_error, _getCanvaSdk;
+        const CanvaError = (_getCanvaSdk = getCanvaSdk()) === null || _getCanvaSdk === void 0 ? void 0 : (_getCanvaSdk_error = _getCanvaSdk.error) === null || _getCanvaSdk_error === void 0 ? void 0 : _getCanvaSdk_error.v2.CanvaError;
+        throw new CanvaError({
+            code: 'failed_precondition',
+            message: "Canva App SDK: You're attempting to call `initTestEnvironment` in a non-test environment, such as in production. This method should be called in test environments, once and only once. For more info refer to https://canva.dev/docs/apps/testing/"
+        });
+    }
+}
+function injectFakeAPIClients(clients) {
+    bindMethodsToClients(clients);
+    window.canva_sdk = {
+        ...getCanvaSdk(),
+        ...clients
+    };
+}
+function bindMethodsToClients(objectToBind) {
+    if (typeof objectToBind !== 'object' || objectToBind == null)
+        return;
+    const classMethods = new Set();
+    let currentPrototype = Object.getPrototypeOf(objectToBind);
+    while(currentPrototype && currentPrototype !== Object.prototype){
+        Object.getOwnPropertyNames(currentPrototype).forEach((method)=>classMethods.add(method));
+        currentPrototype = Object.getPrototypeOf(currentPrototype);
+    }
+    classMethods.delete('constructor');
+    for (const method of classMethods) {
+        const originalFn = objectToBind[method];
+        if (typeof originalFn === 'function') Object.defineProperty(objectToBind, method, {
+            value: (...args)=>{
+                return originalFn.call(objectToBind, ...args);
+            }
+        });
+    }
+    Object.values(objectToBind).forEach(bindMethodsToClients);
+}

package/lib/esm/sdk/platform/beta.js

@@ -0,0 +1,5 @@
+var _window___canva___sdkRegistration, _window___canva__;
+export * from './public';
+(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('platform', '2.1.1', 'beta');
+const { canva_sdk } = window;
+export const notification = canva_sdk.platform.v2.notification;

package/lib/esm/sdk/platform/fake/create.js

@@ -0,0 +1,22 @@
+import { FakeAppProcessClient } from './fake_app_process_client';
+import { FakeFeatureSupportClient } from './fake_feature_support_client';
+import { FakeNotificationClient } from './fake_notification_client';
+import { FakePlatformClient } from './fake_platform_client';
+export function createFakePlatformClients() {
+    const appProcess = new FakeAppProcessClient();
+    const platform = new FakePlatformClient();
+    const features = new FakeFeatureSupportClient();
+    const notification = new FakeNotificationClient();
+    const i18n = undefined;
+    return {
+        platform: {
+            v2: {
+                platform,
+                appProcess,
+                i18n,
+                features,
+                notification
+            }
+        }
+    };
+}

package/lib/esm/sdk/platform/fake/fake_app_process_client.js

@@ -0,0 +1,31 @@
+export class FakeAppProcessClient {
+    async requestClose(target, params) {
+        await Promise.resolve();
+    }
+    registerOnStateChange(target, callback) {
+        return async ()=>{
+            await Promise.resolve();
+        };
+    }
+    registerOnMessage(callback) {
+        return async ()=>{
+            await Promise.resolve();
+        };
+    }
+    broadcastMessage(message) {}
+    constructor(){
+        this.current = {
+            getInfo: ()=>({
+                    processId: 'test-process-id',
+                    surface: 'object_panel'
+                }),
+            requestClose: async (params)=>{
+                await Promise.resolve();
+            },
+            setOnDispose: (callback)=>async ()=>{
+                    await Promise.resolve();
+                },
+            registerOnStateChangeInternal: (callback)=>()=>Promise.resolve()
+        };
+    }
+}

package/lib/esm/sdk/platform/fake/fake_feature_support_client.js

@@ -0,0 +1,9 @@
+export class FakeFeatureSupportClient {
+    isSupported(...features) {
+        return true;
+    }
+    registerOnSupportChange(onSupportChange) {
+        onSupportChange();
+        return ()=>{};
+    }
+}

package/lib/esm/sdk/platform/fake/fake_notification_client.js

@@ -0,0 +1,7 @@
+export class FakeNotificationClient {
+    async addToast(options) {
+        return {
+            status: 'completed'
+        };
+    }
+}

package/lib/esm/sdk/platform/fake/fake_platform_client.js

@@ -0,0 +1,13 @@
+export class FakePlatformClient {
+    async requestOpenExternalUrl(options) {
+        await Promise.resolve();
+        return {
+            status: 'completed'
+        };
+    }
+    getPlatformInfo() {
+        return {
+            canAcceptPayments: true
+        };
+    }
+}

package/lib/esm/sdk/platform/public.js

@@ -1,9 +1,5 @@
 const { canva_sdk } = window;
 export const appProcess = canva_sdk.platform.v2.appProcess;
 export const features = canva_sdk.platform.v2.features;
-export function requestOpenExternalUrl(request) {
-    return canva_sdk.platform.v2.platform.requestOpenExternalUrl(request);
-}
-export function getPlatformInfo() {
-    return canva_sdk.platform.v2.platform.getPlatformInfo();
-}
+export const requestOpenExternalUrl = canva_sdk.platform.v2.platform.requestOpenExternalUrl;
+export const getPlatformInfo = canva_sdk.platform.v2.platform.getPlatformInfo;

package/lib/esm/sdk/platform/test/beta.js

@@ -0,0 +1 @@
+export * from './index';

package/lib/esm/sdk/platform/test/index.js

@@ -0,0 +1,6 @@
+import { createFakePlatformClients } from '../fake/create';
+import { assertIsTestCanvaSdk, injectFakeAPIClients } from '../../utils/canva_sdk';
+export function initTestEnvironment() {
+    assertIsTestCanvaSdk();
+    injectFakeAPIClients(createFakePlatformClients());
+}

package/lib/esm/sdk/utils/canva_sdk.js

@@ -0,0 +1,41 @@
+export function getCanvaSdk() {
+    return window.canva_sdk;
+}
+export function assertIsTestCanvaSdk() {
+    var _window___canva__;
+    if ((_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : _window___canva__.uiKit) {
+        var _getCanvaSdk_error, _getCanvaSdk;
+        const CanvaError = (_getCanvaSdk = getCanvaSdk()) === null || _getCanvaSdk === void 0 ? void 0 : (_getCanvaSdk_error = _getCanvaSdk.error) === null || _getCanvaSdk_error === void 0 ? void 0 : _getCanvaSdk_error.v2.CanvaError;
+        throw new CanvaError({
+            code: 'failed_precondition',
+            message: "Canva App SDK: You're attempting to call `initTestEnvironment` in a non-test environment, such as in production. This method should be called in test environments, once and only once. For more info refer to https://canva.dev/docs/apps/testing/"
+        });
+    }
+}
+export function injectFakeAPIClients(clients) {
+    bindMethodsToClients(clients);
+    window.canva_sdk = {
+        ...getCanvaSdk(),
+        ...clients
+    };
+}
+export function bindMethodsToClients(objectToBind) {
+    if (typeof objectToBind !== 'object' || objectToBind == null)
+        return;
+    const classMethods = new Set();
+    let currentPrototype = Object.getPrototypeOf(objectToBind);
+    while(currentPrototype && currentPrototype !== Object.prototype){
+        Object.getOwnPropertyNames(currentPrototype).forEach((method)=>classMethods.add(method));
+        currentPrototype = Object.getPrototypeOf(currentPrototype);
+    }
+    classMethods.delete('constructor');
+    for (const method of classMethods) {
+        const originalFn = objectToBind[method];
+        if (typeof originalFn === 'function') Object.defineProperty(objectToBind, method, {
+            value: (...args)=>{
+                return originalFn.call(objectToBind, ...args);
+            }
+        });
+    }
+    Object.values(objectToBind).forEach(bindMethodsToClients);
+}

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@canva/platform",
-  "version": "2.0.0",
+  "version": "2.1.1-beta.1",
   "description": "The Canva Apps SDK app platform library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
   "peerDependencies": {
     "@canva/error": "^2.0.0"
   },
-  "main": "./lib/cjs/sdk/platform/index.js",
-  "module": "./lib/esm/sdk/platform/index.js",
+  "main": "./lib/cjs/sdk/platform/beta.js",
+  "module": "./lib/esm/sdk/platform/beta.js",
   "exports": {
     ".": {
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./lib/cjs/sdk/platform/index.js"
-      },
-      "import": {
-        "types": "./index.d.ts",
-        "default": "./lib/esm/sdk/platform/index.js"
-      }
+      "types": "./beta.d.ts",
+      "require": "./lib/cjs/sdk/platform/beta.js",
+      "import": "./lib/esm/sdk/platform/beta.js"
+    },
+    "./test": {
+      "types": "./test/beta.d.ts",
+      "require": "./lib/cjs/sdk/platform/test/beta.js",
+      "import": "./lib/esm/sdk/platform/test/beta.js"
     }
   },
-  "typings": "./index.d.ts"
+  "typings": "./beta.d.ts"
 }

package/test/beta.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ * Initializes a test environment for the `@canva/platform` package, enabling unit tests to mock Canva's APIs.
+ * @remarks
+ * This method should only be called once in a test environment, such as in a Jest setup file.
+ * @see
+ * https://www.canva.dev/docs/apps/testing/
+ */
+export declare function initTestEnvironment(): void;
+
+export {};