lucid-extension-sdk 0.0.309 → 0.0.311

package/core/checks.d.ts

@@ -119,8 +119,8 @@ export declare function isArray(val: unknown): val is unknown[];
 export declare function isTypedArray<T>(typeGuard: (a: unknown) => a is T): (val: unknown) => val is T[];
 export type Tuple<T, N extends number> = N extends N ? (number extends N ? T[] : TupleOfHelper<T, N, []>) : never;
 type TupleOfHelper<T, N extends number, R extends unknown[]> = R['length'] extends N ? R : TupleOfHelper<T, N, [T, ...R]>;
-export declare function isExactLength<T, N extends number>(arr: T[], exactLength: N): arr is Tuple<T, N>;
-export declare function isAtLeastLength<T, N extends number>(arr: T[], minimumLength: N): arr is [...Tuple<T, N>, ...T[]];
+export declare function isExactLength<T, N extends number>(arr: readonly T[], exactLength: N): arr is Tuple<T, N>;
+export declare function isAtLeastLength<T, N extends number>(arr: readonly T[], minimumLength: N): arr is [...Tuple<T, N>, ...T[]];
 /**
  * Returns true if the specified value is a tuple where the first element, T, passes the tGuard function
  * and the second element, U, passes the uGuard function

package/dataconnector/actions/action.d.ts

@@ -23,6 +23,8 @@ export declare class DataConnectorActionContext {
     };
     /** Update filter type for this document */
     updateFilterType: DataUpdateFilterType;
+    /** User timezone to ensure we properly account for any offsets */
+    timezone: string | null | undefined;
     constructor(
     /** The package ID of the extension that triggered this action */
     packageId: string, 
@@ -39,7 +41,9 @@ export declare class DataConnectorActionContext {
         [collectionId: CollectionId]: ItemPrimaryKey[];
     }, 
     /** Update filter type for this document */
-    updateFilterType: DataUpdateFilterType);
+    updateFilterType: DataUpdateFilterType, 
+    /** User timezone to ensure we properly account for any offsets */
+    timezone: string | null | undefined);
 }
 /** Base class for actions to be performed by data connectors */
 export declare class DataConnectorAction {

package/dataconnector/actions/action.js

@@ -20,7 +20,9 @@ class DataConnectorActionContext {
     /** Set of items this document is tracking as a `Record<CollectionId, ItemPrimaryKey[]>` */
     documentCollections, 
     /** Update filter type for this document */
-    updateFilterType) {
+    updateFilterType, 
+    /** User timezone to ensure we properly account for any offsets */
+    timezone) {
         this.packageId = packageId;
         this.packageVersion = packageVersion;
         this.userCredential = userCredential;
@@ -28,6 +30,7 @@ class DataConnectorActionContext {
         this.installationId = installationId;
         this.documentCollections = documentCollections;
         this.updateFilterType = updateFilterType;
+        this.timezone = timezone;
     }
 }
 exports.DataConnectorActionContext = DataConnectorActionContext;

package/dataconnector/actions/serializedactions.js

@@ -20,6 +20,7 @@ const serializedActionsBaseValidator = (0, validators_1.objectValidator)({
     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),
+    timezone: (0, validators_1.nullableOption)(checks_1.isString),
 });
 const serializedPatchDataValidator = (0, validators_1.objectValidator)({
     packageVersion: checks_1.isString,
@@ -29,6 +30,7 @@ const serializedPatchDataValidator = (0, validators_1.objectValidator)({
     })),
     userCredential: checks_1.isString,
     documentUpdateToken: checks_1.isString,
+    timezone: (0, validators_1.nullableOption)(checks_1.isString),
 });
 const parseSerializedPatches = (patches, patchParser) => {
     return patches
@@ -60,7 +62,7 @@ function deserializeActions(client, actions, patchParser) {
         }
         const parsedData = data
             .map((item) => {
-            const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], item['packageVersion'], item['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType']);
+            const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], item['packageVersion'], item['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
             const patches = parseSerializedPatches(item['patches'], patchParser);
             if (patches.length < item['patches'].length) {
                 return undefined;
@@ -74,6 +76,7 @@ function deserializeActions(client, actions, patchParser) {
         }
         return parsedData;
     }
+    //TODO: Add a check for timezone when its made non-optional
     if (!parsedActions['packageVersion'] || !parsedActions['userCredential']) {
         return;
     }
@@ -81,7 +84,7 @@ function deserializeActions(client, actions, patchParser) {
         if (!serializedPatchDataValidator(data)) {
             return;
         }
-        const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType']);
+        const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
         const parsedPatches = parseSerializedPatches(data['patches'], patchParser);
         if (parsedPatches.length < data['patches'].length) {
             console.log(`Failing validation step`);
@@ -91,7 +94,7 @@ function deserializeActions(client, actions, patchParser) {
             new action_1.DataConnectorPatchAction(context, parsedPatches, client.getDataSourceClient(data['documentUpdateToken']), dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch),
         ];
     }
-    const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType']);
+    const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
     if (name == 'ManageWebhook') {
         if (!serializedManageWebhookDataValidator(data)) {
             return;

package/package.json

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