lucid-extension-sdk 0.0.40 → 0.0.41

package/package.json

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

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$/;