lucid-extension-sdk 0.0.319 → 0.0.320

package/commandtypes.d.ts

@@ -730,6 +730,10 @@ export type AddCardIntegrationQuery = {
         /** Field name -> callback name tuples for searching for legal field values in an enum */
         'fvsc'?: [string, string][] | undefined;
     };
+    /** If we can only search for user by their name (and not email) in the card integration. */
+    'subn'?: boolean | undefined;
+    /** Callback to search for a user in the card integration */
+    'usc'?: string | undefined;
     /** Show intro if user has not yet authorized this integration
      *  String, not function; this is the name of the client's registered action hook
      */

package/core/cardintegration/cardintegrationdefinitions.d.ts

@@ -30,6 +30,30 @@ export interface ExtensionCardFieldDefinition extends FieldDefinition {
      */
     search?: string | undefined;
 }
+export type ExtensionCardUserData = ExtensionCardFieldOption & {
+    email: string | undefined;
+};
+/** @ignore */
+export type SerializedExtensionCardUserData = SerializedCardFieldOption & {
+    'e'?: string | undefined;
+};
+/** @ignore */
+export declare function serializeCardUserData(userData: ExtensionCardUserData): SerializedExtensionCardUserData;
+/** @ignore */
+export declare function deserializeCardUserData(userData: SerializedExtensionCardUserData): ExtensionCardUserData;
+export declare const isSerializedCardUserData: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    e: (x: unknown) => x is string | undefined;
+    l: typeof isString;
+    v: typeof isSerializedFieldType;
+    i: (x: unknown) => x is string | undefined;
+}>;
+export declare const isSerializedCardUserDataArray: (p1: unknown) => p1 is import("../guards").DestructureGuardedTypeObj<{
+    e: (x: unknown) => x is string | undefined;
+    l: typeof isString;
+    v: typeof isSerializedFieldType;
+    i: (x: unknown) => x is string | undefined;
+}>[];
+export type ExtensionCardUserDataSearch = ((searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>) | undefined;
 /** @ignore */
 export type SerializedCardFieldOption = {
     'l': string;

package/core/cardintegration/cardintegrationdefinitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = void 0;
+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 schemadefinition_1 = require("../../data/schemadefinition");
 const checks_1 = require("../checks");
 const fieldtypedefinition_1 = require("../data/fieldtypedefinition/fieldtypedefinition");
@@ -8,6 +8,23 @@ const serializedfielddefinition_1 = require("../data/serializedfield/serializedf
 const serializedfields_1 = require("../data/serializedfield/serializedfields");
 const validators_1 = require("../validators/validators");
 /** @ignore */
+function serializeCardUserData(userData) {
+    return Object.assign({ 'e': userData.email }, serializeCardFieldOption(userData));
+}
+exports.serializeCardUserData = serializeCardUserData;
+/** @ignore */
+function deserializeCardUserData(userData) {
+    return Object.assign({ email: userData['e'] }, deserializeFieldOption(userData));
+}
+exports.deserializeCardUserData = deserializeCardUserData;
+exports.isSerializedCardUserData = (0, validators_1.objectValidator)({
+    'e': (0, validators_1.option)(checks_1.isString),
+    'l': checks_1.isString,
+    'v': serializedfields_1.isSerializedFieldType,
+    'i': (0, validators_1.option)(checks_1.isString),
+});
+exports.isSerializedCardUserDataArray = (0, validators_1.arrayValidator)(exports.isSerializedCardUserData);
+/** @ignore */
 function serializeCardFieldOption(option) {
     return {
         'l': option.label,

package/core/cardintegration/lucidcardintegration.d.ts

@@ -76,6 +76,10 @@ export declare abstract class LucidCardIntegration {
          */
         lightIconUrl?: 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.*/
+    userSearchCallback?: string;
     /**
      * @deprecated Use AuthorizationFlowHandlerRegistry.registerAuthorizationFlowHandler.
      * WARNING: Currently unused and does nothing.

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -1,12 +1,13 @@
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldOption } from './cardintegrationdefinitions';
+import { ExtensionCardFieldOption, ExtensionCardUserData } from './cardintegrationdefinitions';
 import { LucidCardIntegration } from './lucidcardintegration';
 export declare class LucidCardIntegrationRegistry {
     private static nextHookId;
     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;
+    static registerUserSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>): string;
     private static registerDependencyMapping;
     /**
      * Register a card integration.

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -26,6 +26,14 @@ class LucidCardIntegrationRegistry {
         });
         return name;
     }
+    static registerUserSearchCallback(client, callback) {
+        const name = LucidCardIntegrationRegistry.nextHookName();
+        client.registerAction(name, async ({ 'i': inputSoFar, 's': searchText }) => {
+            const result = await callback(searchText, new Map(inputSoFar));
+            return result.map((userData) => (0, cardintegrationdefinitions_1.serializeCardUserData)(userData));
+        });
+        return name;
+    }
     static registerDependencyMapping(client, cardIntegration, serialized) {
         if (cardIntegration.showDependencyMapping) {
             serialized['sdm'] = true;
@@ -140,6 +148,8 @@ class LucidCardIntegrationRegistry {
                     ? [...cardIntegration.fieldConfiguration.fieldValueSearchCallbacks.entries()]
                     : undefined,
             },
+            'subn': cardIntegration.searchUserByName,
+            'usc': cardIntegration.userSearchCallback,
             'gdc': getDefaultConfigActionName,
             'i': showIntroActionName,
         };

package/package.json

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