@canva/error 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+## 2.2.0 - 2026-01-19
+
+### Added
+
+- Added a CHANGELOG.md to track changes.
+- Added a new `missing_permission` error code.
+
+## 2.1.0 - 2024-12-15
+
+### Added
+
+- Introduced a test harness to allow for [unit testing](https://www.canva.dev/docs/apps/testing/) of the package.
+
+## 2.0.0 - 2024-09-19
+
+### Changed
+
+- **Breaking:** See [Apps SDK Migration Guide](https://www.canva.dev/docs/apps/upgrades-and-migrations/v2-migration-guide/) for full list of changes.

package/index.d.ts

@@ -1,6 +1,7 @@
 /** @public */
 declare interface BaseCanvaError extends Error {
-  code: ErrorCode;
+    code: ErrorCode;
+
 }
 
 /**
@@ -14,12 +15,15 @@ export declare const CanvaError: typeof CanvaErrorClass;
  * An error thrown by the Apps SDK.
  */
 declare class CanvaErrorClass extends Error implements BaseCanvaError {
-  /**
-   * A code that identifies why the error was thrown.
-   */
-  readonly code: ErrorCode;
+    /**
+     * A code that identifies why the error was thrown.
+     */
+    readonly code: ErrorCode;
 
-  constructor(opts: { code: ErrorCode; message: string });
+    constructor(opts: {
+        code: ErrorCode;
+        message: string;
+    });
 }
 
 /**
@@ -35,7 +39,8 @@ declare class CanvaErrorClass extends Error implements BaseCanvaError {
  * - `"internal_error"` - An error occurred within the Apps SDK's internal implementation.
  * - `"not_found"` - The specified resource couldn't be found.
  * - `"not_allowed"` - The app isn't allowed to perform the requested operation.
- * - `"permission_denied"` - The app isn't allowed perform the requested operation because the appropriate permissions aren't set.
+ * - `"permission_denied"` - The app isn't allowed to perform the requested operation because the appropriate permissions aren't accepted.
+ * - `"missing_permission"` - The app isn't allowed to perform the requested operation because the appropriate permissions aren't set in the app config.
  * - `"quota_exceeded"` - The app or user has exceeded their allocated quota for a resource or service.
  * - `"rate_limited"` - The app attempted too many operations within a certain period of time.
  * - `"timeout"` - The requested operation took too long to complete.
@@ -43,19 +48,6 @@ declare class CanvaErrorClass extends Error implements BaseCanvaError {
  * - `"unsupported_page_type"` - The requested operation isn't supported on the current page.
  * - `"user_offline"` - The requested operation can't be performed because the user is offline.
  */
-export declare type ErrorCode =
-  | "bad_external_service_response"
-  | "bad_request"
-  | "failed_precondition"
-  | "internal_error"
-  | "not_found"
-  | "not_allowed"
-  | "permission_denied"
-  | "quota_exceeded"
-  | "rate_limited"
-  | "timeout"
-  | "unsupported_surface"
-  | "unsupported_page_type"
-  | "user_offline";
+export declare type ErrorCode = 'bad_external_service_response' | 'bad_request' | 'failed_precondition' | 'internal_error' | 'not_found' | 'not_allowed' | 'permission_denied' | 'missing_permission' | 'quota_exceeded' | 'rate_limited' | 'timeout' | 'unsupported_surface' | 'unsupported_page_type' | 'user_offline';
 
-export {};
+export { }

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

@@ -11,8 +11,7 @@ Object.defineProperty(exports, "FakeCanvaError", {
 class FakeCanvaError extends Error {
     constructor(opts){
         const message = `Fake mode error - [${opts.code}]:  ${opts.message}`;
-        super(message);
-        this.name = 'FakeCanvaError';
+        super(message), this.name = 'FakeCanvaError';
         this.rawMessage = opts.message;
         this.code = opts.code;
     }

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+const _version = require("./version");
 _export_star(require("./public"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
@@ -16,6 +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('error', '2.1.0', 'ga');
+window.__canva__?.sdkRegistration?.registerPackageVersion('error', _version.LATEST_VERSION, 'ga');

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

@@ -0,0 +1,24 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get LATEST_VERSION () {
+        return LATEST_VERSION;
+    },
+    get LATEST_VERSION_ALPHA () {
+        return LATEST_VERSION_ALPHA;
+    },
+    get LATEST_VERSION_BETA () {
+        return LATEST_VERSION_BETA;
+    }
+});
+const LATEST_VERSION = '2.2.0';
+const LATEST_VERSION_BETA = 'NONE';
+const LATEST_VERSION_ALPHA = 'NONE';

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

@@ -5,17 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    getCanvaSdk: function() {
-        return getCanvaSdk;
-    },
-    assertIsTestCanvaSdk: function() {
+    get assertIsTestCanvaSdk () {
         return assertIsTestCanvaSdk;
     },
-    injectFakeAPIClients: function() {
+    get bindMethodsToClients () {
+        return bindMethodsToClients;
+    },
+    get getCanvaSdk () {
+        return getCanvaSdk;
+    },
+    get injectFakeAPIClients () {
         return injectFakeAPIClients;
     }
 });
@@ -23,10 +26,8 @@ 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;
+    if (window.__canva__?.uiKit) {
+        const CanvaError = 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/"
@@ -34,8 +35,29 @@ function assertIsTestCanvaSdk() {
     }
 }
 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/error/fake/fake_canva_error.js

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

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

@@ -1,4 +1,3 @@
-var _window___canva___sdkRegistration, _window___canva__;
+import { LATEST_VERSION } from './version';
 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.1.0', 'ga');
+window.__canva__?.sdkRegistration?.registerPackageVersion('error', LATEST_VERSION, 'ga');

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

@@ -0,0 +1,3 @@
+export const LATEST_VERSION = '2.2.0';
+export const LATEST_VERSION_BETA = 'NONE';
+export const LATEST_VERSION_ALPHA = 'NONE';

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

@@ -2,10 +2,8 @@ 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;
+    if (window.__canva__?.uiKit) {
+        const CanvaError = 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/"
@@ -13,8 +11,29 @@ export function assertIsTestCanvaSdk() {
     }
 }
 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,6 +1,6 @@
 {
   "name": "@canva/error",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "The Canva Apps SDK error library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",

package/test/index.d.ts

@@ -8,4 +8,4 @@
  */
 export declare function initTestEnvironment(): void;
 
-export {};
+export { }