lucid-extension-sdk 1.1.1 → 1.1.2

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -63,6 +63,12 @@ export declare const FieldDisplayType: {
      * Truncates value to be a maximum of 20 chars, appending '...' to the given value.
      */
     readonly CustomTextField: "CustomTextField";
+    /**
+     * @experimental
+     * Renders the field value as a small 24x24 rounded-square icon aligned inline with
+     * one of the card's text rows. Use `inlineRowIndex` on the stencil config to pick which row.
+     */
+    readonly InlineIcon: "InlineIcon";
 };
 export type FieldDisplayType = (typeof FieldDisplayType)[keyof typeof FieldDisplayType];
 export declare const isFieldDisplayType: (x: unknown) => x is {} extends {
@@ -123,7 +129,13 @@ export declare const isFieldDisplayType: (x: unknown) => x is {} extends {
      * Truncates value to be a maximum of 20 chars, appending '...' to the given value.
      */
     readonly CustomTextField: "CustomTextField";
-} ? never : "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+    /**
+     * @experimental
+     * Renders the field value as a small 24x24 rounded-square icon aligned inline with
+     * one of the card's text rows. Use `inlineRowIndex` on the stencil config to pick which row.
+     */
+    readonly InlineIcon: "InlineIcon";
+} ? never : "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
 /**
  * When configuring a field on a LucidCardBlock to be displayed as a data graphic, this click handler value
  * specifies what to do when the user clicks on the data graphic produced.
@@ -225,7 +237,7 @@ declare const StencilConfigFormatter: import("../format/format").Format<import("
      * The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
      * but need to support the original serialized key.
      */
-    readonly displayType: readonly ["getterKey", import("../format/format").Format<"BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField", "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField">];
+    readonly displayType: readonly ["getterKey", import("../format/format").Format<"BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon", "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon">];
     /**
      * For displayType values that support it, you may provide an override for the
      * background color for this data. If this is not provided, the background color
@@ -320,8 +332,14 @@ declare const StencilConfigFormatter: import("../format/format").Format<import("
         readonly iswithinpill?: boolean | null | undefined;
         readonly hasleadingicon?: boolean | null | undefined;
     } | null | undefined>];
+    /**
+     * @experimental
+     * For inline stencils, this is the index of the text row that the stencil should render
+     * alongside. Ignored for non-inline display types, defaults to 0 (the first text row)
+     */
+    readonly inlineRowIndex: readonly ["inlineRowIndex", import("../format/format").Format<number | null | undefined, number | null | undefined>];
 }>, {
-    readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+    readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
     readonly backgroundColor?: string | null | undefined;
     readonly foregroundColor?: string | null | undefined;
     readonly imageBadgeSettings?: {
@@ -347,6 +365,7 @@ declare const StencilConfigFormatter: import("../format/format").Format<import("
         readonly iswithinpill?: boolean | null | undefined;
         readonly hasleadingicon?: boolean | null | undefined;
     } | null | undefined;
+    readonly inlineRowIndex?: number | null | undefined;
 }>;
 export type StencilConfig = FormatToDeserializedType<typeof StencilConfigFormatter>;
 export declare const CardFieldDisplaySettingsFormatter: import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
@@ -358,7 +377,7 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
          * The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
          * but need to support the original serialized key.
          */
-        readonly displayType: readonly ["getterKey", import("../format/format").Format<"BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField", "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField">];
+        readonly displayType: readonly ["getterKey", import("../format/format").Format<"BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon", "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon">];
         /**
          * For displayType values that support it, you may provide an override for the
          * background color for this data. If this is not provided, the background color
@@ -453,8 +472,14 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
             readonly iswithinpill?: boolean | null | undefined;
             readonly hasleadingicon?: boolean | null | undefined;
         } | null | undefined>];
+        /**
+         * @experimental
+         * For inline stencils, this is the index of the text row that the stencil should render
+         * alongside. Ignored for non-inline display types, defaults to 0 (the first text row)
+         */
+        readonly inlineRowIndex: readonly ["inlineRowIndex", import("../format/format").Format<number | null | undefined, number | null | undefined>];
     }> | null | undefined, {
-        readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+        readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
         readonly backgroundColor?: string | null | undefined;
         readonly foregroundColor?: string | null | undefined;
         readonly imageBadgeSettings?: {
@@ -480,10 +505,11 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
             readonly iswithinpill?: boolean | null | undefined;
             readonly hasleadingicon?: boolean | null | undefined;
         } | null | undefined;
+        readonly inlineRowIndex?: number | null | undefined;
     } | null | undefined>];
 }>, {
     readonly stencilConfig?: {
-        readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+        readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
         readonly backgroundColor?: string | null | undefined;
         readonly foregroundColor?: string | null | undefined;
         readonly imageBadgeSettings?: {
@@ -509,6 +535,7 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
             readonly iswithinpill?: boolean | null | undefined;
             readonly hasleadingicon?: boolean | null | undefined;
         } | null | undefined;
+        readonly inlineRowIndex?: number | null | undefined;
     } | null | undefined;
 }>;
 /**

package/core/cardintegration/cardfielddisplaysettings.js

@@ -71,6 +71,12 @@ exports.FieldDisplayType = {
      * Truncates value to be a maximum of 20 chars, appending '...' to the given value.
      */
     CustomTextField: 'CustomTextField',
