@canva/error 0.0.1-rc.1 → 1.2.0

package/README.md

@@ -0,0 +1,49 @@
+# @canva/error
+
+A package for Canva's Apps SDK that exports a `CanvaError` class for handling errors.
+
+![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+
+## Table of contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Related packages](#related-packages)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+`@canva/error` is an npm package for Canva's [Apps SDK](https://www.canva.dev/docs/apps). It exports a `CanvaError` class that apps can use to catch and handle errors.
+
+**Note:** To get up and running with the Apps SDK, check out [the quick start guide](https://www.canva.dev/docs/apps/quick-start).
+
+## Installation
+
+```bash
+npm install @canva/error
+```
+
+## Usage
+
+See the documentation for [Handling errors](https://www.canva.dev/docs/apps/handling-errors).
+
+## Related packages
+
+The Apps SDK is made up of the following packages:
+
+- [`@canva/app-ui-kit`](https://www.npmjs.com/package/@canva/app-ui-kit) - React-based component library for creating apps that mimic the look and feel of Canva.
+- [`@canva/asset`](https://www.npmjs.com/package/@canva/asset) - Provides methods for working with assets, such as image and video files.
+- [`@canva/design`](https://www.npmjs.com/package/@canva/design) - Provides methods for interacting with the user's design, such as creating elements.
+- [`@canva/error`](https://www.npmjs.com/package/@canva/error) - Provides a `CanvaError` class for handling errors.
+- [`@canva/platform`](https://www.npmjs.com/package/@canva/platform) - Provides utility methods, such as a method for opening external links.
+- [`@canva/user`](https://www.npmjs.com/package/@canva/user) - Provides methods for accessing user data and authenticating users.
+
+## Contributing
+
+We're actively developing this package but are not currently accepting third-party contributions. If you'd like to request any changes or additions to the package, submit a feature request via the [Canva Developers Community](https://community.canva.dev/).
+
+## License
+
+See the `LICENSE.md` file.

package/index.d.ts

@@ -53,6 +53,10 @@ export declare type ErrorCode =
    * 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.
    */
@@ -61,6 +65,10 @@ export declare type ErrorCode =
    * 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.
    */

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

@@ -1,19 +1,21 @@
+// must use relative paths
 "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
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./public"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    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

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

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

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

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

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

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

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "@canva/error",
-  "version": "0.0.1-rc.1",
+  "version": "1.2.0",
   "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",
+  "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"
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./lib/cjs/sdk/error/index.js"
+      },
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./lib/esm/sdk/error/index.js"
+      }
     }
   },
   "typings": "./index.d.ts"