@based/schema 5.0.0-alpha.1 → 5.0.0-alpha.10

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import { LangName } from './lang.js';
+import { Validation } from './def/validation.js';
 type Role = 'title' | 'source' | 'media' | string;
 export declare const numberDisplays: readonly ["short", "human", "ratio", "bytes", "euro", "dollar", "pound", "meter"];
 export declare const dateDisplays: readonly ["date", "date-time", "date-time-text", "date-time-human", "time", "time-precise"];
@@ -14,6 +15,7 @@ type QueryFn = Function;
 type PropValues = {
     type?: string;
     default?: any;
+    validation?: Validation;
 };
 type Prop<V extends PropValues> = {
     required?: boolean;
@@ -24,6 +26,7 @@ type Prop<V extends PropValues> = {
     role?: Role;
     readOnly?: boolean;
     examples?: string[];
+    validation?: Validation;
 } & V;
 type EnumItem = string | number | boolean;
 type NeverInItems = {
@@ -31,15 +34,18 @@ type NeverInItems = {
 };
 export type SchemaReferences = Prop<{
     type?: 'references';
+    default?: number[];
     items: SchemaReference & NeverInItems;
 }>;
 export type SchemaReferencesOneWay = Prop<{
     type?: 'references';
+    default?: number[];
     items: SchemaReferenceOneWay & NeverInItems;
 }>;
 export type SchemaText = Prop<{
     type: 'text';
     default?: Record<string, string>;
+    format?: StringFormat;
 }>;
 type NumberType = 'number' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32';
 export type SchemaNumber = Prop<{
@@ -49,6 +55,9 @@ export type SchemaNumber = Prop<{
     max?: number;
     step?: number | 'any';
     display?: NumberDisplay;
+    history?: {
+        interval: 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
+    };
 }>;
 export type SchemaString = Prop<{
     type: 'string';
@@ -62,18 +71,24 @@ export type SchemaString = Prop<{
 }>;
 export type SchemaBinary = Prop<{
     type: 'binary';
-    default?: ArrayBuffer;
+    default?: Uint8Array;
     maxBytes?: number;
     mime?: Mime;
     format?: StringFormat;
 }>;
+export type SchemaJson = Prop<{
+    type: 'json';
+    default?: Record<string, any> | null;
+}>;
 export type SchemaBoolean = Prop<{
     type: 'boolean';
     default?: boolean;
 }>;
-export type SchemaHll = Prop<{
-    type: 'hll';
-    default?: number;
+export type SchemaCardinality = Prop<{
+    type: 'cardinality';
+    maxBytes?: number;
+    mime?: Mime;
+    format?: NumberDisplay;
 }>;
 export type SchemaVector = Prop<{
     type: 'vector';
@@ -82,19 +97,22 @@ export type SchemaVector = Prop<{
 }>;
 export type SchemaTimestamp = Prop<{
     type: 'timestamp';
-    default?: number | Date;
+    default?: number | Date | string;
     on?: 'create' | 'update';
     display?: DateDisplay;
+    min?: number | string;
+    max?: number | string;
+    step?: number | 'any' | string;
 }>;
 export type SchemaReferenceOneWay = Prop<{
     type?: 'reference';
-    default?: string;
+    default?: number;
     ref: string;
     mime?: Mime;
 }>;
 export type SchemaReference = Prop<{
     type?: 'reference';
-    default?: string;
+    default?: number;
     ref: string;
     prop: string;
     dependent?: boolean;
@@ -116,13 +134,13 @@ export type SchemaReferencesWithQuery = SchemaReferencesOneWay & {
 };
 export type SchemaEnum = Prop<{
     type?: 'enum';
-    default?: EnumItem;
+    default?: EnumItem | undefined;
     enum: EnumItem[];
 }>;
 export type SchemaAlias = Omit<SchemaString, 'type'> & {
     type: 'alias';
 };
-export type SchemaPropShorthand = 'timestamp' | 'binary' | 'boolean' | 'string' | 'alias' | 'text' | 'hll' | NumberType | EnumItem[];
+export type SchemaPropShorthand = 'timestamp' | 'binary' | 'boolean' | 'string' | 'alias' | 'text' | 'json' | 'cardinality' | NumberType | EnumItem[];
 type SetItems<isStrict = false> = SchemaTimestamp | SchemaBoolean | SchemaNumber | SchemaString | SchemaEnum | (isStrict extends true ? never : 'timestamp' | 'binary' | 'boolean' | 'string' | NumberType | EnumItem[]);
 export type SchemaSet<ItemsType extends SetItems = SetItems> = Prop<{
     type?: 'set';
@@ -131,7 +149,7 @@ export type SchemaSet<ItemsType extends SetItems = SetItems> = Prop<{
     } ? ItemsType['default'][] : undefined;
     items: ItemsType & NeverInItems;
 }>;
-type NonRefSchemaProps<isStrict = false> = SchemaTimestamp | SchemaBoolean | SchemaNumber | SchemaString | SchemaAlias | SchemaText | SchemaEnum | SchemaBinary | SchemaHll | SchemaVector | (isStrict extends true ? SchemaSet<SetItems<true>> : SchemaPropShorthand | SchemaSet);
+type NonRefSchemaProps<isStrict = false> = SchemaTimestamp | SchemaBoolean | SchemaNumber | SchemaString | SchemaAlias | SchemaText | SchemaEnum | SchemaJson | SchemaBinary | SchemaCardinality | SchemaVector | (isStrict extends true ? SchemaSet<SetItems<true>> : SchemaPropShorthand | SchemaSet);
 export type SchemaProp<isStrict = false> = SchemaReferencesWithQuery | SchemaReferenceWithQuery | NonRefSchemaProps<isStrict> | SchemaReferences | SchemaReference | SchemaObject | SchemaBinary;
 export type SchemaPropOneWay<isStrict = false> = SchemaReferencesOneWay | SchemaReferenceOneWay | SchemaObjectOneWay | NonRefSchemaProps<isStrict>;
 export type SchemaAnyProp = SchemaPropOneWay | SchemaProp;
@@ -152,8 +170,10 @@ export type StrictSchemaType = GenericSchemaType<true>;
 export type SchemaType<isStrict = false> = isStrict extends true ? StrictSchemaType : StrictSchemaType | GenericSchemaType<false> | (SchemaProps & {
     props?: never;
 });
-export type SchemaTypeName = AllowedKey;
-export type SchemaTypes<isStrict = false> = Record<SchemaTypeName, SchemaType<isStrict>>;
+export type SchemaTypeName = Exclude<string, '_root'>;
+export type SchemaTypes<isStrict = false> = Record<SchemaTypeName, SchemaType<isStrict>> & {
+    _root?: never;
+};
 export type SchemaPropsOneWay<isStrict = false> = Record<AllowedKey, SchemaPropOneWay<isStrict>> & {
     id?: never;
 };
@@ -178,12 +198,15 @@ export type SchemaPropTypeMap = {
     alias: SchemaAlias;
     enum: SchemaEnum;
     text: SchemaText;
+    json: SchemaJson;
     set: SchemaSet;
     binary: SchemaBinary;
-    hll: SchemaHll;
+    cardinality: SchemaCardinality;
     vector: SchemaVector;
 } & Record<NumberType, SchemaNumber>;
 export type SchemaPropTypes = keyof SchemaPropTypeMap;
 export declare const isPropType: <T extends SchemaPropTypes>(type: T, prop: SchemaProp) => prop is SchemaPropTypeMap[T];
+export declare const MAX_ID = 4294967295;
+export declare const MIN_ID = 1;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -95,4 +95,6 @@ export const stringFormats = [
 export const isPropType = (type, prop) => {
     return getPropType(prop) === type;
 };
+export const MAX_ID = 4294967295;
+export const MIN_ID = 1;
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@based/schema",
-  "version": "5.0.0-alpha.1",
+  "version": "5.0.0-alpha.10",
   "license": "MIT",
-  "main": "dist/index.js",
   "files": [
     "dist",
     "README.md",
     "package.json",
     "!dist/**/*.map"
   ],
+  "main": "./dist/index.js",
+  "exports": {
+    "./def": "./dist/def/index.js",
+    ".": "./dist/index.js"
+  },
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch",
-    "test": "tsc && tsc test/*.ts --noEmit && tsx --test test/*.ts",
-    "test1": "tsc && tsc $npm_config --noEmit && tsx --test $npm_config"
+    "test": "tsc && tsc $npm_config --noEmit && tsx --test $npm_config"
   },
   "prettier": "@saulx/prettier-config",
   "sideEffects": false,
@@ -26,6 +29,7 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
+    "@saulx/utils": "^6.4.0",
     "picocolors": "^1.1.0"
   }
 }