lucid-extension-sdk 0.0.374 → 0.0.376

package/core/data/fieldspecification.d.ts

@@ -1,5 +1,6 @@
 import { FieldConstraintDefinition } from '../../data/schemadefinition';
 import { CollectionEnumFieldType } from './fieldtypedefinition/collectionenumfieldtype';
+import { DeserializedMapEnumFieldType } from './fieldtypedefinition/deserializedmapenumfieldtype';
 import { FieldTypeArray } from './fieldtypedefinition/fieldtypearray';
 import { FieldTypeDefinition } from './fieldtypedefinition/fieldtypedefinition';
 import { LucidFields } from './fieldtypedefinition/lucidfields';
@@ -9,7 +10,7 @@ import { SemanticKind } from './fieldtypedefinition/semantickind';
 import { SerializedColorObject, SerializedLucidCurrency, SerializedLucidDateObject, SerializedLucidDictionary } from './serializedfield/serializedfields';
 type TsTypeOf<X> = X extends ScalarFieldTypeEnum.ANY ? unknown : X extends ScalarFieldTypeEnum.NUMBER ? number : X extends ScalarFieldTypeEnum.BOOLEAN ? boolean : X extends ScalarFieldTypeEnum.STRING ? string : X extends ScalarFieldTypeEnum.COLOR ? SerializedColorObject : X extends ScalarFieldTypeEnum.DATE ? SerializedLucidDateObject : X extends ScalarFieldTypeEnum.NULL ? null : X extends ScalarFieldTypeEnum.DICTIONARY ? SerializedLucidDictionary : X extends FieldTypeArray<infer Inner> ? TsTypeOf<Inner>[] : X extends ScalarFieldTypeEnum.CURRENCY ? SerializedLucidCurrency : X extends ScalarFieldTypeEnum.DATEONLY ? SerializedLucidDateObject & {
     isDateOnly: true;
-} : X extends CollectionEnumFieldType ? string : X extends readonly [infer Inner, ...infer Others] ? TsTypeOf<Inner> | TsTypeOf<Others> : never;
+} : X extends CollectionEnumFieldType ? string : X extends DeserializedMapEnumFieldType ? string : X extends readonly [infer Inner, ...infer Others] ? TsTypeOf<Inner> | TsTypeOf<Others> : never;
 /**
  * Specifies all the fields that this itegration will be sending to the data-sync service.
  * Give you well typed methods to convert from `YourType[]` to `{[PrimaryKey:string]: YourType}`

package/dataconnector/datasourceupdatetypes.d.ts

@@ -11,7 +11,7 @@ import { SerializedFields, SerializedLucidDictionary } from '../core/data/serial
 import { SerializedLabelOverrides } from '../core/data/serializedfield/serializedschema';
 import { JsonSerializable } from '../core/jsonserializable';
 import { DataUpdateFilterType } from '../data/dataupdatefiltertype';
-import { FieldDefinition, SchemaDefinition } from '../data/schemadefinition';
+import { FieldConstraintDefinition, FieldDefinition, SchemaDefinition } from '../data/schemadefinition';
 /**
  * Container for an update to a data source
  */
@@ -32,7 +32,7 @@ export type DataSourceRequest = {
     /** The level of permission the request has to create data */
     creationPermission?: UpdateCreationPermission;
 };
-type SerializedFieldConstraintForApi = {
+export type SerializedFieldConstraintForApi = {
     'type': FieldConstraintType;
     'details'?: JsonSerializable;
 };
@@ -66,6 +66,7 @@ export declare class ItemsPatchInexhaustive {
     /** Items to remove from the collection, based on the same primary key algorithm. */
     itemsDeleted?: string[] | undefined;
     errors?: Map<string, SerializedLucidDictionary> | undefined;
+    fieldConstraintsPerItem?: Map<string, Map<string, FieldConstraintDefinition[]>> | undefined;
     private readonly _brand;
     constructor(
     /**
@@ -74,15 +75,16 @@ export declare class ItemsPatchInexhaustive {
      **/
     items: Map<string, SerializedFields>, 
     /** Items to remove from the collection, based on the same primary key algorithm. */
-    itemsDeleted?: string[] | undefined, errors?: Map<string, SerializedLucidDictionary> | undefined);
+    itemsDeleted?: string[] | undefined, errors?: Map<string, SerializedLucidDictionary> | undefined, fieldConstraintsPerItem?: Map<string, Map<string, FieldConstraintDefinition[]>> | undefined);
 }
 export declare class ItemsPatchExhaustive {
     items: Map<string, SerializedFields>;
     rekeyingMap?: Map<string, string | null> | undefined;
     fieldNamesChanged?: Map<string, string | null> | undefined;
     errors?: Map<string, SerializedLucidDictionary> | undefined;
+    fieldConstraintsPerItem?: Map<string, Map<string, FieldConstraintDefinition[]>> | undefined;
     private readonly _brand;
-    constructor(items: Map<string, SerializedFields>, rekeyingMap?: Map<string, string | null> | undefined, fieldNamesChanged?: Map<string, string | null> | undefined, errors?: Map<string, SerializedLucidDictionary> | undefined);
+    constructor(items: Map<string, SerializedFields>, rekeyingMap?: Map<string, string | null> | undefined, fieldNamesChanged?: Map<string, string | null> | undefined, errors?: Map<string, SerializedLucidDictionary> | undefined, fieldConstraintsPerItem?: Map<string, Map<string, FieldConstraintDefinition[]>> | undefined);
 }
 export type ItemsPatch = {
     /**
@@ -94,16 +96,23 @@ export type ItemsPatch = {
     itemsDeleted?: string[];
     /** Errors found while patching the items */
     errors?: Map<string, SerializedLucidDictionary>;
+    /**
+     *Constraints that can be defined on a per-item basis to conditionally lock fields for a specific item.
+     *The key for this map is the primary key of an item, and the value is a map from the name a field on that item to the constraints that should be applied to that field.
+     */
+    fieldConstraintsPerItem?: Map<string, Map<string, FieldConstraintDefinition[]>>;
 } | ItemsPatchInexhaustive | ItemsPatchExhaustive;
 export type SerializedItemsPatch = {
     'items': Record<string, SerializedFields>;
     'itemsDeleted': string[];
     'errors'?: Record<string, SerializedLucidDictionary>;
+    'fieldConstraintsPerItem'?: Record<string, Record<string, SerializedFieldConstraintForApi[]>>;
 } | {
     'exhaustiveItems': Record<string, SerializedFields>;
     'rekeyingMap'?: Record<string, string | null>;
     'fieldNamesChanged'?: Record<string, string | null>;
     'errors'?: Record<string, SerializedLucidDictionary>;
+    'fieldConstraintsPerItem'?: Record<string, Record<string, SerializedFieldConstraintForApi[]>>;
 };
 export declare function serializeItemsPatch(patch: ItemsPatch): SerializedItemsPatch;
 /**

package/dataconnector/datasourceupdatetypes.js

@@ -13,40 +13,55 @@ class ItemsPatchInexhaustive {
      **/
     items, 
     /** Items to remove from the collection, based on the same primary key algorithm. */
