lucid-extension-sdk 0.0.220 → 0.0.223

package/core/data/datasource/datasourceutils.d.ts

@@ -1,3 +1,4 @@
+import { DataUpdateFilterType } from '../../../data/dataupdatefiltertype';
 import { SerializedFields } from '../serializedfield/serializedfields';
 import { DataSourceType } from './datasourcetype';
 import { SerializedImportedCollection } from './serializedimporteddatasource';
@@ -28,6 +29,7 @@ export declare function makeSerializedImportedDataSource(id: string, name: strin
             UpdateType: UpstreamUpdateType;
             SourceConfig: {
                 spreadsheetId: string;
+                UpdateFilterType: DataUpdateFilterType;
             };
         };
     };

package/core/data/datasource/datasourceutils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeSerializedImportedDataSource = exports.makeSerializedImportedCollection = exports.MetadataPK = exports.makeNameReadablyUnique = exports.normalizeName = exports.alphabetize = void 0;
+const dataupdatefiltertype_1 = require("../../../data/dataupdatefiltertype");
 const checks_1 = require("../../checks");
 const scalarfieldtype_1 = require("../fieldtypedefinition/scalarfieldtype");
 const alphabet_1 = require("./alphabet");
@@ -223,7 +224,10 @@ function makeSerializedImportedDataSource(id, name, collections) {
             'UpstreamConfig': {
                 'SourceType': datasourcetype_1.DataSourceType.DataService,
                 'UpdateType': upstreamupdatetype_1.UpstreamUpdateType.EVENTPULL,
-                'SourceConfig': { 'spreadsheetId': id },
+                'SourceConfig': {
+                    'spreadsheetId': id,
+                    'UpdateFilterType': dataupdatefiltertype_1.DataUpdateFilterType.CurrentCollectionUpdates,
+                },
             },
         },
         'Collections': collections,

package/core/data/serializedfield/serializedfields.d.ts

@@ -87,6 +87,10 @@ export declare const isSerializedLucidCurrency: (subject: unknown) => subject is
     a: typeof isNumber;
     t: typeof isString;
 }>;
+export declare const isSerializedMillisecondsDateObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    ms: typeof isNumber;
+    isDateOnly: (x: unknown) => x is boolean | undefined;
+}>;
 export declare const isSerializedLucidDateObject: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
     ms: typeof isNumber;
     isDateOnly: (x: unknown) => x is boolean | undefined;

