@dereekb/model 13.6.11 → 13.6.12

package/index.cjs.js

@@ -4,6 +4,44 @@ var util = require('@dereekb/util');
 var arktype = require('arktype');
 var makeError = require('make-error');
 
+/**
+ * ArkType schema for a model key (non-empty string).
+ */ var modelKeyType = arktype.type('string > 0');
+/**
+ * ArkType schema for a model id (non-empty string).
+ */ var modelIdType = arktype.type('string > 0');
+/**
+ * ArkType schema for target model params with a required `key` field.
+ */ var targetModelParamsType = arktype.type({
+    key: modelKeyType
+});
+/**
+ * ArkType schema for target model id params with a required `id` field.
+ */ var targetModelIdParamsType = arktype.type({
+    id: modelIdType
+});
+
+function clearable(definition) {
+    var result;
+    if (typeof definition === 'string') {
+        result = "".concat(definition, " | null | undefined");
+    } else {
+        result = definition.or('null').or('undefined');
+    }
+    return result;
+}
+
+/**
+ * Matches "Date | string.date.parse".
+ *
+ * This is used for validating and parsing serialized data (e.g., API responses, JSON payloads)
+ * and/or runtime Date objects into the corresponding runtime types.
+ *
+ * If we only used Date, or only used string.date.parse, then using the ArkType gets more specific to
+ * those independent cases, and will cause validation errors if you end up passing the object of that type
+ * rather than a freshly parsed JSON string POJO of that type.
+ */ var ARKTYPE_DATE_DTO_TYPE = 'Date | string.date.parse';
+
 /**
  * Maximum character length for address line fields (line1, line2).
  */ var ADDRESS_LINE_MAX_LENGTH = 50;
