@goatlab/fluent-formio 0.6.5 → 0.6.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) GOAT, SPA. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -12,20 +12,38 @@
        <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-FORM.IO</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
+
+Fluent query interface for Multiple database types and helpers for fast API generation and general App building.
+
+## Supported Databases
+
+1. Form.io
+
+### Installing
+
+To install this package in your project, you can use the following command within your terminal.
+
+```bash
+yarn add @goatlab/fluent-formio
+```
+
+### Documentation
+
+To learn how to use this visit the [Goat Docs](https://docs.goatlab.io/#/0.7.x/fluent/fluent)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goatlab/fluent-formio",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "description": "Readable query Interface & API generator for TS and Node",
   "homepage": "https://docs.goatlab.io",
   "main": "dist/index.js",
@@ -12,131 +12,44 @@
   "files": [
     "./dist/**/*"
   ],
-  "scripts": {
-    "install-p": "yarn",
-    "prebuild": "rimraf dist",
-    "prestart": "rimraf dist",
-    "predev": "rimraf dist",
-    "test": "jest --forceExit --passWithNoTests",
-    "dev": "tsc --watch",
-    "lint": "eslint src --fix",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "update:packages": "npm-check-updates -u && yarn",
-    "serve": "tsc -w",
-    "build": "tsc",
-    "pack": "npm-pack-zip",
-    "release": "release-it patch --no-npm.publish --ci",
-    "release:patch": "release-it patch --no-npm.publish --ci",
-    "release:minor": "release-it minor --no-npm.publish --ci",
-    "release:major": "release-it major --no-npm.publish --ci ",
-    "rc": "release-it --no-npm.publish --ci --preRelease=rc",
-    "rc:patch": "release-it patch --no-npm.publish --ci --preRelease=rc",
-    "rc:minor": "release-it minor --no-npm.publish --ci --preRelease=rc",
-    "rc:major": "release-it major --no-npm.publish --ci --preRelease=rc",
-    "changelog": "auto-changelog --template changelog-template.hbs -p -u --commit-limit false",
-    "changelog-debug": "auto-changelog --template changelog-template.hbs -p --template json --output changelog-data.json"
-  },
   "keywords": [
     "typescript",
     "TS"
   ],
   "author": "ignacio.cabrera@goatlab.io",
   "license": "MIT",
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ],
-    "rules": {
-      "subject-case": [
-        2,
-        "never",
-        []
-      ]
-    }
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "pretty-quick --staged && npm test",
-      "commit-msg": "exec < /dev/tty && git cz --hook || true && commitlint -E HUSKY_GIT_PARAMS",
-      "pre-push": "npm run build"
-    }
-  },
-  "release-it": {
-    "src": {
-      "commitMessage": "ci: CI-1 [Release] v%s"
-    },
-    "git": {
-      "requireBranch": "master",
-      "commitArgs": [
-        "--no-verify"
-      ]
-    },
-    "hooks": {
-      "before:init": [
-        "npm run build",
-        "npm run pack"
-      ],
-      "after:bump": "npm run changelog",
-      "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
-    },
-    "github": {
-      "release": true,
-      "assets": [
-        "./*.zip"
-      ]
-    }
-  },
-  "auto-changelog": {
-    "commitLimit": false,
-    "unreleased": true,
-    "issueUrl": "https://goatlab.atlassian.net/browse/{id}",
-    "replaceText": {
-      "[Ff]eature:": "",
-      "[Ff]ix:": "",
-      "[Bb]reak:": "",
-      "([A-Z]+-\\d+)": "[$1](https://goatlab.atlassian.net/browse//$1) - "
-    },
-    "includeBranch": [
-      "master"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/@digitalroute/cz-conventional-changelog-for-jira"
-    },
-    "mongodbMemoryServer": {
-      "version": "latest"
-    }
-  },
   "dependencies": {
-    "@goatlab/fluent": "0.6.24"
+    "@goatlab/fluent": "0.7.32",
+    "@goatlab/js-utils": "0.8.34"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.3",
-    "@commitlint/config-conventional": "^16.2.1",
-    "@commitlint/prompt-cli": "^16.2.3",
-    "@digitalroute/cz-conventional-changelog-for-jira": "^7.2.1",
     "@types/jest": "^27.4.1",
     "@types/node": "^17.0.23",
-    "auto-changelog": "^2.4.0",
-    "commitizen": "^4.2.4",
-    "cz-conventional-changelog": "^3.3.0",
-    "cz-jira-smart-commit": "^3.0.0",
     "dotenv-cli": "^5.1.0",
     "eslint": "^8.5.0",
-    "husky": "^7.0.4",
-    "jest": "^27.5.1",
+    "jest": "^29.7.0",
     "jest-environment-node": "^27.5.1",
-    "npm-pack-zip": "^1.3.0",
     "prettier": "^2.6.1",
     "pretty-quick": "^3.1.3",
-    "release-it": "^14.13.1",
-    "ts-jest": "^27.1.4",
-    "ts-node": "^10.7.0",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
     "turbo": "^1.1.10",
-    "typescript": "^4.6.3"
+    "typescript": "^4.6.3",
+    "@goatlab/tsconfig": "0.0.11"
   },
   "engines": {
     "node": ">=14.16.0"
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "prestart": "rimraf dist",
+    "predev": "rimraf dist",
+    "test": "echo 'skip'",
+    "dev": "tsc --watch",
+    "lint": "echo 'skip'",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "update:packages": "npm-check-updates -u && yarn",
+    "serve": "tsc -w",
+    "build": "echo 'skip'"
   }
