lucid-extension-sdk 0.0.311 → 0.0.312

package/commandtypes.d.ts

@@ -764,6 +764,63 @@ export type AddCardIntegrationQuery = {
     } | undefined;
     /** Whether to enable dependency mapping for this integration */
     'sdm'?: boolean;
+    /**
+     * If specified, the text phrases to show in the dependency mapping UI.
+     * If not specified, dependency mapping for this integration uses the default fallback phrases.
+     */
+    'dmp'?: {
+        /** Entrypoint text */
+        'ep'?: string;
+        /**
+         * Text for on-card badge for dependency mapping
+         * String, not a function itself; this is the name of the client's registered action hook
+         */
+        'cl'?: string;
+        /** Text for the dependency manager */
+        'm'?: {
+            /** Header */
+            'h'?: string;
+            /** All links label */
+            'all'?: string;
+            /** Show all links button text */
+            'salb'?: string;
+            /** Hide all links button text */
+            'halb'?: string;
+            /** Show all links tooltip text (when disabled) */
+            'dsalt'?: string;
+            /** Hide all links tooltip text (when disabled) */
+            'dhalt'?: string;
+            /** Text for various empty states */
+            'es'?: {
+                /** Create link instruction text */
+                'cli'?: string;
+                /** Instructional text when no items are selected */
+                'nssi'?: string;
+                /** Heading text when no items are selected */
+                'nssh'?: string;
+                /**
+                 * Heading text when selected item has no links
+                 * String, not a function itself; this is the name of the client's registered action hook
+                 */
+                'ndh'?: string;
+                /** Text when multiple items are selected and have no links */
+                'mikwnl'?: string;
+            };
+        };
+        /** Text for editing a dependency */
+        'ed'?: {
+            'ch'?: string;
+            'cnlo'?: string;
+            'dh'?: string;
+            'dd'?: string;
+            'dab'?: string;
+            /**
+             * Selected issue heading
+             * String, not a function itself; this is the name of the client's registered action hook
+             */
+            'sih'?: string;
+        };
+    } | undefined;
 };
 export type AddCardIntegrationResult = undefined;
 /** @ignore */

package/core/cardintegration/dependencymappingphrases.d.ts

@@ -0,0 +1,31 @@
+interface DependencyManagerEmptyStatePhrasesType {
+    readonly multipleIssueKeyWithNoLink?: string;
+    readonly createLinkInstruction?: string;
+    readonly noSelectionStateInstruction?: string;
+    readonly noSelectionStateHeading?: string;
+    noDependencyHeading?: (key: string) => string;
+}
+interface DependencyManagerPhrasesType {
+    readonly header?: string;
+    readonly allLinksLabel?: string;
+    readonly showAllLinksButton?: string;
+    readonly hideAllLinksButton?: string;
+    readonly disabledShowAllLinksTooltip?: string;
+    readonly disabledHideAllLinksTooltip?: string;
+    readonly emptyState?: DependencyManagerEmptyStatePhrasesType;
+}
+interface DependencyEditPhrasesType {
+    readonly createHeader?: string;
+    readonly createNoLinkOption?: string;
+    readonly deleteHeader?: string;
+    readonly deleteDescription?: string;
+    readonly deleteActionButton?: string;
+    selectedIssueHeading?: (key: string) => string;
+}
+export interface DependencyMappingPhrasesType {
+    entrypoint?: string;
+    cardLabel?: (locale: string, count: number) => string;
+    manager?: DependencyManagerPhrasesType;
+    edit?: DependencyEditPhrasesType;
+}
+export {};

package/core/cardintegration/dependencymappingphrases.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/cardintegration/lucidcardintegration.d.ts

@@ -5,6 +5,7 @@ import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { CardIntegrationConfig } from './cardintegrationconfig';
 import { ExtensionCardFieldDefinition } from './cardintegrationdefinitions';
+import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
 import { LucidCardIntegrationStandardImportModal } from './lucidcardintegrationstandardimportmodal';
 export { ImportResult, SearchResult } from './lucidcardintegrationstandardimportmodal';
@@ -96,4 +97,9 @@ export declare abstract class LucidCardIntegration {
     };
     showCardImport(name: string): import("../../commandtypes").ImportCardsResult;
     showDependencyMapping?: boolean;
+    /**
+     * If specified, the text phrases to show in the dependency mapping UI.
+     * If not specified, dependency mapping for this integration uses the default fallback phrases.
+     */
+    dependencyMappingPhrases?: DependencyMappingPhrasesType;
 }

package/core/cardintegration/lucidcardintegrationdefinitions.d.ts