@@ -26,7 +64,7 @@ var makeError = require('make-error');
  * Base ArkType schema for United States address fields without the state.
  */ var baseUnitedStatesAddressType = arktype.type({
     line1: "0 < string <= ".concat(ADDRESS_LINE_MAX_LENGTH),
-    'line2?': "string <= ".concat(ADDRESS_LINE_MAX_LENGTH),
+    'line2?': clearable("string <= ".concat(ADDRESS_LINE_MAX_LENGTH)),
     city: "0 < string <= ".concat(ADDRESS_CITY_MAX_LENGTH),
     zip: [
         /^\d{5}(-\d{4})?$/,
@@ -155,20 +193,26 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Regex pattern for file link data — disallows the pipe character since it is used as the encoding separator.
  */ var WEBSITE_FILE_LINK_DATA_REGEX = /^[^|]+$/;
+/**
+ * ArkType schema for a {@link WebsiteFileLinkType} value.
+ */ var websiteFileLinkTypeValueType = arktype.type([
+    WEBSITE_FILE_LINK_TYPE_REGEX,
+    '&',
+    "string <= ".concat(WEBSITE_LINK_TYPE_MAX_LENGTH)
+]);
+/**
+ * ArkType schema for a {@link WebsiteFileLinkMimeType} value.
+ */ var websiteFileLinkMimeValueType = arktype.type([
+    WEBSITE_FILE_LINK_MIME_TYPE_REGEX,
+    '&',
+    "string <= ".concat(WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH)
+]);
 /**
  * ArkType schema for a {@link WebsiteFileLink}.
  */ var websiteFileLinkType = arktype.type({
-    'type?': [
-        WEBSITE_FILE_LINK_TYPE_REGEX,
-        '&',
-        "string <= ".concat(WEBSITE_LINK_TYPE_MAX_LENGTH)
-    ],
-    'mime?': [
-        WEBSITE_FILE_LINK_MIME_TYPE_REGEX,
-        '&',
-        "string <= ".concat(WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH)
-    ],
-    'name?': "string <= ".concat(WEBSITE_FILE_LINK_NAME_MAX_LENGTH),
+    'type?': clearable(websiteFileLinkTypeValueType),
+    'mime?': clearable(websiteFileLinkMimeValueType),
+    'name?': clearable("string <= ".concat(WEBSITE_FILE_LINK_NAME_MAX_LENGTH)),
     data: [
         WEBSITE_FILE_LINK_DATA_REGEX,
         '&',
@@ -2706,44 +2750,6 @@ function _ts_generator(thisArg, body) {
     };
 }
 
-/**
- * ArkType schema for a model key (non-empty string).
- */ var modelKeyType = arktype.type('string > 0');
-/**
- * ArkType schema for a model id (non-empty string).
- */ var modelIdType = arktype.type('string > 0');
-/**
- * ArkType schema for target model params with a required `key` field.
- */ var targetModelParamsType = arktype.type({
-    key: modelKeyType
-});
-/**
- * ArkType schema for target model id params with a required `id` field.
- */ var targetModelIdParamsType = arktype.type({
-    id: modelIdType
-});
-
-function clearable(definition) {
-    var result;
-    if (typeof definition === 'string') {
-        result = "".concat(definition, " | null | undefined");
-    } else {
-        result = definition.or('null').or('undefined');
-    }
-    return result;
-}
-
-/**
- * Matches "Date | string.date.parse".
- *
- * This is used for validating and parsing serialized data (e.g., API responses, JSON payloads)
- * and/or runtime Date objects into the corresponding runtime types.
- *
- * If we only used Date, or only used string.date.parse, then using the ArkType gets more specific to
- * those independent cases, and will cause validation errors if you end up passing the object of that type
- * rather than a freshly parsed JSON string POJO of that type.
- */ var ARKTYPE_DATE_DTO_TYPE = 'Date | string.date.parse';
-
 /**
  * ArkType schema for a valid ISO 8601 day string (e.g., "2024-01-15").
  */ var iso8601DayStringType = arktype.type('string > 0').narrow(function(val, ctx) {

package/index.esm.js

@@ -2,6 +2,44 @@ import { US_STATE_CODE_STRING_REGEX, splitJoinRemainder, filterFalsyAndEmptyValu
 import { type } from 'arktype';
 import { BaseError } from 'make-error';
 
+/**
+ * ArkType schema for a model key (non-empty string).
+ */ var modelKeyType = type('string > 0');
+/**
+ * ArkType schema for a model id (non-empty string).
+ */ var modelIdType = type('string > 0');
+/**
+ * ArkType schema for target model params with a required `key` field.
+ */ var targetModelParamsType = type({
+    key: modelKeyType
+});
+/**
+ * ArkType schema for target model id params with a required `id` field.
+ */ var targetModelIdParamsType = type({
+    id: modelIdType
+});
+
+function clearable(definition) {
+    var result;
+    if (typeof definition === 'string') {
+        result = "".concat(definition, " | null | undefined");
+    } else {
+        result = definition.or('null').or('undefined');
+    }
+    return result;
+}
+
+/**
+ * Matches "Date | string.date.parse".
+ *
+ * This is used for validating and parsing serialized data (e.g., API responses, JSON payloads)
+ * and/or runtime Date objects into the corresponding runtime types.
+ *
+ * If we only used Date, or only used string.date.parse, then using the ArkType gets more specific to
+ * those independent cases, and will cause validation errors if you end up passing the object of that type
+ * rather than a freshly parsed JSON string POJO of that type.
+ */ var ARKTYPE_DATE_DTO_TYPE = 'Date | string.date.parse';
+
 /**
  * Maximum character length for address line fields (line1, line2).
  */ var ADDRESS_LINE_MAX_LENGTH = 50;
@@ -24,7 +62,7 @@ import { BaseError } from 'make-error';
  * Base ArkType schema for United States address fields without the state.
  */ var baseUnitedStatesAddressType = type({
     line1: "0 < string <= ".concat(ADDRESS_LINE_MAX_LENGTH),
-    'line2?': "string <= ".concat(ADDRESS_LINE_MAX_LENGTH),
+    'line2?': clearable("string <= ".concat(ADDRESS_LINE_MAX_LENGTH)),
     city: "0 < string <= ".concat(ADDRESS_CITY_MAX_LENGTH),
     zip: [
         /^\d{5}(-\d{4})?$/,
@@ -153,20 +191,26 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Regex pattern for file link data — disallows the pipe character since it is used as the encoding separator.
  */ var WEBSITE_FILE_LINK_DATA_REGEX = /^[^|]+$/;
+/**
+ * ArkType schema for a {@link WebsiteFileLinkType} value.
+ */ var websiteFileLinkTypeValueType = type([
+    WEBSITE_FILE_LINK_TYPE_REGEX,
+    '&',
+    "string <= ".concat(WEBSITE_LINK_TYPE_MAX_LENGTH)
+]);
+/**
+ * ArkType schema for a {@link WebsiteFileLinkMimeType} value.
+ */ var websiteFileLinkMimeValueType = type([
+    WEBSITE_FILE_LINK_MIME_TYPE_REGEX,
+    '&',
+    "string <= ".concat(WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH)
+]);
 /**
  * ArkType schema for a {@link WebsiteFileLink}.
  */ var websiteFileLinkType = type({
-    'type?': [
-        WEBSITE_FILE_LINK_TYPE_REGEX,
-        '&',
-        "string <= ".concat(WEBSITE_LINK_TYPE_MAX_LENGTH)
-    ],
-    'mime?': [
-        WEBSITE_FILE_LINK_MIME_TYPE_REGEX,
-        '&',
-        "string <= ".concat(WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH)
-    ],
-    'name?': "string <= ".concat(WEBSITE_FILE_LINK_NAME_MAX_LENGTH),
+    'type?': clearable(websiteFileLinkTypeValueType),
+    'mime?': clearable(websiteFileLinkMimeValueType),
+    'name?': clearable("string <= ".concat(WEBSITE_FILE_LINK_NAME_MAX_LENGTH)),
     data: [
         WEBSITE_FILE_LINK_DATA_REGEX,
         '&',
@@ -2704,44 +2748,6 @@ function _ts_generator(thisArg, body) {
     };
 }
 
-/**
- * ArkType schema for a model key (non-empty string).
- */ var modelKeyType = type('string > 0');
-/**
- * ArkType schema for a model id (non-empty string).
- */ var modelIdType = type('string > 0');
-/**
- * ArkType schema for target model params with a required `key` field.
- */ var targetModelParamsType = type({
-    key: modelKeyType
-});
-/**
- * ArkType schema for target model id params with a required `id` field.
- */ var targetModelIdParamsType = type({
-    id: modelIdType
-});
-
-function clearable(definition) {
-    var result;
-    if (typeof definition === 'string') {
-        result = "".concat(definition, " | null | undefined");
-    } else {
-        result = definition.or('null').or('undefined');
-    }
-    return result;
-}
-
-/**
- * Matches "Date | string.date.parse".
- *
- * This is used for validating and parsing serialized data (e.g., API responses, JSON payloads)
- * and/or runtime Date objects into the corresponding runtime types.
- *
- * If we only used Date, or only used string.date.parse, then using the ArkType gets more specific to
- * those independent cases, and will cause validation errors if you end up passing the object of that type
- * rather than a freshly parsed JSON string POJO of that type.
- */ var ARKTYPE_DATE_DTO_TYPE = 'Date | string.date.parse';
-
 /**
  * ArkType schema for a valid ISO 8601 day string (e.g., "2024-01-15").
  */ var iso8601DayStringType = type('string > 0').narrow(function(val, ctx) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dereekb/model",
-  "version": "13.6.11",
+  "version": "13.6.12",
   "peerDependencies": {
-    "@dereekb/util": "13.6.11",
+    "@dereekb/util": "13.6.12",
     "arktype": "^2.2.0",
     "make-error": "^1.3.0"
   },

package/src/lib/data/address/address.d.ts

@@ -29,7 +29,7 @@ export declare const unitedStatesAddressWithStateCodeType: import("arktype/inter
     line1: string;
     city: string;
     zip: string;
-    line2?: string | undefined;
+    line2?: string | null | undefined;
     state: string;
 }, {}>;
 export type UnitedStatesAddressWithStateCodeParams = typeof unitedStatesAddressWithStateCodeType.infer;
@@ -40,7 +40,7 @@ export declare const unitedStatesAddressWithStateStringType: import("arktype/int
     line1: string;
     city: string;
     zip: string;
-    line2?: string | undefined;
+    line2?: string | null | undefined;
     state: string;
 }, {}>;
 export type UnitedStatesAddressWithStateStringParams = typeof unitedStatesAddressWithStateStringType.infer;

package/src/lib/data/website/link.file.d.ts

@@ -73,9 +73,9 @@ export interface WebsiteFileLink {
  */
 export declare const websiteFileLinkType: import("arktype/internal/variants/object.ts").ObjectType<{
     data: string;
-    type?: string | undefined;
-    mime?: string | undefined;
-    name?: string | undefined;
+    type?: string | null | undefined;
+    mime?: string | null | undefined;
+    name?: string | null | undefined;
 }, {}>;
 /**
  * A pipe-separated encoded string representation of a {@link WebsiteFileLink}.

package/src/lib/type/type.d.ts

@@ -35,6 +35,12 @@ export type Clearable<T> = Maybe<T>;
  *   "phone?": clearable(e164PhoneNumberType),          // Type instance
  *   "items?": clearable(mySchemaType.array()),          // .array() result
  * });
+ *
+ * // For tuple expressions (e.g. intersections), resolve to a Type first:
+ * const zipType = type([/^\d{5}(-\d{4})?$/, '&', `string <= 11`]);
+ * const schema2 = type({
+ *   "zip?": clearable(zipType),
+ * });
  * ```
  *
  * @param definition The ArkType definition string or Type instance to make clearable.