-}
+}

package/dist/FormioConnector.d.ts

@@ -1,37 +0,0 @@
-import type { Filter, BaseDataElement, PaginatedData, Paginator, Sure } from '@goatlab/fluent';
-import { BaseConnector, FluentConnectorInterface } from '@goatlab/fluent';
-interface IFormioConnector {
-    baseEndPoint: string;
-    token?: string;
-}
-export declare class Formioconnector<ModelDTO = BaseDataElement, InputDTO = ModelDTO, OutputDTO = ModelDTO> extends BaseConnector<ModelDTO, InputDTO, OutputDTO> implements FluentConnectorInterface<InputDTO, OutputDTO> {
-    private baseEndPoint;
-    private authToken;
-    constructor({ baseEndPoint, token }: IFormioConnector);
-    get(): Promise<OutputDTO[]>;
-    all(): Promise<OutputDTO[]>;
-    find(filter: Filter): Promise<OutputDTO[]>;
-    paginate(paginator: Paginator): Promise<PaginatedData<OutputDTO>>;
-    insert(data: InputDTO): Promise<OutputDTO>;
-    insertMany(data: InputDTO[]): Promise<OutputDTO[]>;
-    updateById(id: string, data: InputDTO): Promise<OutputDTO>;
-    truncate({ sure }: Sure): Promise<void>;
-    deleteById(id: string): Promise<string>;
-    findById(id: string): Promise<OutputDTO>;
-    private numberOfRows;
-    private getToken;
-    private getUrl;
-    private getHeaders;
-    private getSpacer;
-    private httpGET;
-    private httpPOST;
-    private httpPUT;
-    private httpDelete;
-    private getTokenType;
-    private getFilters;
-    private getLimit;
-    private getSkip;
-    private getOrder;
-    private getSelect;
-}
-export {};

package/dist/FormioConnector.js

