@goatlab/fluent-formio 0.2.4 → 0.6.3

package/README.md

@@ -1,359 +1,31 @@
-# FLUENT
-
-A JS library that gives a readable query builder. It takes care of the heavy work for you to enjoy quering your services.
-Fluent works for both Local and Remote Storage/API providers
-
-### Installing
-
-To install this package in your project, you can use the following command within your terminal.
-
-```
-npm install --save fast-fluent
-```
-
-# Config
-
-Fluent offers a handy configuration method that will get you up and running in seconds.
-
-```javascript
-import {Fluent} from 'fast-fluent';
-
-Fluent.config(
-		    {
-          REMOTE_CONNECTORS: [{}],
-          LOCAL_CONNECTORS: [{}],
-          MERGE_CONNECTORS: [{}]
-        }
-    );
-```
-
-## Connectors
-All Fluent connectors are independent libraries, so you will need to download them separetly. 
-
-Here is an example of a REMOTE connector using fluent-formio
-
-```javascript
-import formio from 'fluent-formio'
-{
-    name: 'formio',
-    baseUrl: 'https://ydrahgggqviwquft.form.io/',
-    connector: formio
-}
-
-```
-You can use as many connectors as you like. All available connectors are listed bellow.
-
-### REMOTE
-
-Remote connectors give you access to API's or Databases, such as MongoDB, Formio
-| Provider        | Library         | 
-| --------------- | --------------- |
-| Formio          | fluent-formio   |
-
-### LOCAL
-Local connectors give you access to in Browser/Memory DB's such as LokiJs, IndexedDB, LocalStorage
-
-| Provider        | Library         | 
-| --------------- | --------------- |
-| LockiJS          | fluent-loki   |
-
-### MERGE
-Merge connectors will pull from both Local and Remote storage providers and will merge results
-to give you access to all your data from one call
-
-| Provider        | Library         | 
-| --------------- | --------------- |
-| Loki-Formio          | fluent-loki-formio   |
-
-### Your first Model
-
-To start using Fluent your will need to create a Fluent Model.
-Every Fluent Model is a @stampit, so you can further compose it as you like.
-If you only defined one connector it will be used as default, so no need to configure your models
-
-```javascript
-const Mymodel = Fluent.model({
-  properties: {
-    name: 'Mymodel',
-  }
-})
-```
-
-In case you defined multiple connectors, your model will need to choose where to get its data from
-
-```javascript
-const Mymodel = Fluent.model({
-  properties: {
-    name: 'Mymodel',
-    config: {
-      remote: {
-        connector: 'formio'
-      },
-      local: {
-        connector: 'loki'
-      }
-    }
-  }
-})
-```
-
-
-Onother way of defining a connector as default when using multiple connectors, is to set it on the Fluent.config
-
-```javascript
-import {Fluent} from 'fast-fluent';
-import formio from 'fluent-formio'
-
-Fluent.config(
-		    {
-          REMOTE_CONNECTORS: [{
-              default: true,
-              name: 'formio',
-              baseUrl: 'https://ydrahgggqviwquft.form.io/',
-              connector: formio
-          }, {...}, {...}],
-        }
-    );
-
-
-```
-
-# Using a Fluent Model
-
-## Remote, Local or Merge?
-
-Every Fluent Model can pull/push data from those 3 sources. All Fluent methods are ASYNC functions
-be patient and AWAIT for them ;)
-
-```javascript
-const Mymodel = Fluent.model({
-  properties: {
-    name: 'Mymodel',
-  }
-})()
-
-// Option 1
-let model = await Mymodel.remote()
-// Option 2
-let model = await Mymodel.local()
-// Option 3
-let model = await Mymodel.merge()
-```
-
-After deciding where to pull/push the data from you will have access to quite a few helpful methods
-
-## Basic CRUD methods
-
-### Creating
-```javascript
-const Mymodel = Fluent.model({
-  properties: {
-    name: 'Mymodel',
-  }
-})()
-const myObj = { foo : "bar", pin: "pon"}
-const myArrayOfObjs = [{ foo : "bar", pin: "pon"}, { foo : "bar", pin: "pon"}]
-// Single insert example
-let inserted = await Mymodel.remote().insert(myObj)
-
-// Multiple insert example
-let inserted = await Mymodel.remote().insert(myArrayOfObjs)
-
-```
-
-### Updating
-All Fluent models identify records by de _id identifier. To update a record you MUST give it the _id
-
-```javascript
-const Mymodel = Fluent.model({
-  properties: {
-    name: 'Mymodel',
-  }
-})()
-// Single insert example
-let updated = await Mymodel.remote().update({_id : 'abcdefghjklmnopqrsuvwxyz', myNewData: 'SomeNewData' })
-```
-
-### Deleting
-To remove a records you must provide its ID
-
-```javascript
-const Mymodel = Fluent.model({
-  properties: {
-    name: 'Mymodel',
-  }
-})()
-// Single insert example
-let updated = await Mymodel.remote().remove('abcdefghjklmnopqrsuvwxyz')
-```
-
-# Reading - Query Builder
-
-Here is where we start having fun with Fluent.
-Fluent offers a powerful QueryBuilder HEAVILY inspired in Laravel (Thanks Taylor Otwell!!)
-
-## Get all Objects (rows)
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let users = await Users.remote().get()
-```
-Unlike Laravel, Fluent get() Method returns and Array with the requested Objects, ready for you to use.
-
-```javascript
- users.forEach(user => console.log(user.name))
-```
-
-## Get a single Object (row)
-
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let user = await Users.remote().first()
-```
-
-In this case Fluent will return a single Object
-
-```javascript
- user.name
-```
-
-
-## Get a list of Column Values
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let names = await Users.remote().pluck('name')
-```
-
-
-## Select
-
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let users = await Users.remote().select('name', 'last_name as lastName').get()
-
-// Its also possible to pass it as an Array
-let users = await Users.remote().select(['name', 'last_name as lastName']).get()
-```
-
-## Ordering, Grouping, Limit & Offset
-
-### orderBy
-
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let users = await Users.remote().select('name', 'last_name as lastName').orderBy('lastName', 'asc')get()
-
-```
-
-
-### skip / take
-
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let users = await Users.remote().select('name')
-            .skip(10)
-            .take(10)
-            .get()
-```
-Is the same as
-
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let users = await Users.remote().select('name')
-            .offset(10)
-            .limit(10)
-            .get()
-```
-
-
-# Collections
-
-To further operate your data, you can turn your results into Collections (Yes, Thanks again Taylor!)
-Just make sure to call the collect method instead of the get()
-```javascript
-const Users = Fluent.model({
-  properties: {
-    name: 'Users',
-  }
-})()
-// Single insert example
-let users = await Users.remote()
-            .limit(10)
-            .collect()
-```
-You can also turn any array into a Fluent Collection by using the collect method
-
-```javascript
-let users = [{name: 'John', age: 20}, {name: 'Michael', age: 40}]
-// Single insert example
-let users = Fluent.collect(users)
-```
-
-Now with the collection on hand, you can use the following operators
-
-## average
-Alias for avg()
-```javascript
-users.average('age')
-
-// 30
-```
-
-## avg
-```javascript
-users.avg('age')
-
-// 30
-```
-
-## Chunk
-Chunk will just get all results and then separate them in smaller Arrays.
-
-```javascript
-users.chunk(1)
-
-// [[{name: 'John', age: 20}],[{name: 'Michael', age: 40}]]
-```
-
-
-## Collapse
-
-```javascript
-let collection = Fluent.collect(users.chunk(1));
-collection.collapse()
-// [{name: 'John', age: 20}, {name: 'Michael', age: 40}]
-```
+<!-- PROJECT SHIELDS -->
+
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/github_username/repo">
+       <img src="https://docs.goatlab.io/logo.png" alt="Logo" width="150" height="150">
+  </a>
+
+  <h3 align="center">GOAT-FLUENT</h3>
+
+  <p align="center">
+    Readable query Interface & API generator
+    <br />
+    <a href="https://docs.goatlab.io/#/0.5.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>
+
+# Goat - Fluent

package/dist/index.js

@@ -0,0 +1,5 @@
+"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/package.json

@@ -1,73 +1,141 @@
 {
   "name": "@goatlab/fluent-formio",
-  "version": "0.2.4",
-  "description": "Fluent Connector for Formio submissions",
-  "main": "lib/@goatlab/fluent-formio.min.js",
-  "directories": {
-    "lib": "lib",
-    "test": "test"
+  "version": "0.6.3",
+  "description": "Readable query Interface & API generator for TS and Node",
+  "homepage": "https://docs.goatlab.io",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
   },
+  "files": [
+    "./dist/**/*"
+  ],
   "scripts": {
-    "build": "rm -rf lib/* && webpack --env build",
-    "rebuild": "rm -rf node_modules && npm install && npm run build",
-    "dev": "rm -rf lib/* && webpack --progress --colors --watch --env dev",
-    "test": "mocha-webpack --colors --recursive -w --timeout 100000 --webpack-config test/config/webpack.config.test.js --require mock-local-storage --require test/config/setup.js --exit src/**/**/*.spec.js --exit ",
-    "test:watch": "mocha-webpack --webpack-config webpack.config.test.js --watch --glob '*.spect.js' --recursive test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://gitlab.com/goatlabs/goat-fluent-formio.git"
+    "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": [
-    "form.io",
-    "js",
-    "cordova",
-    "browser"
+    "typescript",
+    "TS"
   ],
-  "author": "Ignacio Cabrera",
+  "author": "ignacio.cabrera@goatlab.io",
   "license": "MIT",
-  "bugs": {
-    "url": "https://gitlab.com/goatlabs/goat-fluent-formio.git/issues"
+  "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"
+    }
   },
-  "homepage": "https://gitlab.com/goatlabs/goat-fluent-formio.git#readme",
   "dependencies": {
-    "@goatlab/goat-fluent": "^0.2.4",
-    "await-to-js": "^2.1.1",
-    "axios": "^0.18.0",
-    "bluebird": "^3.5.3",
-    "jwt-decode": "^2.2.0",
-    "moment": "^2.24.0"
+    "@goatlab/fluent": "^0.6.15"
   },
   "devDependencies": {
-    "axios-mock-adapter": "^1.15.0",
-    "babel-cli": "^6.26.0",
-    "babel-core": "^6.26.3",
-    "babel-eslint": "^8.2.3",
-    "babel-loader": "^7.1.4",
-    "babel-plugin-add-module-exports": "^0.2.1",
-    "babel-plugin-lodash": "^3.3.4",
-    "babel-plugin-transform-es2015-arrow-functions": "^6.22.0",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-stage-2": "^6.24.1",
-    "buffer": "^5.2.1",
-    "chai": "^4.1.2",
-    "custom-event": "^1.0.1",
-    "eslint": "^4.19.1",
-    "eslint-loader": "^2.0.0",
-    "isomorphic-fetch": "^2.2.1",
-    "jsdom": "11.11.0",
-    "jsdom-global": "3.0.2",
-    "lodash-webpack-plugin": "^0.11.5",
-    "mocha": "^5.2.0",
-    "mocha-webpack": "^2.0.0-beta.0",
-    "mock-local-storage": "^1.0.5",
-    "node-fetch": "^2.2.0",
-    "webpack": "^4.20.2",
-    "webpack-bundle-analyzer": "^2.13.1",
-    "webpack-cli": "^3.1.1",
-    "webpack-node-externals": "^1.7.2",
-    "xmlhttprequest": "^1.8.0",
-    "yargs": "^11.0.0"
+    "@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-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",
+    "turbo": "^1.1.10",
+    "typescript": "^4.6.3"
   },
-  "gitHead": "143a63c3c23a55d09c2c25f547ba6a293bbbe6b9"
+  "engines": {
+    "node": ">=14.16.0"
+  }
 }

package/.babelrc

@@ -1,9 +0,0 @@
-{
-  "presets": [
-    "env",
-    "stage-2"
-  ],
-  "plugins": [
-    "transform-es2015-arrow-functions"
-  ]
-}

package/.eslintignore

@@ -1,2 +0,0 @@
-lib/*
-node_modules/*

package/.eslintrc.js

@@ -1,61 +0,0 @@
-module.exports = {
-  root: true,
-  parser: "babel-eslint",
-  parserOptions: {
-    sourceType: "module"
-  },
-  env: {
-    browser: true
-  },
-  // https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style
-  extends: ["standard"],
-  // required to lint *.vue files
-  plugins: ["html", "import"],
-  globals: {
-    XLSC: true,
-    XLS: true,
-    Connection: true,
-    universalLinks: true,
-    LocalFileSystem: true,
-    cordova: true,
-    html2pdf: true,
-    DEV: true,
-    PROD: true,
-    __THEME: true,
-    sms: true,
-    logOb: true
-  },
-  // add your custom rules here
-  rules: {
-    // allow paren-less arrow functions
-    "arrow-parens": 0,
-    "one-var": 0,
-    "import/first": 0,
-    "import/named": 2,
-    "import/namespace": 2,
-    "import/default": 2,
-    "import/export": 2,
-    // allow debugger during development
-    "no-debugger": process.env.NODE_ENV === "production" ? 2 : 0,
-    "no-debugger": process.env.NODE_ENV === "production" ? 2 : 0,
-    "no-mixed-spaces-and-tabs": [0],
-    "no-tabs": 0,
-    skipBlankLines: 0,
-    ignoreComments: 0,
-    "no-unreachable": 0,
-    "no-unused-expressions": 0,
-    "space-before-function-paren": 0,
-    "no-trailing-spaces": [2, { skipBlankLines: true }],
-    indent: 0,
-    "no-multiple-empty-lines": 0,
-    "brace-style": 0,
-    "no-useless-return": 0,
-    "no-unexpected-multiline": 0,
-    "func-call-spacing": 0,
-    quotes: 0,
-    semi: 0,
-    "operator-linebreak": 0,
-    "no-new-func": 0,
-    "comma-dangle": 0
-  }
-};