package/core/data/serializedfield/serializedfields.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidDateObject = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
+exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
 const checks_1 = require("../../checks");
 const validators_1 = require("../../validators/validators");
 function isSerializedColorObjectFieldType(value) {
@@ -20,7 +20,7 @@ exports.isSerializedLucidCurrency = (0, validators_1.objectValidator)({
     'a': checks_1.isNumber,
     't': checks_1.isString,
 });
-const isSerializedMillisecondsDateObject = (0, validators_1.objectValidator)({
+exports.isSerializedMillisecondsDateObject = (0, validators_1.objectValidator)({
     'ms': checks_1.isNumber,
     'isDateOnly': (0, validators_1.option)(checks_1.isBoolean),
 });
@@ -28,7 +28,7 @@ const isSerializedIsoDateObject = (0, validators_1.objectValidator)({
     'isoDate': checks_1.isString,
     'displayTimezone': (0, validators_1.option)(checks_1.isString),
 });
-exports.isSerializedLucidDateObject = (0, validators_1.either)(isSerializedMillisecondsDateObject, isSerializedIsoDateObject);
+exports.isSerializedLucidDateObject = (0, validators_1.either)(exports.isSerializedMillisecondsDateObject, isSerializedIsoDateObject);
 function isSerializedFieldType(value) {
     return (value == null ||
         (0, checks_1.isNumber)(value) ||

package/data/dataupdatefiltertype.d.ts

@@ -1,8 +1,8 @@
 /** Allows Lucid documents to determine what updates they will receive when changes happen in the data source */
 export declare enum DataUpdateFilterType {
-    /** All updates relevant to the data source will be sent to the document, new items created in the data source will be added to the document */
+    /** All updates relevant to the data source will be sent to the document, new items created in the data source will be added to the document. Note that the in the `documentCollections` mapping in the `DataConnectorActionContext` will not have a list of all items in it with the DataUpdateFilterType selected */
     'AllUpdates' = "AllUpdates",
-    /** All updates relevant to collections already present on the document will be sent to that document, new items added to those collections in the data source will be added to the document */
+    /** All updates relevant to collections already present on the document will be sent to that document, new items added to those collections in the data source will be added to the document. Note that the `documentCollections` mapping in the `DataConnectorActionContext` will not have a list of all items in it with the DataUpdateFilterType selected */
     'CurrentCollectionUpdates' = "CurrentCollectionUpdates",
     /** All updates to items already present on the document will be sent to the document. New items created in the data source will not be created on the document. */
     'CurrentItemUpdates' = "CurrentItemUpdates"

package/data/dataupdatefiltertype.js

@@ -4,9 +4,9 @@ exports.DataUpdateFilterType = void 0;
 /** Allows Lucid documents to determine what updates they will receive when changes happen in the data source */
 var DataUpdateFilterType;
 (function (DataUpdateFilterType) {
-    /** All updates relevant to the data source will be sent to the document, new items created in the data source will be added to the document */
+    /** All updates relevant to the data source will be sent to the document, new items created in the data source will be added to the document. Note that the in the `documentCollections` mapping in the `DataConnectorActionContext` will not have a list of all items in it with the DataUpdateFilterType selected */
     DataUpdateFilterType["AllUpdates"] = "AllUpdates";
-    /** All updates relevant to collections already present on the document will be sent to that document, new items added to those collections in the data source will be added to the document */
+    /** All updates relevant to collections already present on the document will be sent to that document, new items added to those collections in the data source will be added to the document. Note that the `documentCollections` mapping in the `DataConnectorActionContext` will not have a list of all items in it with the DataUpdateFilterType selected */
     DataUpdateFilterType["CurrentCollectionUpdates"] = "CurrentCollectionUpdates";
     /** All updates to items already present on the document will be sent to the document. New items created in the data source will not be created on the document. */
     DataUpdateFilterType["CurrentItemUpdates"] = "CurrentItemUpdates";

package/dataconnector/actions/action.d.ts

@@ -78,6 +78,8 @@ export declare class Patch {
     itemsChanged: PatchItems;
     /** List of item primary keys deleted by Lucid */
     itemsDeleted: string[];
+    /** */
+    itemOrderChanged: [string, string | null][] | undefined;
     /** The syncSourceId of the changed data source */
     syncSourceId: string;
     /** The syncCollectionId of the changed collection */
@@ -91,6 +93,8 @@ export declare class Patch {
     itemsChanged: PatchItems, 
     /** List of item primary keys deleted by Lucid */
     itemsDeleted: string[], 
+    /** */
+    itemOrderChanged: [string, string | null][] | undefined, 
     /** The syncSourceId of the changed data source */
     syncSourceId: string, 
     /** The syncCollectionId of the changed collection */

package/dataconnector/actions/action.js

@@ -73,6 +73,8 @@ class Patch {
     itemsChanged, 
     /** List of item primary keys deleted by Lucid */
     itemsDeleted, 
+    /** */
+    itemOrderChanged, 
     /** The syncSourceId of the changed data source */
     syncSourceId, 
     /** The syncCollectionId of the changed collection */
@@ -81,6 +83,7 @@ class Patch {
         this.itemsAdded = itemsAdded;
         this.itemsChanged = itemsChanged;
         this.itemsDeleted = itemsDeleted;
+        this.itemOrderChanged = itemOrderChanged;
         this.syncSourceId = syncSourceId;
         this.syncCollectionId = syncCollectionId;
     }

package/dataconnector/actions/serializedactions.js

@@ -6,47 +6,52 @@ const checks_1 = require("../../core/checks");
 const validators_1 = require("../../core/validators/validators");
 const action_1 = require("./action");
 const dataconnectoractionkeys_1 = require("./dataconnectoractionkeys");
-exports.actionsHeaderValidator = (0, validators_1.objectValidator)({ 'x-lucid-rsa-nonce': checks_1.isString, 'x-lucid-signature': checks_1.isString });
+exports.actionsHeaderValidator = (0, validators_1.objectValidator)({
+    'x-lucid-rsa-nonce': checks_1.isString,
+    'x-lucid-signature': checks_1.isString,
+});
 const serializedActionsBaseValidator = (0, validators_1.objectValidator)({
-    'action': (0, validators_1.objectValidator)({ 'name': checks_1.isString, 'data': checks_1.isUnknown }),
-    'packageId': checks_1.isString,
-    'packageVersion': (0, validators_1.nullableOption)(checks_1.isString),
-    'dataConnectorName': checks_1.isString,
-    'installationId': (0, validators_1.nullableOption)(checks_1.isString),
-    'userCredential': (0, validators_1.nullableOption)(checks_1.isString),
-    'documentUpdateToken': (0, validators_1.nullableOption)(checks_1.isString),
-    'documentCollections': (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
-    'updateFilterType': (0, validators_1.enumValidator)(dataupdatefiltertype_1.DataUpdateFilterType),
+    action: (0, validators_1.objectValidator)({ name: checks_1.isString, data: checks_1.isUnknown }),
+    packageId: checks_1.isString,
+    packageVersion: (0, validators_1.nullableOption)(checks_1.isString),
+    dataConnectorName: checks_1.isString,
+    installationId: (0, validators_1.nullableOption)(checks_1.isString),
+    userCredential: (0, validators_1.nullableOption)(checks_1.isString),
+    documentUpdateToken: (0, validators_1.nullableOption)(checks_1.isString),
+    documentCollections: (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
+    updateFilterType: (0, validators_1.enumValidator)(dataupdatefiltertype_1.DataUpdateFilterType),
 });
 const serializedPatchDataValidator = (0, validators_1.objectValidator)({
-    'packageVersion': checks_1.isString,
-    'patches': (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
-        'patch': (0, validators_1.objectValidator)({
-            'itemsAdded': (0, validators_1.objectOfValidator)(checks_1.isObjectUnsafe),
-            'itemsChanged': (0, validators_1.objectOfValidator)(checks_1.isObjectUnsafe),
-            'itemsDeleted': (0, validators_1.arrayValidator)(checks_1.isString),
-            'syncSourceId': checks_1.isString,
-            'syncCollectionId': checks_1.isString,
-            'adapterType': (0, checks_1.isLiteral)('EXTENSION_API'),
-            'syncSchema': checks_1.isUnknown,
+    packageVersion: checks_1.isString,
+    patches: (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
+        patch: (0, validators_1.objectValidator)({
+            itemsAdded: (0, validators_1.objectOfValidator)(checks_1.isObjectUnsafe),
+            itemsChanged: (0, validators_1.objectOfValidator)(checks_1.isObjectUnsafe),
+            itemsDeleted: (0, validators_1.arrayValidator)(checks_1.isString),
+            itemOrderChanged: (0, validators_1.nullableOption)((0, validators_1.arrayValidator)((0, validators_1.tupleValidator)(checks_1.isString, (0, validators_1.nullable)(checks_1.isString)))),
+            syncSourceId: checks_1.isString,
+            syncCollectionId: checks_1.isString,
+            adapterType: (0, checks_1.isLiteral)('EXTENSION_API'),
+            syncSchema: checks_1.isUnknown,
         }),
-        'id': checks_1.isString,
+        id: checks_1.isString,
     })),
-    'userCredential': checks_1.isString,
-    'documentUpdateToken': checks_1.isString,
+    userCredential: checks_1.isString,
+    documentUpdateToken: checks_1.isString,
 });
 const parseSerializedPatches = (patches) => {
     return patches.map((patch) => {
+        var _a;
         const p = patch['patch'];
-        return new action_1.Patch(patch['id'], p['itemsAdded'], p['itemsChanged'], p['itemsDeleted'], p['syncSourceId'], p['syncCollectionId']);
+        return new action_1.Patch(patch['id'], p['itemsAdded'], p['itemsChanged'], p['itemsDeleted'], (_a = p['itemOrderChanged']) !== null && _a !== void 0 ? _a : undefined, p['syncSourceId'], p['syncCollectionId']);
     });
 };
 const serializedManageWebhookDataValidator = (0, validators_1.objectValidator)({
-    'webhooks': (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
-        'documentCollections': (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
-        'webhookData': (0, validators_1.option)(checks_1.isUnknown),
+    webhooks: (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
+        documentCollections: (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
+        webhookData: (0, validators_1.option)(checks_1.isUnknown),
     })),
-    'webhookToken': checks_1.isString,
+    webhookToken: checks_1.isString,
 });
 /** Function to convert the lucid action wire format into a clean list of actions */
 function deserializeActions(client, actions) {
@@ -57,6 +62,7 @@ function deserializeActions(client, actions) {
     const data = actions['action']['data'];
     if (name === dataconnectoractionkeys_1.DataConnectorActionKeys.Patch) {
         if (!(0, validators_1.arrayValidator)(serializedPatchDataValidator)(data)) {
+            console.log(`Failing validation step`);
             return;
         }
         return data.map((item) => {

package/dataconnector/datasourceclient.js

@@ -25,17 +25,18 @@ class DataSourceClient {
         const dataSyncUrl = urls.dataSync;
         this.metadataUrl = (0, checks_1.isString)(dataSyncUrl) ? `${dataSyncUrl}dataSource/metadata` : undefined;
     }
-    formatBody({ dataSourceName, collections, dataSourceConfiguration }) {
+    formatBody({ dataSourceName, collections, updateFilterType, dataSourceConfiguration }) {
         var _a;
         const updateData = {};
         for (const collectionId in collections) {
             updateData[collectionId] = (0, datasourceupdatetypes_1.serializeCollectionPatch)(collections[collectionId]);
         }
+        const updateFilterTypeObj = updateFilterType ? { 'UpdateFilterType': updateFilterType } : {};
         const upstreamConfig = {
             dataSourceType: datasourcetype_1.DataSourceType.DataService,
             updateType: upstreamupdatetype_1.UpstreamUpdateType.EVENTPULL,
             patchType: (_a = dataSourceConfiguration === null || dataSourceConfiguration === void 0 ? void 0 : dataSourceConfiguration.patchType) !== null && _a !== void 0 ? _a : upstreampatchtype_1.UpstreamPatchType.AUTO,
-            sourceConfig: {},
+            sourceConfig: Object.assign({}, updateFilterTypeObj),
         };
         return {
             'updateData': updateData,

package/package.json

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