@blitznocode/blitz-orm 0.0.40 → 0.0.42

package/changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.0.41(2023-02-03)
+- readme, changelog
+
+## 0.0.40(2023-02-03)
+
+### Features
+- cleaned tests
+
+### Bug fixes
+- All current test working again
+
+## 0.0.39(2023-02-03)
+
+### Features
+- Created as new repo and published

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blitznocode/blitz-orm",
-  "version": "0.0.40",
+  "version": "0.0.42",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -17,8 +17,7 @@
   "license": "AGPL-3.0-only",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/blitz/blitz.git",
-    "directory": "packages/blitz-orm"
+    "url": "https://github.com/Blitzapps/blitz-orm"
   },
   "files": [
     "README.md",
@@ -62,9 +61,9 @@
   },
   "description": "Blitz-orm is a public package that can be open-sourced",
   "bugs": {
-    "url": "https://github.com/blitz/blitz/issues"
+    "url": "https://github.com/Blitzapps/blitz-orm/issues"
   },
-  "homepage": "https://github.com/blitz/blitz#readme",
+  "homepage": "https://github.com/Blitzapps/blitz-orm#readme",
   "directories": {
     "test": "tests"
   },

package/readme.md

@@ -1,15 +1,50 @@
-Blitz-orm is a public package that can be open-sourced
-
-Similar to Prisma, it's used to interpret a BQL schema and provide the client and the server with tools to ensure they are "speaking the same language"
-
-## How to use
-- Install the package with your packages manager, like this: 
-`yarn add @blitznocode/blitz-orm`
-
-- Create a
-
-## Definitions
-
-
-## How does it work
-The client can get
+# Blitz-orm
+Blitz-orm is an Object Relational Mapper (ORM) for graph databases that uses a JSON query language called Blitz Query Language (BQL). BQL is similar to GraphQL but uses JSON instead of strings.
+
+Blitz-orm is similar to other ORM packages such as Prisma. You define a BQL schema and it gets translated to different databases (currently only compatible with TypeDB).
+
+## Compatibility
+Currently, the only database that is compatible with Blitz-orm is TypeDB. The goal is to build adapters for other graph databases such as Dgraph and Neo4j, as well as classic databases like PostgreSQL and MongoDB in the future.
+
+## How to Use
+1. Install the package using your package manager, for example:
+`yarn add @blitznocode/blitz-orm`
+2. Create a Borm schema. You can find an example in the test folder. 
+3. The borm.define() function is currently not working, so you will need to manually translate your BQL schema into a TypeQL schema (an example can be found in the test folder).
+4. Create a configuration file with the database name that you have created in TypeDB.
+5. Initialize Blitz-orm in a file like this:
+```
+import BormClient from '@blitznocode/blitz-orm';
+
+import { bormConfig } from './borm.config';
+import { schema } from './schema';
+
+const bormClient = new BormClient({
+  schema,
+  config: bormConfig,
+});
+
+export default bormClient;
+```
+6. You can then run queries and mutations like this:
+```
+const res = await bormClient.mutate({$entity: 'User', name: 'Ann'}, { noMetadata: true });
+```
+
+## How to Run TypeDB Locally
+To run TypeDB locally, follow the official instructions at https://docs.vaticle.com/docs/running-typedb/install-and-run. It is recommended to run TypeDB Studio, define the schema there, and test with pure TypeQL before using Blitz-orm.
+
+## Collaboration & Contact
+You can contribute to the project by adding adapters for other databases, developing a BQL-to-GraphQL mapper, enhancing performance, or contributing to the public roadmap for this package (not yet published). To get in touch, please send an email to loic@blitznocode.com.
+
+## Warning
+Blitz-orm is currently in alpha version and not ready for production use. Some key queries and mutations do work, but there is still much that needs to be done and performance improvements are needed. One of the biggest performance issues is with nested queries, as they currently require a call to TypeDB for each level of depth.
+
+## What is Currently Working
+To see what is currently working and find examples, please check the test folder, where you will find a variety of queries and mutations.
+
+## The future of this package
+- Achieve 100% compatibility with typeDB functions
+- Enhance functionality with new features such as, cardinality management, ordered attributes, Vectors (ordered relations)...
+- Expand compatibility to other graph databases and traditional databases such as PostgreSQL or MongoDB
+- Enable the ability to split queries and mutations across multiple databases (for example, some data stored in PostgreSQL and other data in typeQL, all queried from a single point)

