@canva/design 2.6.1-beta.1 → 2.6.2-beta.1

package/beta.d.ts

@@ -348,29 +348,6 @@ export declare interface ContentDraft<T> {
   save(): Promise<void>;
 }
 
-/**
- * @beta
- * Object for interacting with fill content (images/videos).
- */
-export declare type ContentFill = (
-  | Omit<ImageFill, "altText">
-  | Omit<VideoFill, "altText">
-) & {
-  /**
-   * Indicates whether the fill object has been deleted.
-   */
-  deleted: boolean;
-};
-
-/**
- * @beta
- * Session for reading and updating fill content in a user's design.
- */
-export declare interface ContentFillSession {
-  readonly contents: readonly ContentFill[];
-  sync(): Promise<void>;
-}
-
 /**
  * @beta
  */
@@ -2075,15 +2052,32 @@ export declare type DragStartEvent<E extends Element> = Pick<
 };
 
 /**
- * @public
- * Reads and edits content of the specified type from the user's design.
- * @param options - Options for configuring how a design is read.
- * @param callback - A callback for operating on the read content.
+ * @beta
+ * Reads and edits richtext content from the user's design.
+ * @param options - Options for configuring how a design is read. Must specify `contentType: 'richtext'`.
+ * @param callback - A callback that receives a `RichtextContentSession` for editing.
+ * @returns A promise that resolves when editing is complete.
  */
-export declare const editContent: (
-  options: EditContentOptions_2,
-  callback: EditContentCallback_2,
-) => Promise<void>;
+export declare function editContent(
+  options: EditContentOptions & {
+    contentType: "richtext";
+  },
+  callback: (session: RichtextContentSession) => Promise<void> | void,
+): Promise<void>;
+
+/**
+ * @beta
+ * Reads and edits fill content from the user's design.
+ * @param options - Options for configuring how a design is read. Must specify `contentType: 'fill'`.
+ * @param callback - A callback that receives a `FillContentSession` for editing.
+ * @returns A promise that resolves when editing is complete.
+ */
+export declare function editContent(
+  options: EditContentOptions & {
+    contentType: "fill";
+  },
+  callback: (session: FillContentSession) => Promise<void> | void,
+): Promise<void>;
 
 /**
  * @beta
@@ -2091,7 +2085,7 @@ export declare const editContent: (
  * @param session - The result of reading the content in the design.
  */
 export declare type EditContentCallback = (
-  session: RichtextContentSession | ContentFillSession,
+  session: RichtextContentSession | FillContentSession,
 ) => Promise<void> | void;
 
 /**
@@ -2355,6 +2349,31 @@ export declare type Fill = {
   asset?: ImageFill | VideoFill;
 };
 
+/**
+ * @beta
+ * Object for interacting with fill content (images/videos).
+ */
+export declare type FillContent =
+  | {
+      type: "image";
+      ref: ImageRef;
+      deleted: boolean;
+    }
+  | {
+      type: "video";
+      ref: VideoRef;
+      deleted: boolean;
+    };
+
+/**
+ * @beta
+ * Session for reading and updating fill content in a user's design.
+ */
+export declare interface FillContentSession {
+  readonly contents: readonly FillContent[];
+  sync(): Promise<void>;
+}
+
 /**
  * @public
  * A reference to a font that can be used in other parts of the SDK.

package/lib/cjs/sdk/design/beta.js

@@ -2,9 +2,17 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "getDesignMetadata", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get editContent () {
+        return editContent;
+    },
+    get getDesignMetadata () {
         return getDesignMetadata;
     }
 });
@@ -25,4 +33,7 @@ function _export_star(from, to) {
 var _window___canva___sdkRegistration, _window___canva__;
 const { canva_sdk } = window;
 const getDesignMetadata = canva_sdk.design.v2.designInteraction.getDesignMetadata;
-(_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('design', '2.6.1', 'beta');
+function editContent(options, callback) {
+    return canva_sdk.design.v2.designInteraction.editContent(options, (session)=>callback(session));
+}
+(_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('design', '2.6.2', 'beta');

package/lib/esm/sdk/design/beta.js

@@ -1,5 +1,8 @@
 var _window___canva___sdkRegistration, _window___canva__;
 const { canva_sdk } = window;
 export const getDesignMetadata = canva_sdk.design.v2.designInteraction.getDesignMetadata;
+export function editContent(options, callback) {
+    return canva_sdk.design.v2.designInteraction.editContent(options, (session)=>callback(session));
+}
 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('design', '2.6.1', 'beta');
+(_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('design', '2.6.2', 'beta');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/design",
-  "version": "2.6.1-beta.1",
+  "version": "2.6.2-beta.1",
   "description": "The Canva Apps SDK design library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",
@@ -22,4 +22,4 @@
     }
   },
   "typings": "./beta.d.ts"
-}
+}