lucid-extension-sdk 0.0.436 → 0.0.437

package/commandtypes.d.ts

@@ -749,6 +749,7 @@ export type AutoSyncSettings = {
     'h': string;
     'gsf': string;
     'sqs'?: string | undefined;
+    'syqs'?: string | undefined;
 };
 export type SerializedFieldConfiguration = {
     /** Callback to get field definitions for all fields supported by the card integration */
@@ -832,6 +833,11 @@ export type AddCardIntegrationQuery = {
         /** Callback to fetch icons that show next to the field labels in the card details panel */
         'flic'?: string | undefined;
     } | undefined;
+    /**
+     * @experimental
+     * Tag callback, to display tag information for any card
+     */
+    'tc'?: string | undefined;
     /**
      * 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.

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -1,5 +1,5 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldDefinition, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
 export interface CardIntegrationAutoSyncConfig {
     /**
      * The header to display for the integration. For example, the Jira integration displays "JQL query sync"
@@ -20,4 +20,8 @@ export interface CardIntegrationAutoSyncConfig {
      * @returns either an error AutoSyncError or an array of issues / tasks / cards represented as an AutoSyncRow
      */
     searchQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>, pageNumber: number, nextPageToken: string | undefined) => Promise<SearchResult>;
+    /**
+     * @returns the ImportResult for the query string.
+     */
+    syncQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
 }

package/core/cardintegration/cardintegrationparams.d.ts

@@ -29,6 +29,10 @@ export interface QuerySearchParam {
     'pn': number;
     'npt': string | undefined;
 }
+export interface QuerySyncParam {
+    'qs': string;
+    'of': [string, SerializedFieldType][];
+}
 /** @ignore */
 export interface ImportParam {
     'pks': string[];
@@ -87,7 +91,7 @@ export interface DependencyMappingSelectedIssueHeadingParam {
     'k': string;
 }
 /** @ignore */
-export interface FieldLabelIconsCallbackParam {
+export interface DataItemCallbackParam {
     'd': string;
     'c': string;
     'p': string;

package/core/cardintegration/lucidcardintegration.d.ts

@@ -81,6 +81,12 @@ export declare abstract class LucidCardIntegration {
          */
         fieldLabelIconsCallback?: string;
     };
+    /**
+     * @experimental Optional. Callback function to derive a tag for any given card.
+     * A tag is a combination of a text label (preferably short, less than two words) and an icon,
+     * which can provide extra user-facing information in the card details panel.
+     */
+    tagCallback?: string;
     /** If we are only able to search by name and not email in the card integration (ex: for JDC) */
     searchUserByName?: boolean;
     /** This is used to search for users in the card integration. It returns an additional email field of the user if available.*/

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -2,7 +2,7 @@ import { DataItemProxy } from '../../data/dataitemproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldLabelIcons, ExtensionCardFieldOption, ExtensionCardUserData } from '../sharedcardintegration/cardintegrationdefinitions';
+import { ExtensionCardFieldLabelIcons, ExtensionCardFieldOption, ExtensionCardUserData, TagCallback } from '../sharedcardintegration/cardintegrationdefinitions';
 import { LucidCardIntegration } from './lucidcardintegration';
 export declare class LucidCardIntegrationRegistry {
     private static nextHookId;
@@ -14,8 +14,13 @@ export declare class LucidCardIntegrationRegistry {
     }) => Promise<ExtensionCardFieldOption[]>): string;
     static registerUserSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>): string;
     static registerFieldLabelIconsCallback(client: EditorClient, callback: (dataSourceProxy: DataSourceProxy, dataItemProxy: DataItemProxy) => Promise<ExtensionCardFieldLabelIcons>): string;
+    static registerTagCallback(client: EditorClient, callback: TagCallback): string;
     private static registerDependencyMapping;
     private static serializeSearchResult;
+    /**
+     * Helper to serialize import results (single or array) to the expected format.
+     */
+    private static serializeImportResults;
     private static registerImportCardFromPastedLinkHandler;
     /**
      * Register a card integration.

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -60,6 +60,21 @@ class LucidCardIntegrationRegistry {
         });
         return name;
     }
+    static registerTagCallback(client, callback) {
+        const name = LucidCardIntegrationRegistry.nextHookName();
+        client.registerAction(name, async ({ 'd': dataSourceId, 'c': collectionId, 'p': primaryKey, }) => {
+            const dataSourceProxy = new datasourceproxy_1.DataSourceProxy(dataSourceId, client);
+            const collectionProxy = new collectionproxy_1.CollectionProxy(collectionId, client);
+            const dataItemProxy = new dataitemproxy_1.DataItemProxy(primaryKey, collectionProxy, client);
+            const result = await callback(dataSourceProxy, collectionProxy, dataItemProxy);
+            if (result === undefined) {
+                return undefined;
+            }
+            const serializedResult = (0, cardintegrationdefinitions_1.serializeTagCallbackResult)(result);
+            return serializedResult;
+        });
+        return name;
+    }
     static registerDependencyMapping(client, cardIntegration, serialized) {
         if (cardIntegration.showDependencyMapping) {
             serialized['sdm'] = true;
@@ -176,6 +191,23 @@ class LucidCardIntegrationRegistry {
             'e': searchResult.error,
         };
     }
+    /**
+     * Helper to serialize import results (single or array) to the expected format.
+     */
+    static serializeImportResults(result) {
+        if ((0, checks_1.isArray)(result)) {
+            return result.map((importResult) => {
+                return {
+                    'c': importResult.collection.id,
+                    'pks': importResult.primaryKeys,
+                };
+            });
+        }
+        return {
+            'c': result.collection.id,
+            'pks': result.primaryKeys,
+        };
+    }
     static registerImportCardFromPastedLinkHandler(client, cardIntegration, serialized) {
         if (!cardIntegration.importCardFromPastedLink) {
             return;
@@ -258,6 +290,9 @@ class LucidCardIntegrationRegistry {
                 'flic': cardIntegration.iconConfiguration.fieldLabelIconsCallback,
             };
         }
+        if (cardIntegration.tagCallback) {
+            serialized['tc'] = cardIntegration.tagCallback;
+        }
         if (cardIntegration.importModal) {
             const importModal = cardIntegration.importModal;
             if (importModal instanceof lucidcardintegrationcustomimportmodal_1.LucidCardIntegrationCustomImportModal) {
@@ -369,6 +404,14 @@ class LucidCardIntegrationRegistry {
                     }
                 });
             }
+            if (autoSync.syncQueryString) {
+                serialized['as']['syqs'] = LucidCardIntegrationRegistry.nextHookName();
+                client.registerAction(serialized['as']['syqs'], async ({ 'qs': queryString, 'of': otherFields }) => {
+                    var _a, _b;
+                    const result = (_b = (await ((_a = autoSync.syncQueryString) === null || _a === void 0 ? void 0 : _a.call(autoSync, queryString, new Map(otherFields))))) !== null && _b !== void 0 ? _b : [];
+                    return LucidCardIntegrationRegistry.serializeImportResults(result);
+                });
+            }
         }
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -277,3 +277,33 @@ export type ExtensionFieldConfiguration = {
  * Use the `createLucidIconData()` helper to format the icon data in this map.
  */
 export type ExtensionCardFieldLabelIcons = Map<string, SerializedLucidIconData>;
+/**
+ * @experimental Callback function to derive a tag for any given card's data item.
+ * A tag is a combination of a text label (preferably short, less than two words) and an icon,
+ * which can provide extra user-facing information in the card details panel.
+ */
+export type TagCallback = (dataSourceProxy: DataSourceProxy, collectionProxy: CollectionProxy, dataItemProxy: DataItemProxy) => Promise<TagCallbackResult | undefined>;
+/** @ignore */
+export type TagCallbackResult = {
+    label: string;
+    icon?: SerializedLucidIconData | undefined;
+};
+/** @ignore */
+export interface SerializedTagCallbackResult {
+    'l': string;
+    'i'?: SerializedLucidIconData | undefined;
+}
+/** @ignore */
+export declare const isSerializedTagCallbackResult: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    l: typeof isString;
+    i: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+        dict: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+            icon: typeof isString;
+            ariaLabel: typeof isString;
+            tooltipLabel: (x: unknown) => x is string | undefined;
+            roundedIcon: (x: unknown) => x is boolean | undefined;
+        }>;
+    }> | undefined;
+}>;
+/** @ignore */
+export declare function serializeTagCallbackResult(tag: TagCallbackResult): SerializedTagCallbackResult;

