@canva/platform 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,55 @@
+/**
+ * @public
+ * The result of opening an external URL when a user chooses to not navigate away from Canva.
+ */
+export declare type OpenExternalUrlAborted = {
+  /**
+   * The status of the request.
+   */
+  status: "ABORTED";
+};
+
+/**
+ * @public
+ * The result of opening an external URL when a user agrees to navigate away from Canva.
+ */
+export declare type OpenExternalUrlCompleted = {
+  /**
+   * The status of the request.
+   */
+  status: "COMPLETED";
+};
+
+/**
+ * @public
+ * The options for opening an external URL.
+ */
+export declare type OpenExternalUrlRequest = {
+  /**
+   * The URL to open in a new window
+   */
+  url: string;
+};
+
+/**
+ * @public
+ * The result of opening an external URL.
+ */
+export declare type OpenExternalUrlResponse =
+  | OpenExternalUrlCompleted
+  | OpenExternalUrlAborted;
+
+/**
+ * @public
+ * Opens an external URL.
+ *
+ * @remarks
+ * The URL is opened natively, such as in a new browser tab on desktop or in a browser sheet on mobile.
+ *
+ * In some browsers, the user must enable popup permissions before any URL can be opened.
+ */
+export declare function requestOpenExternalUrl(
+  request: OpenExternalUrlRequest
+): Promise<OpenExternalUrlResponse>;
+
+export {};

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

@@ -0,0 +1,17 @@
+"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);

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestOpenExternalUrl = void 0;
+const { canva } = window;
+/**
+ * @public
+ * Opens an external URL.
+ *
+ * @remarks
+ * The URL is opened natively, such as in a new browser tab on desktop or in a browser sheet on mobile.
+ *
+ * In some browsers, the user must enable popup permissions before any URL can be opened.
+ */
+function requestOpenExternalUrl(request) {
+    return canva.platform.requestOpenExternalUrl(request);
+}
+exports.requestOpenExternalUrl = requestOpenExternalUrl;

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

@@ -0,0 +1 @@
+export * from './public';

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

@@ -0,0 +1,13 @@
+const { canva } = window;
+/**
+ * @public
+ * Opens an external URL.
+ *
+ * @remarks
+ * The URL is opened natively, such as in a new browser tab on desktop or in a browser sheet on mobile.
+ *
+ * In some browsers, the user must enable popup permissions before any URL can be opened.
+ */
+export function requestOpenExternalUrl(request) {
+    return canva.platform.requestOpenExternalUrl(request);
+}

package/package.json

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