lucid-extension-sdk 0.0.39 → 0.0.41

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.39",
+    "version": "0.0.41",
     "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,8 +1,9 @@
+import { ExperimentalLinkUnfurlBlockProxy } from '../../document/blockclasses/linkunfurlblockproxy';
 import { UnfurlDetails } from './unfurldetails';
+import { UnfurlRefreshErrorType } from './unfurlrefresherrortype';
 export declare enum UnfurlCallbackType {
     Unfurl = "u",
-    AfterUnfurl = "a",
-    Refresh = "r"
+    AfterUnfurl = "a"
 }
 /**
  * The callbacks that handle unfurls and refreshing.
@@ -14,9 +15,25 @@ export interface UnfurlCallbacks {
      *
      * This should return with minimal delay to get a partial unfurl shown to the user as quick as possible.
      * Final configuration of the unfurl should be done in afterUnfurlCallback.
+     *
+     * This callback is also used for refresh to re-fetch the information
+     *
      * @param url The url to unfurl
      * @return The details of the unfurl or undefined
      * @ignore
      */
-    unfurlCallback: (url: string) => Promise<UnfurlDetails | undefined>;
+    unfurlCallback: (url: string) => Promise<UnfurlDetails | undefined | UnfurlRefreshErrorType>;
+    /**
+     * Callback after initial unfurl
+     * The purpose is to allow unfurlCallback to happen quickly, while afterUnfurlCallback handles longer running process
+     *
+     * For example, preview image could be added in unfurlCallback,
+     * but multiple thumbnails (or PDF conversion etc.) could be added in afterUnfurlCallback -
+     *
+     * 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) => Promise<void>;
 }

package/sdk/core/unfurl/unfurlcallbacks.js

@@ -5,5 +5,4 @@ var UnfurlCallbackType;
 (function (UnfurlCallbackType) {
     UnfurlCallbackType["Unfurl"] = "u";
     UnfurlCallbackType["AfterUnfurl"] = "a";
-    UnfurlCallbackType["Refresh"] = "r";
 })(UnfurlCallbackType = exports.UnfurlCallbackType || (exports.UnfurlCallbackType = {}));

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

@@ -0,0 +1,5 @@
+export declare enum UnfurlRefreshErrorType {
+    AuthorizationFailure = "Authorization failure",
+    GenericFailure = "Generic failure"
+}
+export declare const unfurlRefreshErrorTypeValidator: (x: unknown) => x is UnfurlRefreshErrorType;

package/sdk/core/unfurl/unfurlrefresherrortype.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unfurlRefreshErrorTypeValidator = exports.UnfurlRefreshErrorType = void 0;
+const validators_1 = require("../validators/validators");
+var UnfurlRefreshErrorType;
+(function (UnfurlRefreshErrorType) {
+    UnfurlRefreshErrorType["AuthorizationFailure"] = "Authorization failure";
+    UnfurlRefreshErrorType["GenericFailure"] = "Generic failure";
+})(UnfurlRefreshErrorType = exports.UnfurlRefreshErrorType || (exports.UnfurlRefreshErrorType = {}));
+exports.unfurlRefreshErrorTypeValidator = (0, validators_1.stringEnumValidator)(UnfurlRefreshErrorType);

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

@@ -37,4 +37,41 @@ export declare class ExperimentalLinkUnfurlBlockProxy extends BlockProxy {
      * @ignore
      */
     setThumbnailUrls(thumbnails: string[]): void;
+    /**
+     * @ignore
+     * Initiates the PDF upload for this block. The result includes an uploadUrl which you can use to upload the PDF.
+     * The PDF uploaded at that url will be assocaite with this block (and any copy of it) in the editor until it is refreshed.
+     * @param options The options for the upload
+     */
+    experimentalStartPDFUpload(options: LinkUnfurlPDFOptions): Promise<LinkUnfurlPDFResult>;
+}
+/**
+ * @ignore
+ * Options for starting the PDF upload process for a link unfurl
+ */
+export interface LinkUnfurlPDFOptions {
+    /**
+     * @ignore
+     * The anticipated number of pages. If this is defined, this is the number of pages that will show up while the PDF
+     * is being processed and converted into images. Once converted, the actual number will take precedence.
+     */
+    expectedNumberOfPages: number;
+}
+/**
+ * @ignore
+ * The result of initiating the PDF upload process.
+ */
+export interface LinkUnfurlPDFResult {
+    /**
+     * @ignore
+     * A signed URL you can upload the pdf to. You can do this manually (via the client, your own service) or via the
+     * oauth proxy.
+     */
+    uploadUrl: string;
+    /**
+     * @ignore
+     * The internal identifier to the PDF upload which is associated with the block.
+     * TODO: Determine if we show this to the extension, or keep internal
+     */
+    blobId: string;
 }

package/sdk/document/blockclasses/linkunfurlblockproxy.js

@@ -49,6 +49,15 @@ class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
     setThumbnailUrls(thumbnails) {
         this.properties.set('LinkUnfurlThumbnailUrls', thumbnails);
     }