+    /**
+     * @experimental
+     * Renders the field value as a small 24x24 rounded-square icon aligned inline with
+     * one of the card's text rows. Use `inlineRowIndex` on the stencil config to pick which row.
+     */
+    InlineIcon: 'InlineIcon',
 };
 exports.isFieldDisplayType = (0, validators_1.enumValidator)(exports.FieldDisplayType);
 /**
@@ -194,6 +200,12 @@ const StencilConfigFormatter = (0, objectformat_1.ObjectFormat)({
      * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
      */
     textBadgeSettings: ['textBadgeSettings', (0, format_1.OptionFormat)(TextBadgeSettingsFormatter)],
+    /**
+     * @experimental
+     * For inline stencils, this is the index of the text row that the stencil should render
+     * alongside. Ignored for non-inline display types, defaults to 0 (the first text row)
+     */
+    inlineRowIndex: ['inlineRowIndex', (0, format_1.OptionFormat)(primitiveformat_1.NumberFormat)],
 });
 exports.CardFieldDisplaySettingsFormatter = (0, objectformat_1.ObjectFormat)({
     stencilConfig: ['StencilConfig', (0, format_1.OptionFormat)(StencilConfigFormatter)],

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -1,3 +1,4 @@
+import { isString } from '../checks';
 import type { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import type { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import type { DocumentPresetSetupFields } from './lucidcardintegrationpresetsetupmodal';
@@ -60,9 +61,13 @@ export interface QueryStringCardIntegrationAutoSyncConfig extends BaseCardIntegr
      * when advanced search mode is enabled and filters are changed.
      *
      * @param filterFields The current filter selections
-     * @returns The generated query string, or undefined if no query can be generated
+     * @returns One of:
+     *   - A query string to populate the search bar with.
+     *   - A {@link ConvertFiltersToQueryStringResult} object that can carry either a `queryString`
+     *     for success, or an `error` message that will be displayed to the user.
+     *   - `undefined`, equivalent to an empty result.
      */
-    convertFiltersToQueryString?: (filterFields: Map<string, SerializedFieldType>) => Promise<string | undefined>;
+    convertFiltersToQueryString?: (filterFields: Map<string, SerializedFieldType>) => Promise<string | ConvertFiltersToQueryStringResult | undefined>;
     /**
      * Provides the default filter fields to display in the auto-sync UI when advanced search mode is
      * enabled. These fields seed the filter form so the user can refine the query without having to
@@ -152,3 +157,11 @@ export declare const isSupportedAutoSyncGeneratorType: (x: unknown) => x is {} e
     readonly DynamicMatrix: "dynamic matrix";
     readonly Frame: "frame";
 } ? never : "timeline" | "dynamic matrix" | "frame";
+export interface ConvertFiltersToQueryStringResult {
+    queryString?: string | undefined;
+    error?: string | undefined;
+}
+export declare const isConvertFiltersToQueryStringResult: (subject: unknown) => subject is Partial<import("../guards").DestructureGuardedTypeObj<{
+    queryString: typeof isString;
+    error: typeof isString;
+}>>;

package/core/cardintegration/cardintegrationautosyncconfig.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSupportedAutoSyncGeneratorType = exports.SupportedAutoSyncGeneratorType = exports.AutoSyncPaginationSize = void 0;
+exports.isConvertFiltersToQueryStringResult = exports.isSupportedAutoSyncGeneratorType = exports.SupportedAutoSyncGeneratorType = exports.AutoSyncPaginationSize = void 0;
+const checks_1 = require("../checks");
 const validators_1 = require("../validators/validators");
 /**
  * The amount of results that will be displayed per page when using pagination. To enable pagination, define the
@@ -14,3 +15,7 @@ exports.SupportedAutoSyncGeneratorType = {
     Frame: 'frame',
 };
 exports.isSupportedAutoSyncGeneratorType = (0, validators_1.stringEnumValidator)(exports.SupportedAutoSyncGeneratorType);
+exports.isConvertFiltersToQueryStringResult = (0, validators_1.partialObjectValidator)({
+    queryString: checks_1.isString,
+    error: checks_1.isString,
+});

package/core/cardintegration/cardintegrationconfig.d.ts

@@ -32,7 +32,7 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
          */
         readonly fieldDisplaySettings: readonly ["fd", import("../format/format").Format<[string, import("../format/objectformat").ObjectFormatSerializedType<{
             readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
-                readonly displayType: readonly ["getterKey", import("../format/format").Format<"BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField", "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField">];
+                readonly displayType: readonly ["getterKey", import("../format/format").Format<"BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon", "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon">];
                 readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
                 readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
                 readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
@@ -72,8 +72,9 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
                     readonly iswithinpill?: boolean | null | undefined;
                     readonly hasleadingicon?: boolean | null | undefined;
                 } | null | undefined>];
+                readonly inlineRowIndex: readonly ["inlineRowIndex", import("../format/format").Format<number | null | undefined, number | null | undefined>];
             }> | null | undefined, {
-                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
                 readonly backgroundColor?: string | null | undefined;
                 readonly foregroundColor?: string | null | undefined;
                 readonly imageBadgeSettings?: {
@@ -99,10 +100,11 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
                     readonly iswithinpill?: boolean | null | undefined;
                     readonly hasleadingicon?: boolean | null | undefined;
                 } | null | undefined;
+                readonly inlineRowIndex?: number | null | undefined;
             } | null | undefined>];
         }>][] | null | undefined, Map<string, {
             readonly stencilConfig?: {
-                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
                 readonly backgroundColor?: string | null | undefined;
                 readonly foregroundColor?: string | null | undefined;
                 readonly imageBadgeSettings?: {
@@ -128,6 +130,7 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
                     readonly iswithinpill?: boolean | null | undefined;
                     readonly hasleadingicon?: boolean | null | undefined;
                 } | null | undefined;
+                readonly inlineRowIndex?: number | null | undefined;
             } | null | undefined;
         }> | null | undefined>];
         readonly supportsParentCards: readonly ["spc", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
@@ -144,7 +147,7 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
         }> | null | undefined;
         readonly fieldDisplaySettings?: Map<string, {
             readonly stencilConfig?: {
-                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
                 readonly backgroundColor?: string | null | undefined;
                 readonly foregroundColor?: string | null | undefined;
                 readonly imageBadgeSettings?: {
@@ -170,6 +173,7 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
                     readonly iswithinpill?: boolean | null | undefined;
                     readonly hasleadingicon?: boolean | null | undefined;
                 } | null | undefined;
+                readonly inlineRowIndex?: number | null | undefined;
             } | null | undefined;
         }> | null | undefined;
         readonly supportsParentCards?: boolean | null | undefined;
