lucid-extension-sdk 0.0.53 → 0.0.55

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -90,6 +90,7 @@ export declare const enum CommandName {
     ShowPanel = "spn",
     SleepForTestCase = "sleep",
     StartDragBlockToCanvas = "sdc",
+    StartPDFUploadRequest = "pdf",
     ThrowForTestCase = "throw",
     UnhookCreateItems = "uci",
     UnhookSelection = "us",
@@ -395,6 +396,10 @@ export declare type CommandArgs = {
         query: StartDragBlockToCanvasQuery;
         result: StartDragBlockToCanvasResult;
     };
+    [CommandName.StartPDFUploadRequest]: {
+        query: StartPDFUploadRequestQuery;
+        result: StartPDFUploadRequestResponse;
+    };
     [CommandName.ThrowForTestCase]: {
         query: ThrowForTestCaseQuery;
         result: ThrowForTestCaseResult;
@@ -993,6 +998,13 @@ export declare type StartDragBlockToCanvasQuery = {
     's'?: JsonSerializable | undefined;
 };
 export declare type StartDragBlockToCanvasResult = Promise<string | undefined>;
+export declare type StartPDFUploadRequestQuery = string;
+/**
+ * @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.
+ */
+export declare type StartPDFUploadRequestResponse = Promise<string>;
 export declare type ThrowForTestCaseQuery = number;
 export declare type ThrowForTestCaseResult = undefined | Promise<void>;
 export declare type UnhookCreateItemsQuery = {

package/sdk/commandtypes.js

@@ -74,6 +74,7 @@ exports.commandTitles = new Map([
     ["spn" /* CommandName.ShowPanel */, 'ShowPanel'],
     ["sleep" /* CommandName.SleepForTestCase */, 'SleepForTestCase'],
     ["sdc" /* CommandName.StartDragBlockToCanvas */, 'StartDragBlockToCanvas'],
+    ["pdf" /* CommandName.StartPDFUploadRequest */, 'StartPDFUploadRequest'],
     ["throw" /* CommandName.ThrowForTestCase */, 'ThrowForTestCase'],
     ["uci" /* CommandName.UnhookCreateItems */, 'UnhookCreateItems'],
     ["us" /* CommandName.UnhookSelection */, 'UnhookSelection'],

package/sdk/core/cardintegration/cardintegration.d.ts

@@ -18,8 +18,19 @@ export interface ExtensionCardFieldDefinition extends FieldDefinition {
     default?: SerializedFieldType;
     /** Additional information we can provide to users, e.g. as a hover tooltip */
     description?: string;
-    /** If specified, the list of options available to choose from */
-    options?: ExtensionCardFieldOption[];
+    /**
+     * If specified, the list of options available to choose from, or the name
+     * of a registered action that returns the list of options (either directly
+     * or as a Promise).
+     */
+    options?: ExtensionCardFieldOption[] | string;
+    /**
+     * If specified, an action that takes the search text and input so far, and
+     * returns the list of options that should be displayed. This is useful when
+     * there are too many possible options to reasonably use the "options"
+     * option for options.
+     */
+    search?: string;
 }
 /** @ignore */
 export declare type SerializedCardFieldOption = {
@@ -33,7 +44,8 @@ export declare type SerializedExtensionCardFieldDefinition = SerializedFieldDefi
     'l': string;
     'def'?: SerializedFieldType;
     'd'?: string;
-    'op'?: SerializedCardFieldOption[];
+    'op'?: SerializedCardFieldOption[] | string;
+    's'?: string;
 };
 /** @ignore */
 export declare function serializeCardFieldDefinition(field: ExtensionCardFieldDefinition): SerializedExtensionCardFieldDefinition;
@@ -64,10 +76,11 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
     l: typeof isString;
     d: (x: unknown) => x is string | undefined;
     def: (x: unknown) => x is SerializedFieldType;
-    op: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+    op: (x: unknown) => x is string | import("../guards").DestructureGuardedTypeObj<{
         l: typeof isString;
         v: typeof isSerializedFieldType;
     }>[] | undefined;
+    s: (x: unknown) => x is string | undefined;
 }>;
 /** @ignore */
 export declare function deserializeCardFieldDefinition(field: SerializedExtensionCardFieldDefinition): ExtensionCardFieldDefinition;

package/sdk/core/cardintegration/cardintegration.js

@@ -18,7 +18,7 @@ exports.serializeCardFieldOption = serializeCardFieldOption;
 /** @ignore */
 function serializeCardFieldDefinition(field) {
     var _a;
-    return Object.assign(Object.assign({}, (0, schemadefinition_1.serializeFieldDefinition)(field)), { 'l': field.label, 'def': field.default, 'd': field.description, 'op': (_a = field.options) === null || _a === void 0 ? void 0 : _a.map(serializeCardFieldOption) });
+    return Object.assign(Object.assign({}, (0, schemadefinition_1.serializeFieldDefinition)(field)), { 'l': field.label, 'def': field.default, 'd': field.description, 'op': (0, checks_1.isString)(field.options) ? field.options : (_a = field.options) === null || _a === void 0 ? void 0 : _a.map(serializeCardFieldOption), 's': field.search });
 }
 exports.serializeCardFieldDefinition = serializeCardFieldDefinition;
 /** @ignore */
@@ -51,12 +51,13 @@ exports.isSerializedExtensionCardFieldDefinition = (0, validators_1.objectValida
     'l': checks_1.isString,
     'd': (0, validators_1.option)(checks_1.isString),
     'def': (0, validators_1.option)(serializedfields_1.isSerializedFieldType),
-    'op': (0, validators_1.option)((0, validators_1.arrayValidator)(exports.isSerializedFieldOption)),
+    'op': (0, validators_1.option)((0, validators_1.either)(checks_1.isString, (0, validators_1.arrayValidator)(exports.isSerializedFieldOption))),
+    's': (0, validators_1.option)(checks_1.isString),
 });
 /** @ignore */
 function deserializeCardFieldDefinition(field) {
     var _a;
-    return Object.assign(Object.assign({}, (0, schemadefinition_1.parseFieldDefinition)(field)), { label: field['l'], description: field['d'], default: field['def'], options: (_a = field['op']) === null || _a === void 0 ? void 0 : _a.map(deserializeFieldOption) });
+    return Object.assign(Object.assign({}, (0, schemadefinition_1.parseFieldDefinition)(field)), { label: field['l'], description: field['d'], default: field['def'], options: (0, checks_1.isString)(field['op']) ? field['op'] : (_a = field['op']) === null || _a === void 0 ? void 0 : _a.map(deserializeFieldOption), search: field['s'] });
 }
 exports.deserializeCardFieldDefinition = deserializeCardFieldDefinition;
 /** @ignore */

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

@@ -1,3 +1,4 @@
+import { StartPDFUploadRequestResponse } from '../../commandtypes';
 import { UnfurlIframe } from '../../core/unfurl/unfurliframe';
 import { BlockProxy } from '../blockproxy';
 /**
@@ -50,7 +51,7 @@ export declare class ExperimentalLinkUnfurlBlockProxy extends BlockProxy {
      * 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>;
+    experimentalStartPDFUpload(options: LinkUnfurlPDFOptions): Promise<StartPDFUploadRequestResponse>;
 }
 /**
  * @ignore
@@ -64,21 +65,3 @@ export interface LinkUnfurlPDFOptions {
      */
     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

@@ -73,8 +73,9 @@ class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
      * 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');
+    async experimentalStartPDFUpload(options) {
+        const result = await this.client.sendCommand("pdf" /* CommandName.StartPDFUploadRequest */, this.id);
+        return result;
     }
 }
 exports.ExperimentalLinkUnfurlBlockProxy = ExperimentalLinkUnfurlBlockProxy;

package/sdk/document/taskmanagementcardintegration.d.ts

@@ -1,10 +1,13 @@
-import { CardIntegration } from '../core/cardintegration/cardintegration';
+import { CardIntegration, ExtensionCardFieldOption } from '../core/cardintegration/cardintegration';
+import { SerializedFieldType } from '../core/data/serializedfield/serializedfields';
 import { EditorClient } from '../editorclient';
 export declare class TaskManagementCardIntegration {
     private readonly client;
     constructor(client: EditorClient);
     private static nextHookId;
     private static nextHookName;
+    registerFieldOptionsCallback(callback: (inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
+    registerFieldSearchCallback(callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
     /**
      * Register a new card integration.
      * @param card The definition of the new card integration

package/sdk/document/taskmanagementcardintegration.js

@@ -12,6 +12,22 @@ class TaskManagementCardIntegration {
     static nextHookName() {
         return '__taskmanagementcard__hook' + TaskManagementCardIntegration.nextHookId++;
     }
+    registerFieldOptionsCallback(callback) {
+        const name = TaskManagementCardIntegration.nextHookName();
+        this.client.registerAction(name, async ({ 'i': inputSoFar }) => {
+            const result = await callback(new Map(inputSoFar));
+            return result.map((option) => (0, cardintegration_1.serializeCardFieldOption)(option));
+        });
+        return name;
+    }
+    registerFieldSearchCallback(callback) {
+        const name = TaskManagementCardIntegration.nextHookName();
+        this.client.registerAction(name, async ({ 'i': inputSoFar, 's': searchText }) => {
+            const result = await callback(searchText, new Map(inputSoFar));
+            return result.map((option) => (0, cardintegration_1.serializeCardFieldOption)(option));
+        });
+        return name;
+    }
     /**
      * Register a new card integration.
      * @param card The definition of the new card integration