lucid-extension-sdk 0.0.376 → 0.0.378

package/commandtypes.d.ts

@@ -862,6 +862,10 @@ export type AddCardIntegrationQuery = {
              */
             'sih'?: string;
         };
+        /**
+         * Item label phrase
+         */
+        'ilp'?: string;
     } | undefined;
 };
 export type AddCardIntegrationResult = undefined;

package/core/assertnever.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Use this to assert that a type check is exhaustive at build-time. There should never be a code path that reaches this function.
+ * @param x the value to assert is never reached
+ */
+export declare function assertNever(x: never): never;

package/core/assertnever.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertNever = void 0;
+/**
+ * Use this to assert that a type check is exhaustive at build-time. There should never be a code path that reaches this function.
+ * @param x the value to assert is never reached
+ */
+function assertNever(x) {
+    throw new Error(`Assertion failed! Expected assertNever to not be called, but it was called with parameter ${JSON.stringify(x)}`);
+}
+exports.assertNever = assertNever;

package/core/cardintegration/cardintegrationparams.d.ts

@@ -36,6 +36,10 @@ interface DependenciesForItemParam {
 export interface DependenciesForItemsParam {
     'dfi': DependenciesForItemParam[];
 }
+export interface DependencyMappingItemLabelPhraseParam {
+    'ci': string;
+    'pk': string;
+}
 /** @ignore */
 export interface CustomImportParam {
     'd': JsonSerializable;

package/core/cardintegration/dependencymappingphrases.d.ts

@@ -1,3 +1,4 @@
+import { DataItemProxy } from '../../data/dataitemproxy';
 interface DependencyManagerEmptyStatePhrasesType {
     readonly multipleIssueKeyWithNoLink?: string;
     readonly createLinkInstruction?: string;
@@ -27,5 +28,9 @@ export interface DependencyMappingPhrasesType {
     cardLabel?: (locale: string, count: number) => string;
     manager?: DependencyManagerPhrasesType;
     edit?: DependencyEditPhrasesType;
+    /**
+     * This function is used to map the dataItemProxy to item label phrase.
+     */
+    itemLabelPhrase?: (dataItem: DataItemProxy) => string;
 }
 export {};

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -47,6 +47,7 @@ class LucidCardIntegrationRegistry {
             const manager = dependencyMappingPhrases.manager;
             const emptyState = manager === null || manager === void 0 ? void 0 : manager.emptyState;
             const edit = dependencyMappingPhrases.edit;
+            const itemLabelPhrase = dependencyMappingPhrases.itemLabelPhrase;
             // Strings that appear on the canvas must calculate their locale at runtime,
             // so all users get canvas content in the same locale
             const cardLabelActionName = dependencyMappingPhrases.cardLabel
@@ -73,6 +74,15 @@ class LucidCardIntegrationRegistry {
                     return (_a = edit === null || edit === void 0 ? void 0 : edit.selectedIssueHeading) === null || _a === void 0 ? void 0 : _a.call(edit, key);
                 });
             }
+            let itemLabelPhraseActionName = undefined;
+            if (itemLabelPhrase) {
+                itemLabelPhraseActionName = LucidCardIntegrationRegistry.nextHookName();
+                client.registerAction(itemLabelPhraseActionName, ({ 'ci': ci, 'pk': pk }) => {
+                    const collectionProxy = new collectionproxy_1.CollectionProxy(ci, client);
+                    const itemProxy = new dataitemproxy_1.DataItemProxy(pk, collectionProxy, client);
+                    return itemLabelPhrase(itemProxy);
+                });
+            }
             serialized['dmp'] = {
                 'ep': dependencyMappingPhrases.entrypoint,
                 'cl': cardLabelActionName,
@@ -105,6 +115,7 @@ class LucidCardIntegrationRegistry {
                         'sih': selectedIssueHeadingActionName,
                     }
                     : undefined,
+                'ilp': itemLabelPhraseActionName,
             };
         }
         if (cardIntegration.importDependencies) {

package/data/schemadefinition.d.ts

@@ -38,6 +38,7 @@ export interface MaxLengthConstraintDefinition {
     value: number;
 }
 export type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition | UniqueEditFieldConstraintDefinition | MaxLengthConstraintDefinition;
+export declare function createFieldConstraintDefinition(type: FieldConstraintType, value?: number): FieldConstraintDefinition;
 export declare function minMaxFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE | FieldConstraintType.MAX_LENGTH;
 export declare const isFieldConstraintDefinition: (x: unknown) => x is {
     type?: FieldConstraintType | undefined;

package/data/schemadefinition.js

@@ -1,10 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSchemaDefinition = exports.parseFieldDefinition = exports.serializeSchemaDefinition = exports.serializeFieldDefinition = exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.minMaxFieldConstraintValidator = void 0;
+exports.parseSchemaDefinition = exports.parseFieldDefinition = exports.serializeSchemaDefinition = exports.serializeFieldDefinition = exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.minMaxFieldConstraintValidator = exports.createFieldConstraintDefinition = void 0;
+const assertnever_1 = require("../core/assertnever");
 const checks_1 = require("../core/checks");
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
 const serializedfielddefinition_1 = require("../core/data/serializedfield/serializedfielddefinition");
 const validators_1 = require("../core/validators/validators");
+function createFieldConstraintDefinition(type, value) {
+    switch (type) {
+        case serializedfielddefinition_1.FieldConstraintType.REQUIRED:
+        case serializedfielddefinition_1.FieldConstraintType.LOCKED:
+            return { type };
+        case serializedfielddefinition_1.FieldConstraintType.MIN_VALUE:
+        case serializedfielddefinition_1.FieldConstraintType.MAX_VALUE:
+        case serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH:
+            if (value === undefined) {
+                throw new Error('Invalid constraint value');
+            }
+            return { type, value };
+        case serializedfielddefinition_1.FieldConstraintType.SINGLE_LINE_ONLY:
+        case serializedfielddefinition_1.FieldConstraintType.NO_WHITESPACE:
+        case serializedfielddefinition_1.FieldConstraintType.UNIQUE_EDIT:
+            if (value !== undefined) {
+                throw new Error('Invalid constraint value');
+            }
+            return { type };
+        default:
+            (0, assertnever_1.assertNever)(type);
+    }
+}
+exports.createFieldConstraintDefinition = createFieldConstraintDefinition;
 function minMaxFieldConstraintValidator(val) {
     return (val === serializedfielddefinition_1.FieldConstraintType.MIN_VALUE ||
         val === serializedfielddefinition_1.FieldConstraintType.MAX_VALUE ||

package/package.json

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