lucid-extension-sdk 0.0.417 → 0.0.419

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -180,7 +180,7 @@ export type SerializedLucidCardFieldDisplaySettings = {
         'textBadgeSettings'?: TextBadgeSettings | undefined;
     } | undefined;
 };
-export declare const isSerializedLucidCardFieldSettings: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+export declare const isSerializedLucidCardFieldDisplaySettings: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
     StencilConfig: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
         getterKey: (x: unknown) => x is FieldDisplayType;
         fg: (x: unknown) => x is string | undefined;

package/core/cardintegration/cardfielddisplaysettings.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LucidCardFields = exports.StatusValues = exports.deserializeLucidCardFieldDisplaySettings = exports.serializeLucidCardFieldDisplaySettings = exports.copyLucidCardFieldDisplaySettings = exports.isSerializedLucidCardFieldSettings = exports.isOnClickHandlerKey = exports.OnClickHandlerKeys = exports.isFieldDisplayType = exports.FieldDisplayType = void 0;
+exports.LucidCardFields = exports.StatusValues = exports.deserializeLucidCardFieldDisplaySettings = exports.serializeLucidCardFieldDisplaySettings = exports.copyLucidCardFieldDisplaySettings = exports.isSerializedLucidCardFieldDisplaySettings = exports.isOnClickHandlerKey = exports.OnClickHandlerKeys = exports.isFieldDisplayType = exports.FieldDisplayType = void 0;
 const checks_1 = require("../checks");
 const badgeposition_1 = require("../properties/datagraphic/badgeposition");
 const validators_1 = require("../validators/validators");
@@ -107,7 +107,7 @@ const isStencilConfig = (0, validators_1.objectValidator)({
     'imageBadgeSettings': (0, validators_1.option)(isImageBadgeSettings),
     'textBadgeSettings': (0, validators_1.option)(isTextBadgeSettings),
 });
-exports.isSerializedLucidCardFieldSettings = (0, validators_1.objectValidator)({
+exports.isSerializedLucidCardFieldDisplaySettings = (0, validators_1.objectValidator)({
     'StencilConfig': (0, validators_1.option)(isStencilConfig),
 });
 function copyLucidCardFieldDisplaySettings(settings) {

package/core/cardintegration/cardintegrationconfig.js

@@ -8,7 +8,7 @@ const cardfielddisplaysettings_1 = require("./cardfielddisplaysettings");
 exports.isSerializedCardIntegrationConfig = (0, validators_1.objectValidator)({
     'cc': (0, validators_1.objectValidator)({
         'f': (0, checks_1.isTypedArray)(checks_1.isString),
-        'fd': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, cardfielddisplaysettings_1.isSerializedLucidCardFieldSettings))),
+        'fd': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, cardfielddisplaysettings_1.isSerializedLucidCardFieldDisplaySettings))),
         'fs': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, textstyle_1.isPartialTextStyle))),
         'id': (0, validators_1.option)(checks_1.isString),
     }),

package/dataconnector/actions/action.d.ts

@@ -3,6 +3,7 @@ import { DataSourceClient } from '../datasourceclient';
 import { ItemPatch, Patch } from './patch';
 export type CollectionId = string;
 export type ItemPrimaryKey = string;
+export type DocumentCollections = Record<CollectionId, ItemPrimaryKey[]>;
 /**
  * This holds all the contextual information about a give data action.
  */