-    itemsDeleted, errors) {
+    itemsDeleted, errors, fieldConstraintsPerItem) {
         this.items = items;
         this.itemsDeleted = itemsDeleted;
         this.errors = errors;
+        this.fieldConstraintsPerItem = fieldConstraintsPerItem;
         this._brand = ItemsPatchInexhaustive;
     }
 }
 exports.ItemsPatchInexhaustive = ItemsPatchInexhaustive;
 class ItemsPatchExhaustive {
-    constructor(items, rekeyingMap, fieldNamesChanged, errors) {
+    constructor(items, rekeyingMap, fieldNamesChanged, errors, fieldConstraintsPerItem) {
         this.items = items;
         this.rekeyingMap = rekeyingMap;
         this.fieldNamesChanged = fieldNamesChanged;
         this.errors = errors;
+        this.fieldConstraintsPerItem = fieldConstraintsPerItem;
         this._brand = ItemsPatchExhaustive;
     }
 }
 exports.ItemsPatchExhaustive = ItemsPatchExhaustive;
-function serializeErrors(errors) {
-    return errors && { 'errors': (0, object_1.fromEntries)(errors) };
-}
 function serializeRekeyingMap(rekeyingMap) {
     return rekeyingMap && { 'rekeyingMap': (0, object_1.fromEntries)(rekeyingMap) };
 }
 function serializeFieldNamesChanged(fieldNamesChanged) {
     return fieldNamesChanged && { 'fieldNamesChanged': (0, object_1.fromEntries)(fieldNamesChanged) };
 }
+function serializeErrors(errors) {
+    return errors && { 'errors': (0, object_1.fromEntries)(errors) };
+}
+function serializeFieldConstraintsPerItem(fieldConstraintsPerItem) {
+    if (!fieldConstraintsPerItem) {
+        return undefined;
+    }
+    const result = {};
+    fieldConstraintsPerItem.forEach((fieldNameToConstraints, key) => {
+        result[key] = {};
+        fieldNameToConstraints.forEach((constraints, fieldName) => {
+            result[key][fieldName] = constraints.map(serializeFieldConstraintForApi);
+        });
+    });
+    return { fieldConstraintsPerItem: result };
+}
 function serializeItemsPatch(patch) {
     var _a;
     if (patch instanceof ItemsPatchExhaustive) {
-        return Object.assign(Object.assign(Object.assign({ 'exhaustiveItems': (0, object_1.fromEntries)(patch.items.entries()) }, serializeRekeyingMap(patch.rekeyingMap)), serializeFieldNamesChanged(patch.fieldNamesChanged)), serializeErrors(patch.errors));
+        return Object.assign(Object.assign(Object.assign(Object.assign({ 'exhaustiveItems': (0, object_1.fromEntries)(patch.items.entries()) }, serializeRekeyingMap(patch.rekeyingMap)), serializeFieldNamesChanged(patch.fieldNamesChanged)), serializeErrors(patch.errors)), serializeFieldConstraintsPerItem(patch.fieldConstraintsPerItem));
     }
     else {
-        return Object.assign({ 'items': (0, object_1.fromEntries)(patch.items.entries()), 'itemsDeleted': (_a = patch.itemsDeleted) !== null && _a !== void 0 ? _a : [] }, serializeErrors(patch.errors));
+        return Object.assign(Object.assign({ 'items': (0, object_1.fromEntries)(patch.items.entries()), 'itemsDeleted': (_a = patch.itemsDeleted) !== null && _a !== void 0 ? _a : [] }, serializeErrors(patch.errors)), serializeFieldConstraintsPerItem(patch.fieldConstraintsPerItem));
     }
 }
 exports.serializeItemsPatch = serializeItemsPatch;

package/package.json

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