s3db.js 1.0.0 → 1.0.2

package/README.md

@@ -1,24 +1,30 @@
 # s3db.js
 
-Hey guys, there is an another way to create a cheap database with an easy ORM to handle your dataset!
+Another way to create a cheap document-base database with an easy ORM to handle your dataset!
 
 1. <a href="#motivation">Motivation</a>
 1. <a href="#install">Install</a>
 1. <a href="#usage">Usage</a>
    1. <a href="#quick-setup">Quick Setup</a>
    1. <a href="#insights">Insights</a>
-   1. <a href="#client">Client</a>
-   1. <a href="#resources">Resources</a>
-      1. <a href="#create-a-resource">Create a resource</a>
-      1. <a href="#insert-data">Insert data</a>
-      1. <a href="#bulk-insert-data">Bulk insert data</a>
-      1. <a href="#get-data">Get data</a>
-      1. <a href="#delete-data">Delete data</a>
-      1. <a href="#resource-read-stream">Resource read stream</a>
-      1. List data (coming soon)
-      1. Write stream (coming soon)
-   1. <a href="#events">Events</a>
-   1. <a href="#s3-client">S3 Client</a>
+   1. <a href="#database">Database</a>
+   1. <a href="#create-a-resource">Create a resource</a>
+1. <a href="#resource-methods">Resource methods</a>
+   1. <a href="#insert">Insert</a>
+   1. <a href="#bulk-insert">Bulk insert</a>
+   1. <a href="#get">Get</a>
+   1. <a href="#update">Update</a>
+   1. <a href="#delete">Delete</a>
+   1. <a href="#count">Count</a>
+   1. <a href="#bulk-delete">Bulk delete</a>
+   1. <a href="#get-all-ids">Get all ids</a>
+   1. <a href="#delete-all">Delete all</a>
+   1. <a href="#get-all">Get all</a>
+1. <a href="#resource-streams">Resource streams</a>
+   1. <a href="#readable-stream">Readable stream</a>
+   1. <a href="#writable-stream">Writable stream</a>
+1. <a href="#events">Events</a>
+1. <a href="#s3-client">S3 Client</a>
 1. <a href="#examples">Examples</a>
 1. <a href="#cost-simulation">Cost Simulation</a>
    1. <a href="#big-example">Big Example</a>
@@ -95,13 +101,13 @@ import S3db from "s3db.js";
 
 - For better use of the <a href="#cache">`cache`</a> (and listing), the best ID format is to use sequential ids with leading zeros (eq: 00001, 00002, 00003) due to S3 internal keys sorting method.
 
-### Client
+### Database
 
 Your `s3db.js` client can be initiated with options:
 
 |   option    | optional |                     description                     |   type    |   default   |
 | :---------: | :------: | :-------------------------------------------------: | :-------: | :---------: |
-|    cache    |   true   |  (Coming soon) If your read methods can be proxied  | `boolean` | `undefined` |
+|    cache    |   true   |  Persist searched data to reduce repeated requests  | `boolean` | `undefined` |
 | parallelism |   true   |            Number of simultaneous tasks             | `number`  |     10      |
 | passphrase  |   true   |               Your encryption secret                | `string`  | `undefined` |
 |     ttl     |   true   | (Coming soon) TTL to your cache duration in seconds | `number`  |    86400    |
@@ -174,8 +180,6 @@ It has this structure:
 }
 ```
 
-### Resources
-
 #### Create a resource
 
 Resources are definitions of data collections.
@@ -230,6 +234,9 @@ const attributes = {
     long: "number",
     city: "string",
   },
+
+  // may have multiple definitions.
+  address_number: ["string", "number"],
 };
 ```
 
@@ -261,11 +268,19 @@ You may just use the reference:
 const Leads = s3db.resource("leads");
 ```
 
-#### Insert data
+### Resources methods
+
+Consider `resource` as:
+
+```javascript
+const resource = s3db.resource("leads");
+```
+
+#### Insert
 
 ```javascript
 // data
