lucid-extension-sdk 0.0.158 → 0.0.160

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/dataconnector/datasourceclient.js

@@ -21,14 +21,7 @@ class DataSourceClient {
         const dataSyncUrl = urls.dataSync;
         this.metadataUrl = (0, checks_1.isString)(dataSyncUrl) ? `${dataSyncUrl}dataSource/metadata` : undefined;
     }
-    formatBody({ updateFilterType, dataSourceName, collections }) {
-        const upstreamConfig = updateFilterType
-            ? {
-                'upstreamConfig': {
-                    'UpdateType': updateFilterType,
-                },
-            }
-            : {};
+    formatBody({ dataSourceName, collections }) {
         const updateData = {};
         for (const collectionId in collections) {
             updateData[collectionId] = (0, datasourceupdatetypes_1.serializeCollectionPatch)(collections[collectionId]);

package/dataconnector/signaturevalidator.d.ts

@@ -24,7 +24,5 @@ export declare class SignatureValidator {
 }
 /** Mock signature validator, always returns true. */
 export declare class MockSignatureValidator {
-    private publicKey;
-    /** Returns true */
     validate(): boolean;
 }

package/dataconnector/signaturevalidator.js

@@ -33,10 +33,6 @@ class SignatureValidator {
 exports.SignatureValidator = SignatureValidator;
 /** Mock signature validator, always returns true. */
 class MockSignatureValidator {
-    constructor() {
-        this.publicKey = false;
-    }
-    /** Returns true */
     validate() {
         return true;
     }

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/package.json

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