@canva/error 2.0.0 → 2.1.0

package/lib/cjs/sdk/error/fake/fake_canva_error.js

@@ -0,0 +1,19 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "FakeCanvaError", {
+    enumerable: true,
+    get: function() {
+        return FakeCanvaError;
+    }
+});
+class FakeCanvaError extends Error {
+    constructor(opts){
+        const message = `Fake mode error - [${opts.code}]:  ${opts.message}`;
+        super(message);
+        this.name = 'FakeCanvaError';
+        this.rawMessage = opts.message;
+        this.code = opts.code;
+    }
+}

package/lib/cjs/sdk/error/fake/inject.js

@@ -0,0 +1,20 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "injectError", {
+    enumerable: true,
+    get: function() {
+        return injectError;
+    }
+});
+const _fake_canva_error = require("./fake_canva_error");
+function injectError() {
+    return {
+        error: {
+            v2: {
+                CanvaError: _fake_canva_error.FakeCanvaError
+            }
+        }
+    };
+}

package/lib/cjs/sdk/error/index.js

@@ -18,4 +18,4 @@ function _export_star(from, to) {
 }
 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('error', '2.0.0', 'ga');
+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('error', '2.1.0', 'ga');

package/lib/cjs/sdk/error/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 _inject = require('../fake/inject');
+const _canva_sdk = require('../../utils/canva_sdk');
+function initTestEnvironment() {
+    (0, _canva_sdk.assertIsTestCanvaSdk)();
+    (0, _canva_sdk.injectFakeAPIClients)((0, _inject.injectError)());
+}

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/error/fake/fake_canva_error.js

@@ -0,0 +1,9 @@
+export class FakeCanvaError extends Error {
+    constructor(opts){
+        const message = `Fake mode error - [${opts.code}]:  ${opts.message}`;
+        super(message);
+        this.name = 'FakeCanvaError';
+        this.rawMessage = opts.message;
+        this.code = opts.code;
+    }
+}

package/lib/esm/sdk/error/fake/inject.js

@@ -0,0 +1,10 @@
+import { FakeCanvaError } from './fake_canva_error';
+export function injectError() {
+    return {
+        error: {
+            v2: {
+                CanvaError: FakeCanvaError
+            }
+        }
+    };
+}

package/lib/esm/sdk/error/index.js

@@ -1,4 +1,4 @@
 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('error', '2.0.0', 'ga');
+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('error', '2.1.0', 'ga');

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

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

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

package/test/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ * Initializes a test environment for the `@canva/error` 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 {};