lucid-extension-sdk 0.0.44 → 0.0.46

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -415,12 +415,18 @@ export declare type CommandArgs = {
 export declare type AddCardIntegrationQuery = {
     /** Title/name */
     'n': string;
+    /** Item label */
+    'il': string;
+    /** Items label */
+    'isl': string;
     /** Icon url */
     'u': string;
     /** Callback to get field definitions for a given imported collection */
     'gf': string;
     /** Show intro if user has not yet authorized this integration */
     'i'?: string;
+    /** Get default config action */
+    'gdc': string;
     /** If specified, import modal settings */
     'im'?: {
         /** Get search fields action */
@@ -430,6 +436,13 @@ export declare type AddCardIntegrationQuery = {
         /** Import action */
         'i': string;
     };
+    /** If specified, add-card settings */
+    'ac'?: {
+        /** Get input fields action */
+        'gif': string;
+        /** Create card action */
+        'cc': string;
+    };
 };
 export declare type AddCardIntegrationResult = undefined;
 export declare type AddLineTextAreaQuery = {
@@ -822,7 +835,8 @@ export declare type PatchDataItemsQuery = {
     /** Primary keys of items to delete */
     'd': string[];
 };
-export declare type PatchDataItemsResult = undefined;
+/** Primary keys inserted, if any */
+export declare type PatchDataItemsResult = string[];
 export declare type RegisterPanelQuery = {
     /** Name of the panel's action for receiving events; generated automatically by Panel base class */
     'n': string;

package/sdk/core/cardintegration/cardintegration.d.ts

@@ -1,36 +1,23 @@
 import { CollectionDefinition } from '../../data/collectiondefinition';
 import { CollectionProxy } from '../../data/collectionproxy';
+import { FieldDefinition } from '../../data/schemadefinition';
 import { isString } from '../checks';
-import { FieldTypeDefinition, SerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
+import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
+import { FieldConstraintType, SerializedFieldDefinition } from '../data/serializedfield/serializedfielddefinition';
 import { isSerializedFieldType, SerializedFieldType } from '../data/serializedfield/serializedfields';
-/**
- * When this field is displayed on a card shape, how should it be displayed?
- */
-export declare enum CardFieldDisplayType {
-    Text = 1,
-    TextBadge = 2,
-    ImageBadge = 3
-}
 /** For fields with Option or ApiOption type, the label and value for each available option */
 export interface ExtensionCardFieldOption {
     label: string;
     value: SerializedFieldType;
 }
-export interface ExtensionCardFieldDefinition {
-    /** Data identifier */
-    fieldName: string;
-    /** The text to display on the menu item */
+export interface ExtensionCardFieldDefinition extends FieldDefinition {
+    /** The label to display in the UI */
     label: string;
-    /** Additional information we can provide to users */
+    /** If defined, the default value for this field */
+    default?: SerializedFieldType;
+    /** Additional information we can provide to users, e.g. as a hover tooltip */
     description?: string;
-    /** Override how a field is displayed */
-    displayType?: CardFieldDisplayType;
-    /**
-     * Override what kind of input to allow the user to edit the value.
-     *   e.g. ScalarFieldTypeEnum.STRING for a text input
-     **/
-    inputType?: FieldTypeDefinition;
-    /** If dataType is Option, the list of options available to choose from */
+    /** If specified, the list of options available to choose from */
     options?: ExtensionCardFieldOption[];
 }
 /** @ignore */
@@ -41,12 +28,10 @@ export declare type SerializedCardFieldOption = {
 /** @ignore */
 export declare function serializeCardFieldOption(option: ExtensionCardFieldOption): SerializedCardFieldOption;
 /** @ignore */
-export declare type SerializedExtensionCardFieldDefinition = {
-    'n': string;
-    't': string;
+export declare type SerializedExtensionCardFieldDefinition = SerializedFieldDefinition & {
+    'l': string;
+    'def'?: SerializedFieldType;
     'd'?: string;
-    'diT'?: CardFieldDisplayType;
-    'daT'?: SerializedFieldTypeDefinition;
     'op'?: SerializedCardFieldOption[];
 };
 /** @ignore */
@@ -63,6 +48,26 @@ export declare const isSerializedFieldOptions: (p1: unknown) => p1 is import("..
     l: typeof isString;
     v: typeof isSerializedFieldType;
 }>[];
+export declare const isSerializedFieldConstraint: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    Type: (x: unknown) => x is FieldConstraintType;
+    Details: (x: unknown) => x is number | undefined;
+}>;
+/** @ignore */
+export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    Name: typeof isString;
+    Type: typeof isSerializedFieldTypeDefinition;
+    Constraints: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+        Type: (x: unknown) => x is FieldConstraintType;
+        Details: (x: unknown) => x is number | undefined;
+    }>[] | undefined;
+    l: typeof isString;
+    d: (x: unknown) => x is string | undefined;
+    def: (x: unknown) => x is SerializedFieldType;
+    op: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+        l: typeof isString;
+        v: typeof isSerializedFieldType;
+    }>[] | undefined;
+}>;
 /** @ignore */
 export declare function deserializeCardFieldDefinition(field: SerializedExtensionCardFieldDefinition): ExtensionCardFieldDefinition;
 /** @ignore */
@@ -92,6 +97,14 @@ export interface CardIntegration {
      * Should be unique within any given extension.
      */
     label: string;
+    /**
+     * Label used to identify one card worth of data, e.g. "Jira task"
+     */
+    itemLabel: string;
+    /**
+     * Label used to identify multiple cards worth of data, e.g. "Jira tasks"
+     */
+    itemsLabel: string;
     /**
      * URL for an icon to display in toolbars, etc. Should be at least 24x24.
      */
@@ -109,6 +122,10 @@ export interface CardIntegration {
      * this should show the user an intro dialog or take some other action.
      */
     showIntro?: () => void;
+    /**
+     * Provide the default configuration for a new import
+     */
+    getDefaultConfig: (collection: CollectionProxy) => Promise<CardIntegrationConfig>;
     /**
      * If specified, allow the user to import cards using the standard card-import modal.
      */
@@ -133,10 +150,27 @@ export interface CardIntegration {
          * The config provided here is only used on the first import from a given source; on subsequent imports,
          * the existing config will remain unchanged to preserve any customizations by the user.
          */
-        import: (primaryKeys: string[]) => Promise<{
+        import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<{
             collection: CollectionProxy;
             primaryKeys: string[];
-            config: CardIntegrationConfig;
+        }>;
+    };
+    /**
+     * If specified, allow the user to create new cards and convert other shapes to cards
+     */
+    addCard?: {
+        /**
+         * Given the values entered by the user so far into input fields, return the list of all input fields
+         * to display in the create-card form.
+         */
+        getInputFields: (inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+        /**
+         * Given the values entered by the user into input fields, create a new data record to represent the
+         * created card, and return information about that record.
+         */
+        createCardData: (input: Map<string, SerializedFieldType>) => Promise<{
+            collection: CollectionProxy;
+            primaryKey: string;
         }>;
     };
 }

package/sdk/core/cardintegration/cardintegration.js

@@ -1,19 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeCardIntegrationConfig = exports.serializeCardIntegrationConfig = exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = exports.CardFieldDisplayType = void 0;
+exports.deserializeCardIntegrationConfig = exports.serializeCardIntegrationConfig = exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldConstraint = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = void 0;
+const schemadefinition_1 = require("../../data/schemadefinition");
 const checks_1 = require("../checks");
 const fieldtypedefinition_1 = require("../data/fieldtypedefinition/fieldtypedefinition");
+const serializedfielddefinition_1 = require("../data/serializedfield/serializedfielddefinition");
 const serializedfields_1 = require("../data/serializedfield/serializedfields");
 const validators_1 = require("../validators/validators");
-/**
- * When this field is displayed on a card shape, how should it be displayed?
- */
-var CardFieldDisplayType;
-(function (CardFieldDisplayType) {
-    CardFieldDisplayType[CardFieldDisplayType["Text"] = 1] = "Text";
-    CardFieldDisplayType[CardFieldDisplayType["TextBadge"] = 2] = "TextBadge";
-    CardFieldDisplayType[CardFieldDisplayType["ImageBadge"] = 3] = "ImageBadge";
-})(CardFieldDisplayType = exports.CardFieldDisplayType || (exports.CardFieldDisplayType = {}));
 /** @ignore */
 function serializeCardFieldOption(option) {
     return {
@@ -25,14 +18,7 @@ exports.serializeCardFieldOption = serializeCardFieldOption;
 /** @ignore */
 function serializeCardFieldDefinition(field) {
     var _a;
-    return {
-        'n': field.fieldName,
-        't': field.label,
-        'd': field.description,
-        'diT': field.displayType,
-        'daT': field.inputType === undefined ? undefined : (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.inputType),
-        'op': (_a = field.options) === null || _a === void 0 ? void 0 : _a.map(serializeCardFieldOption),
-    };
+    return Object.assign(Object.assign({}, (0, schemadefinition_1.serializeFieldDefinition)(field)), { 'l': field.label, 'def': field.default, 'd': field.description, 'op': (_a = field.options) === null || _a === void 0 ? void 0 : _a.map(serializeCardFieldOption) });
 }
 exports.serializeCardFieldDefinition = serializeCardFieldDefinition;
 /** @ignore */
@@ -53,17 +39,24 @@ exports.isSerializedFieldOption = (0, validators_1.objectValidator)({
     'v': serializedfields_1.isSerializedFieldType,
 });
 exports.isSerializedFieldOptions = (0, validators_1.arrayValidator)(exports.isSerializedFieldOption);
+exports.isSerializedFieldConstraint = (0, validators_1.objectValidator)({
+    'Type': (0, validators_1.enumValidator)(serializedfielddefinition_1.FieldConstraintType),
+    'Details': (0, validators_1.option)(checks_1.isNumber),
+});
+/** @ignore */
+exports.isSerializedExtensionCardFieldDefinition = (0, validators_1.objectValidator)({
+    'Name': checks_1.isString,
+    'Type': fieldtypedefinition_1.isSerializedFieldTypeDefinition,
+    'Constraints': (0, validators_1.option)((0, validators_1.arrayValidator)(exports.isSerializedFieldConstraint)),
+    'l': checks_1.isString,
+    'd': (0, validators_1.option)(checks_1.isString),
+    'def': (0, validators_1.option)(serializedfields_1.isSerializedFieldType),
+    'op': (0, validators_1.option)((0, validators_1.arrayValidator)(exports.isSerializedFieldOption)),
+});
 /** @ignore */
 function deserializeCardFieldDefinition(field) {
     var _a;
-    return {
-        fieldName: field['n'],
-        label: field['t'],
-        description: field['d'],
-        displayType: field['diT'],
-        inputType: field['daT'] === undefined ? undefined : (0, fieldtypedefinition_1.deserializeFieldTypeDefinition)(field['daT']),
-        options: (_a = field['op']) === null || _a === void 0 ? void 0 : _a.map(deserializeFieldOption),
-    };
+    return Object.assign(Object.assign({}, (0, schemadefinition_1.parseFieldDefinition)(field)), { label: field['l'], description: field['d'], default: field['def'], options: (_a = field['op']) === null || _a === void 0 ? void 0 : _a.map(deserializeFieldOption) });
 }
 exports.deserializeCardFieldDefinition = deserializeCardFieldDefinition;
 /** @ignore */

package/sdk/core/checks.d.ts

@@ -99,3 +99,14 @@ export declare function isEmptyOrNullishObject(val: unknown): val is {};
 export declare function isAny(val: unknown): val is any;
 export declare function isUnknown(val: unknown): val is unknown;
 export declare function isPromise(val: unknown): val is Promise<unknown>;
+export declare function isLiteral<T extends string | number | symbol>(t: T): (x: unknown) => x is T;
+declare type AbstractConstructor<T> = Function & {
+    prototype: T;
+};
+/**
+ * Since `instanceof` should generally be avoided, this function should generally be avoided as well.
+ *
+ * A valid use case is for native types, like Uint8Array.
+ */
+export declare function isInstanceOf<T>(klass: AbstractConstructor<T>): (x: unknown) => x is T;
+export {};

package/sdk/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isUndefined = exports.isNull = exports.isDef = void 0;
+exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isUndefined = exports.isNull = exports.isDef = void 0;
 /**
  * Returns true if the specified value is not undefined.
  *
@@ -163,3 +163,16 @@ function isPromise(val) {
     return isObject(val) && isFunction(val['then']) && isFunction(val['catch']);
 }
 exports.isPromise = isPromise;
+function isLiteral(t) {
+    return (x) => x === t;
+}
+exports.isLiteral = isLiteral;
+/**
+ * Since `instanceof` should generally be avoided, this function should generally be avoided as well.
+ *
+ * A valid use case is for native types, like Uint8Array.
+ */
+function isInstanceOf(klass) {
+    return (x) => x instanceof klass;
+}
+exports.isInstanceOf = isInstanceOf;

package/sdk/core/xhr.d.ts

@@ -0,0 +1,49 @@
+import { SendXHRResponseFormat } from '../commandtypes';
+import { Validator } from './guards';
+export interface XHRRequest {
+    /** URL to request */
+    url: string;
+    /** HTTP method, e.g. "POST". If omitted, GET is used */
+    method?: string;
+    /** The data to send as the body of the request  */
+    data?: string;
+    /** Headers to send with the request. If specifying an array, multiple headers with the same name will be sent */
+    headers?: {
+        [key: string]: string | string[];
+    };
+    /** If specified, this request should time out after the given number of milliseconds */
+    timeoutMs?: number;
+    /**
+     * The desired format for the returned response body. Defaults to 'utf8'.
+     *
+     * - If 'utf8', the response body will be returned as a string.
+     * - If 'binary', the response body will be returned as a Uint8Array.
+     */
+    responseFormat?: SendXHRResponseFormat;
+}
+export interface BaseXHRResponse {
+    /** URL of the final response, after any redirects */
+    url: string;
+    /** HTTP status, e.g. 200 or 404 */
+    status: number;
+    /** Headers sent by the server in the response */
+    headers: {
+        [key: string]: string;
+    };
+    /** True if this request failed due to a timeout */
+    timeout?: boolean;
+}
+export interface TextXHRResponse extends BaseXHRResponse {
+    responseFormat: 'utf8';
+    /** Plain text of the response body */
+    responseText: string;
+}
+export interface BinaryXHRResponse extends BaseXHRResponse {
+    responseFormat: 'binary';
+    /** Contents of the response body */
+    responseData: Uint8Array;
+}
+export declare type XHRResponse = TextXHRResponse | BinaryXHRResponse;
+export declare const isTextXHRResponse: Validator<TextXHRResponse>;
+export declare const isBinaryXHRResponse: Validator<BinaryXHRResponse>;
+export declare const isXHRResponse: Validator<XHRResponse>;

package/sdk/core/xhr.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isXHRResponse = exports.isBinaryXHRResponse = exports.isTextXHRResponse = void 0;
+const checks_1 = require("./checks");
+const validators_1 = require("./validators/validators");
+const isBaseXHRResponse = (0, validators_1.objectValidator)({
+    url: checks_1.isString,
+    status: checks_1.isNumber,
+    headers: (0, validators_1.objectOfValidator)(checks_1.isString),
+    timeout: (0, validators_1.option)(checks_1.isBoolean),
+});
+exports.isTextXHRResponse = (0, validators_1.both)(isBaseXHRResponse, (0, validators_1.objectValidator)({
+    responseFormat: (0, checks_1.isLiteral)('utf8'),
+    responseText: checks_1.isString,
+}));
+exports.isBinaryXHRResponse = (0, validators_1.both)(isBaseXHRResponse, (0, validators_1.objectValidator)({
+    responseFormat: (0, checks_1.isLiteral)('binary'),
+    responseData: (0, checks_1.isInstanceOf)(Uint8Array),
+}));
+exports.isXHRResponse = (0, validators_1.either)(exports.isTextXHRResponse, exports.isBinaryXHRResponse);

package/sdk/data/collectionproxy.d.ts

@@ -3,6 +3,7 @@ import { MapProxy } from '../document/mapproxy';
 import { PropertyStoreProxy } from '../document/propertystoreproxy';
 import { EditorClient } from '../editorclient';
 import { DataItemProxy } from './dataitemproxy';
+import { SchemaDefinition } from './schemadefinition';
 /**
  * A collection is a set of data items, each with the same set of fields (though some data items may not have all
  * fields defined).
@@ -38,9 +39,10 @@ export declare class CollectionProxy extends PropertyStoreProxy {
         added?: Record<string, SerializedFieldType>[];
         changed?: Map<string, Record<string, SerializedFieldType>>;
         deleted?: string[];
-    }): void;
+    }): import("../commandtypes").PatchDataItemsResult;
     /**
      * @returns an array of field names that are accessible on the items in this collection
      */
     getFields(): string[];
+    getSchema(): SchemaDefinition;
 }

package/sdk/data/collectionproxy.js

@@ -4,6 +4,7 @@ exports.CollectionProxy = void 0;
 const mapproxy_1 = require("../document/mapproxy");
 const propertystoreproxy_1 = require("../document/propertystoreproxy");
 const dataitemproxy_1 = require("./dataitemproxy");
+const schemadefinition_1 = require("./schemadefinition");
 /**
  * A collection is a set of data items, each with the same set of fields (though some data items may not have all
  * fields defined).
@@ -50,7 +51,7 @@ class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
                 changed[primaryKey] = record;
             }
         }
-        this.client.sendCommand("pdi" /* PatchDataItems */, {
+        return this.client.sendCommand("pdi" /* PatchDataItems */, {
             'id': this.id,
             'a': (_a = patch.added) !== null && _a !== void 0 ? _a : [],
             'c': changed,
@@ -63,5 +64,8 @@ class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
     getFields() {
         return this.client.sendCommand("lcf" /* ListCollectionFields */, { 'id': this.id });
     }
+    getSchema() {
+        return (0, schemadefinition_1.parseSchemaDefinition)(this.properties.get('Schema'));
+    }
 }
 exports.CollectionProxy = CollectionProxy;

package/sdk/data/schemadefinition.d.ts

@@ -1,11 +1,38 @@
 import { FieldTypeDefinition } from '../core/data/fieldtypedefinition/fieldtypedefinition';
+import { FieldConstraintType, SerializedFieldConstraint, SerializedFieldDefinition } from '../core/data/serializedfield/serializedfielddefinition';
 import { SerializedSchema } from '../core/data/serializedfield/serializedschema';
+export interface RequiredFieldConstraintDefinition {
+    type: FieldConstraintType.REQUIRED;
+    value?: undefined;
+}
+export interface LockedFieldConstraintDefinition {
+    type: FieldConstraintType.LOCKED;
+    value?: undefined;
+}
+export interface MinValueFieldConstraintDefinition {
+    type: FieldConstraintType.MIN_VALUE;
+    value: number;
+}
+export interface MaxValueFieldConstraintDefinition {
+    type: FieldConstraintType.MAX_VALUE;
+    value: number;
+}
+export interface SingleLineFieldConstraintDefinition {
+    type: FieldConstraintType.SINGLE_LINE_ONLY;
+    value?: undefined;
+}
+export interface NoWhitespaceFieldConstraintDefinition {
+    type: FieldConstraintType.NO_WHITESPACE;
+    value?: undefined;
+}
+export declare type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition;
 /**
  * The definition for a field to be included in a [SchemaDefinition](#interfaces_data_schemadefinition-SchemaDefinition)
  */
 export interface FieldDefinition {
     name: string;
     type: FieldTypeDefinition;
+    constraints?: FieldConstraintDefinition[];
 }
 /**
  * Definition of a schema for creating a [Collection](#classes_data_collectionproxy-CollectionProxy)
@@ -24,6 +51,12 @@ export interface SchemaDefinition {
     fieldLabels?: Record<string, string>;
 }
 /** @ignore */
+export declare function serializeFieldConstraintDefinition(constraint: FieldConstraintDefinition): SerializedFieldConstraint;
+/** @ignore */
+export declare function serializeFieldDefinition(field: FieldDefinition): SerializedFieldDefinition;
+/** @ignore */
 export declare function serializeSchemaDefinition(def: SchemaDefinition): SerializedSchema;
 /** @ignore */
+export declare function parseFieldDefinition(field: SerializedFieldDefinition): FieldDefinition;
+/** @ignore */
 export declare function parseSchemaDefinition(def: SerializedSchema): SchemaDefinition;

package/sdk/data/schemadefinition.js

@@ -1,30 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSchemaDefinition = exports.serializeSchemaDefinition = void 0;
+exports.parseSchemaDefinition = exports.parseFieldDefinition = exports.serializeSchemaDefinition = exports.serializeFieldDefinition = exports.serializeFieldConstraintDefinition = void 0;
+const checks_1 = require("../core/checks");
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
+const serializedfielddefinition_1 = require("../core/data/serializedfield/serializedfielddefinition");
+/** @ignore */
+function serializeFieldConstraintDefinition(constraint) {
+    return {
+        'Type': constraint.type,
+        'Details': constraint.value,
+    };
+}
+exports.serializeFieldConstraintDefinition = serializeFieldConstraintDefinition;
+/** @ignore */
+function serializeFieldDefinition(field) {
+    const serialized = {
+        'Name': field.name,
+        'Type': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type),
+    };
+    if (field.constraints) {
+        serialized['Constraints'] = field.constraints.map(serializeFieldConstraintDefinition);
+    }
+    return serialized;
+}
+exports.serializeFieldDefinition = serializeFieldDefinition;
 /** @ignore */
 function serializeSchemaDefinition(def) {
     return {
-        'Fields': def.fields.map((field) => {
-            return {
-                'Name': field.name,
-                'Type': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type),
-            };
-        }),
+        'Fields': def.fields.map(serializeFieldDefinition),
         'PrimaryKey': def.primaryKey,
         'FieldLabelOverrides': def.fieldLabels,
     };
 }
 exports.serializeSchemaDefinition = serializeSchemaDefinition;
 /** @ignore */
-function parseSchemaDefinition(def) {
+function parseFieldDefinition(field) {
+    var _a;
     return {
-        fields: def['Fields'].map((field) => {
-            return {
-                name: field['Name'],
-                type: (0, fieldtypedefinition_1.deserializeFieldTypeDefinition)(field['Type']),
-            };
+        name: field['Name'],
+        type: (0, fieldtypedefinition_1.deserializeFieldTypeDefinition)(field['Type']),
+        constraints: (_a = field['Constraints']) === null || _a === void 0 ? void 0 : _a.map((constraint) => {
+            switch (constraint['Type']) {
+                case serializedfielddefinition_1.FieldConstraintType.MIN_VALUE:
+                case serializedfielddefinition_1.FieldConstraintType.MAX_VALUE:
+                    if (!(0, checks_1.isNumber)(constraint['Details'])) {
+                        throw new Error('Invalid constraint format');
+                    }
+                    return { type: constraint['Type'], value: constraint['Details'] };
+                case serializedfielddefinition_1.FieldConstraintType.REQUIRED:
+                case serializedfielddefinition_1.FieldConstraintType.LOCKED:
+                case serializedfielddefinition_1.FieldConstraintType.SINGLE_LINE_ONLY:
+                case serializedfielddefinition_1.FieldConstraintType.NO_WHITESPACE:
+                    return { type: constraint['Type'] };
+                default:
+                    throw new Error('Invalid constraint format');
+            }
         }),
+    };
+}
+exports.parseFieldDefinition = parseFieldDefinition;
+/** @ignore */
+function parseSchemaDefinition(def) {
+    return {
+        fields: def['Fields'].map(parseFieldDefinition),
         primaryKey: def['PrimaryKey'],
         fieldLabels: def['FieldLabelOverrides'],
     };

package/sdk/document/taskmanagementcardintegration.js

@@ -23,6 +23,11 @@ class TaskManagementCardIntegration {
             const serializedFields = (0, cardintegration_1.serializeCardFieldArrayDefinition)(fields);
             return serializedFields;
         });
+        const getDefaultConfigActionName = TaskManagementCardIntegration.nextHookName();
+        this.client.registerAction(getDefaultConfigActionName, async (param) => {
+            const collection = new collectionproxy_1.CollectionProxy(param['c'], this.client);
+            return (0, cardintegration_1.serializeCardIntegrationConfig)(await card.getDefaultConfig(collection));
+        });
         let showIntroActionName = undefined;
         if (card.showIntro) {
             showIntroActionName = TaskManagementCardIntegration.nextHookName();
@@ -30,8 +35,11 @@ class TaskManagementCardIntegration {
         }
         const serialized = {
             'n': card.label,
+            'il': card.itemLabel,
+            'isl': card.itemsLabel,
             'u': card.iconUrl,
             'gf': getFieldsActionName,
+            'gdc': getDefaultConfigActionName,
             'i': showIntroActionName,
         };
         if (card.importModal) {
@@ -52,12 +60,29 @@ class TaskManagementCardIntegration {
                     'f': (0, cardintegration_1.serializeCardFieldArrayDefinition)(result.fields),
                 };
             });
-            this.client.registerAction(serialized['im']['i'], async ({ 'pks': primaryKeys }) => {
-                const result = await importModal.import(primaryKeys);
+            this.client.registerAction(serialized['im']['i'], async ({ 'pks': primaryKeys, 's': searchFields }) => {
+                const result = await importModal.import(primaryKeys, new Map(searchFields));
                 return {
                     'c': result.collection.id,
                     'pks': result.primaryKeys,
-                    'cfg': (0, cardintegration_1.serializeCardIntegrationConfig)(result.config),
+                };
+            });
+        }
+        if (card.addCard) {
+            const addCard = card.addCard;
+            serialized['ac'] = {
+                'gif': TaskManagementCardIntegration.nextHookName(),
+                'cc': TaskManagementCardIntegration.nextHookName(),
+            };
+            this.client.registerAction(serialized['ac']['gif'], async ({ 'i': inputSoFar }) => {
+                const result = await addCard.getInputFields(new Map(inputSoFar));
+                return (0, cardintegration_1.serializeCardFieldArrayDefinition)(result);
+            });
+            this.client.registerAction(serialized['ac']['cc'], async ({ 'i': input }) => {
+                const result = await addCard.createCardData(new Map(input));
+                return {
+                    'c': result.collection.id,
+                    'pk': result.primaryKey,
                 };
             });
         }

package/sdk/editorclient.d.ts

@@ -1,6 +1,7 @@
-import { CommandArgs, CommandName, SendXHRResponseFormat, UnionToIntersection } from './commandtypes';
+import { CommandArgs, CommandName, UnionToIntersection } from './commandtypes';
 import { JsonSerializable } from './core/jsonserializable';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
+import { BinaryXHRResponse, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
 import { CollectionProxy } from './data/collectionproxy';
 import { BlockDefinition } from './document/blockdefinition';
 import { BlockProxy } from './document/blockproxy';
@@ -9,50 +10,6 @@ import { GroupProxy } from './document/groupproxy';
 import { LineProxy } from './document/lineproxy';
 import { PageProxy } from './document/pageproxy';
 import { FileUploadData } from './ui/menu';
-export interface XHRRequest {
-    /** URL to request */
-    url: string;
-    /** HTTP method, e.g. "POST". If omitted, GET is used */
-    method?: string;
-    /** The data to send as the body of the request  */
-    data?: string;
-    /** Headers to send with the request. If specifying an array, multiple headers with the same name will be sent */
-    headers?: {
-        [key: string]: string | string[];
-    };
-    /** If specified, this request should time out after the given number of milliseconds */
-    timeoutMs?: number;
-    /**
-     * The desired format for the returned response body. Defaults to 'utf8'.
-     *
-     * - If 'utf8', the response body will be returned as a string.
-     * - If 'binary', the response body will be returned as a Uint8Array.
-     */
-    responseFormat?: SendXHRResponseFormat;
-}
-export interface BaseXHRResponse {
-    /** URL of the final response, after any redirects */
-    url: string;
-    /** HTTP status, e.g. 200 or 404 */
-    status: number;
-    /** Headers sent by the server in the response */
-    headers: {
-        [key: string]: string;
-    };
-    /** True if this request failed due to a timeout */
-    timeout?: boolean;
-}
-export interface TextXHRResponse extends BaseXHRResponse {
-    responseFormat: 'utf8';
-    /** Plain text of the response body */
-    responseText: string;
-}
-export interface BinaryXHRResponse extends BaseXHRResponse {
-    responseFormat: 'binary';
-    /** Contents of the response body */
-    responseData: Uint8Array;
-}
-export declare type XHRResponse = TextXHRResponse | BinaryXHRResponse;
 export declare type DataActionResult = {
     /** The HTTP Status Code from the Extension Data Sync endpoint */
     'status': number;

package/sdk/editorclient.js

@@ -16,7 +16,7 @@ const elementproxy_1 = require("./document/elementproxy");
 const groupproxy_1 = require("./document/groupproxy");
 const lineproxy_1 = require("./document/lineproxy");
 const pageproxy_1 = require("./document/pageproxy");
-const registerunfurlmessage_1 = require("./message/registerunfurlmessage");
+const unfurleventmessage_1 = require("./message/unfurleventmessage");
 function parseRawXHRResponse(responseFormat, raw) {
     var _a, _b, _c, _d;
     return Object.assign({ url: (_a = raw === null || raw === void 0 ? void 0 : raw['url']) !== null && _a !== void 0 ? _a : '', status: (_b = raw === null || raw === void 0 ? void 0 : raw['s']) !== null && _b !== void 0 ? _b : 0, headers: (_c = raw === null || raw === void 0 ? void 0 : raw['h']) !== null && _c !== void 0 ? _c : {}, timeout: raw === null || raw === void 0 ? void 0 : raw['to'] }, (responseFormat === 'utf8'
@@ -207,12 +207,17 @@ class EditorClient {
         const action = this.getUniqueActionName();
         this.registerAction(action, async (rawMsg) => {
             var _a;
-            const msg = (0, registerunfurlmessage_1.deserializeRegisterUnfurlMessage)(rawMsg);
+            const msg = (0, unfurleventmessage_1.deserializeUnfurlEventMessage)(rawMsg);
             switch (msg.unfurlCallbackType) {
                 case unfurlcallbacks_1.UnfurlCallbackType.Unfurl: {
-                    const result = await callbacks.unfurlCallback(msg.url);
-                    if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
-                        return (0, unfurldetails_1.serializeUnfurlDetails)(result);
+                    try {
+                        const result = await callbacks.unfurlCallback(msg.url);
+                        if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
+                            return (0, unfurldetails_1.serializeUnfurlDetails)(result);
+                        }
+                    }
+                    catch (err) {
+                        return unfurlrefresherrortype_1.UnfurlRefreshErrorType.GenericFailure;
                     }
                     break;
                 }

package/sdk/index.d.ts

@@ -5,6 +5,7 @@ export * from './core/offsettype';
 export * from './core/serializeddataerror';
 export * from './core/shapedatainheritance';
 export * from './core/unfurl/unfurldetails';
+export * from './core/xhr';
 export * from './data/collectionproxy';
 export * from './data/dataerror';
 export * from './data/dataitemproxy';

package/sdk/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./core/offsettype"), exports);
 __exportStar(require("./core/serializeddataerror"), exports);
 __exportStar(require("./core/shapedatainheritance"), exports);
 __exportStar(require("./core/unfurl/unfurldetails"), exports);
+__exportStar(require("./core/xhr"), exports);
 __exportStar(require("./data/collectionproxy"), exports);
 __exportStar(require("./data/dataerror"), exports);
 __exportStar(require("./data/dataitemproxy"), exports);

package/sdk/message/unfurleventmessage.d.ts

@@ -0,0 +1,24 @@
+import { JsonObject } from '../core/jsonserializable';
+import { UnfurlCallbackType } from '../core/unfurl/unfurlcallbacks';
+/** @ignore */
+export interface UnfurlEventMessage {
+    /** @ignore */
+    id: string;
+    /** @ignore */
+    url: string;
+    /** @ignore */
+    unfurlCallbackType: UnfurlCallbackType;
+    /** @ignore */
+    blockId?: string;
+}
+/** @ignore */
+export interface SerializedUnfurlEventMessage extends JsonObject {
+    'id': string;
+    'u': string;
+    't': UnfurlCallbackType;
+    'b'?: string;
+}
+/** @ignore */
+export declare function deserializeUnfurlEventMessage(raw: SerializedUnfurlEventMessage): UnfurlEventMessage;
+/** @ignore */
+export declare function serializeUnfurlEventMessage(concrete: UnfurlEventMessage): SerializedUnfurlEventMessage;

package/sdk/message/unfurleventmessage.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeUnfurlEventMessage = exports.deserializeUnfurlEventMessage = void 0;
+/** @ignore */
+function deserializeUnfurlEventMessage(raw) {
+    return {
+        id: raw['id'],
+        url: raw['u'],
+        unfurlCallbackType: raw['t'],
+        blockId: raw['b'],
+    };
+}
+exports.deserializeUnfurlEventMessage = deserializeUnfurlEventMessage;
+/** @ignore */
+function serializeUnfurlEventMessage(concrete) {
+    return {
+        'id': concrete.id,
+        'u': concrete.url,
+        't': concrete.unfurlCallbackType,
+        'b': concrete.blockId,
+    };
+}
+exports.serializeUnfurlEventMessage = serializeUnfurlEventMessage;

package/sdk/message/registerunfurlmessage.d.ts

@@ -1,32 +0,0 @@
-import { JsonObject } from '../../lucid-extension-sdk';
-import { isString } from '../core/checks';
-import { UnfurlCallbackType } from '../core/unfurl/unfurlcallbacks';
-/** @ignore */
-export interface RegisterUnfurlMessage {
-    /** @ignore */
-    id: string;
-    /** @ignore */
-    url: string;
-    /** @ignore */
-    unfurlCallbackType: UnfurlCallbackType;
-    /** @ignore */
-    blockId?: string;
-}
-/** @ignore */
-export interface SerializedRegisterUnfurlMessage extends JsonObject {
-    'id': string;
-    'u': string;
-    't': UnfurlCallbackType;
-    'b'?: string;
-}
-/** @ignore */
-export declare const isValidRegisterUnfurlMessage: (subject: unknown) => subject is import("../core/guards").DestructureGuardedTypeObj<{
-    id: typeof isString;
-    u: typeof isString;
-    t: (x: unknown) => x is UnfurlCallbackType;
-    b: (x: unknown) => x is string | undefined;
-}>;
-/** @ignore */
-export declare function deserializeRegisterUnfurlMessage(raw: SerializedRegisterUnfurlMessage): RegisterUnfurlMessage;
-/** @ignore */
-export declare function serializeRegisterUnfurlMessage(concrete: RegisterUnfurlMessage): SerializedRegisterUnfurlMessage;

package/sdk/message/registerunfurlmessage.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeRegisterUnfurlMessage = exports.deserializeRegisterUnfurlMessage = exports.isValidRegisterUnfurlMessage = void 0;
-const checks_1 = require("../core/checks");
-const unfurlcallbacks_1 = require("../core/unfurl/unfurlcallbacks");
-const validators_1 = require("../core/validators/validators");
-/** @ignore */
-exports.isValidRegisterUnfurlMessage = (0, validators_1.objectValidator)({
-    'id': checks_1.isString,
-    'u': checks_1.isString,
-    't': (0, validators_1.stringEnumValidator)(unfurlcallbacks_1.UnfurlCallbackType),
-    'b': (0, validators_1.option)(checks_1.isString),
-});
-/** @ignore */
-function deserializeRegisterUnfurlMessage(raw) {
-    return {
-        id: raw['id'],
-        url: raw['u'],
-        unfurlCallbackType: raw['t'],
-        blockId: raw['b'],
-    };
-}
-exports.deserializeRegisterUnfurlMessage = deserializeRegisterUnfurlMessage;
-/** @ignore */
-function serializeRegisterUnfurlMessage(concrete) {
-    return {
-        'id': concrete.id,
-        'u': concrete.url,
-        't': concrete.unfurlCallbackType,
-        'b': concrete.blockId,
-    };
-}
-exports.serializeRegisterUnfurlMessage = serializeRegisterUnfurlMessage;