@@ -47,3 +47,16 @@ export interface SearchOptionsParam {
     's': string;
     'i': [string, SerializedFieldType][];
 }
+/** @ignore */
+export interface DependencyMappingCardLabelParam {
+    'l': string;
+    'c': number;
+}
+/** @ignore */
+export interface DependencyMappingNoDependencyHeadingParam {
+    'k': string;
+}
+/** @ignore */
+export interface DependencyMappingSelectedIssueHeadingParam {
+    'k': string;
+}

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -7,6 +7,7 @@ export declare class LucidCardIntegrationRegistry {
     private static nextHookName;
     static registerFieldOptionsCallback(client: EditorClient, callback: (inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
     static registerFieldSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
+    private static registerDependencyMapping;
     /**
      * Register a card integration.
      */

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -26,6 +26,77 @@ class LucidCardIntegrationRegistry {
         });
         return name;
     }
+    static registerDependencyMapping(client, cardIntegration, serialized) {
+        if (cardIntegration.showDependencyMapping) {
+            serialized['sdm'] = true;
+        }
+        if (cardIntegration.dependencyMappingPhrases) {
+            const dependencyMappingPhrases = cardIntegration.dependencyMappingPhrases;
+            const manager = dependencyMappingPhrases.manager;
+            const emptyState = manager === null || manager === void 0 ? void 0 : manager.emptyState;
+            const edit = dependencyMappingPhrases.edit;
+            // 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
+                ? LucidCardIntegrationRegistry.nextHookName()
+                : undefined;
+            if (cardLabelActionName) {
+                client.registerAction(cardLabelActionName, ({ 'l': locale, 'c': count }) => { var _a; return (_a = dependencyMappingPhrases.cardLabel) === null || _a === void 0 ? void 0 : _a.call(dependencyMappingPhrases, locale, count); });
+            }
+            const noDependencyHeadingActionName = (emptyState === null || emptyState === void 0 ? void 0 : emptyState.noDependencyHeading)
+                ? LucidCardIntegrationRegistry.nextHookName()
+                : undefined;
+            if (noDependencyHeadingActionName) {
+                client.registerAction(noDependencyHeadingActionName, ({ 'k': key }) => {
+                    var _a;
+                    return (_a = emptyState === null || emptyState === void 0 ? void 0 : emptyState.noDependencyHeading) === null || _a === void 0 ? void 0 : _a.call(emptyState, key);
+                });
+            }
+            const selectedIssueHeadingActionName = (edit === null || edit === void 0 ? void 0 : edit.selectedIssueHeading)
+                ? LucidCardIntegrationRegistry.nextHookName()
+                : undefined;
+            if (selectedIssueHeadingActionName) {
+                client.registerAction(selectedIssueHeadingActionName, ({ 'k': key }) => {
+                    var _a;
+                    return (_a = edit === null || edit === void 0 ? void 0 : edit.selectedIssueHeading) === null || _a === void 0 ? void 0 : _a.call(edit, key);
+                });
+            }
+            serialized['dmp'] = {
+                'ep': dependencyMappingPhrases.entrypoint,
+                'cl': cardLabelActionName,
+                'm': manager
+                    ? {
+                        'h': manager.header,
+                        'all': manager.allLinksLabel,
+                        'salb': manager.showAllLinksButton,
+                        'halb': manager.hideAllLinksButton,
+                        'dsalt': manager.disabledShowAllLinksTooltip,
+                        'dhalt': manager.disabledHideAllLinksTooltip,
+                        'es': emptyState
+                            ? {
+                                'cli': emptyState.createLinkInstruction,
+                                'nssi': emptyState.noSelectionStateInstruction,
+                                'nssh': emptyState.noSelectionStateHeading,
+                                'ndh': noDependencyHeadingActionName,
+                                'mikwnl': emptyState.multipleIssueKeyWithNoLink,
+                            }
+                            : undefined,
+                    }
+                    : undefined,
+                'ed': edit
+                    ? {
+                        'ch': edit.createHeader,
+                        'cnlo': edit.createNoLinkOption,
+                        'dh': edit.deleteHeader,
+                        'dd': edit.deleteDescription,
+                        'dab': edit.deleteActionButton,
+                        'sih': selectedIssueHeadingActionName,
+                    }
+                    : undefined,
+            };
+        }
+        return serialized;
+    }
     /**
      * Register a card integration.
      */
@@ -141,9 +212,7 @@ class LucidCardIntegrationRegistry {
                 };
             });
         }
-        if (cardIntegration.showDependencyMapping) {
-            serialized['sdm'] = true;
-        }
+        this.registerDependencyMapping(client, cardIntegration, serialized);
         client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);
     }
 }

package/package.json

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