package/dist/index.d.ts

@@ -1,250 +0,0 @@
-import { TypeDBClient, TypeDBSession } from 'typedb-client';
-
-type BormConfig = {
-    server: {
-        provider: 'blitz-orm-js';
-    };
-    query?: {
-        noMetadata?: boolean;
-        simplifiedLinks?: boolean;
-    };
-    mutation?: {
-        noMetadata?: boolean;
-    };
-    dbConnectors: [ProviderObject, ...ProviderObject[]];
-};
-type ProviderObject = {
-    id: string;
-    provider: 'typeDB';
-    dbName: string;
-    url: string;
-};
-type DBConnector = {
-    id: string;
-    subs?: string;
-    path?: string;
-    as?: string;
-};
-type TypeDBHandles = Map<string, {
-    client: TypeDBClient;
-    session: TypeDBSession;
-}>;
-type DBHandles = {
-    typeDB: TypeDBHandles;
-};
-type BormSchema = {
-    entities: {
-        [s: string]: BormEntity;
-    };
-    relations: {
-        [s: string]: BormRelation;
-    };
-};
-type EnrichedBormSchema = {
-    entities: {
-        [s: string]: EnrichedBormEntity;
-    };
-    relations: {
-        [s: string]: EnrichedBormRelation;
-    };
-};
-type BormEntity = {
-    extends: string;
-    idFields?: string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: DataField[];
-    linkFields?: LinkField[];
-} | {
-    extends?: string;
-    idFields: string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: DataField[];
-    linkFields?: LinkField[];
-};
-type BormRelation = BormEntity & {
-    roles?: {
-        [key: string]: RoleField;
-    };
-};
-type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields'> & {
-    extends?: string;
-    idFields: string[];
-    thingType: 'entity';
-    name: string;
-    computedFields: string[];
-    linkFields?: EnrichedLinkField[];
-};
-type EnrichedBormRelation = Omit<BormRelation, 'linkFields'> & {
-    thingType: 'relation';
-    name: string;
-    computedFields: string[];
-    linkFields?: EnrichedLinkField[];
-    roles: {
-        [key: string]: EnrichedRoleField;
-    };
-};
-type LinkField = BormField & {
-    relation: string;
-    plays: string;
-} & ({
-    target: 'role';
-    filter?: Filter | Filter[];
-} | {
-    target: 'relation';
-});
-type LinkedFieldWithThing = LinkField & {
-    thing: string;
-    thingType: ThingType;
-};
-type RequireAtLeastOne<T> = {
-    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
-}[keyof T];
-type LinkFilter = {
-    $thing?: string;
-    $thingType?: string;
-    $role?: string;
-    [key: string]: string | number | Filter | undefined;
-};
-type Filter = DataFilter | LinkFilter | MiddleFilter;
-type MiddleFilter = {
-    $and?: Filter[];
-    $or?: Filter[];
-};
-type DataFilter = RequireAtLeastOne<{
-    $eq?: any;
-    $ge?: number | 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'>[];
-});
-type BormField = {
-    path: string;
-    cardinality: CardinalityType;
-    ordered?: boolean;
-    embedded?: boolean;
-    rights?: RightType[];
-};
-type RoleField = {
-    cardinality: CardinalityType;
-    dbConnector?: DBConnector;
-};
-type EnrichedRoleField = RoleField & {
-    playedBy?: LinkedFieldWithThing[];
-};
-type DataField = BormField & {
-    shared?: boolean;
-    default?: any;
-    contentType: ContentType;
-    validations?: any;
-    dbConnectors?: [DBConnector, ...DBConnector[]];
-};
-type ThingType = 'entity' | 'relation' | 'attribute';
-type RightType = 'CREATE' | 'DELETE' | 'UPDATE' | 'LINK' | 'UNLINK';
-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 CardinalityType = 'ONE' | 'MANY' | 'INTERVAL';
-type RelationClassType = 'SYMMETRICAL' | 'OWNED';
-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 = {
-    [key: string]: any;
-    $id?: string | string[];
-    $filter?: Filter | Filter[];
-    $tempId?: string;
-    $op?: string;
-} & ({
-    $entity: string;
-} | {
-    $relation: string;
-});
-type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'>;
-type BQLFieldObj = {
-    $path: string;
-} & Omit<RawBQLQuery, '$entity' | '$relation'>;
-type BQLField = string | BQLFieldObj;
-type RawBQLQuery = {
-    $id?: string | string[];
-    $filter?: Record<string, any>;
-    $fields?: BQLField[];
-} & ({
-    $entity: string;
-} | {
-    $relation: string;
-});
-type RawBQLMutation = ({
-    $entity: string;
-} | {
-    $relation: string;
-}) & Record<string, any>;
-type ParsedBQLQuery = Omit<RawBQLQuery, '$entity' | '$relation'> & {
-    $localFilters?: Record<string, any>;
-    $nestedFilters?: Record<string, any>;
-} & ({
-    $entity: EnrichedBormEntity;
-} | {
-    $relation: EnrichedBormRelation;
-});
-type ParsedBQLMutation = {
-    things: BQLMutationBlock[];
-    edges: BQLMutationBlock[];
-};
-type TQLRequest = {
-    entity?: string;
-    roles?: {
-        path: string;
-        request: string;
-        owner: string;
-    }[];
-    relations?: {
-        relation: string;
-        entity: string;
-        request: string;
-    }[];
-    insertionMatches?: string;
-    deletionMatches?: string;
-    insertions?: string;
-    deletions?: string;
-};
-type TQLEntityMutation = {
-    entity: string;
-    relations?: {
-        relation: string;
-        entity: string;
-        request: string;
-    }[];
-};
-type BQLResponseSingle = (({
-    $entity: string;
-    $id: string;
-} | undefined) & Record<string, any>) | string | null;
-type BQLResponseMulti = BQLResponseSingle[];
-type BQLResponse = BQLResponseSingle | BQLResponseMulti;
-
-type BormProps = {
-    schema: BormSchema;
-    config: BormConfig;
-};
-declare class BormClient {
-    #private;
-    private schema;
-    private config;
-    private dbHandles?;
-    constructor({ schema, config }: BormProps);
-    init: () => Promise<void>;
-    introspect: () => Promise<BormSchema>;
-    query: (query: RawBQLQuery, queryConfig?: any) => Promise<void | BQLResponse>;
-    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: any) => Promise<void | BQLResponse>;
-    close: () => Promise<void>;
-}
-
-export { BQLField, BQLFieldObj, BQLMutationBlock, BQLResponse, BQLResponseMulti, BQLResponseSingle, BormConfig, BormEntity, BormField, BormRelation, BormSchema, CardinalityType, ContentType, DBConnector, DBHandles, DataField, DataFilter, EnrichedBormEntity, EnrichedBormRelation, EnrichedBormSchema, EnrichedLinkField, EnrichedRoleField, FilledBQLMutationBlock, Filter, LinkField, LinkFilter, LinkedFieldWithThing, MiddleFilter, ParsedBQLMutation, ParsedBQLQuery, ProviderObject, RawBQLMutation, RawBQLQuery, RelationClassType, RightType, RoleField, TQLEntityMutation, TQLRequest, ThingType, BormClient as default };