lucid-extension-sdk 0.0.210 → 0.0.213

package/dataconnector/actions/patchresponsebody.d.ts

@@ -1,7 +1,7 @@
+import { ItemsPatch } from '../datasourceupdatetypes';
 export type PatchChangeCollection = {
     collectionId: string;
-    items?: Record<string, object>;
-    itemsDeleted?: string[];
+    itemsPatch: ItemsPatch;
 };
 /**
  * Reports a completed change back to Lucid
@@ -29,6 +29,8 @@ export type SerializedPatchChange = {
         'itemsPatch': {
             'items': Record<string, object>;
             'itemsDeleted': string[];
+        } | {
+            'exhaustiveItems': Record<string, object>;
         };
     }[];
 };

package/dataconnector/actions/patchresponsebody.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializePatchChanges = exports.serializePatchResponse = exports.PatchErrorTooltipField = exports.PatchChange = void 0;
 const object_1 = require("../../core/object");
+const datasourceupdatetypes_1 = require("../datasourceupdatetypes");
 /**
  * Reports a completed change back to Lucid
  */
@@ -33,13 +34,9 @@ function serializePatchResponse(patchChange) {
     return {
         'syncId': patchChange.syncId,
         'collections': patchChange.collections.map((c) => {
-            var _a, _b;
             return {
                 'collectionId': c.collectionId,
-                'itemsPatch': {
-                    'items': (_a = c.items) !== null && _a !== void 0 ? _a : {},
-                    'itemsDeleted': (_b = c.itemsDeleted) !== null && _b !== void 0 ? _b : [],
-                },
+                'itemsPatch': (0, datasourceupdatetypes_1.serializeItemsPatch)(c.itemsPatch),
             };
         }),
     };

package/dataconnector/datasourceclient.js

@@ -4,6 +4,7 @@ exports.MockDataSourceClient = exports.DataSourceClient = void 0;
 const checks_1 = require("../core/checks");
 const datasourcetype_1 = require("../core/data/datasource/datasourcetype");
 const upstreamconfig_1 = require("../core/data/datasource/upstreamconfig");
+const upstreampatchtype_1 = require("../core/data/datasource/upstreampatchtype");
 const upstreamupdatetype_1 = require("../core/data/datasource/upstreamupdatetype");
 const result_1 = require("../core/result");
 const validators_1 = require("../core/validators/validators");
@@ -25,6 +26,7 @@ class DataSourceClient {
         this.metadataUrl = (0, checks_1.isString)(dataSyncUrl) ? `${dataSyncUrl}dataSource/metadata` : undefined;
     }
     formatBody({ dataSourceName, collections, dataSourceConfiguration }) {
+        var _a;
         const updateData = {};
         for (const collectionId in collections) {
             updateData[collectionId] = (0, datasourceupdatetypes_1.serializeCollectionPatch)(collections[collectionId]);
@@ -32,7 +34,7 @@ class DataSourceClient {
         const upstreamConfig = {
             dataSourceType: datasourcetype_1.DataSourceType.DataService,
             updateType: upstreamupdatetype_1.UpstreamUpdateType.EVENTPULL,
-            patchType: dataSourceConfiguration === null || dataSourceConfiguration === void 0 ? void 0 : dataSourceConfiguration.patchType,
+            patchType: (_a = dataSourceConfiguration === null || dataSourceConfiguration === void 0 ? void 0 : dataSourceConfiguration.patchType) !== null && _a !== void 0 ? _a : upstreampatchtype_1.UpstreamPatchType.AUTO,
             sourceConfig: {},
         };
         return {

package/dataconnector/datasourceupdatetypes.d.ts

@@ -41,11 +41,45 @@ type SerializedSchemaForApi = {
 };
 export interface SerializedCollectionPatch {
     'schema'?: SerializedSchemaForApi;
-    'itemsPatch': {
-        'items': Record<string, SerializedFields>;
-        'itemsDeleted': string[];
-    };
+    'itemsPatch': SerializedItemsPatch;
+}
+export declare class ItemsPatchInexhaustive {
+    /**
+     * Items to be added or changed in the collection. Mapping from item serialized primary key to
+     * the sparse patch of the item. See FormattedPrimaryKey.forItem.
+     **/
+    items: Map<string, SerializedFields>;
+    /** Items to remove from the collection, based on the same primary key algorithm. */
+    itemsDeleted?: string[] | undefined;
+    constructor(
+    /**
+     * Items to be added or changed in the collection. Mapping from item serialized primary key to
+     * the sparse patch of the item. See FormattedPrimaryKey.forItem.
+     **/
+    items: Map<string, SerializedFields>, 
+    /** Items to remove from the collection, based on the same primary key algorithm. */
+    itemsDeleted?: string[] | undefined);
 }
+export declare class ItemsPatchExhaustive {
+    items: Map<string, SerializedFields>;
+    constructor(items: Map<string, SerializedFields>);
+}
+export type ItemsPatch = {
+    /**
+     * Items to be added or changed in the collection. Mapping from item serialized primary key to
+     * the sparse patch of the item. See FormattedPrimaryKey.forItem.
+     **/
+    items: Map<string, SerializedFields>;
+    /** Items to remove from the collection, based on the same primary key algorithm. */
+    itemsDeleted?: string[];
+} | ItemsPatchInexhaustive | ItemsPatchExhaustive;
+export type SerializedItemsPatch = {
+    'items': Record<string, SerializedFields>;
+    'itemsDeleted': string[];
+} | {
+    'exhaustiveItems': Record<string, SerializedFields>;
+};
+export declare function serializeItemsPatch(patch: ItemsPatch): SerializedItemsPatch;
 /**
  * A patch to a collection or the definition of a new collection to be added. If adding a new collection, a schema must
  * be provided. If modifying an existing collection, a schema may be omitted.
@@ -63,15 +97,7 @@ export interface CollectionPatch {
      */
     schema?: SchemaDefinition;
     /** The patch to apply to the collection */
-    patch: {
-        /**
-         * Items to be added or changed in the collection. Mapping from item serialized primary key to
-         * the sparse patch of the item. See FormattedPrimaryKey.forItem.
-         **/
-        items: Map<string, SerializedFields>;
-        /** Items to remove from the collection, based on the same primary key algorithm. */
-        itemsDeleted?: string[];
-    };
+    patch: ItemsPatch;
 }
 /** @ignore */
 export declare function serializeFieldDefinitionForApi(field: FieldDefinition): SerializedFieldDefinitionForApi;

package/dataconnector/datasourceupdatetypes.js

@@ -1,8 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeCollectionPatch = exports.serializeFieldDefinitionForApi = void 0;
+exports.serializeCollectionPatch = exports.serializeFieldDefinitionForApi = exports.serializeItemsPatch = exports.ItemsPatchExhaustive = exports.ItemsPatchInexhaustive = void 0;
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
 const object_1 = require("../core/object");
+class ItemsPatchInexhaustive {
+    constructor(
+    /**
+     * Items to be added or changed in the collection. Mapping from item serialized primary key to
+     * the sparse patch of the item. See FormattedPrimaryKey.forItem.
+     **/
+    items, 
+    /** Items to remove from the collection, based on the same primary key algorithm. */
+    itemsDeleted) {
+        this.items = items;
+        this.itemsDeleted = itemsDeleted;
+    }
+}
+exports.ItemsPatchInexhaustive = ItemsPatchInexhaustive;
+class ItemsPatchExhaustive {
+    constructor(items) {
+        this.items = items;
+    }
+}
+exports.ItemsPatchExhaustive = ItemsPatchExhaustive;
+function serializeItemsPatch(patch) {
+    var _a;
+    if (patch instanceof ItemsPatchExhaustive) {
+        return { 'exhaustiveItems': (0, object_1.fromEntries)(patch.items.entries()) };
+    }
+    else {
+        return {
+            'items': (0, object_1.fromEntries)(patch.items.entries()),
+            'itemsDeleted': (_a = patch.itemsDeleted) !== null && _a !== void 0 ? _a : [],
+        };
+    }
+}
+exports.serializeItemsPatch = serializeItemsPatch;
 function serializeFieldConstraintForApi(constraint) {
     return {
         'type': constraint.type,
@@ -28,13 +61,9 @@ function serializeSchemaForApi(schema) {
     };
 }
 function serializeCollectionPatch(patch) {
-    var _a;
     return {
         'schema': patch.schema && serializeSchemaForApi(patch.schema),
-        'itemsPatch': {
-            'items': (0, object_1.fromEntries)(patch.patch.items.entries()),
-            'itemsDeleted': (_a = patch.patch.itemsDeleted) !== null && _a !== void 0 ? _a : [],
-        },
+        'itemsPatch': serializeItemsPatch(patch.patch),
     };
 }
 exports.serializeCollectionPatch = serializeCollectionPatch;

package/package.json

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