@canva/intents 2.0.1-beta.2 → 2.0.2-beta.3

package/asset/beta.d.ts

@@ -1 +1,236 @@
+/**
+ * @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 {};

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

@@ -2,3 +2,13 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+Object.defineProperty(exports, "prepareUrlExpander", {
+    enumerable: true,
+    get: function() {
+        return prepareUrlExpander;
+    }
+});
+const _version = require("../version");
+const { canva_sdk } = window;
+const prepareUrlExpander = canva_sdk.intents.v1.asset.prepareUrlExpander;
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/asset', _version.LATEST_VERSION, 'beta');

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

@@ -8,4 +8,4 @@ Object.defineProperty(exports, "LATEST_VERSION", {
         return LATEST_VERSION;
     }
 });
-const LATEST_VERSION = '2.0.1';
+const LATEST_VERSION = '2.0.2';

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

@@ -1 +1,4 @@
-export { };
+import { LATEST_VERSION } from '../version';
+const { canva_sdk } = window;
+export const prepareUrlExpander = canva_sdk.intents.v1.asset.prepareUrlExpander;
+window.__canva__?.sdkRegistration?.registerPackageVersion('intents/asset', LATEST_VERSION, 'beta');

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

@@ -1 +1 @@
-export const LATEST_VERSION = '2.0.1';
+export const LATEST_VERSION = '2.0.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/intents",
-  "version": "2.0.1-beta.2",
+  "version": "2.0.2-beta.3",
   "description": "The Canva Apps SDK Intents library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
@@ -42,4 +42,4 @@
     }
   },
   "typings": "./beta.d.ts"
-}
+}