@blitznocode/blitz-orm 0.8.11 → 0.9.0

package/dist/index.d.mts

@@ -20,7 +20,7 @@ type QueryConfig = {
     simplifiedLinks?: boolean;
     debugger?: boolean;
 };
-type MutateConfig = {
+type MutationConfig = {
     noMetadata?: boolean;
     preQuery?: boolean;
     ignoreNonexistingThings?: boolean;
@@ -30,7 +30,7 @@ type BormConfig = {
         provider: 'blitz-orm-js';
     };
     query?: QueryConfig;
-    mutation?: MutateConfig;
+    mutation?: MutationConfig;
     dbConnectors: [ProviderObject, ...ProviderObject[]];
 };
 type ProviderObject = (TypeDBProviderObject & CommonProperties) | (TypeDBClusterProviderObject & CommonProperties);
@@ -45,11 +45,17 @@ type DBConnector = {
     path?: string;
     as?: string;
 };
-type DBHandles = {
+type AllDbHandles = {
     typeDB: TypeDBHandles;
+    surrealDB: any;
 };
+type AtLeastOne<T, U = {
+    [K in keyof T]: Pick<T, K>;
+}> = Partial<T> & U[keyof U];
+type DBHandles = AtLeastOne<AllDbHandles>;
+type DBHandleKey = keyof DBHandles;
 
-type ThingType = 'entity' | 'relation' | 'attribute';
+type ThingType = 'entity' | 'relation';
 type BormMetadata = {
     $id: string;
     $op?: string;
@@ -84,6 +90,66 @@ type DataFilter = RequireAtLeastOne<{
     $ge?: number | string;
 }>;
 
+type BormSchema = {
+    entities: {
+        [s: string]: BormEntity;
+    };
+    relations: {
+        [s: string]: BormRelation;
+    };
+};
+type BormEntity = {
+    extends: string;
+    idFields?: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+    hooks?: Hooks;
+} | {
+    idFields: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+    hooks?: Hooks;
+};
+type BormRelation = BormEntity & {
+    defaultDBConnector: DBConnector & {
+        path: string;
+    };
+    roles?: {
+        [key: string]: RoleField;
+    };
+};
+type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink' | 'replace' | 'match';
+type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink' | 'onReplace' | 'onMatch';
+type Hooks = {
+    pre?: readonly PreHook[];
+};
+type PreHook = {
+    triggers: {
+        [K in BormTrigger]?: () => boolean;
+    };
+    actions: readonly Action[];
+};
+type Action = TransFormAction | ValidateAction;
+type TransFormAction = {
+    type: 'transform';
+    fn: (currentNode: FilledBQLMutationBlock, parentNode?: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
+};
+type ValidateAction = {
+    type: 'validate';
+    fn: (currentNode: FilledBQLMutationBlock, parentNode: FilledBQLMutationBlock) => boolean;
+    severity: 'error' | 'warning' | 'info';
+    message: string;
+};
+
+type AdapterContext = {
+    mutation: {
+        splitArray$Ids: boolean;
+        requiresParseBQL: boolean;
+    };
+};
+
 type BormField = {
     path: string;
     cardinality?: CardinalityType;
@@ -231,6 +297,8 @@ type SharedEnrichedProps = {
     fnValidatedFields: string[];
     linkFields?: EnrichedLinkField[];
     dataFields?: EnrichedDataField[];
+    db: DBHandleKey;
+    dbContext: AdapterContext;
 };
 type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
     extends?: string;
@@ -247,6 +315,7 @@ type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
 type EnrichedRoleField = RoleField & {
     playedBy?: LinkedFieldWithThing[];
     name: string;
+    fieldType: 'roleField';
 };
 type EnrichedDataField = DataField & {
     dbPath: string;
@@ -255,6 +324,7 @@ type EnrichedLinkField = BormField & {
     name: string;
     relation: string;
     plays: string;
+    fieldType: 'linkField';
 } & ({
     target: 'role';
     filter?: Filter | Filter[];
@@ -265,12 +335,15 @@ type EnrichedLinkField = BormField & {
 });
 
 declare const Schema: unique symbol;
+declare const EdgeType: unique symbol;
+declare const EdgeSchema: unique symbol;
 
 type RequiredKey<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };
 type WithRequired<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>> & RequiredKey<T, K>;
-type BQLMutationBlock = {
+type BQLMutation = RootBQLMutationBlock | RootBQLMutationBlock[];
+type RootBQLMutationBlock = {
     [key: string]: any;
     $id?: string | string[];
     $filter?: Filter | Filter[];
@@ -282,11 +355,35 @@ type BQLMutationBlock = {
     $relation: string;
 } | {
     $thing: string;
-    $thingType: 'entity' | 'relation';
+    $thingType?: 'entity' | 'relation';
 });
-type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'> & {
+type BQLMutationBlock = {
+    [key: string]: any;
+    $id?: string | string[];
+    $filter?: Filter | Filter[];
+    $tempId?: string;
+    $op?: string;
     $entity?: string;
-    [Schema]: EnrichedBormEntity | EnrichedBormRelation;
+    $relation?: string;
+    $thing?: string;
+    $thingType?: 'entity' | 'relation';
+};
+type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$op'> & {
+    $entity?: string;
+    $relation?: string;
+    [Schema]?: EnrichedBormEntity | EnrichedBormRelation;
+    [EdgeType]?: 'linkField' | 'roleField';
+};
+type EnrichedBQLMutationBlock = {
+    [key: string]: any;
+    $id?: string | string[];
+    $filter?: Filter | Filter[];
+    $tempId?: string;
+    $op: BormOperation;
+    $thing: string;
+    $thingType: 'entity' | 'relation';
+    [EdgeSchema]?: EnrichedDataField | EnrichedLinkField | EnrichedRoleField;
+    [EdgeType]?: 'linkField' | 'roleField';
 };
 type RawBQLMutation<T extends Record<string, any> = Record<string, any>> = ({
     $id?: string;
@@ -350,59 +447,6 @@ type TQLEntityMutation = {
     }[];
 };
 
-type BormSchema = {
-    entities: {
-        [s: string]: BormEntity;
-    };
-    relations: {
-        [s: string]: BormRelation;
-    };
-};
-type BormEntity = {
-    extends: string;
-    idFields?: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    hooks?: Hooks;
-} | {
-    idFields: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    hooks?: Hooks;
-};
-type BormRelation = BormEntity & {
-    defaultDBConnector: DBConnector & {
-        path: string;
-    };
-    roles?: {
-        [key: string]: RoleField;
-    };
-};
-type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink';
-type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink';
-type Hooks = {
-    pre?: readonly PreHook[];
-};
-type PreHook = {
-    triggers: {
-        [K in BormTrigger]?: () => boolean;
-    };
-    actions: readonly Action[];
-};
-type Action = TransFormAction | ValidateAction;
-type TransFormAction = {
-    type: 'transform';
-    fn: (currentNode: FilledBQLMutationBlock, parentNode?: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
-};
-type ValidateAction = {
-    type: 'validate';
-    fn: (currentNode: FilledBQLMutationBlock, parentNode: FilledBQLMutationBlock) => boolean;
-    severity: 'error' | 'warning' | 'info';
-    message: string;
-};
-
 type ContentTypeToType<C extends keyof ContentTypeMapping> = ContentTypeMapping[C];
 type HandleCardinality<T, C extends 'ONE' | 'MANY'> = C extends 'MANY' ? T[] : T;
 type ContentTypeAndCardinality = {
@@ -466,8 +510,8 @@ declare class BormClient {
     introspect: () => Promise<BormSchema>;
     define: () => Promise<void>;
     query: (query: RawBQLQuery | RawBQLQuery[], queryConfig?: QueryConfig) => Promise<BQLResponse>;
-    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: MutateConfig) => Promise<BQLResponseMulti>;
+    mutate: (mutation: BQLMutation, mutationConfig?: MutationConfig) => Promise<BQLResponseMulti>;
     close: () => Promise<void>;
 }
 
-export { type Action, type BQLField, type BQLFieldObj, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type CardinalityType, type CommonProperties, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandles, type DataField, type DataFilter, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedLinkField, type EnrichedRoleField, type FilledBQLMutationBlock, type Filter, type Hooks, type LinkField, type LinkFilter, type LinkedFieldWithThing, type MiddleFilter, type MutateConfig, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type TQLEntityMutation, type TQLRequest, type ThingType, type TransFormAction, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type ValidateAction, type WithBormMetadata, BormClient as default };
+export { type Action, type BQLField, type BQLFieldObj, type BQLMutation, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type CardinalityType, type CommonProperties, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandleKey, type DBHandles, type DataField, type DataFilter, type EnrichedBQLMutationBlock, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedLinkField, type EnrichedRoleField, type FilledBQLMutationBlock, type Filter, type Hooks, type LinkField, type LinkFilter, type LinkedFieldWithThing, type MiddleFilter, type MutationConfig, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type RootBQLMutationBlock, type TQLEntityMutation, type TQLRequest, type ThingType, type TransFormAction, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type ValidateAction, type WithBormMetadata, BormClient as default };

package/dist/index.d.ts

@@ -20,7 +20,7 @@ type QueryConfig = {
     simplifiedLinks?: boolean;
     debugger?: boolean;
 };
-type MutateConfig = {
+type MutationConfig = {
     noMetadata?: boolean;
     preQuery?: boolean;
     ignoreNonexistingThings?: boolean;
@@ -30,7 +30,7 @@ type BormConfig = {
         provider: 'blitz-orm-js';
     };
     query?: QueryConfig;
-    mutation?: MutateConfig;
+    mutation?: MutationConfig;
     dbConnectors: [ProviderObject, ...ProviderObject[]];
 };
 type ProviderObject = (TypeDBProviderObject & CommonProperties) | (TypeDBClusterProviderObject & CommonProperties);
@@ -45,11 +45,17 @@ type DBConnector = {
     path?: string;
     as?: string;
 };
-type DBHandles = {
+type AllDbHandles = {
     typeDB: TypeDBHandles;
+    surrealDB: any;
 };
+type AtLeastOne<T, U = {
+    [K in keyof T]: Pick<T, K>;
+}> = Partial<T> & U[keyof U];
+type DBHandles = AtLeastOne<AllDbHandles>;
+type DBHandleKey = keyof DBHandles;
 
-type ThingType = 'entity' | 'relation' | 'attribute';
+type ThingType = 'entity' | 'relation';
 type BormMetadata = {
     $id: string;
     $op?: string;
@@ -84,6 +90,66 @@ type DataFilter = RequireAtLeastOne<{
     $ge?: number | string;
 }>;
 
+type BormSchema = {
+    entities: {
+        [s: string]: BormEntity;
+    };
+    relations: {
+        [s: string]: BormRelation;
+    };
+};
+type BormEntity = {
+    extends: string;
+    idFields?: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+    hooks?: Hooks;
+} | {
+    idFields: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+    hooks?: Hooks;
+};
+type BormRelation = BormEntity & {
+    defaultDBConnector: DBConnector & {
+        path: string;
+    };
+    roles?: {
+        [key: string]: RoleField;
+    };
+};
+type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink' | 'replace' | 'match';
+type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink' | 'onReplace' | 'onMatch';
+type Hooks = {
+    pre?: readonly PreHook[];
+};
+type PreHook = {
+    triggers: {
+        [K in BormTrigger]?: () => boolean;
+    };
+    actions: readonly Action[];
+};
+type Action = TransFormAction | ValidateAction;
+type TransFormAction = {
+    type: 'transform';
+    fn: (currentNode: FilledBQLMutationBlock, parentNode?: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
+};
+type ValidateAction = {
+    type: 'validate';
+    fn: (currentNode: FilledBQLMutationBlock, parentNode: FilledBQLMutationBlock) => boolean;
+    severity: 'error' | 'warning' | 'info';
+    message: string;
+};
+
+type AdapterContext = {
+    mutation: {
+        splitArray$Ids: boolean;
+        requiresParseBQL: boolean;
+    };
+};
+
 type BormField = {
     path: string;
     cardinality?: CardinalityType;
@@ -231,6 +297,8 @@ type SharedEnrichedProps = {
     fnValidatedFields: string[];
     linkFields?: EnrichedLinkField[];
     dataFields?: EnrichedDataField[];
+    db: DBHandleKey;
+    dbContext: AdapterContext;
 };
 type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
     extends?: string;
@@ -247,6 +315,7 @@ type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
 type EnrichedRoleField = RoleField & {
     playedBy?: LinkedFieldWithThing[];
     name: string;
+    fieldType: 'roleField';
 };
 type EnrichedDataField = DataField & {
     dbPath: string;
@@ -255,6 +324,7 @@ type EnrichedLinkField = BormField & {
     name: string;
     relation: string;
     plays: string;
+    fieldType: 'linkField';
 } & ({
     target: 'role';
     filter?: Filter | Filter[];
@@ -265,12 +335,15 @@ type EnrichedLinkField = BormField & {
 });
 
 declare const Schema: unique symbol;
+declare const EdgeType: unique symbol;
+declare const EdgeSchema: unique symbol;
 
 type RequiredKey<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };
 type WithRequired<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>> & RequiredKey<T, K>;
-type BQLMutationBlock = {
+type BQLMutation = RootBQLMutationBlock | RootBQLMutationBlock[];
+type RootBQLMutationBlock = {
     [key: string]: any;
     $id?: string | string[];
     $filter?: Filter | Filter[];
@@ -282,11 +355,35 @@ type BQLMutationBlock = {
     $relation: string;
 } | {
     $thing: string;
-    $thingType: 'entity' | 'relation';
+    $thingType?: 'entity' | 'relation';
 });
-type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'> & {
+type BQLMutationBlock = {
+    [key: string]: any;
+    $id?: string | string[];
+    $filter?: Filter | Filter[];
+    $tempId?: string;
+    $op?: string;
     $entity?: string;
-    [Schema]: EnrichedBormEntity | EnrichedBormRelation;
+    $relation?: string;
+    $thing?: string;
+    $thingType?: 'entity' | 'relation';
+};
+type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$op'> & {
+    $entity?: string;
+    $relation?: string;
+    [Schema]?: EnrichedBormEntity | EnrichedBormRelation;
+    [EdgeType]?: 'linkField' | 'roleField';
+};
+type EnrichedBQLMutationBlock = {
+    [key: string]: any;
+    $id?: string | string[];
+    $filter?: Filter | Filter[];
+    $tempId?: string;
+    $op: BormOperation;
+    $thing: string;
+    $thingType: 'entity' | 'relation';
+    [EdgeSchema]?: EnrichedDataField | EnrichedLinkField | EnrichedRoleField;
+    [EdgeType]?: 'linkField' | 'roleField';
 };
 type RawBQLMutation<T extends Record<string, any> = Record<string, any>> = ({
     $id?: string;
@@ -350,59 +447,6 @@ type TQLEntityMutation = {
     }[];
 };
 
-type BormSchema = {
-    entities: {
-        [s: string]: BormEntity;
-    };
-    relations: {
-        [s: string]: BormRelation;
-    };
-};
-type BormEntity = {
-    extends: string;
-    idFields?: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    hooks?: Hooks;
-} | {
-    idFields: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    hooks?: Hooks;
-};
-type BormRelation = BormEntity & {
-    defaultDBConnector: DBConnector & {
-        path: string;
-    };
-    roles?: {
-        [key: string]: RoleField;
-    };
-};
-type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink';
-type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink';
-type Hooks = {
-    pre?: readonly PreHook[];
-};
-type PreHook = {
-    triggers: {
-        [K in BormTrigger]?: () => boolean;
-    };
-    actions: readonly Action[];
-};
-type Action = TransFormAction | ValidateAction;
-type TransFormAction = {
-    type: 'transform';
-    fn: (currentNode: FilledBQLMutationBlock, parentNode?: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
-};
-type ValidateAction = {
-    type: 'validate';
-    fn: (currentNode: FilledBQLMutationBlock, parentNode: FilledBQLMutationBlock) => boolean;
-    severity: 'error' | 'warning' | 'info';
-    message: string;
-};
-
 type ContentTypeToType<C extends keyof ContentTypeMapping> = ContentTypeMapping[C];
 type HandleCardinality<T, C extends 'ONE' | 'MANY'> = C extends 'MANY' ? T[] : T;
 type ContentTypeAndCardinality = {
@@ -466,8 +510,8 @@ declare class BormClient {
     introspect: () => Promise<BormSchema>;
     define: () => Promise<void>;
     query: (query: RawBQLQuery | RawBQLQuery[], queryConfig?: QueryConfig) => Promise<BQLResponse>;
-    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: MutateConfig) => Promise<BQLResponseMulti>;
+    mutate: (mutation: BQLMutation, mutationConfig?: MutationConfig) => Promise<BQLResponseMulti>;
     close: () => Promise<void>;
 }
 
-export { type Action, type BQLField, type BQLFieldObj, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type CardinalityType, type CommonProperties, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandles, type DataField, type DataFilter, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedLinkField, type EnrichedRoleField, type FilledBQLMutationBlock, type Filter, type Hooks, type LinkField, type LinkFilter, type LinkedFieldWithThing, type MiddleFilter, type MutateConfig, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type TQLEntityMutation, type TQLRequest, type ThingType, type TransFormAction, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type ValidateAction, type WithBormMetadata, BormClient as default };
+export { type Action, type BQLField, type BQLFieldObj, type BQLMutation, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type CardinalityType, type CommonProperties, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandleKey, type DBHandles, type DataField, type DataFilter, type EnrichedBQLMutationBlock, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedLinkField, type EnrichedRoleField, type FilledBQLMutationBlock, type Filter, type Hooks, type LinkField, type LinkFilter, type LinkedFieldWithThing, type MiddleFilter, type MutationConfig, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type RootBQLMutationBlock, type TQLEntityMutation, type TQLRequest, type ThingType, type TransFormAction, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type ValidateAction, type WithBormMetadata, BormClient as default };