@canva/intents 2.2.1-beta.1 → 2.3.0

package/lib/cjs/sdk/intents/asset/index.js

@@ -1,18 +1,4 @@
-"use strict";
+"use strict"
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./beta"), 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/intents/fake/{create_beta.js → create.js}

@@ -2,27 +2,24 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "createBetaFakeIntentsClients", {
+Object.defineProperty(exports, "createFakeIntentsClients", {
     enumerable: true,
     get: function() {
-        return createBetaFakeIntentsClients;
+        return createFakeIntentsClients;
     }
 });
-function createBetaFakeIntentsClients() {
+function createFakeIntentsClients() {
     return {
         intents: {
             v1: {
-                asset: {
-                    prepareUrlExpander: ()=>{}
-                },
-                content: {
-                    prepareContentPublisher: ()=>{}
-                },
                 design: {
                     prepareDesignEditor: ()=>{}
                 },
                 data: {
                     prepareDataConnector: ()=>{}
+                },
+                content: {
+                    prepareContentPublisher: ()=>{}
                 }
             }
         }

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

@@ -1,8 +1,9 @@
-"use strict";
+"use strict"
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./beta"), exports);
+const _version = require("./version");
+_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)) {
@@ -16,3 +17,4 @@ function _export_star(from, to) {
     });
     return from;
 }
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents', _version.LATEST_VERSION, 'ga');

package/lib/cjs/sdk/intents/test/index.js

@@ -1,18 +1,19 @@
-"use strict";
+"use strict"
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./beta"), 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];
-                }
-            });
-        }
+Object.defineProperty(exports, "initTestEnvironment", {
+    enumerable: true,
+    get: function() {
+        return initTestEnvironment;
+    }
+});
+const _create = require('../fake/create');
+const _canva_sdk = require('../../utils/canva_sdk');
+function initTestEnvironment() {
+    (0, _canva_sdk.assertIsTestCanvaSdk)();
+    const fakeClients = (0, _create.createFakeIntentsClients)();
+    (0, _canva_sdk.injectFakeAPIClients)({
+        intents: fakeClients.intents
     });
-    return from;
 }

package/lib/cjs/sdk/intents/version.js

@@ -19,6 +19,6 @@ _export(exports, {
         return LATEST_VERSION_BETA;
     }
 });
-const LATEST_VERSION = '2.2.0';
+const LATEST_VERSION = '2.3.0';
 const LATEST_VERSION_BETA = '2.2.1-beta.1';
 const LATEST_VERSION_ALPHA = 'NONE';

package/lib/esm/sdk/intents/asset/index.js

@@ -1 +1 @@
-export * from './beta';
+export {};

package/lib/esm/sdk/intents/fake/{create_beta.js → create.js}