@@ -20,9 +21,7 @@ export declare class DataConnectorActionContext {
     /** The installation id of the extension/user that triggered this action */
     installationId: string | undefined;
     /** Set of items this document is tracking as a `Record<CollectionId, ItemPrimaryKey[]>` */
-    documentCollections: {
-        [collectionId: CollectionId]: ItemPrimaryKey[];
-    };
+    documentCollections: DocumentCollections;
     /** Update filter type for this document */
     updateFilterType: DataUpdateFilterType;
     constructor(
@@ -39,9 +38,7 @@ export declare class DataConnectorActionContext {
     /** The installation id of the extension/user that triggered this action */
     installationId: string | undefined, 
     /** Set of items this document is tracking as a `Record<CollectionId, ItemPrimaryKey[]>` */
-    documentCollections: {
-        [collectionId: CollectionId]: ItemPrimaryKey[];
-    }, 
+    documentCollections: DocumentCollections, 
     /** Update filter type for this document */
     updateFilterType: DataUpdateFilterType);
 }
@@ -87,16 +84,12 @@ export declare class DataConnectorPatchAction<P extends Patch = ItemPatch> exten
  **/
 export declare class Webhook {
     /** Set of items this webhook is tracking as a `Record<CollectionId, ItemPrimaryKey[]>` */
-    documentCollections: {
-        [collectionId: CollectionId]: ItemPrimaryKey[];
-    };
+    documentCollections: DocumentCollections;
     /** Arbitrary extra data to allow the data connector to better identitify the webhook. */
     webhookData: unknown;
     constructor(
     /** Set of items this webhook is tracking as a `Record<CollectionId, ItemPrimaryKey[]>` */
-    documentCollections: {
-        [collectionId: CollectionId]: ItemPrimaryKey[];
-    }, 
+    documentCollections: DocumentCollections, 
     /** Arbitrary extra data to allow the data connector to better identitify the webhook. */
     webhookData: unknown);
 }

package/dataconnector/dataconnector.d.ts

@@ -1,5 +1,5 @@
 import { UnsafeJsonSerializableOrUndefined } from '../core/jsonserializable';
-import { DataConnectorAction, DataConnectorAsynchronousAction, DataConnectorManageWebhookAction, DataConnectorPatchAction, Webhook } from './actions/action';
+import { DataConnectorAction, DataConnectorAsynchronousAction, DataConnectorManageWebhookAction, DataConnectorPatchAction, DocumentCollections, Webhook } from './actions/action';
 import { DataConnectorActionKeys } from './actions/dataconnectoractionkeys';
 import { ItemPatch, Patch, PatchParser } from './actions/patch';
 import { PatchChange } from './actions/patchresponsebody';
@@ -44,7 +44,12 @@ export declare class DataConnectorResponseError extends Error {
     response: string;
     constructor(message: string, response: string);
 }
-type ActionTypeForName<P extends Patch, Name extends string, Asynchronous = boolean> = Name extends `${DataConnectorActionKeys.Patch}` ? ActionRequest<DataConnectorPatchAction<P>, PatchChange[]> : Name extends `${DataConnectorActionKeys.UnbatchedPatch}` ? ActionRequest<DataConnectorPatchAction<P>, PatchChange[]> : Name extends `${DataConnectorActionKeys.ManageWebhook}` ? ActionRequest<DataConnectorManageWebhookAction, Webhook> : ActionRequest<Asynchronous extends true ? DataConnectorAsynchronousAction : DataConnectorAction>;
+/** Used to track user collection access when EditorExtensionScope is PERSISTENT_SYNC. */
+export interface DocumentCollectionsBody {
+    /** A mapping from collection IDs to item IDs indicating what was affected (e.g. imported, refreshed, updated) by the action. */
+    documentCollections?: DocumentCollections;
+}
+type ActionTypeForName<P extends Patch, Name extends string, Asynchronous = boolean> = Name extends `${DataConnectorActionKeys.Patch}` ? ActionRequest<DataConnectorPatchAction<P>, PatchChange[]> : Name extends `${DataConnectorActionKeys.UnbatchedPatch}` ? ActionRequest<DataConnectorPatchAction<P>, PatchChange[]> : Name extends `${DataConnectorActionKeys.ManageWebhook}` ? ActionRequest<DataConnectorManageWebhookAction, Webhook> : ActionRequest<Asynchronous extends true ? DataConnectorAsynchronousAction : DataConnectorAction, unknown | DocumentCollectionsBody>;
 /** Factory class to define a bunch of action handlers. */
 export declare class DataConnector<P extends Patch = ItemPatch> {
     private client;

package/package.json

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