@canva/error 0.0.1-rc.1

package/LICENSE.md

@@ -0,0 +1,48 @@
+# A message from Canva
+
+By making these software components available to you, our goal is to give you
+the right to use the components to build your apps for Canva's ecosystem. See
+below for the specific licence terms that apply to your use.
+
+# Licence
+
+Canva Pty Ltd (ACN 158 929 938) ("Canva") owns the copyright in the software and
+associated documentation files to which this Licence relates (each a "Software
+Component"). Canva reserves all of its rights.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+the Software Components ("You"), to use the Software Components, but strictly
+subject to the following restrictions and conditions:
+
+1. You must only use the Software Components and any Derivative on the Canva
+   Platform.
+
+2. You must only use the Software Components and any Derivative for the purpose
+   of building or updating Permitted Apps, and for no other purpose.
+
+3. You must include a copy of this Licence in all copies of any Software
+   Component and Derivative.
+
+4. To the fullest extent permitted by law, the Software Components are provided
+   "as is", without warranty of any kind, express or implied, including but not
+   limited to the warranties of merchantability, fitness for a particular
+   purpose and non-infringement. To the fullest extent permitted by law, in no
+   event shall the authors or copyright holders be liable for any claim,
+   damages or other liability, whether in an action of contract, tort or
+   otherwise, arising from, out of or in connection with the Software Components
+   or any Derivative, or the use of or other dealings in the Software Components
+   or any Derivative.
+
+5. In this Licence:
+
+   (a) "Canva Platform" means the visual communications platform owned and
+   operated by Canva that is made available on Canva.com (as well as any
+   sub-domains and international versions) and via mobile applications, desktop
+   applications, and in other forms provided or made available by Canva;
+
+   (b) "Derivative" means any software, document or other material that: (i)
+   contains any Software Component; and/or (ii) comprises or contains a
+   derivative, adaptation or substantial part of any Software Component; and
+
+   (c) "Permitted App" means a software application that is solely offered to
+   end-users on the Canva Platform.

package/index.d.ts

@@ -0,0 +1,69 @@
+/** @public */
+declare interface BaseCanvaError extends Error {
+  code: ErrorCode;
+}
+
+/**
+ * @public
+ * Base Error thrown by Apps SDK methods
+ */
+export declare const CanvaError: typeof CanvaErrorClass;
+
+/**
+ * @public
+ * Base Error thrown by Apps SDK methods
+ */
+declare class CanvaErrorClass extends Error implements BaseCanvaError {
+  readonly code: ErrorCode;
+
+  constructor(opts: { code: ErrorCode; message: string });
+}
+
+/**
+ * @public
+ * Error codes that could be thrown by Apps SDK methods
+ */
+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 user is currently offline and cannot perform the requested operation.
+   */
+  | "USER_OFFLINE"
+  /**
+   * The specified resource was not found
+   */
+  | "NOT_FOUND"
+  /**
+   * The operation exceeded the maximum allowed time to complete.
+   */
+  | "TIMEOUT";
+
+export {};

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

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./public"), exports);
+// 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

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanvaError = void 0;
+const { canva } = window;
+/**
+ * @public
+ * Base Error thrown by Apps SDK methods
+ */
+exports.CanvaError = canva.CanvaError;

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

@@ -0,0 +1,3 @@
+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

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

@@ -0,0 +1,6 @@
+const { canva } = window;
+/**
+ * @public
+ * Base Error thrown by Apps SDK methods
+ */
+export const CanvaError = canva.CanvaError;

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@canva/error",
+  "version": "0.0.1-rc.1",
+  "description": "The Canva Apps SDK error library",
+  "author": "Canva Pty Ltd.",
+  "license": "SEE LICENSE IN LICENSE.md FILE",
+  "private": false,
+  "main": "lib/cjs/sdk/error/index.js",
+  "module": "lib/esm/sdk/error/index.js",
+  "exports": {
+    ".": {
+      "require": "./lib/cjs/sdk/error/index.js",
+      "import": "./lib/esm/sdk/error/index.js"
+    }
+  },
+  "typings": "./index.d.ts"
+}