lucid-extension-sdk 1.1.0 → 1.1.2

package/commandtypes.d.ts

@@ -90,6 +90,8 @@ export declare const CommandName: {
     readonly GetLLMContextFromItems: "llm";
     readonly GetOAuthClientId: "goci";
     readonly GetOAuthToken: "got";
+    readonly ClearOAuthToken: "cot";
+    readonly RevokeOAuthToken: "rot";
     readonly GetPackageSettings: "gps";
     readonly GetProduct: "gpr";
     readonly GetProperty: "gp";
@@ -430,6 +432,14 @@ export type CommandArgs = {
         query: GetOAuthTokenQuery;
         result: GetOAuthTokenResult;
     };
+    [CommandName.ClearOAuthToken]: {
+        query: ClearOAuthTokenQuery;
+        result: ClearOAuthTokenResult;
+    };
+    [CommandName.RevokeOAuthToken]: {
+        query: RevokeOAuthTokenQuery;
+        result: RevokeOAuthTokenResult;
+    };
     [CommandName.GetPackageSettings]: {
         query: GetPackageSettingsQuery;
         result: GetPackageSettingsResult;
@@ -838,6 +848,8 @@ export type AutoSyncSettings = {
         'rnml': string;
         /**no matched label */
         'nml': string;
+        /**empty state label */
+        'esl'?: string | undefined;
         /**syncing growl message*/
         'sgm'?: string | undefined;
         /**removing growl message */
@@ -846,6 +858,12 @@ export type AutoSyncSettings = {
     'gsf': string;
     'sqs'?: string | undefined;
     'syqs'?: string | undefined;
+    /** getDefaultFilterFields action ID - field-only config */
+    'gdf'?: string | undefined;
+    /** searchFields action ID - field-only config */
+    'sf'?: string | undefined;
+    /** syncFields action ID - field-only config */
+    'syf'?: string | undefined;
     /** If specified, setup fields that allow user to create query template that auto applies to dynamic tables when created*/
     'dpf'?: {
         /** Get search fields action */
@@ -854,6 +872,8 @@ export type AutoSyncSettings = {
         'gpv': string;
     } | undefined;
     'cftqs'?: string | undefined;
+    /** Get default filter fields action */
+    'gdff'?: string | undefined;
 };
 export type SerializedFieldConfiguration = {
     /** Callback to get field definitions for all fields supported by the card integration */
@@ -1592,6 +1612,16 @@ export type GetOAuthTokenQuery = {
     'p': string;
 };
 export type GetOAuthTokenResult = Promise<string | undefined>;
+export type ClearOAuthTokenQuery = {
+    /** OAuth provider name as specified in the package manifest */
+    'p': string;
+};
+export type ClearOAuthTokenResult = Promise<boolean>;
+export type RevokeOAuthTokenQuery = {
+    /** OAuth provider name as specified in the package manifest */
+    'p': string;
+};
+export type RevokeOAuthTokenResult = Promise<boolean>;
 export type GetProductQuery = undefined;
 export type GetProductResult = LucidProduct;
 export type GetOAuthClientIdQuery = {

package/commandtypes.js

@@ -78,6 +78,8 @@ exports.CommandName = {
     GetLLMContextFromItems: 'llm',
     GetOAuthClientId: 'goci',
     GetOAuthToken: 'got',
+    ClearOAuthToken: 'cot',
+    RevokeOAuthToken: 'rot',
     GetPackageSettings: 'gps',
     GetProduct: 'gpr',
     GetProperty: 'gp',
@@ -214,6 +216,8 @@ exports.commandTitles = new Map([
     [exports.CommandName.GetLLMContextFromItems, 'GetLLMContextFromItems'],
     [exports.CommandName.GetOAuthClientId, 'GetOAuthClientId'],
     [exports.CommandName.GetOAuthToken, 'GetOAuthToken'],
+    [exports.CommandName.ClearOAuthToken, 'ClearOAuthToken'],
+    [exports.CommandName.RevokeOAuthToken, 'RevokeOAuthToken'],
     [exports.CommandName.GetPackageSettings, 'GetPackageSettings'],
     [exports.CommandName.GetProduct, 'GetProduct'],
     [exports.CommandName.GetProperty, 'GetProperty'],

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';
@@ -8,10 +9,10 @@ import type { DocumentPresetSetupFields } from './lucidcardintegrationpresetsetu
  */
 export declare const AutoSyncPaginationSize = 50;
 /**
- * This config defines variables and methods required to implement query sync for various container objects in Lucid
- * (e.g. timelines).
+ * Base config shared by all auto sync config types. Contains fields common to both query-based and
+ * field-only sync configurations.
  */
-export interface CardIntegrationAutoSyncConfig {
+export interface BaseCardIntegrationAutoSyncConfig {
     /**
      * @deprecated Use AutoSyncConfigPhrasesType instead.
      */
@@ -28,6 +29,21 @@ export interface CardIntegrationAutoSyncConfig {
      * with a single ExtensionCardFieldOption in ExtensionCardField.options
      */
     getSyncDataSourceIdField: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+    /**
+     * @experimental
+     * Document preset setup configuration for this card integration's auto sync.
+     *
+     * When specified, this enables your card integration to participate in Lucid's document preset
+     * system, which allows users to configure dynamic matrix templates that automatically populate new
+     * documents with cards from your integration.
+     */
+    documentPresetSetupFields?: DocumentPresetSetupFields | undefined;
+}
+/**
+ * Auto sync config for query-string-based sync. Users enter a query string (e.g. JQL) to filter
+ * which items are synced.
+ */
+export interface QueryStringCardIntegrationAutoSyncConfig extends BaseCardIntegrationAutoSyncConfig {
     /**
      * Perform a search on the query string. This should support pagination (See {@link AutoSyncPaginationSize}).
      *
@@ -40,24 +56,61 @@ export interface CardIntegrationAutoSyncConfig {
      * @returns the ImportResult for the query string.
      */
     syncQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
-    /**
-     * @experimental
-     * Document preset setup configuration for this card integration's auto sync.
-     *
-     * When specified, this enables your card integration to participate in Lucid's document preset
-     * system, which allows users to configure dynamic matrix templates that automatically populate new
-     * documents with cards from your integration.
-     */
-    documentPresetSetupFields?: DocumentPresetSetupFields | undefined;
     /**
      * Convert current filter selections to a query string. This is used to auto-fill the search bar
      * 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
+     * type a raw query string.
+     *
+     * @param searchSoFar The fields the user has populated so far (e.g. the selected data source id)
+     * @returns The filter fields to render
+     */
+    getDefaultFilterFields?: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+}
+/**
+ * @experimental
+ * Auto sync config for field-only sync. Users select values for structured filter fields rather
+ * than entering a free-form query string.
+ */
+export interface FieldOnlyCardIntegrationAutoSyncConfig extends BaseCardIntegrationAutoSyncConfig {
+    /**
+     * Returns the filter field definitions available for the user to configure. Called whenever the
+     * current field selections change, allowing fields to be dynamically updated based on prior selections.
+     *
+     * @param searchSoFar The filter field values selected so far
+     * @returns the field definitions to display for filtering
+     */
+    getDefaultFilterFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+    /**
+     * Perform a search using the selected filter field values. This should support pagination
+     * (See {@link AutoSyncPaginationSize}).
+     *
+     * The syncDataSourceIdNonce is provided in instanceFields
+     * @param pageNumber If undefined, will return all results from the search
+     * @returns the search results after filtering using the given field values.
+     */
+    searchFields: (fields: Map<string, SerializedFieldType>, instanceFields: Map<string, SerializedFieldType>, pageNumber: number | undefined, nextPageToken: string | undefined) => Promise<SearchResult>;
+    /**
+     * @returns the ImportResult for the selected filter field values.
+     */
+    syncFields: (fields: Map<string, SerializedFieldType>, instanceFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
 }
+/**
+ * Union of all supported auto sync config types. Use {@link QueryStringCardIntegrationAutoSyncConfig}
+ * for query-string-based sync or {@link FieldOnlyCardIntegrationAutoSyncConfig} for field-based sync.
+ */
+export type CardIntegrationAutoSyncConfig = QueryStringCardIntegrationAutoSyncConfig | FieldOnlyCardIntegrationAutoSyncConfig;
 export interface AutoSyncConfigPhrasesType {
     /**
      * The header to display for the integration in the autosync modal.
@@ -79,6 +132,11 @@ export interface AutoSyncConfigPhrasesType {
      * The string to display when there are no matched items. For example, the Jira integration displays "No issues matched your search query"
      */
     noMatchedLabel: string;
+    /**
+     * The string to display in the empty state placeholder before any search has been executed. For example, the Jira
+     * integration displays "Input a query or set filters to search for Jira issues".
+     */
+    emptyStateLabel?: string | undefined;
     /**
      * If defined, A growl would show up with the string when the cards are syncing / importing into generators. For example, the Jira integration displays "Syncing 1 issue" or "Syncing 5 issues"
      */
@@ -99,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/cardintegrationparams.d.ts

@@ -36,10 +36,26 @@ export interface QuerySyncParam {
     'of': [string, SerializedFieldType][];
 }
 /** @ignore */
+export interface FieldSearchParam {
+    'f': [string, SerializedFieldType][];
+    'if': [string, SerializedFieldType][];
+    'pn': number | undefined;
+    'npt': string | undefined;
+}
+/** @ignore */
+export interface FieldSyncParam {
+    'f': [string, SerializedFieldType][];
+    'if': [string, SerializedFieldType][];
+}
+/** @ignore */
 export interface ConvertFiltersToQueryStringParam {
     'ff': [string, SerializedFieldType][];
 }
 /** @ignore */
+export interface GetDefaultFilterFieldsParam {
+    's': [string, SerializedFieldType][];
+}
+/** @ignore */
 export interface QuerySyncRemoveNonMatchingLabelParam {
     'g': string;
 }

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -347,6 +347,7 @@ class LucidCardIntegrationRegistry {
                     'qph': autoSync.phrases.queryPlaceholder,
                     'rnml': LucidCardIntegrationRegistry.nextHookName(),
                     'nml': autoSync.phrases.noMatchedLabel,
+                    'esl': autoSync.phrases.emptyStateLabel,
                 };
                 client.registerAction(serialized['as']['p']['rnml'], ({ 'g': inputSoFar }) => {
                     var _a;
@@ -374,11 +375,16 @@ class LucidCardIntegrationRegistry {
                 const result = await autoSync.getSyncDataSourceIdField(new Map(inputSoFar));
                 return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
             });
-            if (autoSync.searchQueryString) {
-                serialized['as']['sqs'] = LucidCardIntegrationRegistry.nextHookName();
-                client.registerAction(serialized['as']['sqs'], async ({ 'qs': queryString, 'of': otherFields, 'pn': pageNumber, 'npt': nextPageToken, }) => {
-                    var _a;
-                    const result = await ((_a = autoSync.searchQueryString) === null || _a === void 0 ? void 0 : _a.call(autoSync, queryString, new Map(otherFields), pageNumber, nextPageToken));
+            if ('searchFields' in autoSync) {
+                const fieldOnlyAutoSync = autoSync;
+                serialized['as']['gdf'] = LucidCardIntegrationRegistry.nextHookName();
+                client.registerAction(serialized['as']['gdf'], async ({ 'i': inputSoFar }) => {
+                    const result = await fieldOnlyAutoSync.getDefaultFilterFields(new Map(inputSoFar));
+                    return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
+                });
+                serialized['as']['sf'] = LucidCardIntegrationRegistry.nextHookName();
+                client.registerAction(serialized['as']['sf'], async ({ 'f': fields, 'if': instanceFields, 'pn': pageNumber, 'npt': nextPageToken, }) => {
+                    const result = await fieldOnlyAutoSync.searchFields(new Map(fields), new Map(instanceFields), pageNumber, nextPageToken);
                     if (result) {
                         return this.serializeSearchResult(result);
                     }
@@ -389,15 +395,62 @@ 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 : [];
+                serialized['as']['syf'] = LucidCardIntegrationRegistry.nextHookName();
+                client.registerAction(serialized['as']['syf'], async ({ 'f': fields, 'if': instanceFields }) => {
+                    var _a;
+                    const result = (_a = (await fieldOnlyAutoSync.syncFields(new Map(fields), new Map(instanceFields)))) !== null && _a !== void 0 ? _a : [];
                     return LucidCardIntegrationRegistry.serializeImportResults(result);
                 });
             }
+            else {
+                const queryStringAutoSync = autoSync;
+                if (queryStringAutoSync.searchQueryString) {
+                    serialized['as']['sqs'] = LucidCardIntegrationRegistry.nextHookName();
+                    client.registerAction(serialized['as']['sqs'], async ({ 'qs': queryString, 'of': otherFields, 'pn': pageNumber, 'npt': nextPageToken, }) => {
+                        var _a;
+                        const result = await ((_a = queryStringAutoSync.searchQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, queryString, new Map(otherFields), pageNumber, nextPageToken));
+                        if (result) {
+                            return this.serializeSearchResult(result);
+                        }
+                        else {
+                            return this.serializeSearchResult({
+                                searchResults: [],
+                                error: 'Unknown Error Occurred',
+                            });
+                        }
+                    });
+                }
+                if (queryStringAutoSync.syncQueryString) {
+                    serialized['as']['syqs'] = LucidCardIntegrationRegistry.nextHookName();
+                    client.registerAction(serialized['as']['syqs'], async ({ 'qs': queryString, 'of': otherFields }) => {
+                        var _a, _b;
+                        const result = (_b = (await ((_a = queryStringAutoSync.syncQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, queryString, new Map(otherFields))))) !== null && _b !== void 0 ? _b : [];
+                        return LucidCardIntegrationRegistry.serializeImportResults(result);
+                    });
+                }
+                if (queryStringAutoSync.convertFiltersToQueryString) {
+                    serialized['as']['cftqs'] = LucidCardIntegrationRegistry.nextHookName();
+                    client.registerAction(serialized['as']['cftqs'], async ({ 'ff': filterFields }) => {
+                        var _a;
+                        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) {
+                    serialized['as']['gdff'] = LucidCardIntegrationRegistry.nextHookName();
+                    client.registerAction(serialized['as']['gdff'], async ({ 's': searchSoFar }) => {
+                        var _a, _b;
+                        const result = (_b = (await ((_a = queryStringAutoSync.getDefaultFilterFields) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, new Map(searchSoFar))))) !== null && _b !== void 0 ? _b : [];
+                        return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
+                    });
+                }
+            }
             if (autoSync.documentPresetSetupFields) {
                 const documentPresetSetupFields = autoSync.documentPresetSetupFields;
                 serialized['as']['dpf'] = {
@@ -417,13 +470,6 @@ class LucidCardIntegrationRegistry {
                     };
                 });
             }
-            if (autoSync.convertFiltersToQueryString) {
-                serialized['as']['cftqs'] = LucidCardIntegrationRegistry.nextHookName();
-                client.registerAction(serialized['as']['cftqs'], async ({ 'ff': filterFields }) => {
-                    var _a;
-                    return await ((_a = autoSync.convertFiltersToQueryString) === null || _a === void 0 ? void 0 : _a.call(autoSync, new Map(filterFields)));
-                });
-            }
         }
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {

package/core/checks.d.ts

@@ -124,6 +124,13 @@ export declare function isTypedArray<T>(typeGuard: (a: unknown) => a is T): (val
  * @returns Whether variable is an array of defined and not null elements.
  */
 export declare function isDefinedArray<T>(val: (T | undefined | null)[]): val is T[];
+/**
+ * Returns true if the specified value is an array with the same length as the provided type guards, and each element
+ * passes the type guard at the same index in guards.
+ */
+export declare function isTypedTuple<const Tuple extends readonly unknown[]>(guards: {
+    [K in keyof Tuple]: (a: unknown) => a is Tuple[K];
+}): (val: unknown) => val is Tuple;
 /**
  * Returns true if the specified value is a map.
  *

package/core/checks.js

@@ -19,6 +19,7 @@ exports.isRecord = isRecord;
 exports.isArray = isArray;
 exports.isTypedArray = isTypedArray;
 exports.isDefinedArray = isDefinedArray;
+exports.isTypedTuple = isTypedTuple;
 exports.isMap = isMap;
 exports.isExactLength = isExactLength;
 exports.isAtLeastLength = isAtLeastLength;
@@ -196,6 +197,15 @@ function isTypedArray(typeGuard) {
 function isDefinedArray(val) {
     return isArray(val) && val.every(isDefAndNotNull);
 }
+/**
+ * Returns true if the specified value is an array with the same length as the provided type guards, and each element
+ * passes the type guard at the same index in guards.
+ */
+function isTypedTuple(guards) {
+    return function (val) {
+        return isArray(val) && val.length == guards.length && guards.every((guard, i) => guard(val[i]));
+    };
+}
 /**
  * Returns true if the specified value is a map.
  *

package/core/format/tupleformat.d.ts

@@ -0,0 +1,10 @@
+import { Format } from './format';
+import { FormatInput, FormatOutput } from './simpleformat';
+type Raw<Formats extends readonly Format<any, any>[]> = {
+    [K in keyof Formats]: FormatInput<Formats[K]>;
+};
+type Tuple<Formats extends readonly Format<any, any>[]> = {
+    [K in keyof Formats]: FormatOutput<Formats[K]>;
+};
+export declare function TupleFormat<const T extends readonly Format<any, any>[]>(formats: T): Format<Raw<T>, Tuple<T>>;
+export {};

package/core/format/tupleformat.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TupleFormat = TupleFormat;
+const checks_1 = require("../checks");
+const primitivedata_1 = require("../primitivedata");
+const format_1 = require("./format");
+function TupleFormat(formats) {
+    return new format_1.Format((tuple) => tuple.map((x, i) => formats[i].fromJson(x)), (tuple) => tuple.map((x, i) => formats[i].toJson(x)), (0, checks_1.isTypedTuple)(formats.map((f) => f.validator)), (0, primitivedata_1.generateTuple)(formats.map((f) => f.generator)));
+}

package/core/iterable.d.ts

@@ -17,6 +17,6 @@ export declare function mergeGenerators<T>(...generatorFunctions: (() => Iterabl
  */
 export declare function zipHoldShorter<T extends {
     [key: string]: Iterable<unknown>;
-}>(obj: T): Iterable<{
+} | Iterable<unknown>[]>(obj: T): Iterable<{
     [key in keyof T]-?: T[key] extends Iterable<infer U> ? U : never;
 }>;

package/core/iterable.js

@@ -29,6 +29,7 @@ function mergeGenerators(...generatorFunctions) {
  * Assumes that no iterables are empty
  */
 function* zipHoldShorter(obj) {
+    const array = Array.isArray(obj);
     const unheldKeys = new Set(Object.keys(obj));
     const iterators = {};
     for (const key of unheldKeys) {
@@ -39,13 +40,16 @@ function* zipHoldShorter(obj) {
         }
         iterators[key] = value[Symbol.iterator]();
     }
-    const heldValues = {};
-    let previous = {};
+    const heldValues = array ? [] : {};
+    let previous = array ? [] : {};
     while (unheldKeys.size > 0) {
-        const zipped = Object.assign({}, heldValues);
+        const zipped = array ? [...heldValues] : Object.assign({}, heldValues);
         for (const key of unheldKeys) {
             const result = iterators[key].next();
             if (result.done) {
+                // if obj is an array, heldValues will likely be a sparse array
+                // splatting a sparse array creates a dense array, so zipped will never be sparse
+                // thus the sparse array never escapes this function
                 heldValues[key] = previous[key];
                 unheldKeys.delete(key);
                 zipped[key] = heldValues[key];

package/core/primitivedata.d.ts

@@ -29,6 +29,10 @@ export declare function generateUnknown(): Iterable<unknown>;
 /** @see {generateData} */
 export declare function generateArray<T>(dataGenerator: () => Iterable<T>): () => Iterable<T[]>;
 /** @see {generateData} */
+export declare function generateTuple<const Tuple extends readonly unknown[]>(generators: {
+    [K in keyof Tuple]: () => Iterable<Tuple[K]>;
+}): () => Iterable<Tuple>;
+/** @see {generateData} */
 export declare function generateNull(): Iterable<null>;
 /** @see {generateData} */
 export declare function generateUndefined(): Iterable<undefined>;

package/core/primitivedata.js

@@ -13,6 +13,7 @@ exports.generateUrlStrings = generateUrlStrings;
 exports.generateBooleans = generateBooleans;
 exports.generateUnknown = generateUnknown;
 exports.generateArray = generateArray;
+exports.generateTuple = generateTuple;
 exports.generateNull = generateNull;
 exports.generateUndefined = generateUndefined;
 exports.generateVoid = generateVoid;
@@ -89,6 +90,13 @@ function generateArray(dataGenerator) {
     };
 }
 /** @see {generateData} */
+function generateTuple(generators) {
+    return function () {
+        const gs = generators.map((g) => g());
+        return (0, iterable_1.zipHoldShorter)(gs);
+    };
+}
+/** @see {generateData} */
 function generateNull() {
     return [null];
 }

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/editorclient.d.ts

@@ -183,6 +183,25 @@ export declare class EditorClient {
      * @returns An oauth token, or undefined if a valid token cannot be obtained
      */
     getOAuthToken(providerName: string): Promise<string | undefined>;
+    /**
+     * Clear the cached OAuth token for a provider, removing it from Lucid's storage without
+     * revoking it at the external provider. After clearing, the next call to getOAuthToken will
+     * re-prompt the user for authorization.
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns true if the token was cleared successfully
+     */
+    clearOAuthToken(providerName: string): Promise<boolean>;
+    /**
+     * Revoke the OAuth token at the external provider's revocation endpoint (if configured in the
+     * package manifest via revokeTokenUrl), then remove it from Lucid's storage. If revocation at
+     * the external provider fails, the token is preserved and this method returns false so you can
+     * retry.
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns true if the token was revoked and cleared successfully, false if external revocation failed
+     */
+    revokeOAuthToken(providerName: string): Promise<boolean>;
     /**
      * Fetch the OAuth Client Id if there is one
      *

package/editorclient.js

@@ -260,6 +260,29 @@ class EditorClient {
     async getOAuthToken(providerName) {
         return await this.sendCommand(commandtypes_1.CommandName.GetOAuthToken, { 'p': providerName });
     }
+    /**
+     * Clear the cached OAuth token for a provider, removing it from Lucid's storage without
+     * revoking it at the external provider. After clearing, the next call to getOAuthToken will
+     * re-prompt the user for authorization.
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns true if the token was cleared successfully
+     */
+    async clearOAuthToken(providerName) {
+        return await this.sendCommand(commandtypes_1.CommandName.ClearOAuthToken, { 'p': providerName });
+    }
+    /**
+     * Revoke the OAuth token at the external provider's revocation endpoint (if configured in the
+     * package manifest via revokeTokenUrl), then remove it from Lucid's storage. If revocation at
+     * the external provider fails, the token is preserved and this method returns false so you can
+     * retry.
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns true if the token was revoked and cleared successfully, false if external revocation failed
+     */
+    async revokeOAuthToken(providerName) {
+        return await this.sendCommand(commandtypes_1.CommandName.RevokeOAuthToken, { 'p': providerName });
+    }
     /**
      * Fetch the OAuth Client Id if there is one
      *

package/package.json

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