lucid-extension-sdk 0.0.328 → 0.0.330

package/core/cardintegration/cardintegrationdefinitions.d.ts

@@ -22,6 +22,13 @@ export interface ExtensionCardFieldDefinition extends FieldDefinition {
      * or as a Promise).
      */
     options?: ExtensionCardFieldOption[] | string | undefined;
+    /**
+     * If set, when this field is changed, selections for any of the fields in
+     * this list will be unset.
+     *
+     * This is useful if changing this field invalidates the values of other fields.
+     */
+    unsetFieldsWhenChanged?: string[] | undefined;
     /**
      * If specified, an action that takes the search text and input so far, and
      * returns the list of options that should be displayed. This is useful when
@@ -69,6 +76,7 @@ export type SerializedExtensionCardFieldDefinition = SerializedFieldDefinition &
     'd'?: string | undefined;
     'op'?: SerializedCardFieldOption[] | string | undefined;
     's'?: string | undefined;
+    'u'?: string[] | undefined;
 };
 /** @ignore */
 export declare function serializeCardFieldDefinition(field: ExtensionCardFieldDefinition): SerializedExtensionCardFieldDefinition;
@@ -103,6 +111,7 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
         i: (x: unknown) => x is string | undefined;
     }>[] | undefined;
     s: (x: unknown) => x is string | undefined;
+    u: (x: unknown) => x is string[] | undefined;
 }>;
 /** @ignore */
 export declare function deserializeCardFieldDefinition(field: SerializedExtensionCardFieldDefinition): ExtensionCardFieldDefinition;

package/core/cardintegration/cardintegrationdefinitions.js

@@ -36,7 +36,7 @@ exports.serializeCardFieldOption = serializeCardFieldOption;
 /** @ignore */
 function serializeCardFieldDefinition(field) {
     var _a;
-    return Object.assign(Object.assign({}, (0, schemadefinition_1.serializeFieldDefinition)(field)), { 'l': field.label, 'def': field.default, 'd': field.description, 'op': (0, checks_1.isString)(field.options) ? field.options : (_a = field.options) === null || _a === void 0 ? void 0 : _a.map(serializeCardFieldOption), 's': field.search });
+    return Object.assign(Object.assign({}, (0, schemadefinition_1.serializeFieldDefinition)(field)), { 'l': field.label, 'def': field.default, 'd': field.description, 'op': (0, checks_1.isString)(field.options) ? field.options : (_a = field.options) === null || _a === void 0 ? void 0 : _a.map(serializeCardFieldOption), 's': field.search, 'u': field.unsetFieldsWhenChanged });
 }
 exports.serializeCardFieldDefinition = serializeCardFieldDefinition;
 /** @ignore */
@@ -69,11 +69,12 @@ exports.isSerializedExtensionCardFieldDefinition = (0, validators_1.objectValida
     'def': (0, validators_1.option)(serializedfields_1.isSerializedFieldType),
     'op': (0, validators_1.option)((0, validators_1.either)(checks_1.isString, (0, validators_1.arrayValidator)(exports.isSerializedFieldOption))),
     's': (0, validators_1.option)(checks_1.isString),
+    'u': (0, validators_1.option)((0, checks_1.isTypedArray)(checks_1.isString)),
 });
 /** @ignore */
 function deserializeCardFieldDefinition(field) {
     var _a;
-    return Object.assign(Object.assign({}, (0, schemadefinition_1.parseFieldDefinition)(field)), { label: field['l'], description: field['d'], default: field['def'], options: (0, checks_1.isString)(field['op']) ? field['op'] : (_a = field['op']) === null || _a === void 0 ? void 0 : _a.map(deserializeFieldOption), search: field['s'] });
+    return Object.assign(Object.assign({}, (0, schemadefinition_1.parseFieldDefinition)(field)), { label: field['l'], description: field['d'], default: field['def'], options: (0, checks_1.isString)(field['op']) ? field['op'] : (_a = field['op']) === null || _a === void 0 ? void 0 : _a.map(deserializeFieldOption), search: field['s'], unsetFieldsWhenChanged: field['u'] });
 }
 exports.deserializeCardFieldDefinition = deserializeCardFieldDefinition;
 /** @ignore */

package/core/validators/validators.d.ts

