@blitznocode/blitz-orm 0.7.3 → 0.8.0

package/dist/index.d.mts

@@ -84,6 +84,191 @@ type DataFilter = RequireAtLeastOne<{
     $ge?: number | string;
 }>;
 
+type BormField = {
+    path: string;
+    cardinality: CardinalityType;
+    ordered?: boolean;
+    embedded?: boolean;
+    rights?: readonly RightType[];
+};
+type RoleField = {
+    cardinality: CardinalityType;
+    dbConnector?: DBConnector;
+};
+type LinkField = BormField & {
+    relation: string;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+} | {
+    target: 'relation';
+});
+type LinkedFieldWithThing = LinkField & {
+    thing: string;
+    thingType: ThingType;
+};
+type StringField = BormField & {
+    contentType: 'ID' | 'COLOR' | 'DATE' | 'FILE' | 'EMAIL' | 'PHONE' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT';
+    default?: {
+        type: 'fn';
+        fn: (currentNode: BQLMutationBlock) => string;
+    } | {
+        type: 'value';
+        value: string;
+    };
+    validations?: {
+        enum?: string[];
+        unique?: boolean;
+        fn?: (value: string) => boolean;
+    };
+};
+type NumberField = BormField & {
+    contentType: 'DURATION' | 'HOUR' | 'RATING' | 'CURRENCY' | 'PERCENTAGE' | 'NUMBER_DECIMAL' | 'NUMBER';
+    default?: {
+        type: 'fn';
+        fn: (currentNode: BQLMutationBlock) => number;
+    } | {
+        type: 'value';
+        value: number;
+    };
+    validations?: {
+        enum?: number[];
+        unique?: boolean;
+        fn?: (value: number) => boolean;
+    };
+};
+type DateField = BormField & {
+    contentType: 'TIME';
+    default?: {
+        type: 'fn';
+        fn: (currentNode: BQLMutationBlock) => Date;
+    } | {
+        type: 'value';
+        value: Date;
+    };
+    validations?: {
+        enum: Date[];
+        fn?: (value: Date) => boolean;
+    };
+};
+type BooleanField = BormField & {
+    contentType: 'BOOLEAN';
+    default?: {
+        type: 'fn';
+        fn: (currentNode: BQLMutationBlock) => boolean;
+    } | {
+        type: 'value';
+        value: boolean;
+    };
+    validations?: {
+        enum?: boolean[];
+        fn?: (value: boolean) => boolean;
+    };
+};
+type AllDataField = StringField | NumberField | DateField | BooleanField;
+type DataField = BormField & {
+    shared?: boolean;
+    validations?: {
+        required?: boolean;
+        unique?: boolean;
+    };
+    isVirtual?: boolean;
+    dbConnectors?: [DBConnector, ...DBConnector[]];
+} & AllDataField;
+type ContentType = keyof ContentTypeMapping;
+type ContentTypeMapping = {
+    ID: string;
+    JSON: unknown;
+    COLOR: string;
+    BOOLEAN: boolean;
+    POINT: {
+        x: number;
+        y: number;
+    };
+    FILE: string;
+    EMAIL: string;
+    PHONE: string;
+    WEEK_DAY: 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';
+    DURATION: number;
+    HOUR: number;
+    TIME: Date;
+    DATE: string;
+    RATING: number;
+    CURRENCY: number;
+    PERCENTAGE: number;
+    NUMBER_DECIMAL: number;
+    NUMBER: number;
+    URL: string;
+    PASSWORD: string;
+    LANGUAGE_TEXT: string;
+    RICH_TEXT: string;
+    TEXT: string;
+};
+type CardinalityType = 'ONE' | 'MANY' | 'INTERVAL';
+type RightType = 'CREATE' | 'DELETE' | 'UPDATE' | 'LINK' | 'UNLINK';
+type BQLFieldObj = {
+    $path: string;
+    $as?: string;
+} & Omit<RawBQLQuery, '$entity' | '$relation' | '$thing' | '$thingType'>;
+type BQLField = string | BQLFieldObj;
+
+type EnrichedBormSchema = {
+    entities: {
+        [s: string]: EnrichedBormEntity;
+    };
+    relations: {
+        [s: string]: EnrichedBormRelation;
+    };
+};
+type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
+    extends?: string;
+    allExtends?: string[];
+    idFields: string[];
+    thingType: 'entity';
+    name: string;
+    computedFields: string[];
+    virtualFields: string[];
+    requiredFields: string[];
+    enumFields: string[];
+    linkFields?: EnrichedLinkField[];
+    dataFields?: EnrichedDataField[];
+};
+type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
+    thingType: 'relation';
+    name: string;
+    computedFields: string[];
+    virtualFields: string[];
+    requiredFields: string[];
+    enumFields: string[];
+    linkFields?: EnrichedLinkField[];
+    dataFields?: EnrichedDataField[];
+    roles: {
+        [key: string]: EnrichedRoleField;
+    };
+};
+type EnrichedRoleField = RoleField & {
+    playedBy?: LinkedFieldWithThing[];
+    name: string;
+};
+type EnrichedDataField = DataField & {
+    dbPath: string;
+};
+type EnrichedLinkField = BormField & {
+    name: string;
+    relation: string;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+    oppositeLinkFieldsPlayedBy: LinkedFieldWithThing[];
+} | {
+    target: 'relation';
+    oppositeLinkFieldsPlayedBy: Pick<LinkedFieldWithThing, 'thing' | 'thingType' | 'plays'>[];
+});
+
+declare const Schema: unique symbol;
+
 type RequiredKey<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };
@@ -102,7 +287,10 @@ type BQLMutationBlock = {
     $thing: string;
     $thingType: 'entity' | 'relation';
 });
-type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'>;
+type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'> & {
+    $entity?: string;
+    [Schema]: EnrichedBormEntity | EnrichedBormRelation;
+};
 type RawBQLMutation<T extends Record<string, any> = Record<string, any>> = ({
     $id?: string;
     $op?: 'create' | 'delete' | 'update';
@@ -179,6 +367,7 @@ type BormEntity = {
     defaultDBConnector: DBConnector;
     dataFields?: readonly DataField[];
     linkFields?: readonly LinkField[];
+    hooks?: Hooks;
 } | {
     extends?: string;
     idFields: readonly string[];
@@ -194,125 +383,26 @@ type BormRelation = BormEntity & {
         [key: string]: RoleField;
     };
 };
-
-type BormField = {
-    path: string;
-    cardinality: CardinalityType;
-    ordered?: boolean;
-    embedded?: boolean;
-    rights?: readonly RightType[];
-};
-type RoleField = {
-    cardinality: CardinalityType;
-    dbConnector?: DBConnector;
-};
-type LinkField = BormField & {
-    relation: string;
-    plays: string;
-} & ({
-    target: 'role';
-    filter?: Filter | Filter[];
-} | {
-    target: 'relation';
-});
-type LinkedFieldWithThing = LinkField & {
-    thing: string;
-    thingType: ThingType;
-};
-type DataField = BormField & {
-    shared?: boolean;
-    default?: any;
-    contentType: ContentType;
-    validations?: any;
-    isVirtual?: boolean;
-    dbConnectors?: [DBConnector, ...DBConnector[]];
+type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink';
+type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink';
+type Hooks = {
+    pre?: readonly PreHook[];
 };
-type ContentType = 'ID' | 'JSON' | 'COLOR' | 'BOOLEAN' | 'POINT' | 'FILE' | 'EMAIL' | 'PHONE' | 'WEEK_DAY' | 'DURATION' | 'HOUR' | 'TIME' | 'DATE' | 'RATING' | 'CURRENCY' | 'PERCENTAGE' | 'NUMBER_DECIMAL' | 'NUMBER' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT';
-type ContentTypeMapping = {
-    ID: string;
-    JSON: any;
-    COLOR: string;
-    BOOLEAN: boolean;
-    POINT: {
-        x: number;
-        y: number;
-    };
-    FILE: string;
-    EMAIL: string;
-    PHONE: string;
-    WEEK_DAY: 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';
-    DURATION: number;
-    HOUR: number;
-    TIME: Date;
-    DATE: Date;
-    RATING: number;
-    CURRENCY: number;
-    PERCENTAGE: number;
-    NUMBER_DECIMAL: number;
-    NUMBER: number;
-    URL: string;
-    PASSWORD: string;
-    LANGUAGE_TEXT: string;
-    RICH_TEXT: string;
-    TEXT: string;
-};
-type CardinalityType = 'ONE' | 'MANY' | 'INTERVAL';
-type RightType = 'CREATE' | 'DELETE' | 'UPDATE' | 'LINK' | 'UNLINK';
-type BQLFieldObj = {
-    $path: string;
-    $as?: string;
-} & Omit<RawBQLQuery, '$entity' | '$relation' | '$thing' | '$thingType'>;
-type BQLField = string | BQLFieldObj;
-
-type EnrichedBormSchema = {
-    entities: {
-        [s: string]: EnrichedBormEntity;
-    };
-    relations: {
-        [s: string]: EnrichedBormRelation;
+type PreHook = {
+    triggers: {
+        [K in BormTrigger]?: () => boolean;
     };
+    actions: readonly Action[];
 };
-type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
-    extends?: string;
-    allExtends?: string[];
-    idFields: string[];
-    thingType: 'entity';
-    name: string;
-    computedFields: string[];
-    virtualFields: string[];
-    linkFields?: EnrichedLinkField[];
-    dataFields?: EnrichedDataField[];
-};
-type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
-    thingType: 'relation';
-    name: string;
-    computedFields: string[];
-    virtualFields: string[];
-    linkFields?: EnrichedLinkField[];
-    dataFields?: EnrichedDataField[];
-    roles: {
-        [key: string]: EnrichedRoleField;
-    };
-};
-type EnrichedRoleField = RoleField & {
-    playedBy?: LinkedFieldWithThing[];
-    name: string;
-};
-type EnrichedDataField = DataField & {
-    dbPath: string;
-};
-type EnrichedLinkField = BormField & {
-    name: string;
-    relation: string;
-    plays: string;
-} & ({
-    target: 'role';
-    filter?: Filter | Filter[];
-    oppositeLinkFieldsPlayedBy: LinkedFieldWithThing[];
+type Action = {
+    type: 'validate';
+    fn: (entity: FilledBQLMutationBlock) => boolean;
+    severity: 'error' | 'warning' | 'info';
+    message: string;
 } | {
-    target: 'relation';
-    oppositeLinkFieldsPlayedBy: Pick<LinkedFieldWithThing, 'thing' | 'thingType' | 'plays'>[];
-});
+    type: 'transform';
+    fn: (entity: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
+};
 
 type ContentTypeToType<C extends keyof ContentTypeMapping> = ContentTypeMapping[C];
 type HandleCardinality<T, C extends 'ONE' | 'MANY'> = C extends 'MANY' ? T[] : T;
@@ -380,4 +470,4 @@ declare class BormClient {
     close: () => Promise<void>;
 }
 
-export { BQLField, BQLFieldObj, BQLMutationBlock, BQLResponse, BQLResponseMulti, BQLResponseSingle, BormConfig, BormEntity, BormField, BormMetadata, BormRelation, BormSchema, CardinalityType, CommonProperties, ContentType, ContentTypeMapping, DBConnector, DBHandles, DataField, DataFilter, EnrichedBormEntity, EnrichedBormRelation, EnrichedBormSchema, EnrichedDataField, EnrichedLinkField, EnrichedRoleField, FilledBQLMutationBlock, Filter, LinkField, LinkFilter, LinkedFieldWithThing, MiddleFilter, MutateConfig, ParsedBQLMutation, ParsedBQLQuery, Provider, ProviderObject, QueryConfig, RawBQLMutation, RawBQLQuery, RightType, RoleField, TQLEntityMutation, TQLRequest, ThingType, TypeDBClusterProviderObject, TypeDBHandles, TypeDBProviderObject, TypeGen, WithBormMetadata, BormClient as default };
+export { Action, BQLField, BQLFieldObj, BQLMutationBlock, BQLResponse, BQLResponseMulti, BQLResponseSingle, BormConfig, BormEntity, BormField, BormMetadata, BormOperation, BormRelation, BormSchema, BormTrigger, CardinalityType, CommonProperties, ContentType, ContentTypeMapping, DBConnector, DBHandles, DataField, DataFilter, EnrichedBormEntity, EnrichedBormRelation, EnrichedBormSchema, EnrichedDataField, EnrichedLinkField, EnrichedRoleField, FilledBQLMutationBlock, Filter, Hooks, LinkField, LinkFilter, LinkedFieldWithThing, MiddleFilter, MutateConfig, ParsedBQLMutation, ParsedBQLQuery, PreHook, Provider, ProviderObject, QueryConfig, RawBQLMutation, RawBQLQuery, RightType, RoleField, TQLEntityMutation, TQLRequest, ThingType, TypeDBClusterProviderObject, TypeDBHandles, TypeDBProviderObject, TypeGen, WithBormMetadata, BormClient as default };