@canva/platform 2.1.1 → 2.2.0-beta.1

package/{index.d.ts → beta.d.ts}

@@ -475,6 +475,41 @@ export declare interface FeatureSupport {
  */
 export declare const getPlatformInfo: () => PlatformInfo;
 
+/**
+ * @public
+ * Provides methods for interacting with notifications.
+ */
+export declare const notification: NotificationClient;
+
+/**
+ * @public
+ *
+ * Provides methods for interacting with notifications.
+ */
+export declare interface NotificationClient {
+  /**
+   * @public
+   *
+   * A method that shows a toast notification to the user.
+   *
+   * @example
+   * ```tsx
+   * import { notification } from '@canva/platform';
+   * import type { ToastRequest } from '@canva/platform';
+   *
+   * const showToast = () => {
+   *   const request: ToastRequest = {
+   *     messageText: "Hello world!",
+   *   };
+   *   notification.addToast(request);
+   * };
+   *
+   * <Button onClick={() => showToast()}>Show Toast</Button>
+   * ```
+   */
+  addToast: (request: ToastRequest) => Promise<ToastResponse>;
+}
+
 /**
  * @public
  * A callback that runs when an app process is about to close.
@@ -646,4 +681,44 @@ export declare const requestOpenExternalUrl: (
   request: OpenExternalUrlRequest,
 ) => Promise<OpenExternalUrlResponse>;
 
+/**
+ * @public
+ * The result when a toast notification is successfully added.
+ */
+export declare type ToastCompleted = {
+  /**
+   * The status of the request.
+   */
+  status: "completed";
+};
+
+/**
+ * @public
+ *
+ * Options for configuring a toast notification.
+ */
+export declare type ToastRequest = {
+  /**
+   * Text to show within the toast notification.
+   */
+  messageText: string;
+  /**
+   * The duration that the notification will be visible.
+   *
+   * If set to `"infinite"`, the notification will be displayed until manually dismissed by the user.
+   *
+   * If set to a number, the notification will automatically disappear after that duration (in milliseconds).
+   *
+   * @defaultValue 5000
+   */
+  timeoutMs?: number | "infinite";
+};
+
+/**
+ * @public
+ *
+ * The response from adding a toast notification.
+ */
+export declare type ToastResponse = ToastCompleted;
+
 export {};

package/lib/cjs/sdk/platform/{index.js → beta.js}

@@ -17,4 +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('platform', '2.1.1', 'ga');
+(_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('platform', '2.2.0', 'beta');

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

@@ -5,25 +5,29 @@ 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, {
-    appProcess: function() {
+    get appProcess () {
         return appProcess;
     },
-    features: function() {
+    get features () {
         return features;
     },
-    getPlatformInfo: function() {
+    get getPlatformInfo () {
         return getPlatformInfo;
     },
-    requestOpenExternalUrl: function() {
+    get notification () {
+        return notification;
+    },
+    get requestOpenExternalUrl () {
         return requestOpenExternalUrl;
     }
 });
 const { canva_sdk } = window;
 const appProcess = canva_sdk.platform.v2.appProcess;
 const features = canva_sdk.platform.v2.features;
+const notification = canva_sdk.platform.v2.notification;
 const requestOpenExternalUrl = canva_sdk.platform.v2.platform.requestOpenExternalUrl;
 const getPlatformInfo = canva_sdk.platform.v2.platform.getPlatformInfo;

package/lib/cjs/sdk/platform/test/beta.js

@@ -0,0 +1,18 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./index"), 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;
+}

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

@@ -5,20 +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, {
-    assertIsTestCanvaSdk: function() {
+    get assertIsTestCanvaSdk () {
         return assertIsTestCanvaSdk;
     },
-    bindMethodsToClients: function() {
+    get bindMethodsToClients () {
         return bindMethodsToClients;
     },
-    getCanvaSdk: function() {
+    get getCanvaSdk () {
         return getCanvaSdk;
     },
-    injectFakeAPIClients: function() {
+    get injectFakeAPIClients () {
         return injectFakeAPIClients;
     }
 });

package/lib/esm/sdk/platform/{index.js → beta.js}

@@ -1,3 +1,3 @@
 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('platform', '2.1.1', 'ga');
+(_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('platform', '2.2.0', 'beta');

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

@@ -1,5 +1,6 @@
 const { canva_sdk } = window;
 export const appProcess = canva_sdk.platform.v2.appProcess;
 export const features = canva_sdk.platform.v2.features;
+export const notification = canva_sdk.platform.v2.notification;
 export const requestOpenExternalUrl = canva_sdk.platform.v2.platform.requestOpenExternalUrl;
 export const getPlatformInfo = canva_sdk.platform.v2.platform.getPlatformInfo;

package/lib/esm/sdk/platform/test/beta.js

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

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@canva/platform",
-  "version": "2.1.1",
+  "version": "2.2.0-beta.1",
   "description": "The Canva Apps SDK app platform library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
   "peerDependencies": {
     "@canva/error": "^2.0.0"
   },
-  "main": "./lib/cjs/sdk/platform/index.js",
-  "module": "./lib/esm/sdk/platform/index.js",
+  "main": "./lib/cjs/sdk/platform/beta.js",
+  "module": "./lib/esm/sdk/platform/beta.js",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "require": "./lib/cjs/sdk/platform/index.js",
-      "import": "./lib/esm/sdk/platform/index.js"
+      "types": "./beta.d.ts",
+      "require": "./lib/cjs/sdk/platform/beta.js",
+      "import": "./lib/esm/sdk/platform/beta.js"
     },
     "./test": {
-      "types": "./test/index.d.ts",
-      "require": "./lib/cjs/sdk/platform/test/index.js",
-      "import": "./lib/esm/sdk/platform/test/index.js"
+      "types": "./test/beta.d.ts",
+      "require": "./lib/cjs/sdk/platform/test/beta.js",
+      "import": "./lib/esm/sdk/platform/test/beta.js"
     }
   },
-  "typings": "./index.d.ts"
-}
+  "typings": "./beta.d.ts"
+}