@@ -28,6 +28,12 @@ export declare function rangeValidator(min: number, max: number): (x: unknown) =
  * @return A validator for the array type
  */
 export declare function arrayValidator<T>(subValidator: (p1: unknown) => p1 is T): (p1: unknown) => p1 is T[];
+/**
+ * valid if at least one item in the array is valid.
+ * @param subValidator
+ * @returns
+ */
+export declare function arrayValidatorWithList<T>(subValidator: (p1: unknown) => p1 is T): (p1: unknown, invalidItems?: unknown[]) => p1 is T[];
 /**
  * Creates a validator for a fixed width array where each entry
  * in the array can have a separate validator
@@ -74,7 +80,7 @@ export declare function objectValidator<T extends {
  * which will return all of the fields that were found to be invalid.
  */
 export declare function objectValidatorWithList<T extends {
-    [key: string]: (p1: unknown) => p1 is unknown;
+    [key: string]: (p1: unknown, invalidFields?: unknown[]) => p1 is unknown;
 }>(validatorStructure: T): (subject: unknown, invalidFields?: unknown[]) => subject is DestructureGuardedTypeObj<T>;
 /**
  * Creates a validator which tests if the target is an object

package/core/validators/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isFalse = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullable = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithList = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
+exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isFalse = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullable = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithList = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithList = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
 const checks_1 = require("../checks");
 /*********************************************************************************
  * Validator generators:  These functions construct new composite validators
@@ -64,6 +64,25 @@ function arrayValidator(subValidator) {
     };
 }
 exports.arrayValidator = arrayValidator;
+/**
+ * valid if at least one item in the array is valid.
+ * @param subValidator
+ * @returns
+ */
+function arrayValidatorWithList(subValidator) {
+    return (x, invalidItems) => {
+        if (!(0, checks_1.isArray)(x)) {
+            return false;
+        }
+        for (const element of x) {
+            if (!subValidator(element)) {
+                invalidItems === null || invalidItems === void 0 ? void 0 : invalidItems.push(element);
+            }
+        }
+        return x.some(subValidator);
+    };
+}
+exports.arrayValidatorWithList = arrayValidatorWithList;
 /**
  * Creates a validator for a fixed width array where each entry
  * in the array can have a separate validator
@@ -157,7 +176,7 @@ function objectValidatorWithList(validatorStructure) {
         else {
             let valid = true;
             Object.entries(validatorStructure).forEach(([key, validator]) => {
-                if (!validator(subject[key])) {
+                if (!validator(subject[key], invalidFields)) {
                     if (invalidFields && Array.isArray(invalidFields)) {
                         invalidFields.push(key);
                     }

package/editorclient.d.ts

@@ -1,5 +1,5 @@
 import { CommandArgs, CommandName, HashAlgorithmEnum, TriggerAuthFlowResult, UnionToIntersection } from './commandtypes';
-import { JsonSerializable } from './core/jsonserializable';
+import { JsonObject, JsonSerializable } from './core/jsonserializable';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
 import { BinaryXHRResponse, OAuthXHRRequest, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
 import { CollectionProxy } from './data/collectionproxy';
@@ -20,6 +20,7 @@ export type DataActionResponse = {
     /** The body of the HTTP Response (otherwise) */
     'text': string;
 });
+export declare function getResponseBody(response: DataActionResponse): string | JsonObject;
 export type DataActionOptions = {
     dataConnectorName: string;
     actionName: string;

package/editorclient.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditorClient = void 0;
+exports.EditorClient = exports.getResponseBody = void 0;
 const commandtypes_1 = require("./commandtypes");
 const base64_1 = require("./core/base64");
 const checks_1 = require("./core/checks");
@@ -29,6 +29,18 @@ function parseRawXHRResponse(responseFormat, raw) {
             responseData: (raw === null || raw === void 0 ? void 0 : raw['t']) ? (0, base64_1.decodeBase64)(raw['t']) : new Uint8Array(0),
         }));
 }
+function getResponseBody(response) {
+    if ('json' in response) {
+        return response['json'];
+    }
+    else if ('text' in response) {
+        return response['text'];
+    }
+    else {
+        return '';
+    }
+}
+exports.getResponseBody = getResponseBody;
 class EditorClient {
     getUniqueActionName() {
         while (this.actionExists('a' + this.nextId)) {

package/package.json

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