lucid-extension-sdk 0.0.96 → 0.0.98

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.96",
+    "version": "0.0.98",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "sdk/index.js",
     "types": "sdk/index.d.ts",
@@ -13,5 +13,9 @@
         "typedoc": "^0.23.15",
         "typedoc-plugin-markdown": "^3.13.6",
         "typescript": "4.7.4"
+    },
+    "exports": {
+        ".": "./sdk/index.js",
+        "./*": "./sdk/*.js"
     }
 }

package/sdk/core/cardintegration/taskmanagementcardintegration.d.ts

@@ -33,7 +33,7 @@ export declare abstract class TaskManagementCardIntegration {
         /**
          * Callback to provide a list of all supported field names for the card integration.
          */
-        getAllFields: (collection: CollectionProxy, dataSource: DataSourceProxy) => Promise<string[]>;
+        getAllFields: (dataSource: DataSourceProxy) => Promise<string[]>;
         /**
          * Callback that handled changes in the fields the user wants to be displayed in the card integration.
          * If this callback is not provided then the user will not be shown the modal to configure fields.
@@ -48,7 +48,7 @@ export declare abstract class TaskManagementCardIntegration {
     /**
      * Provide the default configuration for a new import
      */
-    abstract getDefaultConfig: (collection: CollectionProxy, dataSource: DataSourceProxy) => Promise<CardIntegrationConfig>;
+    abstract getDefaultConfig: (dataSource: DataSourceProxy) => Promise<CardIntegrationConfig>;
     /**
      * If specified, allow the user to import cards using the standard card-import modal.
      *

package/sdk/core/cardintegration/taskmanagementcardintegrationdefinitions.d.ts

@@ -1,12 +1,10 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 /** @ignore */
 export interface GetFieldsParam {
-    'c': string;
     'd': string;
 }
 /** @ignore */
 export interface GetDefaultConfigParam {
-    'c': string;
     'd': string;
 }
 /** @ignore */

package/sdk/core/cardintegration/taskmangementcardregistry.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaskManagementCardRegistry = void 0;
 const collectiondefinition_1 = require("../../data/collectiondefinition");
-const collectionproxy_1 = require("../../data/collectionproxy");
 const datasourceproxy_1 = require("../../data/datasourceproxy");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
 const cardintegrationdefinitions_1 = require("./cardintegrationdefinitions");
@@ -32,9 +31,8 @@ class TaskManagementCardRegistry {
     static addCardIntegration(client, cardIntegration) {
         const getFieldsActionName = TaskManagementCardRegistry.nextHookName();
         client.registerAction(getFieldsActionName, async (param) => {
-            const collection = new collectionproxy_1.CollectionProxy(param['c'], client);
             const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
-            const fields = await cardIntegration.fieldConfiguration.getAllFields(collection, dataSource);
+            const fields = await cardIntegration.fieldConfiguration.getAllFields(dataSource);
             return fields;
         });
         let onSelectedFieldsChangeActionName = undefined;
@@ -48,9 +46,8 @@ class TaskManagementCardRegistry {
         }
         const getDefaultConfigActionName = TaskManagementCardRegistry.nextHookName();
         client.registerAction(getDefaultConfigActionName, async (param) => {
-            const collection = new collectionproxy_1.CollectionProxy(param['c'], client);
             const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
-            return (0, cardintegrationconfig_1.serializeCardIntegrationConfig)(await cardIntegration.getDefaultConfig(collection, dataSource));
+            return (0, cardintegrationconfig_1.serializeCardIntegrationConfig)(await cardIntegration.getDefaultConfig(dataSource));
         });
         let showIntroActionName = undefined;
         if (cardIntegration.showIntro) {

package/sdk/data/collectionproxy.d.ts

@@ -20,6 +20,7 @@ export declare class CollectionProxy extends PropertyStoreProxy {
      * @returns a human-readable name for this collection
      */
     getName(): string;
+    getSyncCollectionId(): string | undefined;
     /**
      * Some data collections may have local branches on the document, to store the set of changes that have been
      * made by the user since the time the data was last refreshed from its source. For those collections, you

package/sdk/data/collectionproxy.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CollectionProxy = void 0;
+const checks_1 = require("../core/checks");
 const mapproxy_1 = require("../document/mapproxy");
 const propertystoreproxy_1 = require("../document/propertystoreproxy");
 const dataitemproxy_1 = require("./dataitemproxy");
@@ -31,6 +32,13 @@ class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
     getName() {
         return this.properties.get('Name');
     }
+    getSyncCollectionId() {
+        const upstreamConfig = this.properties.get('UpstreamConfig');
+        if ((0, checks_1.isObject)(upstreamConfig) && (0, checks_1.isString)(upstreamConfig['SyncId'])) {
+            return upstreamConfig['SyncId'];
+        }
+        return undefined;
+    }
     /**
      * Some data collections may have local branches on the document, to store the set of changes that have been
      * made by the user since the time the data was last refreshed from its source. For those collections, you