@goatlab/fluent 0.6.24 → 0.7.1

package/README.md

@@ -12,20 +12,20 @@
        <img src="https://docs.goatlab.io/logo.png" alt="Logo" width="150" height="150">
   </a>
 
-  <h3 align="center">GOAT-FLUENT</h3>
+  <h3 align="center">GOAT - FLUENT</h3>
 
   <p align="center">
-    Readable query Interface & API generator
+    Fluent - Time Saving (TS) utils
     <br />
-    <a href="https://docs.goatlab.io/#/0.5.x/fluent/fluent"><strong>Explore the docs »</strong></a>
+    <a href="https://docs.goatlab.io/#/0.7.x/fluent/fluent"><strong>Explore the docs »</strong></a>
     <br />
     <br />
-    <a href="https://codesandbox.io/s/goat-nestjs-tytmv?file=/src/main.ts">View Demo</a>
     ·
     <a href="https://github.com/goat-io/fluent/issues">Report Bug</a>
     ·
     <a href="https://github.com/goat-io/fluent/issues">Request Feature</a>
   </p>
+  </p>
 </p>
 
 # Goat - Fluent
@@ -34,147 +34,28 @@ Fluent query interface for Multiple database types and helpers for fast API gene
 
 ## Supported Databases
 
-1. Firebase\*\*
-2. MongoDB\*
-3. Mysql\*
-4. MariaDB\*
-5. SQLite\*
-6. Postgres\*
-7. CockroachDB\*
-8. Microsoft SQL Server\*
-9. Oracle\*
-10. SAP Hana\*
-11. sql.js\*
-12. LokiJS
-13. In-memory
+1. MongoDB\*
+2. Mysql\*
+3. MariaDB\*
+4. SQLite\*
+5. Postgres\*
+6. CockroachDB\*
+7. Microsoft SQL Server\*
+8. Oracle\*
+9. SAP Hana\*
+10. sql.js\*
+11. In-memory SQlite
 
 Wrapper for TypeORM \*
 
-Wrapper for firebase-admin and fireorm \*\*
-
 ### Installing
 
 To install this package in your project, you can use the following command within your terminal.
 
 ```bash
-npm install --global @goatlab/fluent
+yarn add @goatlab/fluent
 ```
 
 ### Documentation
 
