lucid-extension-sdk 0.0.159 → 0.0.161

package/commandtypes.d.ts

@@ -69,6 +69,7 @@ export declare const enum CommandName {
     GetVisibleRect = "gvr",
     HideModal = "hm",
     HidePanel = "hp",
+    HookAllChanges = "hac",
     HookCreateItems = "hci",
     HookDeleteItems = "hdi",
     HookSelection = "hs",
@@ -115,6 +116,7 @@ export declare const enum CommandName {
     StartPDFUploadRequest = "pdf",
     ThrowForTestCase = "throw",
     TriggerAuthFlow = "tauth",
+    UnhookAllChanges = "uac",
     UnhookCreateItems = "uci",
     UnhookDeleteItems = "udi",
     UnhookSelection = "us",
@@ -327,6 +329,10 @@ export declare type CommandArgs = {
         query: HidePanelQuery;
         result: HidePanelResult;
     };
+    [CommandName.HookAllChanges]: {
+        query: HookAllChangesQuery;
+        result: HookAllChangesResult;
+    };
     [CommandName.HookCreateItems]: {
         query: HookCreateItemsQuery;
         result: HookCreateItemsResult;
@@ -511,6 +517,10 @@ export declare type CommandArgs = {
         query: TriggerAuthFlowQuery;
         result: TriggerAuthFlowResult;
     };
+    [CommandName.UnhookAllChanges]: {
+        query: UnhookAllChangesQuery;
+        result: UnhookAllChangesResult;
+    };
     [CommandName.UnhookCreateItems]: {
         query: UnhookCreateItemsQuery;
         result: UnhookCreateItemsResult;
@@ -962,6 +972,11 @@ export declare type HidePanelQuery = {
     'n': string;
 };
 export declare type HidePanelResult = undefined;
+export declare type HookAllChangesQuery = {
+    /** Name of the action for receiving events. Will be called with no parameters periodically as changes are made to the document */
+    'n': string;
+};
+export declare type HookAllChangesResult = undefined;
 export declare type HookCreateItemsQuery = {
     /** Name of the action for receiving events. Will be called with an array of strings of all recently created item IDs. */
     'n': string;
@@ -1271,6 +1286,11 @@ export declare type TriggerAuthFlowResult = Promise<RawTriggerAuthFlowResult>;
 export declare type RawTriggerAuthFlowResult = {
     's': boolean;
 };
+export declare type UnhookAllChangesQuery = {
+    /** Name of the action passed to HookAllChanges */
+    'n': string;
+};
+export declare type UnhookAllChangesResult = undefined;
 export declare type UnhookCreateItemsQuery = {
     /** Name of the action passed to HookCreateItems */
     'n': string;

package/commandtypes.js

@@ -51,6 +51,7 @@ exports.commandTitles = new Map([
     ["gvr" /* CommandName.GetVisibleRect */, 'GetVisibleRect'],
     ["hm" /* CommandName.HideModal */, 'HideModal'],
     ["hp" /* CommandName.HidePanel */, 'HidePanel'],
+    ["hac" /* CommandName.HookAllChanges */, 'HookAllChanges'],
     ["hci" /* CommandName.HookCreateItems */, 'HookCreateItems'],
     ["hdi" /* CommandName.HookDeleteItems */, 'HookDeleteItems'],
     ["hs" /* CommandName.HookSelection */, 'HookSelection'],
@@ -95,6 +96,7 @@ exports.commandTitles = new Map([
     ["pdf" /* CommandName.StartPDFUploadRequest */, 'StartPDFUploadRequest'],
     ["throw" /* CommandName.ThrowForTestCase */, 'ThrowForTestCase'],
     ["tauth" /* CommandName.TriggerAuthFlow */, 'TriggerAuthFlow'],
+    ["uac" /* CommandName.UnhookAllChanges */, 'UnhookAllChanges'],
     ["uci" /* CommandName.UnhookCreateItems */, 'UnhookCreateItems'],
     ["udi" /* CommandName.UnhookDeleteItems */, 'UnhookDeleteItems'],
     ["us" /* CommandName.UnhookSelection */, 'UnhookSelection'],

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -148,3 +148,20 @@ export declare type SerializedLucidCardFieldDisplaySettings = {
 export declare function serializeLucidCardFieldDisplaySettings(settings: LucidCardFieldDisplaySettings): SerializedLucidCardFieldDisplaySettings;
 /** @ignore */
 export declare function deserializeLucidCardFieldDisplaySettings(settings: SerializedLucidCardFieldDisplaySettings): LucidCardFieldDisplaySettings;
+/**
+ * These are the three possible values for the status of a basic card block.
+ */
+export declare enum StatusValues {
+    Todo = "To Do",
+    InProgress = "In Progress",
+    Done = "Done"
+}
+export declare enum LucidCardFields {
+    Title = "Title",
+    Description = "Description",
+    Assignee = "Assignee",
+    Estimate = "Estimate",
+    Status = "Status",
+    StartTime = "StartTime",
+    EndTime = "EndTime"
+}

package/core/cardintegration/cardfielddisplaysettings.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeLucidCardFieldDisplaySettings = exports.serializeLucidCardFieldDisplaySettings = exports.isOnClickHandlerKey = exports.OnClickHandlerKeys = exports.isFieldDisplayType = exports.FieldDisplayType = void 0;
+exports.LucidCardFields = exports.StatusValues = exports.deserializeLucidCardFieldDisplaySettings = exports.serializeLucidCardFieldDisplaySettings = exports.isOnClickHandlerKey = exports.OnClickHandlerKeys = exports.isFieldDisplayType = exports.FieldDisplayType = void 0;
 const validators_1 = require("../validators/validators");
 /**
  * When configuring a field on a LucidCardBlock to be displayed as a data graphic, one of these values specifies
@@ -95,3 +95,22 @@ function deserializeLucidCardFieldDisplaySettings(settings) {
     };
 }
 exports.deserializeLucidCardFieldDisplaySettings = deserializeLucidCardFieldDisplaySettings;
+/**
+ * These are the three possible values for the status of a basic card block.
+ */
+var StatusValues;
+(function (StatusValues) {
+    StatusValues["Todo"] = "To Do";
+    StatusValues["InProgress"] = "In Progress";
+    StatusValues["Done"] = "Done";
+})(StatusValues = exports.StatusValues || (exports.StatusValues = {}));
+var LucidCardFields;
+(function (LucidCardFields) {
+    LucidCardFields["Title"] = "Title";
+    LucidCardFields["Description"] = "Description";
+    LucidCardFields["Assignee"] = "Assignee";
+    LucidCardFields["Estimate"] = "Estimate";
+    LucidCardFields["Status"] = "Status";
+    LucidCardFields["StartTime"] = "StartTime";
+    LucidCardFields["EndTime"] = "EndTime";
+})(LucidCardFields = exports.LucidCardFields || (exports.LucidCardFields = {}));

package/document/blockclasses/cardblockproxy.d.ts

@@ -1,4 +1,47 @@
+import { StatusValues } from '../../core/cardintegration/cardfielddisplaysettings';
+import { SerializedIsoDateObject } from '../../core/data/serializedfield/serializedfields';
 import { BlockProxy } from '../blockproxy';
+/**
+ * A generic lucid card block.
+ * This shape has all of the base functionality as a BlockProxy, as well as additional card specific properties.
+ */
 export declare class CardBlockProxy extends BlockProxy {
     static classNameRegex: RegExp;
+    private getSettings;
+    getTitle(): string;
+    getDescription(): string;
+    getStatus(): StatusValues;
+    getAssignee(): string;
+    getStartTime(): SerializedIsoDateObject;
+    getEndTime(): SerializedIsoDateObject;
+    getEstimate(): number;
+    /**
+     * @param title The title that you want to set for this card.
+     */
+    setTitle(title: string): void;
+    /**
+     * @param description The description that you want to set for this card.
+     */
+    setDescription(description: string): void;
+    /**
+     * @param status The status that you want to set for this card.
+     * This can be one of three values: "To Do", "In Progress", or "Done".
+     */
+    setStatus(status: StatusValues): void;
+    /**
+     * @param assignee The assignee that you want to set for this card.
+     */
+    setAssignee(assignee: string): void;
+    /**
+     * @param startTime The start time that you want to set for this card.
+     */
+    setStartTime(startTime: SerializedIsoDateObject): void;
+    /**
+     * @param endTime The end time that you want to set for this card.
+     */
+    setEndTime(endTime: SerializedIsoDateObject): void;
+    /**
+     * @param estimate The estimate that you want to set for this card.
+     */
+    setEstimate(estimate: number): void;
 }

package/document/blockclasses/cardblockproxy.js

@@ -1,8 +1,94 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CardBlockProxy = void 0;
+const cardfielddisplaysettings_1 = require("../../core/cardintegration/cardfielddisplaysettings");
 const blockproxy_1 = require("../blockproxy");
+/**
+ * A generic lucid card block.
+ * This shape has all of the base functionality as a BlockProxy, as well as additional card specific properties.
+ */
 class CardBlockProxy extends blockproxy_1.BlockProxy {
+    getSettings() {
+        return this.referenceKeys.get(this.referenceKeys.keys()[0]).definition;
+    }
+    getTitle() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.Title];
+    }
+    getDescription() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.Description];
+    }
+    getStatus() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.Status];
+    }
+    getAssignee() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.Assignee];
+    }
+    getStartTime() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.StartTime];
+    }
+    getEndTime() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.EndTime];
+    }
+    getEstimate() {
+        return this.getSettings().data[cardfielddisplaysettings_1.LucidCardFields.Estimate];
+    }
+    /**
+     * @param title The title that you want to set for this card.
+     */
+    setTitle(title) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.Title] = title;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
+    /**
+     * @param description The description that you want to set for this card.
+     */
+    setDescription(description) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.Description] = description;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
+    /**
+     * @param status The status that you want to set for this card.
+     * This can be one of three values: "To Do", "In Progress", or "Done".
+     */
+    setStatus(status) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.Status] = status;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
+    /**
+     * @param assignee The assignee that you want to set for this card.
+     */
+    setAssignee(assignee) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.Assignee] = assignee;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
+    /**
+     * @param startTime The start time that you want to set for this card.
+     */
+    setStartTime(startTime) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.StartTime] = startTime;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
+    /**
+     * @param endTime The end time that you want to set for this card.
+     */
+    setEndTime(endTime) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.EndTime] = endTime;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
+    /**
+     * @param estimate The estimate that you want to set for this card.
+     */
+    setEstimate(estimate) {
+        const settings = this.getSettings();
+        settings.data[cardfielddisplaysettings_1.LucidCardFields.Estimate] = estimate;
+        this.setReferenceKey(this.referenceKeys.keys()[0], settings);
+    }
 }
 exports.CardBlockProxy = CardBlockProxy;
 CardBlockProxy.classNameRegex = /^LucidCardBlock$/;