+    /**
+     * @ignore
+     * Initiates the PDF upload for this block. The result includes an uploadUrl which you can use to upload the PDF.
+     * The PDF uploaded at that url will be assocaite with this block (and any copy of it) in the editor until it is refreshed.
+     * @param options The options for the upload
+     */
+    experimentalStartPDFUpload(options) {
+        throw new Error('Not yet implemented');
+    }
 }
 exports.ExperimentalLinkUnfurlBlockProxy = ExperimentalLinkUnfurlBlockProxy;
 ExperimentalLinkUnfurlBlockProxy.classNameRegex = /^LinkUnfurlBlock$/;

package/sdk/editorclient.js

@@ -6,8 +6,10 @@ const base64_1 = require("./core/base64");
 const checks_1 = require("./core/checks");
 const unfurlcallbacks_1 = require("./core/unfurl/unfurlcallbacks");
 const unfurldetails_1 = require("./core/unfurl/unfurldetails");
+const unfurlrefresherrortype_1 = require("./core/unfurl/unfurlrefresherrortype");
 const collectionproxy_1 = require("./data/collectionproxy");
 const blockproxyregistry_1 = require("./document/blockclasses/blockproxyregistry");
+const linkunfurlblockproxy_1 = require("./document/blockclasses/linkunfurlblockproxy");
 const blockproxy_1 = require("./document/blockproxy");
 const documentproxy_1 = require("./document/documentproxy");
 const elementproxy_1 = require("./document/elementproxy");
@@ -204,20 +206,23 @@ class EditorClient {
     experimentalRegisterUnfurlHandler(domain, callbacks) {
         const action = this.getUniqueActionName();
         this.registerAction(action, async (rawMsg) => {
+            var _a;
             const msg = (0, registerunfurlmessage_1.deserializeRegisterUnfurlMessage)(rawMsg);
             switch (msg.unfurlCallbackType) {
                 case unfurlcallbacks_1.UnfurlCallbackType.Unfurl: {
                     const result = await callbacks.unfurlCallback(msg.url);
-                    if (result) {
+                    if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
                         return (0, unfurldetails_1.serializeUnfurlDetails)(result);
                     }
                     break;
                 }
                 case unfurlcallbacks_1.UnfurlCallbackType.AfterUnfurl: {
-                    throw new Error('UnfurlCallbackType afterUnfurl not implmeneted');
-                }
-                case unfurlcallbacks_1.UnfurlCallbackType.Refresh: {
-                    throw new Error('UnfurlCallbackType refresh not implmeneted');
+                    if (msg.blockId) {
+                        const proxy = this.getBlockProxy(msg.blockId);
+                        if (proxy instanceof linkunfurlblockproxy_1.ExperimentalLinkUnfurlBlockProxy) {
+                            await ((_a = callbacks.afterUnfurlCallback) === null || _a === void 0 ? void 0 : _a.call(callbacks, proxy));
+                        }
+                    }
                 }
                 default:
                     break;

package/sdk/message/registerunfurlmessage.d.ts

@@ -9,18 +9,22 @@ export interface RegisterUnfurlMessage {
     url: string;
     /** @ignore */
     unfurlCallbackType: UnfurlCallbackType;
+    /** @ignore */
+    blockId?: string;
 }
 /** @ignore */
 export interface SerializedRegisterUnfurlMessage extends JsonObject {
     'id': string;
     'u': string;
     't': UnfurlCallbackType;
+    'b'?: string;
 }
 /** @ignore */
 export declare const isValidRegisterUnfurlMessage: (subject: unknown) => subject is import("../core/guards").DestructureGuardedTypeObj<{
     id: typeof isString;
     u: typeof isString;
     t: (x: unknown) => x is UnfurlCallbackType;
+    b: (x: unknown) => x is string | undefined;
 }>;
 /** @ignore */
 export declare function deserializeRegisterUnfurlMessage(raw: SerializedRegisterUnfurlMessage): RegisterUnfurlMessage;

package/sdk/message/registerunfurlmessage.js

@@ -9,6 +9,7 @@ exports.isValidRegisterUnfurlMessage = (0, validators_1.objectValidator)({
     'id': checks_1.isString,
     'u': checks_1.isString,
     't': (0, validators_1.stringEnumValidator)(unfurlcallbacks_1.UnfurlCallbackType),
+    'b': (0, validators_1.option)(checks_1.isString),
 });
 /** @ignore */
 function deserializeRegisterUnfurlMessage(raw) {
@@ -16,6 +17,7 @@ function deserializeRegisterUnfurlMessage(raw) {
         id: raw['id'],
         url: raw['u'],
         unfurlCallbackType: raw['t'],
+        blockId: raw['b'],
     };
 }
 exports.deserializeRegisterUnfurlMessage = deserializeRegisterUnfurlMessage;
@@ -25,6 +27,7 @@ function serializeRegisterUnfurlMessage(concrete) {
         'id': concrete.id,
         'u': concrete.url,
         't': concrete.unfurlCallbackType,
+        'b': concrete.blockId,
     };
 }
 exports.serializeRegisterUnfurlMessage = serializeRegisterUnfurlMessage;