lucid-extension-sdk 0.0.103 → 0.0.105

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/interop.d.ts CHANGED
@@ -7,6 +7,29 @@ declare namespace lucid {
7
7
  }
8
8
 
9
9
  /** @ignore */
10
- declare namespace console {
11
- export function log(...args: any[]): void;
10
+ declare const console: Console;
11
+
12
+ // from lib.dom.d.ts
13
+ /** @ignore */
14
+ interface Console {
15
+ assert(condition?: boolean, ...data: any[]): void;
16
+ clear(): void;
17
+ count(label?: string): void;
18
+ countReset(label?: string): void;
19
+ debug(...data: any[]): void;
20
+ dir(item?: any, options?: any): void;
21
+ dirxml(...data: any[]): void;
22
+ error(...data: any[]): void;
23
+ group(...data: any[]): void;
24
+ groupCollapsed(...data: any[]): void;
25
+ groupEnd(): void;
26
+ info(...data: any[]): void;
27
+ log(...data: any[]): void;
28
+ table(tabularData?: any, properties?: string[]): void;
29
+ time(label?: string): void;
30
+ timeEnd(label?: string): void;
31
+ timeLog(label?: string, ...data: any[]): void;
32
+ timeStamp(label?: string): void;
33
+ trace(...data: any[]): void;
34
+ warn(...data: any[]): void;
12
35
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lucid-extension-sdk",
3
- "version": "0.0.103",
3
+ "version": "0.0.105",
4
4
  "description": "Utility classes for writing Lucid Software editor extensions",
5
5
  "main": "sdk/index.js",
6
6
  "types": "sdk/index.d.ts",
@@ -9,10 +9,6 @@ export interface CardIntegrationConfig {
9
9
  * The data fields to be displayed on cards as data graphics
10
10
  */
11
11
  fieldDisplaySettings?: Map<string, LucidCardFieldDisplaySettings>;
12
- /**
13
- * The field name to use as the displayed ID of the card, if any
14
- */
15
- idFieldName?: string;
16
12
  };
17
13
  cardDetailsPanelConfig: {
18
14
  /**
@@ -13,7 +13,6 @@ function serializeCardIntegrationConfig(config) {
13
13
  (0, cardfielddisplaysettings_1.serializeLucidCardFieldDisplaySettings)(settings),
14
14
  ])
15
15
  : undefined,
16
- 'id': config.cardConfig.idFieldName,
17
16
  },
18
17
  'cdpc': {
19
18
  'f': config.cardDetailsPanelConfig.fields.map((field) => {
@@ -37,7 +36,6 @@ function deserializeCardIntegrationConfig(raw) {
37
36
  (0, cardfielddisplaysettings_1.deserializeLucidCardFieldDisplaySettings)(settings),
38
37
  ]))
39
38
  : undefined,
40
- idFieldName: raw['cc']['id'],
41
39
  },
42
40
  cardDetailsPanelConfig: {
43
41
  fields: raw['cdpc']['f'].map((field) => {
@@ -5,7 +5,7 @@ import { EditorClient } from '../../editorclient';
5
5
  import { SerializedFieldType } from '../data/serializedfield/serializedfields';
6
6
  import { CardIntegrationConfig } from './cardintegrationconfig';
7
7
  import { ExtensionCardFieldDefinition } from './cardintegrationdefinitions';
8
- export declare abstract class TaskManagementCardIntegration {
8
+ export declare abstract class LucidCardIntegration {
9
9
  private readonly client;
10
10
  constructor(client: EditorClient);
11
11
  /**
@@ -44,7 +44,7 @@ export declare abstract class TaskManagementCardIntegration {
44
44
  * If specified, and the user hasn't yet authorized the data connector for this extension,
45
45
  * this should show the user an intro dialog or take some other action.
46
46
  */
47
- abstract showIntro?: () => void;
47
+ showIntro?: () => void;
48
48
  /**
49
49
  * Provide the default configuration for a new import
50
50
  */
@@ -74,7 +74,7 @@ export declare abstract class TaskManagementCardIntegration {
74
74
  * The config provided here is only used on the first import from a given source; on subsequent imports,
75
75
  * the existing config will remain unchanged to preserve any customizations by the user.
76
76
  */
77
- abstract importModal?: {
77
+ importModal?: {
78
78
  getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
79
79
  search: (fields: Map<string, SerializedFieldType>) => Promise<{
80
80
  partialImportMetadata?: {
@@ -92,7 +92,7 @@ export declare abstract class TaskManagementCardIntegration {
92
92
  /**
93
93
  * If specified, allow the user to create new cards and convert other shapes to cards
94
94
  */
95
- abstract addCard?: {
95
+ addCard?: {
96
96
  /**
97
97
  * Given the values entered by the user so far into input fields, return the list of all input fields
98
98
  * to display in the create-card form.
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TaskManagementCardIntegration = void 0;
4
- class TaskManagementCardIntegration {
3
+ exports.LucidCardIntegration = void 0;
4
+ class LucidCardIntegration {
5
5
  constructor(client) {
6
6
  this.client = client;
7
7
  }
@@ -9,4 +9,4 @@ class TaskManagementCardIntegration {
9
9
  return this.client.sendCommand("ic" /* CommandName.ImportCards */, name);
10
10
  }
11
11
  }
12
- exports.TaskManagementCardIntegration = TaskManagementCardIntegration;
12
+ exports.LucidCardIntegration = LucidCardIntegration;
@@ -1,8 +1,8 @@
1
1
  import { EditorClient } from '../../editorclient';
2
2
  import { SerializedFieldType } from '../data/serializedfield/serializedfields';
3
3
  import { ExtensionCardFieldOption } from './cardintegrationdefinitions';
4
- import { TaskManagementCardIntegration } from './taskmanagementcardintegration';
5
- export declare class TaskManagementCardRegistry {
4
+ import { LucidCardIntegration } from './lucidcardintegration';
5
+ export declare class LucidCardIntegrationRegistry {
6
6
  private static nextHookId;
7
7
  private static nextHookName;
8
8
  static registerFieldOptionsCallback(client: EditorClient, callback: (inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
@@ -10,5 +10,5 @@ export declare class TaskManagementCardRegistry {
10
10
  /**
11
11
  * Register a card integration.
12
12
  */
13
- static addCardIntegration(client: EditorClient, cardIntegration: TaskManagementCardIntegration): void;
13
+ static addCardIntegration(client: EditorClient, cardIntegration: LucidCardIntegration): void;
14
14
  }
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TaskManagementCardRegistry = void 0;
3
+ exports.LucidCardIntegrationRegistry = void 0;
4
4
  const collectiondefinition_1 = require("../../data/collectiondefinition");
5
5
  const datasourceproxy_1 = require("../../data/datasourceproxy");
6
6
  const cardintegrationconfig_1 = require("./cardintegrationconfig");
7
7
  const cardintegrationdefinitions_1 = require("./cardintegrationdefinitions");
8
- class TaskManagementCardRegistry {
8
+ class LucidCardIntegrationRegistry {
9
9
  static nextHookName() {
10
- return '__taskmanagementcard__hook' + TaskManagementCardRegistry.nextHookId++;
10
+ return '__lucidcard__hook' + LucidCardIntegrationRegistry.nextHookId++;
11
11
  }
12
12
  static registerFieldOptionsCallback(client, callback) {
13
- const name = TaskManagementCardRegistry.nextHookName();
13
+ const name = LucidCardIntegrationRegistry.nextHookName();
14
14
  client.registerAction(name, async ({ 'i': inputSoFar }) => {
15
15
  const result = await callback(new Map(inputSoFar));
16
16
  return result.map((option) => (0, cardintegrationdefinitions_1.serializeCardFieldOption)(option));
@@ -18,7 +18,7 @@ class TaskManagementCardRegistry {
18
18
  return name;
19
19
  }
20
20
  static registerFieldSearchCallback(client, callback) {
21
- const name = TaskManagementCardRegistry.nextHookName();
21
+ const name = LucidCardIntegrationRegistry.nextHookName();
22
22
  client.registerAction(name, async ({ 'i': inputSoFar, 's': searchText }) => {
23
23
  const result = await callback(searchText, new Map(inputSoFar));
24
24
  return result.map((option) => (0, cardintegrationdefinitions_1.serializeCardFieldOption)(option));
@@ -29,7 +29,7 @@ class TaskManagementCardRegistry {
29
29
  * Register a card integration.
30
30
  */
31
31
  static addCardIntegration(client, cardIntegration) {
32
- const getFieldsActionName = TaskManagementCardRegistry.nextHookName();
32
+ const getFieldsActionName = LucidCardIntegrationRegistry.nextHookName();
33
33
  client.registerAction(getFieldsActionName, async (param) => {
34
34
  const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
35
35
  const fields = await cardIntegration.fieldConfiguration.getAllFields(dataSource);
@@ -38,20 +38,20 @@ class TaskManagementCardRegistry {
38
38
  let onSelectedFieldsChangeActionName = undefined;
39
39
  const onSelectedFieldsChange = cardIntegration.fieldConfiguration.onSelectedFieldsChange;
40
40
  if (onSelectedFieldsChange) {
41
- onSelectedFieldsChangeActionName = TaskManagementCardRegistry.nextHookName();
41
+ onSelectedFieldsChangeActionName = LucidCardIntegrationRegistry.nextHookName();
42
42
  client.registerAction(onSelectedFieldsChangeActionName, async (param) => {
43
43
  const dataSource = new datasourceproxy_1.DataSourceProxy(param['ds'], client);
44
44
  await onSelectedFieldsChange(dataSource, param['sf']);
45
45
  });
46
46
  }
47
- const getDefaultConfigActionName = TaskManagementCardRegistry.nextHookName();
47
+ const getDefaultConfigActionName = LucidCardIntegrationRegistry.nextHookName();
48
48
  client.registerAction(getDefaultConfigActionName, async (param) => {
49
49
  const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
50
50
  return (0, cardintegrationconfig_1.serializeCardIntegrationConfig)(await cardIntegration.getDefaultConfig(dataSource));
51
51
  });
52
52
  let showIntroActionName = undefined;
53
53
  if (cardIntegration.showIntro) {
54
- showIntroActionName = TaskManagementCardRegistry.nextHookName();
54
+ showIntroActionName = LucidCardIntegrationRegistry.nextHookName();
55
55
  client.registerAction(showIntroActionName, cardIntegration.showIntro);
56
56
  }
57
57
  const serialized = {
@@ -70,9 +70,9 @@ class TaskManagementCardRegistry {
70
70
  if (cardIntegration.importModal) {
71
71
  const importModal = cardIntegration.importModal;
72
72
  serialized['im'] = {
73
- 'gsf': TaskManagementCardRegistry.nextHookName(),
74
- 's': TaskManagementCardRegistry.nextHookName(),
75
- 'i': TaskManagementCardRegistry.nextHookName(),
73
+ 'gsf': LucidCardIntegrationRegistry.nextHookName(),
74
+ 's': LucidCardIntegrationRegistry.nextHookName(),
75
+ 'i': LucidCardIntegrationRegistry.nextHookName(),
76
76
  };
77
77
  client.registerAction(serialized['im']['gsf'], async ({ 's': searchSoFar }) => {
78
78
  const result = await importModal.getSearchFields(new Map(searchSoFar));
@@ -100,8 +100,8 @@ class TaskManagementCardRegistry {
100
100
  if (cardIntegration.addCard) {
101
101
  const addCard = cardIntegration.addCard;
102
102
  serialized['ac'] = {
103
- 'gif': TaskManagementCardRegistry.nextHookName(),
104
- 'cc': TaskManagementCardRegistry.nextHookName(),
103
+ 'gif': LucidCardIntegrationRegistry.nextHookName(),
104
+ 'cc': LucidCardIntegrationRegistry.nextHookName(),
105
105
  };
106
106
  client.registerAction(serialized['ac']['gif'], async ({ 'i': inputSoFar }) => {
107
107
  const result = await addCard.getInputFields(new Map(inputSoFar));
@@ -118,5 +118,5 @@ class TaskManagementCardRegistry {
118
118
  client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);
119
119
  }
120
120
  }
121
- exports.TaskManagementCardRegistry = TaskManagementCardRegistry;
122
- TaskManagementCardRegistry.nextHookId = 0;
121
+ exports.LucidCardIntegrationRegistry = LucidCardIntegrationRegistry;
122
+ LucidCardIntegrationRegistry.nextHookId = 0;
package/sdk/index.d.ts CHANGED
@@ -3,8 +3,8 @@ export * from './core/base64';
3
3
  export * from './core/cardintegration/cardfielddisplaysettings';
4
4
  export * from './core/cardintegration/cardintegrationconfig';
5
5
  export * from './core/cardintegration/cardintegrationdefinitions';
6
- export * from './core/cardintegration/taskmanagementcardintegration';
7
- export * from './core/cardintegration/taskmangementcardregistry';
6
+ export * from './core/cardintegration/lucidcardintegration';
7
+ export * from './core/cardintegration/lucidcardintegrationregistry';
8
8
  export * from './core/checks';
9
9
  export * from './core/data/fieldspecification';
10
10
  export * from './core/data/fieldtypedefinition/basefieldtypedefinition';
package/sdk/index.js CHANGED
@@ -19,8 +19,8 @@ __exportStar(require("./core/base64"), exports);
19
19
  __exportStar(require("./core/cardintegration/cardfielddisplaysettings"), exports);
20
20
  __exportStar(require("./core/cardintegration/cardintegrationconfig"), exports);
21
21
  __exportStar(require("./core/cardintegration/cardintegrationdefinitions"), exports);
22
- __exportStar(require("./core/cardintegration/taskmanagementcardintegration"), exports);
23
- __exportStar(require("./core/cardintegration/taskmangementcardregistry"), exports);
22
+ __exportStar(require("./core/cardintegration/lucidcardintegration"), exports);
23
+ __exportStar(require("./core/cardintegration/lucidcardintegrationregistry"), exports);
24
24
  __exportStar(require("./core/checks"), exports);
25
25
  __exportStar(require("./core/data/fieldspecification"), exports);
26
26
  __exportStar(require("./core/data/fieldtypedefinition/basefieldtypedefinition"), exports);