@@ -1,18 +1,15 @@
-export function createBetaFakeIntentsClients() {
+export function createFakeIntentsClients() {
     return {
         intents: {
             v1: {
-                asset: {
-                    prepareUrlExpander: ()=>{}
-                },
-                content: {
-                    prepareContentPublisher: ()=>{}
-                },
                 design: {
                     prepareDesignEditor: ()=>{}
                 },
                 data: {
                     prepareDataConnector: ()=>{}
+                },
+                content: {
+                    prepareContentPublisher: ()=>{}
                 }
             }
         }

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

@@ -1 +1,3 @@
-export * from './beta';
+import { LATEST_VERSION } from './version';
+export * from './public';
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents', LATEST_VERSION, 'ga');

package/lib/esm/sdk/intents/test/index.js

@@ -1 +1,9 @@
-export * from './beta';
+import { createFakeIntentsClients } from '../fake/create';
+import { assertIsTestCanvaSdk, injectFakeAPIClients } from '../../utils/canva_sdk';
+export function initTestEnvironment() {
+    assertIsTestCanvaSdk();
+    const fakeClients = createFakeIntentsClients();
+    injectFakeAPIClients({
+        intents: fakeClients.intents
+    });
+}

package/lib/esm/sdk/intents/version.js

@@ -1,3 +1,3 @@
-export const LATEST_VERSION = '2.2.0';
+export const LATEST_VERSION = '2.3.0';
 export const LATEST_VERSION_BETA = '2.2.1-beta.1';
 export const LATEST_VERSION_ALPHA = 'NONE';

package/package.json

@@ -1,45 +1,45 @@
 {
   "name": "@canva/intents",
-  "version": "2.2.1-beta.1",
+  "version": "2.3.0",
   "description": "The Canva Apps SDK Intents library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
   "peerDependencies": {
     "@canva/error": "^2.0.0"
   },
-  "main": "./lib/cjs/sdk/intents/beta.js",
-  "module": "./lib/esm/sdk/intents/beta.js",
+  "main": "./lib/cjs/sdk/intents/index.js",
+  "module": "./lib/esm/sdk/intents/index.js",
   "exports": {
     ".": {
-      "types": "./beta.d.ts",
-      "require": "./lib/cjs/sdk/intents/beta.js",
-      "import": "./lib/esm/sdk/intents/beta.js"
+      "types": "./index.d.ts",
+      "require": "./lib/cjs/sdk/intents/index.js",
+      "import": "./lib/esm/sdk/intents/index.js"
     },
     "./test": {
-      "types": "./test/beta.d.ts",
-      "require": "./lib/cjs/sdk/intents/test/beta.js",
-      "import": "./lib/esm/sdk/intents/test/beta.js"
+      "types": "./test/index.d.ts",
+      "require": "./lib/cjs/sdk/intents/test/index.js",
+      "import": "./lib/esm/sdk/intents/test/index.js"
     },
     "./data": {
-      "types": "./data/beta.d.ts",
-      "require": "./lib/cjs/sdk/intents/data/beta.js",
-      "import": "./lib/esm/sdk/intents/data/beta.js"
+      "types": "./data/index.d.ts",
+      "require": "./lib/cjs/sdk/intents/data/index.js",
+      "import": "./lib/esm/sdk/intents/data/index.js"
     },
     "./design": {
-      "types": "./design/beta.d.ts",
-      "require": "./lib/cjs/sdk/intents/design/beta.js",
-      "import": "./lib/esm/sdk/intents/design/beta.js"
+      "types": "./design/index.d.ts",
+      "require": "./lib/cjs/sdk/intents/design/index.js",
+      "import": "./lib/esm/sdk/intents/design/index.js"
     },
     "./asset": {
-      "types": "./asset/beta.d.ts",
-      "require": "./lib/cjs/sdk/intents/asset/beta.js",
-      "import": "./lib/esm/sdk/intents/asset/beta.js"
+      "types": "./asset/index.d.ts",
+      "require": "./lib/cjs/sdk/intents/asset/index.js",
+      "import": "./lib/esm/sdk/intents/asset/index.js"
     },
     "./content": {
-      "types": "./content/beta.d.ts",
-      "require": "./lib/cjs/sdk/intents/content/beta.js",
-      "import": "./lib/esm/sdk/intents/content/beta.js"
+      "types": "./content/index.d.ts",
+      "require": "./lib/cjs/sdk/intents/content/index.js",
+      "import": "./lib/esm/sdk/intents/content/index.js"
     }
   },
-  "typings": "./beta.d.ts"
-}
+  "typings": "./index.d.ts"
+}

package/test/index.d.ts

@@ -1 +1,11 @@
-export * from "./beta";
+/**
+ * @public
+ * Initializes a test environment for the `@canva/intents` package, enabling unit tests to mock Canva's APIs.
+ * @remarks
+ * This method should only be called once in a test environment, such as in a Jest setup file.
+ * @see
+ * https://www.canva.dev/docs/apps/testing/
+ */
+export declare function initTestEnvironment(): void;
+
+export { }

package/asset/beta.d.ts

@@ -1,190 +0,0 @@
-/**
- * @beta
- * Union of all supported asset types.
- */
-export declare type Asset = ImageAsset | VideoAsset | AudioAsset | DocumentAsset | SheetAsset | GenericAsset;
-
-/**
- * @beta
- * Reference to an asset. Used as a unique identifier.
- */
-export declare type AssetRef = string & {
-    __assetRef: never;
-};
-
-/**
- * @beta
- * Audio asset result structure.
- */
-export declare type AudioAsset = BaseAsset & {
-    type: 'audio';
-    mimeType: 'audio/mpeg' | 'audio/mp4' | 'audio/x-m4a' | 'audio/mp3' | 'audio/ogg' | 'audio/wav' | 'audio/x-wav' | 'audio/x-pn-wav' | 'audio/wave' | 'audio/vnd.wave' | 'audio/webm';
-};
-
-/**
- * @beta
- * Base structure for an asset result.
- */
-export declare type BaseAsset = {
-    name: string;
-    url: string;
-};
-
-/**
- * @beta
- * Document asset result structure.
- */
-export declare type DocumentAsset = BaseAsset & {
-    type: 'document';
-    parentRef?: AssetRef;
-    mimeType: DocumentMimeType;
-};
-
-/**
- * @beta
- * Supported mimetype for document assets.
- */
-export declare type DocumentMimeType = 'application/pdf' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'text/plain' | 'text/markdown';
-
-/**
- * @beta
- * Request parameters for URL expansion.
- */
-export declare type ExpandUrlRequest = {
-    url: string;
-    requestConnection: () => Promise<void>;
-};
-
-/**
- * @beta
- * Response from URL expansion operation.
- */
-export declare type ExpandUrlResponse = {
-    status: 'completed';
-    result: ExpandUrlResult;
-} | {
-    status: 'not_found';
-};
-
-/**
- * @beta
- * Result of completed URL expansion.
- */
-export declare type ExpandUrlResult = {
-    ref: UrlExpanderAssetRef;
-};
-
-/**
- * @beta
- * Generic asset result structure.
- * A generic asset is any file that is not already covered by other asset types such as ImageAsset etc.
- * It is an error to pass a mime type that is covered by another asset type.
- */
-export declare type GenericAsset = BaseAsset & {
-    type: 'generic';
-    mimeType: string;
-};
-
-/**
- * @beta
- * Completed response from content retrieval operation.
- */
-export declare type GetContentCompletedResponse = {
-    status: 'completed';
-    result: {
-        type: 'asset';
-        asset: Asset;
-    };
-};
-
-/**
- * @beta
- * Error response from content retrieval operation.
- */
-export declare type GetContentErrorResponse = {
-    status: 'app_error';
-    message: string;
-};
-
-/**
- * @beta
- * Request parameters for content retrieval.
- */
-export declare type GetContentRequest = {
-    ref: UrlExpanderAssetRef;
-    requestConnection: () => Promise<void>;
-};
-
-/**
- * @beta
- * Response from content retrieval operation.
- */
-export declare type GetContentResponse = GetContentCompletedResponse | GetContentErrorResponse;
-
-/**
- * @beta
- * Image asset result structure.
- */
-export declare type ImageAsset = BaseAsset & {
-    type: 'image';
-    thumbnailUrl: string;
-    parentRef?: AssetRef;
-    mimeType: 'image/heic' | 'image/jpeg' | 'image/png' | 'image/svg+xml' | 'image/tiff' | 'image/webp';
-};
-
-/**
- * @beta
- *
- * Prepares the `UrlExpanderIntent`.
- */
-export declare const prepareUrlExpander: (implementation: UrlExpanderIntent) => void;
-
-/**
- * @beta
- * Sheet asset result structure.
- */
-export declare type SheetAsset = BaseAsset & {
-    type: 'sheet';
-    parentRef?: AssetRef;
-    mimeType: SheetMimeType;
-};
-
-/**
- * @beta
- * Supported mimetype for sheet assets.
- */
-export declare type SheetMimeType = 'text/csv' | 'application/vnd.ms-excel' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
-
-/**
- * @beta
- * Reference to an asset with metadata.
- */
-export declare type UrlExpanderAssetRef = {
-    type: 'asset';
-    id: string;
-    name: string;
-    iconUrl?: string;
-    description?: string;
-};
-
-/**
- * @beta
- * Intent interface for URL expansion and content retrieval operations.
- */
-export declare type UrlExpanderIntent = {
-    expandUrl(request: ExpandUrlRequest): Promise<ExpandUrlResponse>;
-    getContent(request: GetContentRequest): Promise<GetContentResponse>;
-};
-
-/**
- * @beta
- * Video asset result structure.
- */
-export declare type VideoAsset = BaseAsset & {
-    type: 'video';
-    thumbnailImageUrl: string;
-    parentRef?: AssetRef;
-    mimeType: 'video/avi' | 'video/x-msvideo' | 'image/gif' | 'video/x-m4v' | 'video/x-matroska' | 'video/quicktime' | 'video/mp4' | 'video/mpeg' | 'video/webm';
-};
-
-export { }