-To learn how to use this visit the [Goat Docs](https://docs.goatlab.io/#/0.5.x/fluent/fluent)
-
-<!--
-
-Packages that we need to replace
-npm-pack-zip
-@commitlint/prompt-cli
-formiojs
-react-native
-multer-google-storage
-nestjs-typed-dynamodb
--->
-
-## Roadmap
-
-See the [open issues](https://github.com/github_username/repo/issues) for a list of proposed features (and known issues).
-
-<!-- CONTRIBUTING -->
-
-## Contributing
-
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
-
-We use a few tools to help with code styling, pre-commits, versioning, changelog and releases.
-
-- [Pretty-quick](https://github.com/azz/pretty-quick)
-- [Husky](https://github.com/typicode/husky)
-- [Auto-changelog](https://github.com/CookPete/auto-changelog)
-- [Release-it](https://github.com/release-it/release-it)
-
-All of these should run out of the box with your dev dependencies
-
-1. If you have an issue assigned, please include the issue code/id in the beginning of you commits.
-2. Include the issue id also at the start of your PR message.
-3. Fork the Project
-4. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-5. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-6. Push to the Branch (`git push origin feature/AmazingFeature`)
-7. Open a Pull Request
-
-## Release Process
-
-1. All PRs will be merge directly into Master. (If test are green)
-2. Once we are ready to create a release, we will locally pull the latest master version and run the release process
-
-If patch release
-
-```
-npm run release
-```
-
-If minor release
-
-```
-npm run release:minor
-```
-
-If mayor release
-
-```
-npm run release:mayor
-```
-
-This will start the release scripts including:
-
-- Local tests
-- Final version building
-- Final release zip
-- Tag
-- Release
-- Push
-
-## Continuous Deployment
-
-Continuous deployment is optional. We will trigger a deployment with every published release. The equivalent trigger in Github Actions is:
-
-```yml
-on:
-  release:
-    types: [published]
-```
-
-<!-- LICENSE -->
-
-## License
-
-Distributed under the MIT License. See `LICENSE` for more information.
-
-<!-- CONTACT -->
-
-## Contact
-
-Ignacio Cabrera - [@twitter_handle](https://twitter.com/cabrerabywaters) - ignacio.cabrera@goatlab.io
-
-<!-- ACKNOWLEDGEMENTS -->
-
-## Acknowledgements
-
-- [Tomas Castro]()
-- []()
-- []()
-
-<!-- MARKDOWN LINKS & IMAGES -->
-<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-
-[contributors-url]: https://github.com/goat-io/fluent/graphs/contributors
-[forks-url]: https://github.com/goat-io/fluent/network/members
-[stars-shield]: https://img.shields.io/github/stars/goat-io/fluent?style=flat-square
-[stars-url]: https://github.com/goat-io/fluent/stargazers
-[issues-shield]: https://img.shields.io/github/issues/goat-io/fluent?style=flat-square
-[issues-url]: https://github.com/goat-io/fluent/issues
-[license-shield]: https://img.shields.io/github/license/goat-io/fluent?style=flat-square
-[license-url]: https://github.com/goat-io/fluent/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/othneildrew
-[product-screenshot]: images/screenshot.png
+To learn how to use this visit the [Goat Docs](https://docs.goatlab.io/#/0.7.x/fluent/fluent)

package/dist/BaseConnector.d.ts

@@ -1,89 +1,59 @@
-import { TypedPathWrapper } from 'typed-path';
 import { Collection } from '@goatlab/js-utils';
-import { Filter, LogicOperator, Primitives, PrimitivesArray } from './types';
-import { ValidationError } from 'class-validator';
-export interface FluentConnectorInterface<InputDTO, OutputDTO> {
-    get(): Promise<OutputDTO[]>;
-    all(filter: Filter): Promise<OutputDTO[]>;
-    findById(id: string): Promise<OutputDTO>;
-    findByIds(id: string[]): Promise<OutputDTO[]>;
-    find(filter: Filter): Promise<OutputDTO[]>;
-    deleteById(id: string): Promise<string>;
-    updateById(id: string, data: InputDTO): Promise<OutputDTO>;
+import { FindByIdFilter, FluentHasManyParams, FluentBelongsToParams, FluentBelongsToManyParams, FluentQuery, LogicOperator, Primitives, PrimitivesArray, QueryFieldSelector, QueryOutput, SingleQueryOutput } from './types';
+export interface FluentConnectorInterface<ModelDTO, InputDTO, OutputDTO> {
+    findByIds<T extends FindByIdFilter<ModelDTO>>(ids: string[], q?: T): Promise<QueryOutput<T, ModelDTO, OutputDTO>>;
+    findMany<T extends FluentQuery<ModelDTO>>(query?: T): Promise<QueryOutput<T, ModelDTO, OutputDTO>>;
     insert(data: InputDTO): Promise<OutputDTO>;
     insertMany(data: InputDTO[]): Promise<OutputDTO[]>;
+    loadFirst(query?: FluentQuery<ModelDTO>): any;
+    loadById(id: string): any;
+    replaceById(id: string, data: InputDTO): Promise<OutputDTO>;
+    updateById(id: string, data: InputDTO): Promise<OutputDTO>;
+    clear(): Promise<boolean>;
+    requireById(id: string, q?: FindByIdFilter<ModelDTO>): Promise<SingleQueryOutput<FindByIdFilter<ModelDTO>, ModelDTO, OutputDTO>>;
 }
 export declare abstract class BaseConnector<ModelDTO, InputDTO, OutputDTO> {
-    generatedKeyPath: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never> & {
-        $path: (path: import("typed-path").TypedPathKey[]) => string;
-        $raw: (path: import("typed-path").TypedPathKey[]) => string[];
-        $rawPath: (path: import("typed-path").TypedPathKey[]) => import("typed-path").TypedPathKey[];
-        toString: (path: import("typed-path").TypedPathKey[]) => () => string;
-        valueOf: (path: import("typed-path").TypedPathKey[]) => () => string;
-        [Symbol.toStringTag]: (path: import("typed-path").TypedPathKey[]) => string;
-    }>;
     protected outputKeys: string[];
-    protected chainReference: any[];
-    protected whereArray: any[];
-    protected orWhereArray: any[];
-    protected selectArray: any[];
-    protected forceSelectArray: any[];
-    protected orderByArray: any[];
-    protected limitNumber: number;
-    protected offsetNumber: number;
-    protected populateArray: any[];
-    protected chunk: any;
-    protected pullSize: any;
-    protected ownerId: any;
-    protected paginator: any;
-    protected rawQuery: any;
-    protected getFirst: boolean;
-    protected relations: any;
-    protected loadModels: boolean;
-    protected relationQuery: any;
+    protected relatedQuery?: {
+        entity: new () => ModelDTO;
+        query?: FluentQuery<ModelDTO>;
+        repository?: any;
+        key?: string;
+        pivot?: any;
+    };
+    protected chunk: null;
+    protected pullSize: null;
+    protected paginator: undefined;
+    protected rawQuery: undefined;
     protected modelRelations: any;
     isMongoDB: boolean;
     constructor();
-    findByIds(ids: string[]): Promise<OutputDTO[]>;
-    get(): Promise<OutputDTO[]>;
+    findByIds<T extends FindByIdFilter<ModelDTO>>(ids: string[], q?: T): Promise<QueryOutput<T, ModelDTO, OutputDTO>>;
     insertMany(data: InputDTO[]): Promise<OutputDTO[]>;
     updateById(id: string, data: InputDTO): Promise<OutputDTO>;
-    owner(user: string): this;
-    own(user: string): this;
-    first(): Promise<OutputDTO | null>;
-    collect(): Promise<Collection<OutputDTO>>;
-    select(paths: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>>[] | TypedPathWrapper<string[], Record<never, never>[]>): this;
-    forceSelect(paths: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>>[] | TypedPathWrapper<string[], Record<never, never>[]>): this;
-    offset(offset: number): this;
-    populate(...relations: any[]): this;
-    skip(offset: number): this;
-    where(path: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>> | TypedPathWrapper<string[], Record<never, never>>, operator: LogicOperator, value: Primitives | PrimitivesArray): this;
-    andWhere(path: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>> | TypedPathWrapper<string[], Record<never, never>>, operator: LogicOperator, value: Primitives | Primitives[]): this;
-    orWhere(path: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>> | TypedPathWrapper<string[], Record<never, never>>, operator: LogicOperator, value: Primitives): this;
-    limit(limit: number): this;
-    take(limit: number): this;
-    pluck(path: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>> | TypedPathWrapper<string[], Record<never, never>>): Promise<string[]>;
-    orderBy(path: (p: TypedPathWrapper<ModelDTO & InputDTO & OutputDTO, Record<never, never>>) => TypedPathWrapper<string, Record<never, never>> | TypedPathWrapper<string[], Record<never, never>>, order?: 'asc' | 'desc', orderType?: 'string' | 'number' | 'date'): this;
-    protected jsApplySelect(data: any): any[];
-    protected jsApplyOrderBy(data: any): any[];
-    protected reset(): void;
-    load(): Promise<this>;
-    loadFirst(): Promise<this>;
-    getLoadedData(): OutputDTO[] | OutputDTO;
-    with(entities: any): this;
-    attach(data: InputDTO | OutputDTO): Promise<OutputDTO[]>;
-    associate(id: string): any;
-    protected hasMany<T>(Repository: any, relationName: string): T;
+    findMany<T extends FluentQuery<ModelDTO>>(query?: T): Promise<QueryOutput<T, ModelDTO, OutputDTO>>;
+    findFirst<T extends FluentQuery<ModelDTO>>(query?: T): Promise<SingleQueryOutput<T, ModelDTO, OutputDTO> | null>;
+    collect(query: FluentQuery<ModelDTO>): Promise<Collection<OutputDTO>>;
+    pluck(path: QueryFieldSelector<ModelDTO>, query?: FluentQuery<ModelDTO>): Promise<Primitives[]>;
+    protected setRelatedQuery(r: {
+        entity: new () => ModelDTO;
+        query?: FluentQuery<ModelDTO>;
+        repository?: any;
+        key?: string;
+    }): void;
+    associate(data: InputDTO | OutputDTO): Promise<OutputDTO[]>;
+    attach(id: string): Promise<any>;
+    protected hasMany<T extends FluentHasManyParams<T>>(r: T): InstanceType<T['repository']>;
+    protected belongsTo<T extends FluentBelongsToParams<T>>(r: T): InstanceType<T['repository']>;
     protected hasOne(): void;
-    protected belongsTo<T>(Repository: any, relationName: string): T;
-    protected belongsToMany<T, R>(Repository: any, Pivot: any, relationName: string): T;
-    withPivot(): this;
+    protected belongsToMany<T extends FluentBelongsToManyParams<T>>(r: T): InstanceType<T['repository']>;
     protected hasManyThrough(): void;
-    private prepareInput;
-    validateInput(validationClass: {
-        new (): ModelDTO;
-    }, input: InputDTO): Promise<{
-        errors: ValidationError[] | null;
-        result: Awaited<InputDTO>;
-    }>;
+    protected clearEmpties(object: any): any;
+    private isAnyObject;
+    protected extractConditions(conditions: FluentQuery<ModelDTO>['where'][]): {
+        operator: LogicOperator;
+        element: string;
+        value: Primitives | PrimitivesArray;
+    }[];
+    protected jsApplySelect(select: FluentQuery<ModelDTO>['select'], data: ModelDTO[]): ModelDTO[];
 }