@canva/error 1.2.0 → 2.0.0

package/index.d.ts

@@ -5,15 +5,18 @@ declare interface BaseCanvaError extends Error {
 
 /**
  * @public
- * Base Error thrown by Apps SDK methods
+ * An error thrown by the Apps SDK.
  */
 export declare const CanvaError: typeof CanvaErrorClass;
 
 /**
  * @public
- * Base Error thrown by Apps SDK methods
+ * 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;
 
   constructor(opts: { code: ErrorCode; message: string });
@@ -21,57 +24,38 @@ declare class CanvaErrorClass extends Error implements BaseCanvaError {
 
 /**
  * @public
- * Error codes that could be thrown by Apps SDK methods
+ * An error code that identifies why an error was thrown by the Apps SDK.
+ *
+ * @remarks
+ * The possible error codes include:
+ *
+ * - `"bad_external_service_response"` - A response from an external service is invalid or malformed.
+ * - `"bad_request"` - The app made a request with invalid or malformed inputs.
+ * - `"failed_precondition"` - The requested operation can't be performed because a precondition hasn't been met.
+ * - `"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.
+ * - `"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.
+ * - `"unsupported_surface"` - The requested operation isn't supported on the current surface.
+ * - `"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 =
-  /**
-   * The system is currently unable to perform the requested operation because it is not in the necessary state.
-   * Refer to the error message for more information on how to satisfy the failed precondition.
-   */
-  | "FAILED_PRECONDITION"
-  /**
-   * The response received from an external service is invalid or malformed.
-   */
-  | "BAD_EXTERNAL_SERVICE_RESPONSE"
-  /**
-   * The request received from the client is invalid or malformed.
-   */
-  | "BAD_REQUEST"
-  /**
-   * An error occurred within the SDK's internal implementation.
-   */
-  | "INTERNAL_ERROR"
-  /**
-   * The allocated quota for the resource or service has been exceeded.
-   */
-  | "QUOTA_EXCEEDED"
-  /**
-   * The system has received too many requests in a short period of time.
-   */
-  | "RATE_LIMITED"
-  /**
-   * The caller does not have sufficient permissions to execute the specified operation.
-   */
-  | "PERMISSION_DENIED"
-  /**
-   * The specified operation is not supported on the surface.
-   */
-  | "UNSUPPORTED_SURFACE"
-  /**
-   * The user is currently offline and cannot perform the requested operation.
-   */
-  | "USER_OFFLINE"
-  /**
-   * The specified resource was not found
-   */
-  | "NOT_FOUND"
-  /**
-   * The specified operation was not allowed
-   */
-  | "NOT_ALLOWED"
-  /**
-   * The operation exceeded the maximum allowed time to complete.
-   */
-  | "TIMEOUT";
+  | "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 {};

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

@@ -1,5 +1,4 @@
-// must use relative paths
-"use strict";
+"use strict"
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
@@ -17,5 +16,6 @@ function _export_star(from, to) {
     });
     return from;
 }
- // purposefully not exporting `BaseCanvaError` from '../.../api/error/api' since we want to export
- // the actual CanvaError class, and not the interface, to allow apps to do instanceof checks
+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');

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

@@ -8,5 +8,5 @@ Object.defineProperty(exports, "CanvaError", {
         return CanvaError;
     }
 });
-const { canva } = window;
-const CanvaError = canva.CanvaError;
+const { canva_sdk } = window;
+const CanvaError = canva_sdk.error.v2.CanvaError;

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

@@ -1,3 +1,4 @@
-// must use relative paths
-export * from './public'; // purposefully not exporting `BaseCanvaError` from '../.../api/error/api' since we want to export
- // the actual CanvaError class, and not the interface, to allow apps to do instanceof checks
+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');

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

@@ -1,5 +1,2 @@
-const { canva } = window;
-/**
- * @public
- * Base Error thrown by Apps SDK methods
- */ export const CanvaError = canva.CanvaError;
+const { canva_sdk } = window;
+export const CanvaError = canva_sdk.error.v2.CanvaError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/error",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "The Canva Apps SDK error library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",