-const attributes = {
+const data = {
   id: "mypersonal@email.com", // if not defined a id will be generated!
   utm: {
     source: "abc",
@@ -278,12 +293,12 @@ const attributes = {
   invalidAttr: "this attribute will disappear",
 };
 
-const insertedData = await s3db.resource("leads").insert(attributes);
+const insertedData = await resource.insert(data);
 ```
 
 If not defined an id attribute, `s3db.js` will use [`nanoid`](https://github.com/ai/nanoid) to generate a random unique id!
 
-#### Bulk insert data
+#### Bulk insert
 
 You may bulk insert data with a friendly method.
 
@@ -291,7 +306,7 @@ This method uses [`supercharge/promise-pool`](https://github.com/supercharge/pro
 
 ```javascript
 const s3db = new S3db({
-  parallelism: 10,
+  parallelism: 10, // default
 });
 ```
 
@@ -303,17 +318,17 @@ const objects = new Array(100).fill(0).map((v, k) => ({
   lead: {
     fullName: "My Test Name",
     personalEmail: `bulk-${k}@mymail.com`,
-    mobileNumber: "+55 34 234567890",
+    mobileNumber: "+55 11 1234567890",
   },
 }));
 
-await s3db.resource("leads").bulkInsert(objects);
+await resource.bulkInsert(objects);
 ```
 
-#### Get data
+#### Get
 
 ```javascript
-const obj = await s3db.resource("leads").get("mypersonal@email.com");
+const obj = await resource.getById("mypersonal@email.com");
 
 // {
 //   id: "mypersonal@email.com",
@@ -328,32 +343,95 @@ const obj = await s3db.resource("leads").get("mypersonal@email.com");
 // }
 ```
 
-#### Resource read stream
+#### Update
+
+```javascript
+const obj = await resource.updateById("mypersonal@email.com", {
+  lead: {
+    mobileNumber: "+5511999999999",
+  },
+});
+
+// {
+//   id: "mypersonal@email.com",
+//   utm: {
+//     source: "abc",
+//   },
+//   lead: {
+//     fullName: "My Complex Name",
+//     personalEmail: "mypersonal@email.com",
+//     mobileNumber: "+5511999999999",
+//   },
+// }
+```
+
+#### Delete
 
 ```javascript
-const readStream = await s3db.resource("leads").stream();
+await resource.deleteById(id);
+```
 
-readStream.on("id", (id) => console.log("id =", id));
-readStream.on("data", (lead) => console.log("lead.id =", lead.id));
-readStream.on("end", console.log("end"));
+#### Count
+
+```javascript
+await resource.count();
+
+// 101
 ```
 
-#### Delete data
+#### Bulk Delete
 
 ```javascript
-await s3db.resource("leads").deleteById(id);
+await resource.bulkDelete(["id1", "id2", "id3 "]);
 ```
 
-#### List data (coming soon)
+#### Get all Ids
 
 ```javascript
-await s3db.resource("leads").list();
+const ids = await resource.getAllIds();
+// [
+//   'id1',
+//   'id2',
+//   'id3',
+// ]
 ```
 
-#### Write stream (coming soon)
+#### Delete all
 
 ```javascript
-// code
+await resource.deleteAll();
+```
+
+#### Get all
+
+```javascript
+const data = await resource.getAll();
+```
+
+### Resource streams
+
+#### Readable stream
+
+```javascript
+const readableStream = await resource.readable();
+
+readableStream.on("id", (id) => console.log("id =", id));
+readableStream.on("data", (lead) => console.log("lead.id =", lead.id));
+readableStream.on("end", console.log("end"));
+```
+
+#### Writable stream
+
+```javascript
+const writableStream = await resource.writable();
+
+writableStream.write({
+  lead: {
+    fullName: "My Test Name",
+    personalEmail: `bulk-${k}@mymail.com`,
+    mobileNumber: "+55 11 1234567890",
+  },
+});
 ```
 
 ### Events

package/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

package/package.json

@@ -1,22 +1,23 @@
 {
   "name": "s3db.js",
-  "version": "1.0.0",
-  "description": "Use AWS S3 as a database",
+  "version": "1.0.2",
+  "description": "Use AWS S3 as a cheap document database.",
   "main": "build/index.js",
+  "author": "filipeforattini",
+  "license": "UNLICENSE",
   "scripts": {
     "build": "rimraf ./build && tsc",
     "test": "jest --coverage",
+    "coverage": "coveralls < coverage/lcov.info",
+    "coverage:serve": "npx http-server ./coverage/lcov-report",
     "test:cache": "jest --coverage ./tests/cache.spec.ts",
     "example:1": "cd examples; node 1-bulk-insert.js",
     "example:2": "cd examples; node 2-read-stream.js",
     "example:3": "cd examples; node 3-read-stream-to-csv.js",
     "example:4": "cd examples; node 4-read-stream-to-zip.js",
     "example:5": "cd examples; node 5-write-stream.js",
-    "example:6": "cd examples; node 6-jwt-tokens.js",
-    "coverage": "npx http-server ./coverage/lcov-report"
+    "example:6": "cd examples; node 6-jwt-tokens.js"
   },
-  "author": "filipeforattini",
-  "license": "ISC",
   "devDependencies": {
     "@types/crypto-js": "^4.1.1",
     "@types/flat": "^5.0.2",
@@ -25,6 +26,7 @@
     "@types/node": "^18.11.9",
     "@types/pako": "^2.0.0",
     "@types/progress": "^2.0.5",
+    "coveralls": "^3.1.1",
     "dotenv": "^16.0.3",
     "esm": "^3.2.25",
     "fakerator": "^0.3.6",
@@ -47,5 +49,22 @@
     "lodash": "^4.17.21",
     "nanoid": "3.3.4",
     "ts-mixer": "^6.0.2"
-  }
+  },
+  "directories": {
+    "example": "examples",
+    "test": "tests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/filipeforattini/s3db.js.git"
+  },
+  "keywords": [
+    "s3",
+    "aws",
+    "database"
+  ],
+  "bugs": {
+    "url": "https://github.com/filipeforattini/s3db.js/issues"
+  },
+  "homepage": "https://github.com/filipeforattini/s3db.js#readme"
 }

package/src/resource.class.ts

@@ -225,7 +225,7 @@ export default class Resource
     });
 
     // validate
-    const { isValid, errors, data: validated } = this.check(attrs);
+    let { isValid, errors, data: validated } = this.check(attrs);
 
     if (!isValid) {
       return Promise.reject(
@@ -239,18 +239,16 @@ export default class Resource
     }
 
     if (!id && id !== 0) id = nanoid();
+    validated = this.map(validated);
 
     // save
     await this.s3Client.putObject({
       key: path.join(`resource=${this.name}`, `id=${id}`),
       body: "",
-      metadata: this.map(validated),
+      metadata: validated,
     });
 
-    const final = {
-      id,
-      ...(unflatten(validated) as object),
-    };
+    const final = { id, ...(unflatten(this.unmap(validated)) as object) };
 
     this.emit("inserted", final);
     this.s3db.emit("inserted", this.name, final);