@@ -229,7 +233,7 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
         }> | null | undefined;
         readonly fieldDisplaySettings?: Map<string, {
             readonly stencilConfig?: {
-                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField";
+                readonly displayType: "BasicTextBadge" | "InitializedString" | "StandardEstimation" | "ImageBadge" | "SquareImageBadge" | "TagBadge" | "DateBadge" | "DateRangeBadge" | "UserProfile" | "CustomSingleSelectField" | "CustomTextField" | "InlineIcon";
                 readonly backgroundColor?: string | null | undefined;
                 readonly foregroundColor?: string | null | undefined;
                 readonly imageBadgeSettings?: {
@@ -255,6 +259,7 @@ declare const CardIntegrationConfigFormatter: import("../format/format").Format<
                     readonly iswithinpill?: boolean | null | undefined;
                     readonly hasleadingicon?: boolean | null | undefined;
                 } | null | undefined;
+                readonly inlineRowIndex?: number | null | undefined;
             } | null | undefined;
         }> | null | undefined;
         readonly supportsParentCards?: boolean | null | undefined;

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -432,7 +432,14 @@ class LucidCardIntegrationRegistry {
                     serialized['as']['cftqs'] = LucidCardIntegrationRegistry.nextHookName();
                     client.registerAction(serialized['as']['cftqs'], async ({ 'ff': filterFields }) => {
                         var _a;
-                        return await ((_a = queryStringAutoSync.convertFiltersToQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, new Map(filterFields)));
+                        const result = await ((_a = queryStringAutoSync.convertFiltersToQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, new Map(filterFields)));
+                        if ((0, cardintegrationautosyncconfig_1.isConvertFiltersToQueryStringResult)(result)) {
+                            return {
+                                'qs': result.queryString,
+                                'e': result.error,
+                            };
+                        }
+                        return result;
                     });
                 }
                 if (queryStringAutoSync.getDefaultFilterFields) {

package/dataconnector/dataconnector.js

@@ -135,7 +135,11 @@ class DataConnector {
         }
         catch (e) {
             const errorLogger = console.error ? console.error : console.log;
-            if (e instanceof Error && 'response' in e) {
+            if (e instanceof DataConnectorRequestError) {
+                const statusText = e.statusText ? ` ${e.statusText}` : '';
+                errorLogger(`Error running ${actionName} action: ${e.message} Status: ${e.status}${statusText} body: ${e.response}`);
+            }
+            else if (e instanceof Error && 'response' in e && (0, checks_1.isObject)(e.response) && 'status' in e.response) {
                 const response = e.response;
                 errorLogger(`Error running ${actionName} action Status: ${response.status}`);
             }

package/package.json

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