package/document/documentproxy.d.ts

@@ -35,6 +35,22 @@ export declare class DocumentProxy extends ElementProxy {
      * @returns The title of this document
      */
     getTitle(): string;
+    /**
+     * Infrequently, you may need to watch for *any* changes to the document. These changes may be
+     * the local user adding content, or a data integration sending updated records to a data collection,
+     * or a remote user hitting undo, or any user entering or exiting an intra-document mutex.
+     *
+     * Because these changes may happen rapidly, the callback you provide here will only be called on
+     * a heavily-debounced schedule. The callback will happen between 1-10 seconds after changes are
+     * made to the document, depending on the frequency with which changes are happening.
+     * @param callback
+     * @returns A handle that can be passed into `unhookAllChanges`
+     */
+    hookAllChanges(callback: () => void): string;
+    /**
+     * @param handle Return value from `hookAllChanges`
+     */
+    unhookAllChanges(handle: string): void;
     /**
      * Watch for new blocks, lines, or groups added to this document. The callback will
      * be called with new items created by the current user, but will not be called with items

package/document/documentproxy.js

@@ -55,6 +55,32 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
     getTitle() {
         return this.properties.get('Title');
     }
+    /**
+     * Infrequently, you may need to watch for *any* changes to the document. These changes may be
+     * the local user adding content, or a data integration sending updated records to a data collection,
+     * or a remote user hitting undo, or any user entering or exiting an intra-document mutex.
+     *
+     * Because these changes may happen rapidly, the callback you provide here will only be called on
+     * a heavily-debounced schedule. The callback will happen between 1-10 seconds after changes are
+     * made to the document, depending on the frequency with which changes are happening.
+     * @param callback
+     * @returns A handle that can be passed into `unhookAllChanges`
+     */
+    hookAllChanges(callback) {
+        const actionName = DocumentProxy.getNextHookName();
+        this.client.registerAction(actionName, () => {
+            callback();
+        });
+        this.client.sendCommand("hac" /* CommandName.HookAllChanges */, { 'n': actionName });
+        return actionName;
+    }
+    /**
+     * @param handle Return value from `hookAllChanges`
+     */
+    unhookAllChanges(handle) {
+        this.client.deleteAction(handle);
+        this.client.sendCommand("uac" /* CommandName.UnhookAllChanges */, { 'n': handle });
+    }
     /**
      * Watch for new blocks, lines, or groups added to this document. The callback will
      * be called with new items created by the current user, but will not be called with items

package/package.json

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