@canva/platform 2.0.0 → 2.1.0

package/index.d.ts

@@ -26,7 +26,7 @@ export declare interface AppProcess {
    */
   requestClose<T extends CloseParams>(
     target: AppProcessId,
-    params: T
+    params: T,
   ): Promise<void>;
   /**
    * @public
@@ -40,7 +40,7 @@ export declare interface AppProcess {
    */
   registerOnStateChange(
     target: AppProcessId,
-    callback: OnStateChangeCallback
+    callback: OnStateChangeCallback,
   ): () => Promise<void>;
   /**
    * @public
@@ -176,7 +176,7 @@ export declare type CurrentAppProcess = {
    * - The complete execution of the callback is not guaranteed as some user actions (e.g. closing tabs) may close the process prematurely.
    */
   setOnDispose<T extends CloseParams>(
-    callback: OnDisposeCallback<T>
+    callback: OnDisposeCallback<T>,
   ): () => Promise<void>;
 };
 
@@ -221,7 +221,7 @@ export declare interface FeatureSupport {
  * @public
  * Returns information about the platform on which the app is running.
  */
-export declare function getPlatformInfo(): PlatformInfo;
+export declare const getPlatformInfo: () => PlatformInfo;
 
 /**
  * @public
@@ -229,7 +229,7 @@ export declare function getPlatformInfo(): PlatformInfo;
  * @param opts - Parameters passed to the `setOnDispose` callback when a process is about to close.
  */
 export declare type OnDisposeCallback<T extends CloseParams> = (
-  opts: T
+  opts: T,
 ) => Promise<void>;
 
 /**
@@ -246,7 +246,7 @@ export declare type OnMessageCallback = (
     appProcessId: AppProcessId;
     surface: AppSurface;
   },
-  message: any
+  message: any,
 ) => Promise<void>;
 
 /**
@@ -355,8 +355,8 @@ export declare type ProcessState = "opening" | "open" | "closing" | "closed";
  *
  * In some browsers, the user must enable popup permissions before any URL can be opened.
  */
-export declare function requestOpenExternalUrl(
-  request: OpenExternalUrlRequest
-): Promise<OpenExternalUrlResponse>;
+export declare const requestOpenExternalUrl: (
+  request: OpenExternalUrlRequest,
+) => Promise<OpenExternalUrlResponse>;
 
 export {};

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

@@ -0,0 +1,29 @@
+"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_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 i18n = undefined;
+    return {
+        platform: {
+            v2: {
+                platform,
+                appProcess,
+                i18n,
+                features
+            }
+        }
+    };
+}

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_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/index.js

@@ -17,5 +17,4 @@ 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');
+(_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.0', 'ga');

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

@@ -25,9 +25,5 @@ _export(exports, {
 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/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,41 @@
+"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, {
+    getCanvaSdk: function() {
+        return getCanvaSdk;
+    },
+    assertIsTestCanvaSdk: function() {
+        return assertIsTestCanvaSdk;
+    },
+    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) {
+    window.canva_sdk = {
+        ...getCanvaSdk(),
+        ...clients
+    };
+}

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

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

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_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/index.js

@@ -1,4 +1,3 @@
 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.0.0', 'ga');
+(_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.0', 'ga');

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/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,20 @@
+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) {
+    window.canva_sdk = {
+        ...getCanvaSdk(),
+        ...clients
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/platform",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The Canva Apps SDK app platform library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
@@ -11,14 +11,14 @@
   "module": "./lib/esm/sdk/platform/index.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": "./index.d.ts",
+      "require": "./lib/cjs/sdk/platform/index.js",
+      "import": "./lib/esm/sdk/platform/index.js"
+    },
+    "./test": {
+      "types": "./test/index.d.ts",
+      "require": "./lib/cjs/sdk/platform/test/index.js",
+      "import": "./lib/esm/sdk/platform/test/index.js"
     }
   },
   "typings": "./index.d.ts"

package/test/index.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 {};