package/core/sharedcardintegration/cardintegrationdefinitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializePlaceholderImportMetadata = exports.serializePlaceholderImportMetadata = exports.isSerializedPlaceholderImportMetadata = exports.isSearchResult = exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = exports.isSerializedCardUserDataArray = exports.isSerializedCardUserData = exports.deserializeCardUserData = exports.serializeCardUserData = void 0;
+exports.serializeTagCallbackResult = exports.isSerializedTagCallbackResult = exports.deserializePlaceholderImportMetadata = exports.serializePlaceholderImportMetadata = exports.isSerializedPlaceholderImportMetadata = exports.isSearchResult = exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = exports.isSerializedCardUserDataArray = exports.isSerializedCardUserData = exports.deserializeCardUserData = exports.serializeCardUserData = void 0;
 const collectiondefinition_1 = require("../../data/collectiondefinition");
 const schemadefinition_1 = require("../../data/schemadefinition");
 const checks_1 = require("../checks");
@@ -104,3 +104,16 @@ function deserializePlaceholderImportMetadata(serializedPlaceholderImportMetadat
     };
 }
 exports.deserializePlaceholderImportMetadata = deserializePlaceholderImportMetadata;
+/** @ignore */
+exports.isSerializedTagCallbackResult = (0, validators_1.objectValidator)({
+    'l': checks_1.isString,
+    'i': (0, validators_1.option)(serializedfields_1.isSerializedLucidIconData),
+});
+/** @ignore */
+function serializeTagCallbackResult(tag) {
+    return {
+        'l': tag.label,
+        'i': tag === null || tag === void 0 ? void 0 : tag.icon,
+    };
+}
+exports.serializeTagCallbackResult = serializeTagCallbackResult;

package/package.json

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