@goatlab/fluent 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -136
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,20 +12,20 @@
12
12
  <img src="https://docs.goatlab.io/logo.png" alt="Logo" width="150" height="150">
13
13
  </a>
14
14
 
15
- <h3 align="center">GOAT-FLUENT</h3>
15
+ <h3 align="center">GOAT - FLUENT</h3>
16
16
 
17
17
  <p align="center">
18
- Readable query Interface & API generator
18
+ Fluent - Time Saving (TS) utils
19
19
  <br />
20
- <a href="https://docs.goatlab.io/#/0.5.x/fluent/fluent"><strong>Explore the docs »</strong></a>
20
+ <a href="https://docs.goatlab.io/#/0.7.x/fluent/fluent"><strong>Explore the docs »</strong></a>
21
21
  <br />
22
22
  <br />
23
- <a href="https://codesandbox.io/s/goat-nestjs-tytmv?file=/src/main.ts">View Demo</a>
24
23
  ·
25
24
  <a href="https://github.com/goat-io/fluent/issues">Report Bug</a>
26
25
  ·
27
26
  <a href="https://github.com/goat-io/fluent/issues">Request Feature</a>
28
27
  </p>
28
+ </p>
29
29
  </p>
30
30
 
31
31
  # Goat - Fluent
@@ -34,147 +34,28 @@ Fluent query interface for Multiple database types and helpers for fast API gene
34
34
 
35
35
  ## Supported Databases
36
36
 
37
- 1. Firebase\*\*
38
- 2. MongoDB\*
39
- 3. Mysql\*
40
- 4. MariaDB\*
41
- 5. SQLite\*
42
- 6. Postgres\*
43
- 7. CockroachDB\*
44
- 8. Microsoft SQL Server\*
45
- 9. Oracle\*
46
- 10. SAP Hana\*
47
- 11. sql.js\*
48
- 12. LokiJS
49
- 13. In-memory
37
+ 1. MongoDB\*
38
+ 2. Mysql\*
39
+ 3. MariaDB\*
40
+ 4. SQLite\*
41
+ 5. Postgres\*
42
+ 6. CockroachDB\*
43
+ 7. Microsoft SQL Server\*
44
+ 8. Oracle\*
45
+ 9. SAP Hana\*
46
+ 10. sql.js\*
47
+ 11. In-memory SQlite
50
48
 
51
49
  Wrapper for TypeORM \*
52
50
 
53
- Wrapper for firebase-admin and fireorm \*\*
54
-
55
51
  ### Installing
56
52
 
57
53
  To install this package in your project, you can use the following command within your terminal.
58
54
 
59
55
  ```bash
60
- npm install --global @goatlab/fluent
56
+ yarn add @goatlab/fluent
61
57
  ```
62
58
 
63
59
  ### Documentation
64
60
 
65
- To learn how to use this visit the [Goat Docs](https://docs.goatlab.io/#/0.5.x/fluent/fluent)
66
-
67
- <!--
68
-
69
- Packages that we need to replace
70
- npm-pack-zip
71
- @commitlint/prompt-cli
72
- formiojs
73
- react-native
74
- multer-google-storage
75
- nestjs-typed-dynamodb
76
- -->
77
-
78
- ## Roadmap
79
-
80
- See the [open issues](https://github.com/github_username/repo/issues) for a list of proposed features (and known issues).
81
-
82
- <!-- CONTRIBUTING -->
83
-
84
- ## Contributing
85
-
86
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
87
-
88
- We use a few tools to help with code styling, pre-commits, versioning, changelog and releases.
89
-
90
- - [Pretty-quick](https://github.com/azz/pretty-quick)
91
- - [Husky](https://github.com/typicode/husky)
92
- - [Auto-changelog](https://github.com/CookPete/auto-changelog)
93
- - [Release-it](https://github.com/release-it/release-it)
94
-
95
- All of these should run out of the box with your dev dependencies
96
-
97
- 1. If you have an issue assigned, please include the issue code/id in the beginning of you commits.
98
- 2. Include the issue id also at the start of your PR message.
99
- 3. Fork the Project
100
- 4. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
101
- 5. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
102
- 6. Push to the Branch (`git push origin feature/AmazingFeature`)
103
- 7. Open a Pull Request
104
-
105
- ## Release Process
106
-
107
- 1. All PRs will be merge directly into Master. (If test are green)
108
- 2. Once we are ready to create a release, we will locally pull the latest master version and run the release process
109
-
110
- If patch release
111
-
112
- ```
113
- npm run release
114
- ```
115
-
116
- If minor release
117
-
118
- ```
119
- npm run release:minor
120
- ```
121
-
122
- If mayor release
123
-
124
- ```
125
- npm run release:mayor
126
- ```
127
-
128
- This will start the release scripts including:
129
-
130
- - Local tests
131
- - Final version building
132
- - Final release zip
133
- - Tag
134
- - Release
135
- - Push
136
-
137
- ## Continuous Deployment
138
-
139
- Continuous deployment is optional. We will trigger a deployment with every published release. The equivalent trigger in Github Actions is:
140
-
141
- ```yml
142
- on:
143
- release:
144
- types: [published]
145
- ```
146
-
147
- <!-- LICENSE -->
148
-
149
- ## License
150
-
151
- Distributed under the MIT License. See `LICENSE` for more information.
152
-
153
- <!-- CONTACT -->
154
-
155
- ## Contact
156
-
157
- Ignacio Cabrera - [@twitter_handle](https://twitter.com/cabrerabywaters) - ignacio.cabrera@goatlab.io
158
-
159
- <!-- ACKNOWLEDGEMENTS -->
160
-
161
- ## Acknowledgements
162
-
163
- - [Tomas Castro]()
164
- - []()
165
- - []()
166
-
167
- <!-- MARKDOWN LINKS & IMAGES -->
168
- <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
169
-
170
- [contributors-url]: https://github.com/goat-io/fluent/graphs/contributors
171
- [forks-url]: https://github.com/goat-io/fluent/network/members
172
- [stars-shield]: https://img.shields.io/github/stars/goat-io/fluent?style=flat-square
173
- [stars-url]: https://github.com/goat-io/fluent/stargazers
174
- [issues-shield]: https://img.shields.io/github/issues/goat-io/fluent?style=flat-square
175
- [issues-url]: https://github.com/goat-io/fluent/issues
176
- [license-shield]: https://img.shields.io/github/license/goat-io/fluent?style=flat-square
177
- [license-url]: https://github.com/goat-io/fluent/blob/master/LICENSE.txt
178
- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
179
- [linkedin-url]: https://linkedin.com/in/othneildrew
180
- [product-screenshot]: images/screenshot.png
61
+ To learn how to use this visit the [Goat Docs](https://docs.goatlab.io/#/0.7.x/fluent/fluent)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@goatlab/fluent",
3
- "version": "0.7.0",
3
+ "version": "0.7.1",
4
4
  "description": "Readable query Interface & API generator for TS and Node",
5
5
  "scripts": {
6
6
  "install-p": "yarn",
@@ -16,7 +16,7 @@
16
16
  "build": "tsc"
17
17
  },
18
18
  "dependencies": {
19
- "@goatlab/js-utils": "^0.8.0",
19
+ "@goatlab/js-utils": "^0.8.1",
20
20
  "@loopback/metadata": "^4.1.2",
21
21
  "bson": "^4.6.2",
22
22
  "graphql": "^16.3.0",