lucid-extension-sdk 0.0.353 → 0.0.355

package/core/data/fieldspecification.d.ts

@@ -18,6 +18,11 @@ type TsTypeOf<X> = X extends ScalarFieldTypeEnum.ANY ? unknown : X extends Scala
  * There is fromItems which does the above will full type information, and fromItems sparse
  * which allows all the fields not part of the primaryKey to be undefined. The former should
  * be used with initial imports, and the latter can be used for updates.
+ *
+ * If you declare your schema using PrimaryKey values that *exactly* match (case sensitive) the enum values of
+ * `collectionenumfieldtype.ts` (e.g. using a key with the value "id" for your ID field) you will be opting in to some
+ * additional (and valuable) user functionality. This includes better support in the edit panel, and better user facing
+ * descriptions of your fields.
  */
 export declare function declareSchema<Names extends string, Types extends Readonly<FieldTypeDefinition>, Constraint extends FieldConstraintDefinition, Fields extends {
     [Name in Names]: {

package/core/data/fieldspecification.js

@@ -12,6 +12,11 @@ function isArrayAndAssertReadonly(val) {
  * There is fromItems which does the above will full type information, and fromItems sparse
  * which allows all the fields not part of the primaryKey to be undefined. The former should
  * be used with initial imports, and the latter can be used for updates.
+ *
+ * If you declare your schema using PrimaryKey values that *exactly* match (case sensitive) the enum values of
+ * `collectionenumfieldtype.ts` (e.g. using a key with the value "id" for your ID field) you will be opting in to some
+ * additional (and valuable) user functionality. This includes better support in the edit panel, and better user facing
+ * descriptions of your fields.
  */
 function declareSchema({ primaryKey, fields }) {
     const primaryKeyObj = new FormattedPrimaryKey(...primaryKey);

package/core/validators/validators.d.ts

@@ -111,6 +111,13 @@ export declare function objectOfValidator<T>(subValidator: Validator<T>): (x: un
  * @return A validator for the array type
  */
 export declare function nullable<T>(subValidator: (p1: unknown) => p1 is T): (x: unknown) => x is T | null;
+/**
+ * Create a validator which allows the target to be either null or satisfy the
+ * sub-validator.
+ *
+ * @return A validator for the array type
+ */
+export declare function nullableValidatorWithInvalidElementTracking<T>(subValidator: (p1: unknown, invalidElements?: Map<number, unknown[]>, level?: number) => p1 is T): (subject: unknown, invalidElements?: Map<number, unknown[]>, level?: number) => subject is T | null;
 /**
  * Create a validator which allows the target to be undefined or satisfy the
  * sub-validator.

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.objectValidatorWithInvalidFieldTracking = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithInvalidElementTracking = 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.nullableValidatorWithInvalidElementTracking = exports.nullable = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithInvalidFieldTracking = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithInvalidElementTracking = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
 const checks_1 = require("../checks");
 /*********************************************************************************
  * Validator generators:  These functions construct new composite validators
@@ -269,6 +269,18 @@ function nullable(subValidator) {
     };
 }
 exports.nullable = nullable;
+/**
+ * Create a validator which allows the target to be either null or satisfy the
+ * sub-validator.
+ *
+ * @return A validator for the array type
+ */
+function nullableValidatorWithInvalidElementTracking(subValidator) {
+    return (subject, invalidElements, level = 0) => {
+        return subject === null || subValidator(subject, invalidElements, level);
+    };
+}
+exports.nullableValidatorWithInvalidElementTracking = nullableValidatorWithInvalidElementTracking;
 /**
  * Create a validator which allows the target to be undefined or satisfy the
  * sub-validator.

package/package.json

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