@@ -1,344 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Formioconnector = void 0;
-const tslib_1 = require("tslib");
-const axios_1 = tslib_1.__importDefault(require("axios"));
-const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
-const isSameOrAfter_1 = tslib_1.__importDefault(require("dayjs/plugin/isSameOrAfter"));
-const jwt_decode_1 = tslib_1.__importDefault(require("jwt-decode"));
-const await_to_js_1 = tslib_1.__importDefault(require("await-to-js"));
-const js_utils_1 = require("@goatlab/js-utils");
-const fluent_1 = require("@goatlab/fluent");
-dayjs_1.default.extend(isSameOrAfter_1.default);
-const GoatExtenderAttributes = [
-    'id',
-    'owner',
-    'roles',
-    'created',
-    'modified',
-    '_ngram'
-];
-class Formioconnector extends fluent_1.BaseConnector {
-    constructor({ baseEndPoint, token }) {
-        super();
-        this.baseEndPoint = '';
-        this.authToken = '';
-        this.baseEndPoint = baseEndPoint;
-        this.authToken = token;
-    }
-    async get() {
-        const [error, result] = await (0, await_to_js_1.default)(this.httpGET());
-        if (error) {
-            console.log(error);
-            throw new Error('Error while getting submissions');
-        }
-        const data = result.data.map(r => {
-            const response = {
-                ...{
-                    id: r.id,
-                    owner: r.owner,
-                    roles: r.roles,
-                    created: r.created,
-                    modified: r.modified
-                },
-                ...r.data
-            };
-            return response;
-        });
-        let orderedResults = this.jsApplySelect(data);
-        orderedResults = this.jsApplyOrderBy(orderedResults);
-        this.reset();
-        return orderedResults;
-    }
-    async all() {
-        return this.get();
-    }
-    async find(filter) {
-        return this.get();
-    }
-    async paginate(paginator) {
-        const numberOfRows = await this.numberOfRows();
-        this.offset((paginator.page - 1) * paginator.perPage).take(paginator.perPage);
-        const results = {
-            data: await this.get(),
-            current_page: paginator.page,
-            first_page_url: '',
-            prev_page_url: '',
-            next_page_url: '',
-            per_page: paginator.perPage,
-            path: '',
-            total: Number(numberOfRows)
-        };
-        this.reset();
-        return results;
-    }
-    async insert(data) {
-        const [error, result] = await (0, await_to_js_1.default)(this.httpPOST(data));
-        if (error) {
-            console.log(error);
-            throw new Error('Cannot insert data');
-        }
-        const response = {
-            ...{
-                id: result.data.id,
-                owner: result.data.owner,
-                roles: result.data.roles,
-                created: result.data.created,
-                modified: result.data.modified
-            },
-            ...result.data.data
-        };
-        this.reset();
-        return response;
-    }
-    async insertMany(data) {
-        const insertedElements = [];
-        for (const element of data) {
-            const inserted = await this.insert({
-                ...element
-            });
-            insertedElements.push(inserted);
-        }
-        this.reset();
-        return insertedElements;
-    }
-    async updateById(id, data) {
-        if (!id) {
-            throw new Error('Formio connector error. Cannot update a Model without id key');
-        }
-        if (id.includes('_local')) {
-            throw new Error('Formio connector error. Cannot update a local document');
-        }
-        const [error, result] = await (0, await_to_js_1.default)(this.httpPUT(id, data));
-        if (error) {
-            console.log(error);
-            throw new Error('Cannot insert data');
-        }
-        const response = result.data;
-        this.reset();
-        return response;
-    }
-    async truncate({ sure }) {
-    }
-    async deleteById(id) {
-        const [error, removed] = await (0, await_to_js_1.default)(this.httpDelete(id));
-        if (error) {
-            console.log(error);
-            throw new Error(`FormioConnector: Could not delete ${id}`);
-        }
-        this.reset();
-        return removed.data;
-    }
-    async findById(id) {
-        const [error, data] = await (0, await_to_js_1.default)(this.first());
-        if (error) {
-            console.log(error);
-            throw new Error('Find() could not get remote data');
-        }
-        this.reset();
-        return data;
-    }
-    async numberOfRows() {
-        let url = this.getUrl();
-        const headers = this.getHeaders();
-        const filters = this.getFilters();
-        const limit = '?limit=1';
-        const skip = this.getSkip();
-        const order = this.getOrder();
-        const select = this.getSelect();
-        const spacer = '';
-        url = url + spacer + limit;
-        url = filters ? url + this.getSpacer(url) + filters : url;
-        url = skip ? url + this.getSpacer(url) + skip : url;
-        url = order ? url + this.getSpacer(url) + order : url;
-        url = select ? url + this.getSpacer(url) + select : url;
-        const isOnline = true;
-        if (!isOnline) {
-            throw new Error(`Cannot make get request to ${url}.You are not online`);
-        }
-        const response = await axios_1.default.get(url, { headers });
-        return response.headers['content-range'].split('/')[1];
-    }
-    getToken() {
-        if (typeof localStorage === 'undefined') {
-            return;
-        }
-        const token = localStorage.getItem('formioToken');
-        if (!token || this.getTokenType(token) === 'x-jwt-token') {
-            return token;
-        }
-        const decodedToken = (0, jwt_decode_1.default)(token);
-        const expDate = dayjs_1.default.unix(decodedToken.exp);
-        if ((0, dayjs_1.default)().isSameOrAfter(expDate)) {
-            js_utils_1.Events.emit('GOAT:SESSION:EXPIRED', {
-                data: expDate,
-                text: 'Session expired'
-            });
-            throw new Error('Token has expired.');
-        }
-        return token;
-    }
-    getUrl() {
-        const baseUrl = `${this.baseEndPoint}/submission`;
-        return baseUrl;
-    }
-    getHeaders() {
-        const headers = {};
-        let token = {};
-        if (typeof localStorage !== 'undefined') {
-            token = this.getToken();
-        }
-        if (this.authToken || this.authToken === '') {
-            token = this.authToken;
-        }
-        if (!token) {
-            return headers;
-        }
-        const type = this.getTokenType(token);
-        headers[type] = token;
-        return headers;
-    }
-    getSpacer(url) {
-        return url.substr(url.length - 1) === '&' ? '' : '&';
-    }
-    async httpGET() {
-        let url = this.getUrl();
-        const headers = this.getHeaders();
-        const filters = this.getFilters();
-        const limit = this.getLimit();
-        const skip = this.getSkip();
-        const order = this.getOrder();
-        const select = this.getSelect();
-        const spacer = '';
-        url = url + spacer + limit;
-        url = filters ? url + this.getSpacer(url) + filters : url;
-        url = skip ? url + this.getSpacer(url) + skip : url;
-        url = order ? url + this.getSpacer(url) + order : url;
-        url = select ? url + this.getSpacer(url) + select : url;
-        const isOnline = true;
-        if (!isOnline) {
-            throw new Error(`Cannot make get request to ${url}.You are not online`);
-        }
-        return axios_1.default.get(url, { headers });
-    }
-    async httpPOST(data) {
-        const url = this.getUrl();
-        const headers = this.getHeaders();
-        const isOnline = true;
-        if (!isOnline) {
-            throw new Error(`Cannot make request post to ${url}.You are not online`);
-        }
-        return axios_1.default.post(url, { data }, { headers });
-    }
-    async httpPUT(id, data) {
-        const isOnline = true;
-        const url = `${this.getUrl()}/${id}`;
-        const headers = this.getHeaders();
-        if (!isOnline) {
-            throw new Error(`Cannot make request post to ${url}.You are not online`);
-        }
-        return axios_1.default.put(url, { data }, { headers });
-    }
-    httpDelete(id) {
-        const headers = this.getHeaders();
-        const url = `${this.getUrl()}/${id}`;
-        return axios_1.default.delete(url, { headers });
-    }
-    getTokenType(token) {
-        return token.length > 32 ? 'x-jwt-token' : 'x-token';
-    }
-    getFilters() {
-        const filter = this.whereArray;
-        if (!filter || filter.length === 0) {
-            return undefined;
-        }
-        let filterQuery = '';
-        filter.forEach(condition => {
-            let valueString = '';
-            const element = GoatExtenderAttributes.includes(condition[0])
-                ? condition[0]
-                : `data.${condition[0]}`;
-            const operator = condition[1];
-            const value = condition[2];
-            switch (operator) {
-                case '=':
-                    filterQuery = `${filterQuery + element}=${value}&`;
-                    break;
-                case '!=':
-                    filterQuery = `${filterQuery + element}__ne=${value}&`;
-                    break;
-                case '>':
-                    filterQuery = `${filterQuery + element}__gt=${value}&`;
-                    break;
-                case '>=':
-                    filterQuery = `${filterQuery + element}__gte=${value}&`;
-                    break;
-                case '<':
-                    filterQuery = `${filterQuery + element}__lt=${value}&`;
-                    break;
-                case '<=':
-                    filterQuery = `${filterQuery + element}__lte=${value}&`;
-                    break;
-                case 'in':
-                    valueString = '';
-                    value.forEach((val, index, array) => {
-                        valueString =
-                            index === array.length - 1
-                                ? valueString + val
-                                : `${valueString + val},`;
-                    });
-                    filterQuery = `${filterQuery + element}__in=${valueString}&`;
-                    break;
-                case 'nin':
-                    valueString = '';
-                    value.forEach((val, index, array) => {
-                        valueString =
-                            index === array.length - 1
-                                ? valueString + val
-                                : `${valueString + val},`;
-                    });
-                    filterQuery = `${filterQuery + element}__nin=${valueString}&`;
-                    break;
-                case 'exists':
-                    filterQuery = `${filterQuery + element}__exists=${true}&`;
-                    break;
-                case '!exists':
-                    filterQuery = `${filterQuery + element}__exists=${false}&`;
-                    break;
-                case 'regex':
-                    filterQuery = `${filterQuery + element}__regex=${value}&`;
-                    break;
-            }
-        });
-        return filterQuery.substring(0, filterQuery.length - 1);
-    }
-    getLimit() {
-        const limit = '?limit=';
-        if (!this.limitNumber || this.limitNumber === 0) {
-            this.limitNumber = 50;
-        }
-        return `${limit}${this.limitNumber}`;
-    }
-    getSkip() {
-        const skip = 'skip=';
-        if (!this.offsetNumber) {
-            this.offsetNumber = 0;
-        }
-        return skip + this.offsetNumber;
-    }
-    getOrder() {
-        const order = 'sort=';
-        const or = this.orderByArray[1] === 'DESC' ? '-' : '';
-        return order + or + this.orderByArray[0];
-    }
-    getSelect() {
-        let select = this.selectArray;
-        select = select.map(e => e.split(' as ')[0]);
-        if (!select) {
-            return;
-        }
-        select = select.map(e => GoatExtenderAttributes.includes(e) ? e : `data.${e}`);
-        return `select=${select.join(',')}`;
-    }
-}
-exports.Formioconnector = Formioconnector;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-import { Formioconnector } from './FormioConnector';
-export { Formioconnector };

package/dist/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Formioconnector = void 0;
-const FormioConnector_1 = require("./FormioConnector");
-Object.defineProperty(exports, "Formioconnector", { enumerable: true, get: function () { return FormioConnector_1.Formioconnector; } });

package/dist/test/advanced/advancedTestSuite.d.ts

@@ -1 +0,0 @@
-export declare const advancedTestSuite: (Model: any) => void;