@dereekb/model 13.12.0 → 13.12.2

package/index.cjs.js

@@ -2938,6 +2938,12 @@ function _ts_generator(thisArg, body) {
     return val != null && util.isISO8601DayString(val) || ctx.mustBe('a valid ISO 8601 day string');
 });
 
+/**
+ * A number greater than or equal to 0.
+ */ var NON_NEGATIVE_NUMBER = 'number >= 0';
+/**
+ * A non-negative integer.
+ */ var NON_NEGATIVE_INTEGER = 'number.integer >= 0';
 /**
  * ArkType schema for a valid minute of the day (0-1439).
  */ var minuteOfDayType = arktype.type('number').narrow(function(val, ctx) {
@@ -2974,6 +2980,31 @@ function _ts_generator(thisArg, body) {
     return val != null && util.isLatLngString(val) || ctx.mustBe('a valid lat,lng string (e.g. "30.5,-96.3")');
 });
 
+/**
+ * A string with at least one character (non-empty).
+ */ var NON_EMPTY_STRING = 'string > 0';
+/**
+ * A valid email address string.
+ */ var EMAIL_STRING = 'string.email';
+/**
+ * Creates an ArkType string definition for a non-empty string with a maximum length.
+ *
+ * Composes {@link NON_EMPTY_STRING} with an upper-bound length constraint, producing a
+ * DSL fragment that can be interpolated directly into an ArkType `type({ ... })` schema.
+ *
+ * @param maxLength - The maximum number of characters allowed (inclusive).
+ * @returns The ArkType string definition.
+ *
+ * @example
+ * ```ts
+ * const userType = type({
+ *   displayName: nonEmptyStringWithMaxLength(64)
+ * });
+ * ```
+ */ function nonEmptyStringWithMaxLength(maxLength) {
+    return "".concat(NON_EMPTY_STRING, " & string <= ").concat(maxLength);
+}
+
 /**
  * Creates an ArkType schema that validates an array has no duplicate keys.
  *
@@ -3013,6 +3044,7 @@ exports.AbstractModelPermissionService = AbstractModelPermissionService;
 exports.CASHAPP_BASE_URL = CASHAPP_BASE_URL;
 exports.CASHAPP_USERNAME_PREFIX = CASHAPP_USERNAME_PREFIX;
 exports.CASHAPP_WEBSITE_LINK_TYPE = CASHAPP_WEBSITE_LINK_TYPE;
+exports.EMAIL_STRING = EMAIL_STRING;
 exports.EMAIL_URL_WEBSITE_LINK_TYPE = EMAIL_URL_WEBSITE_LINK_TYPE;
 exports.EMPTY_ARKTYPE_TYPE = EMPTY_ARKTYPE_TYPE;
 exports.FACEBOOK_BASE_URL = FACEBOOK_BASE_URL;
@@ -3027,6 +3059,9 @@ exports.GRANTED_UPDATE_ROLE_KEY = GRANTED_UPDATE_ROLE_KEY;
 exports.GrantedRoleMapReaderInstance = GrantedRoleMapReaderInstance;
 exports.INSTAGRAM_BASE_URL = INSTAGRAM_BASE_URL;
 exports.INSTAGRAM_WEBSITE_LINK_TYPE = INSTAGRAM_WEBSITE_LINK_TYPE;
+exports.NON_EMPTY_STRING = NON_EMPTY_STRING;
+exports.NON_NEGATIVE_INTEGER = NON_NEGATIVE_INTEGER;
+exports.NON_NEGATIVE_NUMBER = NON_NEGATIVE_NUMBER;
 exports.NO_ACCESS_ROLE_KEY = NO_ACCESS_ROLE_KEY;
 exports.PAYPAL_BASE_URL = PAYPAL_BASE_URL;
 exports.PAYPAL_WEBSITE_LINK_TYPE = PAYPAL_WEBSITE_LINK_TYPE;
@@ -3096,6 +3131,7 @@ exports.modelIdType = modelIdType;
 exports.modelKeyType = modelKeyType;
 exports.noAccessContextGrantedModelRoles = noAccessContextGrantedModelRoles;
 exports.noAccessRoleMap = noAccessRoleMap;
+exports.nonEmptyStringWithMaxLength = nonEmptyStringWithMaxLength;
 exports.paypalProfileUrl = paypalProfileUrl;
 exports.paypalProfileUrlToWebsiteLink = paypalProfileUrlToWebsiteLink;
 exports.phoneNumberToWebsiteLink = phoneNumberToWebsiteLink;

package/index.esm.js

@@ -2936,6 +2936,12 @@ function _ts_generator(thisArg, body) {
     return val != null && isISO8601DayString(val) || ctx.mustBe('a valid ISO 8601 day string');
 });
 
+/**
+ * A number greater than or equal to 0.
+ */ var NON_NEGATIVE_NUMBER = 'number >= 0';
+/**
+ * A non-negative integer.
+ */ var NON_NEGATIVE_INTEGER = 'number.integer >= 0';
 /**
  * ArkType schema for a valid minute of the day (0-1439).
  */ var minuteOfDayType = type('number').narrow(function(val, ctx) {
@@ -2972,6 +2978,31 @@ function _ts_generator(thisArg, body) {
     return val != null && isLatLngString(val) || ctx.mustBe('a valid lat,lng string (e.g. "30.5,-96.3")');
 });
 
+/**
+ * A string with at least one character (non-empty).
+ */ var NON_EMPTY_STRING = 'string > 0';
+/**
+ * A valid email address string.
+ */ var EMAIL_STRING = 'string.email';
+/**
+ * Creates an ArkType string definition for a non-empty string with a maximum length.
+ *
+ * Composes {@link NON_EMPTY_STRING} with an upper-bound length constraint, producing a
+ * DSL fragment that can be interpolated directly into an ArkType `type({ ... })` schema.
+ *
+ * @param maxLength - The maximum number of characters allowed (inclusive).
+ * @returns The ArkType string definition.
+ *
+ * @example
+ * ```ts
+ * const userType = type({
+ *   displayName: nonEmptyStringWithMaxLength(64)
+ * });
+ * ```
+ */ function nonEmptyStringWithMaxLength(maxLength) {
+    return "".concat(NON_EMPTY_STRING, " & string <= ").concat(maxLength);
+}
+
 /**
  * Creates an ArkType schema that validates an array has no duplicate keys.
  *
@@ -3000,4 +3031,4 @@ function _ts_generator(thisArg, body) {
     return val != null && isWebsiteUrlWithPrefix(val) || ctx.mustBe('a valid website URL starting with http:// or https://');
 });
 
-export { ADDRESS_CITY_MAX_LENGTH, ADDRESS_COUNTRY_MAX_LENGTH, ADDRESS_LINE_MAX_LENGTH, ADDRESS_STATE_CODE_MAX_LENGTH, ADDRESS_STATE_MAX_LENGTH, ADDRESS_ZIP_MAX_LENGTH, ARKTYPE_DATE_DTO_TYPE, AbstractModelPermissionService, CASHAPP_BASE_URL, CASHAPP_USERNAME_PREFIX, CASHAPP_WEBSITE_LINK_TYPE, EMAIL_URL_WEBSITE_LINK_TYPE, EMPTY_ARKTYPE_TYPE, FACEBOOK_BASE_URL, FACEBOOK_WEBSITE_LINK_TYPE, FULL_ACCESS_ROLE_KEY, GRANTED_ADMIN_ROLE_KEY, GRANTED_DELETE_ROLE_KEY, GRANTED_OWNER_ROLE_KEY, GRANTED_READ_ROLE_KEY, GRANTED_SYS_ADMIN_ROLE_KEY, GRANTED_UPDATE_ROLE_KEY, GrantedRoleMapReaderInstance, INSTAGRAM_BASE_URL, INSTAGRAM_WEBSITE_LINK_TYPE, NO_ACCESS_ROLE_KEY, PAYPAL_BASE_URL, PAYPAL_WEBSITE_LINK_TYPE, PHONE_URL_WEBSITE_LINK_TYPE, SNAPCHAT_BASE_URL, SNAPCHAT_WEBSITE_LINK_ISOLATE_PROFILE_ID, SNAPCHAT_WEBSITE_LINK_TYPE, SPOTIFY_BASE_URL, SPOTIFY_WEBSITE_LINK_ISOLATE_PROFILE_ID, SPOTIFY_WEBSITE_LINK_TYPE, TIKTOK_BASE_URL, TIKTOK_USERNAME_PREFIX, TIKTOK_WEBSITE_LINK_TYPE, TWITTER_BASE_URL, TWITTER_WEBSITE_LINK_TYPE, UNKNOWN_WEBSITE_LINK_TYPE, VENMO_BASE_URL, VENMO_WEBSITE_LINK_ISOLATE_PROFILE_ID, VENMO_WEBSITE_LINK_TYPE, WEBSITE_FILE_LINK_DATA_MAX_LENGTH, WEBSITE_FILE_LINK_DATA_REGEX, WEBSITE_FILE_LINK_ENCODE_SEPARATOR, WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH, WEBSITE_FILE_LINK_MIME_TYPE_REGEX, WEBSITE_FILE_LINK_NAME_MAX_LENGTH, WEBSITE_FILE_LINK_TYPE_MAX_LENGTH, WEBSITE_FILE_LINK_TYPE_REGEX, WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE, WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH, WEBSITE_LINK_ISOLATE_BASE_URL_PROFILE_ID, WEBSITE_LINK_TYPE_MAX_LENGTH, WEBSITE_LINK_TYPE_REGEX, WEBSITE_URL_WEBSITE_LINK_TYPE, YOUTUBE_BASE_URL, YOUTUBE_WEBSITE_LINK_ISOLATE_PROFILE_ID, YOUTUBE_WEBSITE_LINK_TYPE, arktypeToJsonSchemaForExport, basicSyncEntityCommonTypeSynchronizerInstanceFactory, cashappProfileUrl, cashappProfileUrlToWebsiteLink, clearable, contextGrantedModelRoles, decodeWebsiteLinkEncodedDataToWebsiteFileLink, e164PhoneNumberType, e164PhoneNumberWithExtensionType, e164PhoneNumberWithOptionalExtensionType, emailAddressToWebsiteLink, emptyType, encodeWebsiteFileLinkToWebsiteLinkEncodedData, facebookProfileUrl, facebookProfileUrlToWebsiteLink, fullAccessGrantedModelRoles, fullAccessRoleMap, grantedRoleKeysMapFromArray, grantedRoleMapReader, instagramProfileUrl, instagramProfileUrlToWebsiteLink, isFullAccessRoleMap, isGrantedAdminLevelRole, isNoAccessRoleMap, isValidWebsiteLinkType, iso8601DayStringType, latLngPointType, latLngStringType, minuteOfDayType, modelIdType, modelKeyType, noAccessContextGrantedModelRoles, noAccessRoleMap, paypalProfileUrl, paypalProfileUrlToWebsiteLink, phoneNumberToWebsiteLink, pruneFalseUnionBranches, snapchatProfileUrl, snapchatProfileUrlToWebsiteLink, spotifyProfileUrl, spotifyProfileUrlToWebsiteLink, syncEntityCommonTypeIdPairFactory, syncEntityFactory, syncEntitySynchronizer, targetModelIdParamsType, targetModelParamsType, tiktokProfileUrl, tiktokProfileUrlToWebsiteLink, toTransformAndValidateFunctionResult, toTransformAndValidateFunctionResultFactory, transformAndValidateFunctionResultFactory, transformAndValidateObject, transformAndValidateObjectFactory, transformAndValidateObjectResult, transformAndValidateResultFactory, twitterProfileUrl, twitterProfileUrlToWebsiteLink, uniqueKeyedType, unitedStatesAddressWithStateCodeType, unitedStatesAddressWithStateStringType, usernameFromUsernameOrWebsiteWithBaseUrlUsername, usernameFromUsernameOrWebsiteWithOneOffBaseUrlUsername, usernameOrWebsiteUrlToWebsiteUrl, venmoProfileUrl, venmoProfileUrlToWebsiteLink, websiteFileLinkToWebsiteLink, websiteFileLinkType, websiteLinkToWebsiteLinkFile, websiteLinkType, websiteUrlToWebsiteLink, websiteUrlType, websiteUrlWithPrefixType, youtubeProfileUrl, youtubeProfileUrlToWebsiteLink };
+export { ADDRESS_CITY_MAX_LENGTH, ADDRESS_COUNTRY_MAX_LENGTH, ADDRESS_LINE_MAX_LENGTH, ADDRESS_STATE_CODE_MAX_LENGTH, ADDRESS_STATE_MAX_LENGTH, ADDRESS_ZIP_MAX_LENGTH, ARKTYPE_DATE_DTO_TYPE, AbstractModelPermissionService, CASHAPP_BASE_URL, CASHAPP_USERNAME_PREFIX, CASHAPP_WEBSITE_LINK_TYPE, EMAIL_STRING, EMAIL_URL_WEBSITE_LINK_TYPE, EMPTY_ARKTYPE_TYPE, FACEBOOK_BASE_URL, FACEBOOK_WEBSITE_LINK_TYPE, FULL_ACCESS_ROLE_KEY, GRANTED_ADMIN_ROLE_KEY, GRANTED_DELETE_ROLE_KEY, GRANTED_OWNER_ROLE_KEY, GRANTED_READ_ROLE_KEY, GRANTED_SYS_ADMIN_ROLE_KEY, GRANTED_UPDATE_ROLE_KEY, GrantedRoleMapReaderInstance, INSTAGRAM_BASE_URL, INSTAGRAM_WEBSITE_LINK_TYPE, NON_EMPTY_STRING, NON_NEGATIVE_INTEGER, NON_NEGATIVE_NUMBER, NO_ACCESS_ROLE_KEY, PAYPAL_BASE_URL, PAYPAL_WEBSITE_LINK_TYPE, PHONE_URL_WEBSITE_LINK_TYPE, SNAPCHAT_BASE_URL, SNAPCHAT_WEBSITE_LINK_ISOLATE_PROFILE_ID, SNAPCHAT_WEBSITE_LINK_TYPE, SPOTIFY_BASE_URL, SPOTIFY_WEBSITE_LINK_ISOLATE_PROFILE_ID, SPOTIFY_WEBSITE_LINK_TYPE, TIKTOK_BASE_URL, TIKTOK_USERNAME_PREFIX, TIKTOK_WEBSITE_LINK_TYPE, TWITTER_BASE_URL, TWITTER_WEBSITE_LINK_TYPE, UNKNOWN_WEBSITE_LINK_TYPE, VENMO_BASE_URL, VENMO_WEBSITE_LINK_ISOLATE_PROFILE_ID, VENMO_WEBSITE_LINK_TYPE, WEBSITE_FILE_LINK_DATA_MAX_LENGTH, WEBSITE_FILE_LINK_DATA_REGEX, WEBSITE_FILE_LINK_ENCODE_SEPARATOR, WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH, WEBSITE_FILE_LINK_MIME_TYPE_REGEX, WEBSITE_FILE_LINK_NAME_MAX_LENGTH, WEBSITE_FILE_LINK_TYPE_MAX_LENGTH, WEBSITE_FILE_LINK_TYPE_REGEX, WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE, WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH, WEBSITE_LINK_ISOLATE_BASE_URL_PROFILE_ID, WEBSITE_LINK_TYPE_MAX_LENGTH, WEBSITE_LINK_TYPE_REGEX, WEBSITE_URL_WEBSITE_LINK_TYPE, YOUTUBE_BASE_URL, YOUTUBE_WEBSITE_LINK_ISOLATE_PROFILE_ID, YOUTUBE_WEBSITE_LINK_TYPE, arktypeToJsonSchemaForExport, basicSyncEntityCommonTypeSynchronizerInstanceFactory, cashappProfileUrl, cashappProfileUrlToWebsiteLink, clearable, contextGrantedModelRoles, decodeWebsiteLinkEncodedDataToWebsiteFileLink, e164PhoneNumberType, e164PhoneNumberWithExtensionType, e164PhoneNumberWithOptionalExtensionType, emailAddressToWebsiteLink, emptyType, encodeWebsiteFileLinkToWebsiteLinkEncodedData, facebookProfileUrl, facebookProfileUrlToWebsiteLink, fullAccessGrantedModelRoles, fullAccessRoleMap, grantedRoleKeysMapFromArray, grantedRoleMapReader, instagramProfileUrl, instagramProfileUrlToWebsiteLink, isFullAccessRoleMap, isGrantedAdminLevelRole, isNoAccessRoleMap, isValidWebsiteLinkType, iso8601DayStringType, latLngPointType, latLngStringType, minuteOfDayType, modelIdType, modelKeyType, noAccessContextGrantedModelRoles, noAccessRoleMap, nonEmptyStringWithMaxLength, paypalProfileUrl, paypalProfileUrlToWebsiteLink, phoneNumberToWebsiteLink, pruneFalseUnionBranches, snapchatProfileUrl, snapchatProfileUrlToWebsiteLink, spotifyProfileUrl, spotifyProfileUrlToWebsiteLink, syncEntityCommonTypeIdPairFactory, syncEntityFactory, syncEntitySynchronizer, targetModelIdParamsType, targetModelParamsType, tiktokProfileUrl, tiktokProfileUrlToWebsiteLink, toTransformAndValidateFunctionResult, toTransformAndValidateFunctionResultFactory, transformAndValidateFunctionResultFactory, transformAndValidateObject, transformAndValidateObjectFactory, transformAndValidateObjectResult, transformAndValidateResultFactory, twitterProfileUrl, twitterProfileUrlToWebsiteLink, uniqueKeyedType, unitedStatesAddressWithStateCodeType, unitedStatesAddressWithStateStringType, usernameFromUsernameOrWebsiteWithBaseUrlUsername, usernameFromUsernameOrWebsiteWithOneOffBaseUrlUsername, usernameOrWebsiteUrlToWebsiteUrl, venmoProfileUrl, venmoProfileUrlToWebsiteLink, websiteFileLinkToWebsiteLink, websiteFileLinkType, websiteLinkToWebsiteLinkFile, websiteLinkType, websiteUrlToWebsiteLink, websiteUrlType, websiteUrlWithPrefixType, youtubeProfileUrl, youtubeProfileUrlToWebsiteLink };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dereekb/model",
-  "version": "13.12.0",
+  "version": "13.12.2",
   "sideEffects": false,
   "peerDependencies": {
-    "@dereekb/util": "13.12.0",
+    "@dereekb/util": "13.12.2",
     "arktype": "^2.2.0",
     "make-error": "^1.3.6"
   },

package/src/lib/validator/index.d.ts

@@ -2,5 +2,6 @@ export * from './date';
 export * from './number';
 export * from './phone';
 export * from './point';
+export * from './string';
 export * from './unique';
 export * from './url';

package/src/lib/validator/number.d.ts

@@ -1,3 +1,11 @@
+/**
+ * A number greater than or equal to 0.
+ */
+export declare const NON_NEGATIVE_NUMBER: "number >= 0";
+/**
+ * A non-negative integer.
+ */
+export declare const NON_NEGATIVE_INTEGER: "number.integer >= 0";
 /**
  * ArkType schema for a valid minute of the day (0-1439).
  */

package/src/lib/validator/string.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A string with at least one character (non-empty).
+ */
+export declare const NON_EMPTY_STRING: "string > 0";
+/**
+ * A valid email address string.
+ */
+export declare const EMAIL_STRING: "string.email";
+/**
+ * Creates an ArkType string definition for a non-empty string with a maximum length.
+ *
+ * Composes {@link NON_EMPTY_STRING} with an upper-bound length constraint, producing a
+ * DSL fragment that can be interpolated directly into an ArkType `type({ ... })` schema.
+ *
+ * @param maxLength - The maximum number of characters allowed (inclusive).
+ * @returns The ArkType string definition.
+ *
+ * @example
+ * ```ts
+ * const userType = type({
+ *   displayName: nonEmptyStringWithMaxLength(64)
+ * });
+ * ```
+ */
+export declare function nonEmptyStringWithMaxLength<N extends number>(maxLength: N): `string > 0 & string <= ${N}`;