lucid-extension-sdk 0.0.88 → 0.0.90

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.88",
+    "version": "0.0.90",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "sdk/index.js",
     "types": "sdk/index.d.ts",

package/sdk/core/unfurl/unfurlcallbacks.d.ts

@@ -1,4 +1,4 @@
-import { ExperimentalLinkUnfurlBlockProxy } from '../../document/blockclasses/linkunfurlblockproxy';
+import { LinkUnfurlBlockProxy } from '../../document/blockclasses/linkunfurlblockproxy';
 import { UnfurlDetails } from './unfurldetails';
 import { UnfurlRefreshErrorType } from './unfurlrefresherrortype';
 export declare enum UnfurlCallbackType {
@@ -7,7 +7,6 @@ export declare enum UnfurlCallbackType {
 }
 /**
  * The callbacks that handle unfurls and refreshing.
- * @ignore
  */
 export interface UnfurlCallbacks {
     /**
@@ -20,7 +19,6 @@ export interface UnfurlCallbacks {
      *
      * @param url The url to unfurl
      * @return The details of the unfurl or undefined
-     * @ignore
      */
     unfurlCallback: (url: string) => Promise<UnfurlDetails | undefined | UnfurlRefreshErrorType>;
     /**
@@ -33,7 +31,6 @@ export interface UnfurlCallbacks {
      * This callback is also used for refresh to re-fetch the information
      *
      * @param blockProxy The block proxy of the unfurl block
-     * @ignore
      */
-    afterUnfurlCallback?: (blockProxy: ExperimentalLinkUnfurlBlockProxy, url: string) => Promise<void>;
+    afterUnfurlCallback?: (blockProxy: LinkUnfurlBlockProxy, url: string) => Promise<void>;
 }

package/sdk/core/xhr.d.ts

@@ -27,7 +27,7 @@ export interface OAuthXHRRequest extends XHRRequest {
      * whether the request will be made and forwarded, and not the actual request.
      *
      * Note: There is an allow list which limits where the result can be posted. It is currently only to the result of
-     * ExperimentalLinkUnfurlBlockProxy#experimentalStartPDFUpload
+     * LinkUnfurlBlockProxy#experimentalStartPDFUpload
      */
     postResultTo?: string;
 }

package/sdk/document/blockclasses/blockproxyregistry.js

@@ -8,7 +8,7 @@ const linkunfurlblockproxy_1 = require("./linkunfurlblockproxy");
 const allProxyClasses = [
     erdblockproxy_1.ERDBlockProxy,
     customblockproxy_1.CustomBlockProxy,
-    linkunfurlblockproxy_1.ExperimentalLinkUnfurlBlockProxy,
+    linkunfurlblockproxy_1.LinkUnfurlBlockProxy,
     cardblockproxy_1.CardBlockProxy,
 ];
 function findProxyClass(className) {

package/sdk/document/blockclasses/linkunfurlblockproxy.d.ts

@@ -2,47 +2,33 @@ import { StartPDFUploadRequestResponse } from '../../commandtypes';
 import { UnfurlIframe } from '../../core/unfurl/unfurliframe';
 import { BlockProxy } from '../blockproxy';
 /**
- * @ignore
- *
  * This is the kind of block that appears when a link is pasted onto the canvas of a Lucid editor.
  */
-export declare class ExperimentalLinkUnfurlBlockProxy extends BlockProxy {
+export declare class LinkUnfurlBlockProxy extends BlockProxy {
     static classNameRegex: RegExp;
     /**
      * Returns the title on the block, which is the main text shown on the block.
-     *
-     * @ignore
      */
     getTitle(): string;
     /**
      * Sets the title on the block, which is the main text shown on the block.
-     *
-     * @ignore
      */
     setTitle(title: string): void;
     /**
      * Returns the name of the service the link belongs to, such as "Lucid" or "Google", as displayed below the title on
      * the block.
-     *
-     * @ignore
      */
     getProviderName(): string;
     /**
      * Sets the URL to be loaded in an iframe when the user clicks the "Expand" action on the block.
-     *
-     * @ignore
      */
     setIframe(unfurlIframe: UnfurlIframe): void;
     /**
      * Sets the main thumbnail on the block
-     *
-     * @ignore
      */
     setPreviewThumbnailUrl(thumbnailUrl: string): void;
     /**
      * Sets additional thumbnails on the block
-     *
-     * @ignore
      */
     setThumbnailUrls(thumbnails: string[]): void;
     /**
@@ -52,3 +38,13 @@ export declare class ExperimentalLinkUnfurlBlockProxy extends BlockProxy {
      */
     experimentalStartPDFUpload(): Promise<StartPDFUploadRequestResponse>;
 }
+/**
+ * @ignore
+ * @deprecated Use LinkUnfurlBlockProxy instead.
+ */
+export declare const ExperimentalLinkUnfurlBlockProxy: typeof LinkUnfurlBlockProxy;
+/**
+ * @ignore
+ * @deprecated Use LinkUnfurlBlockProxy instead.
+ */
+export declare type ExperimentalLinkUnfurlBlockProxy = LinkUnfurlBlockProxy;

package/sdk/document/blockclasses/linkunfurlblockproxy.js

@@ -1,27 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExperimentalLinkUnfurlBlockProxy = void 0;
+exports.ExperimentalLinkUnfurlBlockProxy = exports.LinkUnfurlBlockProxy = void 0;
 const iframeutils_1 = require("../../core/iframe/iframeutils");
 const unfurliframe_1 = require("../../core/unfurl/unfurliframe");
 const blockproxy_1 = require("../blockproxy");
 /**
- * @ignore
- *
  * This is the kind of block that appears when a link is pasted onto the canvas of a Lucid editor.
  */
-class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
+class LinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
     /**
      * Returns the title on the block, which is the main text shown on the block.
-     *
-     * @ignore
      */
     getTitle() {
         return this.textAreas.get('t_LinkUnfurlTitle');
     }
     /**
      * Sets the title on the block, which is the main text shown on the block.
-     *
-     * @ignore
      */
     setTitle(title) {
         this.textAreas.set('t_LinkUnfurlTitle', title, { force: true });
@@ -29,16 +23,12 @@ class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
     /**
      * Returns the name of the service the link belongs to, such as "Lucid" or "Google", as displayed below the title on
      * the block.
-     *
-     * @ignore
      */
     getProviderName() {
         return this.textAreas.get('t_LinkUnfurlProviderName');
     }
     /**
      * Sets the URL to be loaded in an iframe when the user clicks the "Expand" action on the block.
-     *
-     * @ignore
      */
     setIframe(unfurlIframe) {
         const iframeAttributes = (0, unfurliframe_1.generateIframeAttributes)(unfurlIframe);
@@ -48,16 +38,12 @@ class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
     }
     /**
      * Sets the main thumbnail on the block
-     *
-     * @ignore
      */
     setPreviewThumbnailUrl(thumbnailUrl) {
         this.properties.set('LinkUnfurlThumbnailUrl', thumbnailUrl);
     }
     /**
      * Sets additional thumbnails on the block
-     *
-     * @ignore
      */
     setThumbnailUrls(thumbnails) {
         this.properties.set('LinkUnfurlThumbnailUrls', thumbnails);
@@ -72,5 +58,10 @@ class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
         return result;
     }
 }
-exports.ExperimentalLinkUnfurlBlockProxy = ExperimentalLinkUnfurlBlockProxy;
-ExperimentalLinkUnfurlBlockProxy.classNameRegex = /^LinkUnfurlBlock$/;
+exports.LinkUnfurlBlockProxy = LinkUnfurlBlockProxy;
+LinkUnfurlBlockProxy.classNameRegex = /^LinkUnfurlBlock$/;
+/**
+ * @ignore
+ * @deprecated Use LinkUnfurlBlockProxy instead.
+ */
+exports.ExperimentalLinkUnfurlBlockProxy = LinkUnfurlBlockProxy;

package/sdk/editorclient.d.ts

@@ -51,7 +51,11 @@ export declare class EditorClient {
      * @param mediaType The media type, e.g. 'image/png'
      * @returns A promise that resolves with the URL of the created image.
      *
+     */
+    createUserImage(mediaType: string, data: Uint8Array | string): Promise<string>;
+    /**
      * @ignore
+     * @deprecated Use createUserImage instead.
      */
     experimentalCreateUserImage(mediaType: string, data: Uint8Array | string): Promise<string>;
     /**
@@ -148,11 +152,15 @@ export declare class EditorClient {
      */
     registerFileUploadAction(name: string, callback: (files: FileUploadData[]) => void): void;
     /**
-     * @ignore
-     * Registers an handler for link unfurling.
+     * Registers a handler for link unfurling.
      * @param domain The domain
      * @param callbacks The callbacks to call when a link matching the domain is pasted.
      */
+    registerUnfurlHandler(domain: string, callbacks: UnfurlCallbacks): void;
+    /**
+     * @ignore
+     * @deprecated Use registerUnfurlHandler instead.
+     */
     experimentalRegisterUnfurlHandler(domain: string, callbacks: UnfurlCallbacks): void;
     /**
      * Remove the callback for a given action. If the action is later invoked, nothing will happen.

package/sdk/editorclient.js

@@ -82,15 +82,21 @@ class EditorClient {
      * @param mediaType The media type, e.g. 'image/png'
      * @returns A promise that resolves with the URL of the created image.
      *
-     * @ignore
      */
-    async experimentalCreateUserImage(mediaType, data) {
+    async createUserImage(mediaType, data) {
         const result = await this.sendCommand("cui" /* CommandName.CreateUserImage */, {
             't': mediaType,
             'd': (0, checks_1.isString)(data) ? data : (0, base64_1.encodeBase64)(data),
         });
         return result['u'];
     }
+    /**
+     * @ignore
+     * @deprecated Use createUserImage instead.
+     */
+    experimentalCreateUserImage(mediaType, data) {
+        return this.createUserImage(mediaType, data);
+    }
     /**
      *
      * @param flowName
@@ -247,12 +253,11 @@ class EditorClient {
         });
     }
     /**
-     * @ignore
-     * Registers an handler for link unfurling.
+     * Registers a handler for link unfurling.
      * @param domain The domain
      * @param callbacks The callbacks to call when a link matching the domain is pasted.
      */
-    experimentalRegisterUnfurlHandler(domain, callbacks) {
+    registerUnfurlHandler(domain, callbacks) {
         const action = this.getUniqueActionName();
         this.registerAction(action, async (rawMsg) => {
             var _a;
@@ -273,7 +278,7 @@ class EditorClient {
                 case unfurlcallbacks_1.UnfurlCallbackType.AfterUnfurl: {
                     if (msg.blockId) {
                         const proxy = this.getBlockProxy(msg.blockId);
-                        if (proxy instanceof linkunfurlblockproxy_1.ExperimentalLinkUnfurlBlockProxy) {
+                        if (proxy instanceof linkunfurlblockproxy_1.LinkUnfurlBlockProxy) {
                             await ((_a = callbacks.afterUnfurlCallback) === null || _a === void 0 ? void 0 : _a.call(callbacks, proxy, msg.url));
                         }
                     }
@@ -285,6 +290,13 @@ class EditorClient {
         });
         this.sendCommand("ru" /* CommandName.RegisterUnfurl */, { 'd': domain, 'a': action });
     }
+    /**
+     * @ignore
+     * @deprecated Use registerUnfurlHandler instead.
+     */
+    experimentalRegisterUnfurlHandler(domain, callbacks) {
+        return this.registerUnfurlHandler(domain, callbacks);
+    }
     /**
      * Remove the callback for a given action. If the action is later invoked, nothing will happen.
      * @param name name of the action to unregister