lucid-extension-sdk 0.0.315 → 0.0.317

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/commandtypes.d.ts CHANGED
@@ -717,7 +717,7 @@ export type AddCardIntegrationQuery = {
717
717
  'il': string;
718
718
  /** Items label */
719
719
  'isl': string;
720
- /** Icon url */
720
+ /** Icon url. Replaced by iconConfiguration.primaryIconUrl */
721
721
  'u': string;
722
722
  /** Text style */
723
723
  'ts'?: Partial<TextStyle> | undefined;
@@ -764,6 +764,13 @@ export type AddCardIntegrationQuery = {
764
764
  } | undefined;
765
765
  /** Whether to enable dependency mapping for this integration */
766
766
  'sdm'?: boolean;
767
+ /** Icons to display throughout the card integration */
768
+ 'icu'?: {
769
+ /** Primary Icon Url */
770
+ 'pi'?: string;
771
+ /** Light Icon URl */
772
+ 'li'?: string;
773
+ } | undefined;
767
774
  /**
768
775
  * If specified, the text phrases to show in the dependency mapping UI.
769
776
  * If not specified, dependency mapping for this integration uses the default fallback phrases.
@@ -26,6 +26,7 @@ export declare abstract class LucidCardIntegration {
26
26
  */
27
27
  abstract itemsLabel: string;
28
28
  /**
29
+ * @deprecated Use iconConfiguration.primaryIconUrl.
29
30
  * URL for an icon to display in toolbars, etc. Should be at least 24x24.
30
31
  */
31
32
  abstract iconUrl: string;
@@ -63,6 +64,18 @@ export declare abstract class LucidCardIntegration {
63
64
  */
64
65
  fieldValueSearchCallbacks?: Map<string, string>;
65
66
  };
67
+ iconConfiguration?: {
68
+ /**
69
+ * URL for the primary icon to display in most components, usually on a white background.
70
+ * Should be at least 24x24.
71
+ */
72
+ primaryIconUrl: string;
73
+ /**
74
+ * Optional. URL for an alternate light icon to show in colored components where the primary icon may appear too dark.
75
+ * If not provided, the primaryIconUrl will be used. Should be at least 24x24.
76
+ */
77
+ lightIconUrl?: string;
78
+ };
66
79
  /**
67
80
  * @deprecated Use AuthorizationFlowHandlerRegistry.registerAuthorizationFlowHandler.
68
81
  * WARNING: Currently unused and does nothing.
@@ -20,6 +20,7 @@ export declare const isSerializedDataSourceProperties: (subject: unknown) => sub
20
20
  SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
21
21
  Id: typeof isString;
22
22
  SourceFields: (p1: unknown) => p1 is string[];
23
- RelationshipType: typeof isString;
23
+ OutwardLabel: typeof isString;
24
+ InwardLabel: typeof isString;
24
25
  }>[] | null | undefined;
25
26
  }>;
@@ -59,7 +59,8 @@ export declare const isSerializedImportedDataSource: (subject: unknown) => subje
59
59
  SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
60
60
  Id: typeof isString;
61
61
  SourceFields: (p1: unknown) => p1 is string[];
62
- RelationshipType: typeof isString;
62
+ OutwardLabel: typeof isString;
63
+ InwardLabel: typeof isString;
63
64
  }>[] | null | undefined;
64
65
  }>;
65
66
  Collections: (val: unknown) => val is import("../../guards").DestructureGuardedTypeObj<{
@@ -96,7 +97,8 @@ export declare const isSerializedPreviewData: (subject: unknown) => subject is i
96
97
  SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
97
98
  Id: typeof isString;
98
99
  SourceFields: (p1: unknown) => p1 is string[];
99
- RelationshipType: typeof isString;
100
+ OutwardLabel: typeof isString;
101
+ InwardLabel: typeof isString;
100
102
  }>[] | null | undefined;
101
103
  }>;
102
104
  Collections: (val: unknown) => val is import("../../guards").DestructureGuardedTypeObj<{
@@ -1,12 +1,10 @@
1
1
  import { isString } from '../../checks';
2
- import { SemanticRelationships } from './semanticrelationships';
3
2
  export type SerializedSourceForeignKey = {
4
3
  'Id': string;
5
4
  'SourceFields': string[];
6
- 'RelationshipType': SemanticRelationships | string;
7
5
  'Represents'?: string | null | undefined;
8
- 'OutwardLabel'?: string | undefined;
9
- 'InwardLabel'?: string | undefined;
6
+ 'OutwardLabel': string;
7
+ 'InwardLabel': string;
10
8
  /**
11
9
  * This exists to handle the rare situation when there are fields on the target item that reference the source item.
12
10
  * Please reach out to #dev-data-platform before setting this to a defined value.
@@ -16,5 +14,6 @@ export type SerializedSourceForeignKey = {
16
14
  export declare const isSerializedSourceForeignKey: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
17
15
  Id: typeof isString;
18
16
  SourceFields: (p1: unknown) => p1 is string[];
19
- RelationshipType: typeof isString;
17
+ OutwardLabel: typeof isString;
18
+ InwardLabel: typeof isString;
20
19
  }>;
@@ -6,5 +6,6 @@ const validators_1 = require("../../validators/validators");
6
6
  exports.isSerializedSourceForeignKey = (0, validators_1.objectValidator)({
7
7
  'Id': checks_1.isString,
8
8
  'SourceFields': (0, validators_1.arrayValidator)(checks_1.isString),
9
- 'RelationshipType': checks_1.isString,
9
+ 'OutwardLabel': checks_1.isString,
10
+ 'InwardLabel': checks_1.isString,
10
11
  });
@@ -1,12 +1,10 @@
1
- import { SemanticRelationships } from './semanticrelationships';
2
1
  import { SerializedSourceForeignKey } from './serializedsourceforeignkey';
3
2
  export type SourceForeignKey = {
4
3
  'id': string;
5
4
  'sourceFields': string[];
6
- 'relationshipType': SemanticRelationships | string;
7
5
  'represents'?: string | undefined;
8
- 'outwardLabel'?: string;
9
- 'inwardLabel'?: string;
6
+ 'outwardLabel': string;
7
+ 'inwardLabel': string;
10
8
  /**
11
9
  * This exists to handle the rare situation when there are fields on the target item that reference the source item.
12
10
  * Please reach out to #dev-data-platform before setting this to a defined value.
@@ -5,7 +5,6 @@ function serializeSourceForeignKey(foreignKey) {
5
5
  return {
6
6
  'Id': foreignKey.id,
7
7
  'SourceFields': foreignKey.sourceFields,
8
- 'RelationshipType': foreignKey.relationshipType,
9
8
  'Represents': foreignKey.represents,
10
9
  'OutwardLabel': foreignKey.outwardLabel,
11
10
  'InwardLabel': foreignKey.inwardLabel,
@@ -17,10 +16,9 @@ function deserializeSourceForeignKey(foreignKey) {
17
16
  return {
18
17
  'id': foreignKey['Id'],
19
18
  'sourceFields': foreignKey['SourceFields'],
20
- 'relationshipType': foreignKey['RelationshipType'],
21
19
  'represents': foreignKey['Represents'] === null ? undefined : foreignKey['Represents'],
22
- 'outwardLabel': foreignKey['OutwardLabel'] === null ? undefined : foreignKey['OutwardLabel'],
23
- 'inwardLabel': foreignKey['InwardLabel'] === null ? undefined : foreignKey['InwardLabel'],
20
+ 'outwardLabel': foreignKey['OutwardLabel'],
21
+ 'inwardLabel': foreignKey['InwardLabel'],
24
22
  'targetFields': foreignKey['TargetFields'] === null ? undefined : foreignKey['TargetFields'],
25
23
  };
26
24
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lucid-extension-sdk",
3
- "version": "0.0.315",
3
+ "version": "0.0.317",
4
4
  "description": "Utility classes for writing Lucid Software editor extensions",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",