@based/client 2.5.1 → 2.6.0

package/README.md

@@ -1,79 +1,350 @@
 # @based/client
 
-## 🔗 Links
-- [GitHub](https://github.com/atelier-saulx/based#readme)
+### Index
+
+- [Modify data](#modify-data)
+- [Observe data](#observe-data)
+- [Upload files](#upload-files)
+- [Schema](#schema)
+- [Analytics](#analytics)
 
 ---
 
-## Description
+This package allows to interact with a Based environment, set and observe data, upload files, track and see analytics, and authenticate users.
 
-## .observe(query, cb, err?)
+This page provides a quick first look at the main methods this package offers. Detailed information about each method is linked in the appropriate paragraph.
 
-```
-const unobserve = await b.observe({
-    $id: 'sp1',
-    title: true
-}, (data) => {
+###### Example:
+
+```js
+import based from '@based/client'
+
+const client = based({
+  org: 'my-org',
+  project: 'someproject',
+  env: 'production',
+})
+
+// create a schema
+await client.updateSchema({
+  schema: {
+    types: {
+      thing: {
+        fields: {
+          name: { type: 'string' },
+          quantity: { type: 'number' },
+          reason: { type: 'string' },
+          otherThings: { type: 'references' },
+          favouriteThing: { type: 'reference' },
+        },
+      },
+    },
+  },
+})
 
-}, (err) => {
+// observe some data
+await client.observe(
+  { $id: 'root', children: { $all: true, $list: true } },
+  (data) => {
+    console.log(data)
+  }
+)
 
+// set data
+await client.set({
+  type: 'thing',
+  name: 'book',
+  quantity: 3,
 })
 ```
 
-## .get(query)
+## Modify data
+
+> Read more about `set` and its operators [here](docs/set.md)
 
+### `set`
+
+The `based.set()` method allows to create new nodes or modify data on existing nodes. To change an existing one, one can do the following:
+
+###### Example:
+
+<!-- prettier-ignore-start -->
+```js
+/*
+Let's assume the following node in database:
+{
+  id: 'maASxsd3',
+  type: 'match',
+  value: 10,
+  title: {
+    en: 'yes'
+  }
+}
+*/
+
+const result = await client.set({        // Value of result: maASxsd3
+  $id: 'maASxsd3',                       // Resulting node in database:
+  type: 'match',                         // { id: 'maASxsd3',
+  title: {                               //   type: 'match',
+    en: 'hello',                         //   value: 10,     // existing value remains
+    de: 'hallo',                         //   title: {
+  },                                     //     en: 'hello', // .en is overwritten
+  name: 'match',                         //     de: 'hallo'  // .de is added
+                                         //   },
+                                         //   name: 'match'  // name is added
+})
 ```
-const result = await b.get({
-    $id: 'sp1',
-    title: true
+<!-- prettier-ignore-end -->
+
+Omitting the `$id` field would **create a new node instead**.
+
+> :exclamation: **All set operations must still respect the schema, otherwise the set won't take effect.**
+
+### `delete`
+
+A node can be removed using `client.delete()`, by passing an object with a property named `$id` containing the node's ID.
+
+###### Example:
+
+```js
+await client.delete({
+  $id: 'maASxsd3',
 })
 ```
 
-## .set(payload)
+## Observe data
+
+> Read more about `observe` and the query language [here](docs/get.md)
+
+Based is built from the ground up with realtime updates in mind. This is why the best way to retrieve data for the database is to _observe_ it. This allows to pass an `onData` function that will get called any time the data that the query points to changes.
+
+> ❗ Warning: The `data` object that gets passed to the onData function should **NOT** be modified in place since, due to performance reasons, the object gets reused between calls.
+
+Using this same method, it is also possible to observe a data function.
 
+This method returns a `close` function that must be called in order to allow the subscription to close gracefully.
+
+###### Example:
+
+```js
+// This query observes all nodes of type `thing` and counts how many times any of them
+// changes, is removed, or is added, while also logging all the entries every time.
+let receivedCnt = 0
+
+const close = await client.observe(
+  {
+    things: {
+      name: true,
+      id: true,
+      nested: true,
+      $list: {
+        $find: {
+          $traverse: 'children',
+          $filter: {
+            $operator: '=',
+            $value: 'thing',
+            $field: 'type',
+          },
+        },
+      },
+    },
+  },
+  (data) => {
+    console.log(data)
+    receivedCnt++
+  }
+)
+
+// when done ...
+close()
 ```
-const { id } = await b.set({
-    $id: 'sp1',
-    title: 'Yes, the best'
+
+**To observe a data function instead**, one can simply replace the query with the name of the function:
+
+###### Example:
+
+```js
+let receivedCnt = 0
+
+const close = await client.observe('observeAllThings', (data) => {
+  console.log(data)
+  receivedCnt++
 })
+
+// when done ...
+close()
 ```
 
-## .delete(payload)
+#### `get`
+
+It's also possible to simply get the data once, instead of observing it, using the `based.get()` method, which accepts a query or data function name as argument.
 
+###### Example:
+
+```js
+// Gets every child of `root`
+const data = await client.get({
+  $id: 'root',
+  children: { $all: true, $list: true },
+})
 ```
-const { ids } = await b.delete({
-    $id: 'sp1'
+
+## Upload files
+
+> Details [here](docs/files.md)
+
+Based provides a way to upload and serve user content without hassle using the `client.file()` API.
+
+This sets a new node of type `file` in the database, which contains all its relevant information
+
+###### Example:
+
+```js
+const fileId = await client.file({
+  contents: 'This is a string I want to store as plain text!',
+  mimeType: 'text/plain',
+  name: 'my-file-name',
 })
 ```
 
-## .copy(payload)
+Also supports browser file objects
+
+```jsx
+<input
+  type="file"
+  onChange={async (e) => {
+    const id = await client.file(e.target.files[0])
+    // const id = await client.file({ contents: e.target.files[0], name: 'custom name' });
+  }}
+/>
+```
+
+Or streams in node
+
+```js
+import fs from 'fs'
 
+const id = await client.file(fs.createReadStream(aFile))
 ```
-const { ids } = await b.copy({
-    $id: 'sp1'
+
+###### Retrieve the file node:
+
+```js
+const data = await client.get({
+  $id: fileId,
+  $all: true,
 })
+/*
+data = {
+  id: "fi6a535226",
+  name: "eb3f67a3bc65325bf739ebddd94403e5",
+  mimeType: "text/plain",
+  version: "eb3f67a3bc65325bf739ebddd94403e5",
+  origin: "https://based-env-files-do-usproduction-enb-xz-apz--orn-t-v-...98446afcb87d",
+  src: "https://based-2129034536588.imgix.net/fi6a535226/84e62df3-75...98446afcb87d",
+  progress: 1,
+  size: 31,
+  type: "file",
+  createdAt: 1650360875043,
+  updatedAt: 1650360882865,
+}
+*/
 ```
 
-## .call(name, payload)
+## Schema
+
+> Read more about schemas [here](docs/schema.md)
+
+The schema describes what types of nodes can exist on the database. Each `type` can have several named `fields`, each with its own data type (i.e. `string`, `number`, `object`, and so on). Based on the data type, Based will validate the value passed.
+
+One of the first things a Based user will have to do is set a schema for its database. This is done using the `client.updateSchema()` method.
 
+###### Example:
+
+```js
+await client.updateSchema({
+  types: {
+    thing: {
+      fields: {
+        name: { type: 'string' },
+        nested: {
+          type: 'object',
+          properties: {
+            something: { type: 'string' },
+          },
+        },
+      },
+    },
+  },
+})
 ```
-const res = await b.call('email', {
-    from: 'x',
-    to: 'y'
+
+## Analytics
+
+Based is capable of tracking a client in realtime using the included `client.track()` method (and `client.untrack()`).  
+This method allows to track any user defined event, attaching a payload to it. The client stops being tracked when `client.untrack()` is called, or when the connection is closed.
+
+###### Example:
+
+<!-- prettier-ignore-start -->
+```js
+client.track('view', {
+  edition: '2022',
+  language: 'en',
+})
+
+// when the event is no longer happening (e.g. the user moves to a different view)...
+client.untrack('view', {
+  edition: '2022', // The payload needs to be specified again, since it defines a unique event type
+  language: 'en',
 })
 ```
+<!-- prettier-ignore-end -->
 
-# auth
+To then retrieve the analytics data, Based provides the `client.analytics()` method, which takes as argument an object containg the event type and its payload.  
+This method can also take a `onData` function as a second argument, which turns it into an observer.
 
+###### Example:
+
+<!-- prettier-ignore-start -->
+```js
+  const data = await client.analytics({ type: 'view' })
+  console.log(data)           // prints an object { all, unique, active }
+                              // `all` represents the total count of how many times the event was fired overall
+                              // `unique` represents the total count of unique users that fired the event
+                              // `active` are the users that are active right now (real time visitors)
+                              
+  
+  // it's also possible to observe the analytics by passing an onData function to it
+  const close = await client.analytics(
+    { type: 'view' },
+    (analyticsInfo) => console.log(analyticsInfo)
+  )
 ```
-try {
-  await b.auth(token)
+<!-- prettier-ignore-end -->
 
-  await b.auth(false)
-} catch (e) {
+### `$geo` and `$history`
 
-}
+Based analytics can provide more specific data by using the `$geo` and `$history` operators, which give information about the location of the user and the historical values of the event tracked, respectively.
+
+###### Example:
+
+<!-- prettier-ignore-start -->
+```js
+  const data = await client.analytics({ type: 'view', $geo: true, $history: 30 })
+  console.log(data)           // prints an object containing all the information as the normal 
+                              // client.analytics call, but with a geo property containig ISO value counts,
+                              // and with the total counts turned into an array of max 30 tuples, 
+                              // with the first item in the tuple being a timestamp and the second one being the value at the time
+                              
+  
+  // it's also possible to observe the analytics by passing an onData function to it
+  const close = await client.analytics(
+    { type: 'view' },
+    (analyticsInfo) => console.log(analyticsInfo)
+  )
 ```
+<!-- prettier-ignore-end -->
 
 ---
 

package/dist/Client.d.ts

@@ -1,5 +1,5 @@
 import { Connection } from './websocket/types';
-import { GenericObject, RequestMessage, SubscriptionMessage, FunctionCallMessage, Configuration, TrackMessage, SendTokenOptions } from '@based/types';
+import { RequestTypes, GenericObject, RequestMessage, SubscriptionMessage, FunctionCallMessage, Configuration, TrackMessage, SendTokenOptions, AuthMessage } from '@based/types';
 import { Based } from './';
 export * from '@based/types';
 export declare class BasedClient {
@@ -7,7 +7,9 @@ export declare class BasedClient {
     constructor(based: Based);
     token: string;
     sendTokenOptions: SendTokenOptions;
+    retryingRenewToken: boolean;
     beingAuth: boolean;
+    isLogginIn: boolean;
     auth: ((x?: any) => void)[];
     subscriptions: {
         [subscriptionId: string]: {
@@ -34,6 +36,16 @@ export declare class BasedClient {
         };
     };
     requestCallbacks: {
+        [reqId: string]: {
+            resolve: (val?: any) => void;
+            reject: (err: Error) => void;
+            type?: Exclude<RequestTypes, RequestTypes.Subscription | RequestTypes.SubscriptionDiff | RequestTypes.SendSubscriptionData | RequestTypes.Unsubscribe | RequestTypes.GetSubscription | RequestTypes.Token | RequestTypes.Track>;
+            payload?: any;
+            name?: string;
+            isRetry?: boolean;
+        };
+    };
+    authCallbacks: {
         [reqId: string]: {
             resolve: (val?: any) => void;
             reject: (err: Error) => void;
@@ -44,7 +56,7 @@ export declare class BasedClient {
     connected: boolean;
     connection: Connection;
     subscriptionQueue: SubscriptionMessage[];
-    queue: (RequestMessage | FunctionCallMessage | TrackMessage)[];
+    queue: (RequestMessage | FunctionCallMessage | TrackMessage | AuthMessage)[];
     drainInProgress: boolean;
     drainTimeout: ReturnType<typeof setTimeout>;
     idlePing: ReturnType<typeof setTimeout>;

package/dist/Client.js

@@ -23,6 +23,8 @@ const subscriptions_1 = require("./subscriptions");
 const queue_1 = require("./queue");
 const request_1 = require("./request");
 const token_1 = __importDefault(require("./token"));
+const auth_1 = require("./auth");
+const auth_2 = require("./auth");
 __exportStar(require("@based/types"), exports);
 class BasedClient {
     constructor(based) {
@@ -30,6 +32,7 @@ class BasedClient {
         this.subscriptions = {};
         this.cache = {};
         this.requestCallbacks = {};
+        this.authCallbacks = {};
         this.connected = false;
         this.subscriptionQueue = [];
         // and more
@@ -71,35 +74,60 @@ class BasedClient {
     onData(d) {
         try {
             const data = JSON.parse(d.data);
-            if (data[0] === types_1.RequestTypes.Token) {
+            const [type, reqId, payload, err] = data;
+            if (type === types_1.RequestTypes.Token) {
+                this.retryingRenewToken = false;
                 // means stomething got de-auth wrong
-                if (data[1].length) {
+                if (reqId.length) {
                     (0, subscriptions_1.logoutSubscriptions)(this, data);
                 }
-                // console.info(data, data[2])
                 for (const fn of this.auth) {
-                    fn(!data[2]);
+                    fn(!payload);
                 }
                 this.beingAuth = false;
                 this.auth = [];
             }
-            else if (data[0] === types_1.RequestTypes.Set ||
-                data[0] === types_1.RequestTypes.Get ||
-                data[0] === types_1.RequestTypes.Configuration ||
-                data[0] === types_1.RequestTypes.GetConfiguration ||
-                data[0] === types_1.RequestTypes.Call ||
-                data[0] === types_1.RequestTypes.Delete ||
-                data[0] === types_1.RequestTypes.Copy ||
-                data[0] === types_1.RequestTypes.Digest ||
-                data[0] === types_1.RequestTypes.RemoveType ||
-                data[0] === types_1.RequestTypes.RemoveField) {
-                (0, request_1.incomingRequest)(this, data);
+            else if (type === types_1.RequestTypes.Auth) {
+                (0, auth_1.incomingAuthRequest)(this, data);
             }
-            else if (data[0] === types_1.RequestTypes.Subscription) {
-                (0, subscriptions_1.incomingSubscription)(this, data);
-            }
-            else if (data[0] === types_1.RequestTypes.SubscriptionDiff) {
-                (0, subscriptions_1.incomingSubscriptionDiff)(this, data);
+            else {
+                if (err?.code === types_1.BasedErrorCodes.TokenExpired &&
+                    !this.retryingRenewToken) {
+                    this.retryingRenewToken = true;
+                    const refreshToken = this.sendTokenOptions?.refreshToken;
+                    (0, auth_2.renewToken)(this, {
+                        refreshToken,
+                    })
+                        .then((result) => {
+                        (0, token_1.default)(this, result.token, this.sendTokenOptions);
+                        (0, request_1.addRequest)(this, 
+                        // @ts-ignore
+                        type, err?.payload, this.requestCallbacks[reqId].resolve, this.requestCallbacks[reqId].reject);
+                    })
+                        .catch((err) => {
+                        this.requestCallbacks[reqId].reject(err);
+                    });
+                }
+                else {
+                    if (type === types_1.RequestTypes.Set ||
+                        type === types_1.RequestTypes.Get ||
+                        type === types_1.RequestTypes.Configuration ||
+                        type === types_1.RequestTypes.GetConfiguration ||
+                        type === types_1.RequestTypes.Call ||
+                        type === types_1.RequestTypes.Delete ||
+                        type === types_1.RequestTypes.Copy ||
+                        type === types_1.RequestTypes.Digest ||
+                        type === types_1.RequestTypes.RemoveType ||
+                        type === types_1.RequestTypes.RemoveField) {
+                        (0, request_1.incomingRequest)(this, data);
+                    }
+                    else if (type === types_1.RequestTypes.Subscription) {
+                        (0, subscriptions_1.incomingSubscription)(this, data);
+                    }
+                    else if (type === types_1.RequestTypes.SubscriptionDiff) {
+                        (0, subscriptions_1.incomingSubscriptionDiff)(this, data);
+                    }
+                }
             }
         }
         catch (err) {

package/dist/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","sourceRoot":"","sources":["../src/Client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,wCAUqB;AACrB,mDAOwB;AAExB,mCAAgE;AAChE,uCAA2C;AAC3C,oDAA+B;AAE/B,+CAA4B;AAE5B,MAAa,WAAW;IAGtB,YAAY,KAAY;QASxB,SAAI,GAA0B,EAAE,CAAA;QAEhC,kBAAa,GAuBT,EAAE,CAAA;QAEN,UAAK,GAKD,EAAE,CAAA;QAEN,qBAAgB,GAMZ,EAAE,CAAA;QAMN,cAAS,GAAY,KAAK,CAAA;QAI1B,sBAAiB,GAA0B,EAAE,CAAA;QAE7C,WAAW;QACX,UAAK,GAA4D,EAAE,CAAA;QAEnE,oBAAe,GAAY,KAAK,CAAA;QA/D9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAoED,OAAO;QACL,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAA;QACpB,IAAA,2CAA2B,EAAC,IAAI,CAAC,CAAA;QACjC,IAAA,kDAAkC,EAAC,IAAI,CAAC,CAAA;QACxC,qCAAqC;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE;YACnC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;SACxD;IACH,CAAC;IAED,WAAW;QACT,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE;YAClC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;SACvD;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAC7B,IAAA,kBAAU,EAAC,IAAI,EAAE,CAAC,oBAAY,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;aACjD;SACF;IACH,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE;YAChC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;SACrD;QACD,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAA,eAAS,EAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;SACnD;QAED,IAAA,oCAAoB,EAAC,IAAI,CAAC,CAAA;QAC1B,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,CAAC;QACN,IAAI;YACF,MAAM,IAAI,GAAiB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC7C,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,KAAK,EAAE;gBAClC,qCAAqC;gBACrC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;oBAClB,IAAA,mCAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;iBAChC;gBAED,8BAA8B;gBAC9B,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE;oBAC1B,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;iBACb;gBACD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;gBACtB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;aACf;iBAAM,IACL,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,GAAG;gBAC5B,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,GAAG;gBAC5B,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,aAAa;gBACtC,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,gBAAgB;gBACzC,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,IAAI;gBAC7B,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,MAAM;gBAC/B,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,IAAI;gBAC7B,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,MAAM;gBAC/B,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,UAAU;gBACnC,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,WAAW,EACpC;gBACA,IAAA,yBAAe,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;aAC5B;iBAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,YAAY,EAAE;gBAChD,IAAA,oCAAoB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;aACjC;iBAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,oBAAY,CAAC,gBAAgB,EAAE;gBACpD,IAAA,wCAAwB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;aACrC;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAA;SAC7C;IACH,CAAC;CACF;AAjJD,kCAiJC"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../src/Client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,wCAcqB;AACrB,mDAOwB;AAExB,mCAAgE;AAChE,uCAAuD;AACvD,oDAA+B;AAC/B,iCAA4C;AAC5C,iCAAmC;AAEnC,+CAA4B;AAE5B,MAAa,WAAW;IAGtB,YAAY,KAAY;QAaxB,SAAI,GAA0B,EAAE,CAAA;QAEhC,kBAAa,GAuBT,EAAE,CAAA;QAEN,UAAK,GAKD,EAAE,CAAA;QAEN,qBAAgB,GAoBZ,EAAE,CAAA;QAEN,kBAAa,GAMT,EAAE,CAAA;QAMN,cAAS,GAAY,KAAK,CAAA;QAI1B,sBAAiB,GAA0B,EAAE,CAAA;QAE7C,WAAW;QACX,UAAK,GACH,EAAE,CAAA;QAEJ,oBAAe,GAAY,KAAK,CAAA;QA1F9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IA+FD,OAAO;QACL,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAA;QACpB,IAAA,2CAA2B,EAAC,IAAI,CAAC,CAAA;QACjC,IAAA,kDAAkC,EAAC,IAAI,CAAC,CAAA;QACxC,qCAAqC;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE;YACnC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;SACxD;IACH,CAAC;IAED,WAAW;QACT,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE;YAClC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;SACvD;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAC7B,IAAA,kBAAU,EAAC,IAAI,EAAE,CAAC,oBAAY,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;aACjD;SACF;IACH,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE;YAChC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;SACrD;QACD,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAA,eAAS,EAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;SACnD;QAED,IAAA,oCAAoB,EAAC,IAAI,CAAC,CAAA;QAC1B,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,CAAC;QACN,IAAI;YACF,MAAM,IAAI,GAAiB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC7C,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;YACxC,IAAI,IAAI,KAAK,oBAAY,CAAC,KAAK,EAAE;gBAC/B,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAA;gBAC/B,qCAAqC;gBACrC,IAAI,KAAK,CAAC,MAAM,EAAE;oBAChB,IAAA,mCAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;iBAChC;gBACD,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE;oBAC1B,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;iBACb;gBACD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;gBACtB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;aACf;iBAAM,IAAI,IAAI,KAAK,oBAAY,CAAC,IAAI,EAAE;gBACrC,IAAA,0BAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;aAChC;iBAAM;gBACL,IACG,GAAkB,EAAE,IAAI,KAAK,uBAAe,CAAC,YAAY;oBAC1D,CAAC,IAAI,CAAC,kBAAkB,EACxB;oBACA,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;oBAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAA;oBACxD,IAAA,iBAAU,EAAC,IAAI,EAAE;wBACf,YAAY;qBACb,CAAC;yBACC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBACf,IAAA,eAAS,EAAC,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;wBACpD,IAAA,oBAAU,EACR,IAAI;wBACJ,aAAa;wBACb,IAAI,EACH,GAAmB,EAAE,OAAO,EAC7B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,OAAO,EACpC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,MAAM,CACpC,CAAA;oBACH,CAAC,CAAC;yBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;wBACb,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;oBAC1C,CAAC,CAAC,CAAA;iBACL;qBAAM;oBACL,IACE,IAAI,KAAK,oBAAY,CAAC,GAAG;wBACzB,IAAI,KAAK,oBAAY,CAAC,GAAG;wBACzB,IAAI,KAAK,oBAAY,CAAC,aAAa;wBACnC,IAAI,KAAK,oBAAY,CAAC,gBAAgB;wBACtC,IAAI,KAAK,oBAAY,CAAC,IAAI;wBAC1B,IAAI,KAAK,oBAAY,CAAC,MAAM;wBAC5B,IAAI,KAAK,oBAAY,CAAC,IAAI;wBAC1B,IAAI,KAAK,oBAAY,CAAC,MAAM;wBAC5B,IAAI,KAAK,oBAAY,CAAC,UAAU;wBAChC,IAAI,KAAK,oBAAY,CAAC,WAAW,EACjC;wBACA,IAAA,yBAAe,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;qBAC5B;yBAAM,IAAI,IAAI,KAAK,oBAAY,CAAC,YAAY,EAAE;wBAC7C,IAAA,oCAAoB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;qBACjC;yBAAM,IAAI,IAAI,KAAK,oBAAY,CAAC,gBAAgB,EAAE;wBACjD,IAAA,wCAAwB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;qBACrC;iBACF;aACF;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAA;SAC7C;IACH,CAAC;CACF;AAzMD,kCAyMC"}

package/dist/auth.d.ts

@@ -0,0 +1,10 @@
+import { BasedClient } from '.';
+import { AuthData, GenericObject, LoginOpts, RenewTokenOpts } from '@based/types';
+export declare const login: (client: BasedClient, opts: LoginOpts) => Promise<{
+    token: string;
+}>;
+export declare const renewToken: (client: BasedClient, opts: RenewTokenOpts) => Promise<{
+    token: string;
+}>;
+export declare const incomingAuthRequest: (client: BasedClient, data: AuthData) => void;
+export declare const logout: (client: BasedClient) => Promise<GenericObject>;

package/dist/auth.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logout = exports.incomingAuthRequest = exports.renewToken = exports.login = void 0;
+const queue_1 = require("./queue");
+const types_1 = require("@based/types");
+const createError_1 = __importDefault(require("./createError"));
+const token_1 = __importDefault(require("./token"));
+let loginCbId = 0;
+const login = (client, opts) => {
+    const reqId = ++loginCbId;
+    (0, queue_1.addToQueue)(client, [types_1.RequestTypes.Auth, types_1.AuthRequestTypes.Login, reqId, opts]);
+    return new Promise((resolve, reject) => {
+        client.authCallbacks[reqId] = {
+            resolve: (response) => {
+                (0, token_1.default)(client, response.token, {
+                    refreshToken: response.refreshToken,
+                });
+                resolve(response);
+            },
+            reject,
+        };
+    });
+};
+exports.login = login;
+const renewToken = (client, opts) => {
+    const reqId = ++loginCbId;
+    (0, queue_1.addToQueue)(client, [
+        types_1.RequestTypes.Auth,
+        types_1.AuthRequestTypes.RenewToken,
+        reqId,
+        opts,
+    ]);
+    return new Promise((resolve, reject) => {
+        client.authCallbacks[reqId] = {
+            resolve: (response) => {
+                (0, token_1.default)(client, response.token);
+                resolve(response);
+            },
+            reject,
+        };
+    });
+};
+exports.renewToken = renewToken;
+const incomingAuthRequest = (client, data) => {
+    const [, reqId, payload, err] = data;
+    const cb = client.authCallbacks[reqId];
+    if (cb) {
+        delete client.authCallbacks[reqId];
+        if (err) {
+            cb.reject((0, createError_1.default)(err));
+        }
+        else {
+            cb.resolve(payload);
+        }
+    }
+};
+exports.incomingAuthRequest = incomingAuthRequest;
+const logout = (client) => {
+    const reqId = ++loginCbId;
+    (0, queue_1.addToQueue)(client, [types_1.RequestTypes.Auth, types_1.AuthRequestTypes.Logout, reqId]);
+    return new Promise((resolve, reject) => {
+        client.authCallbacks[reqId] = {
+            resolve: (response) => {
+                (0, token_1.default)(client);
+                resolve(response);
+            },
+            reject,
+        };
+    });
+};
+exports.logout = logout;
+//# sourceMappingURL=auth.js.map

package/dist/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":";;;;;;AACA,mCAAoC;AACpC,wCAOqB;AACrB,gEAAuC;AACvC,oDAA+B;AAE/B,IAAI,SAAS,GAAG,CAAC,CAAA;AAEV,MAAM,KAAK,GAAG,CACnB,MAAmB,EACnB,IAAe,EACa,EAAE;IAC9B,MAAM,KAAK,GAAG,EAAE,SAAS,CAAA;IACzB,IAAA,kBAAU,EAAC,MAAM,EAAE,CAAC,oBAAY,CAAC,IAAI,EAAE,wBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAC5E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG;YAC5B,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACpB,IAAA,eAAS,EAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE;oBAChC,YAAY,EAAE,QAAQ,CAAC,YAAY;iBACpC,CAAC,CAAA;gBACF,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC;YACD,MAAM;SACP,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAjBY,QAAA,KAAK,SAiBjB;AAEM,MAAM,UAAU,GAAG,CACxB,MAAmB,EACnB,IAAoB,EACQ,EAAE;IAC9B,MAAM,KAAK,GAAG,EAAE,SAAS,CAAA;IACzB,IAAA,kBAAU,EAAC,MAAM,EAAE;QACjB,oBAAY,CAAC,IAAI;QACjB,wBAAgB,CAAC,UAAU;QAC3B,KAAK;QACL,IAAI;KACL,CAAC,CAAA;IACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG;YAC5B,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACpB,IAAA,eAAS,EAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;gBACjC,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC;YACD,MAAM;SACP,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AApBY,QAAA,UAAU,cAoBtB;AAEM,MAAM,mBAAmB,GAAG,CAAC,MAAmB,EAAE,IAAc,EAAE,EAAE;IACzE,MAAM,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpC,MAAM,EAAE,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IACtC,IAAI,EAAE,EAAE;QACN,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QAClC,IAAI,GAAG,EAAE;YACP,EAAE,CAAC,MAAM,CAAC,IAAA,qBAAW,EAAC,GAAG,CAAC,CAAC,CAAA;SAC5B;aAAM;YACL,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;SACpB;KACF;AACH,CAAC,CAAA;AAXY,QAAA,mBAAmB,uBAW/B;AAEM,MAAM,MAAM,GAAG,CAAC,MAAmB,EAA0B,EAAE;IACpE,MAAM,KAAK,GAAG,EAAE,SAAS,CAAA;IACzB,IAAA,kBAAU,EAAC,MAAM,EAAE,CAAC,oBAAY,CAAC,IAAI,EAAE,wBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG;YAC5B,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACpB,IAAA,eAAS,EAAC,MAAM,CAAC,CAAA;gBACjB,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC;YACD,MAAM;SACP,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAZY,QAAA,MAAM,UAYlB"}

package/dist/createError.d.ts

@@ -1,5 +1,3 @@
-import { ErrorObject } from '@based/types';
-declare const _default: (err: ErrorObject) => Error & {
-    code?: string;
-};
+import { ErrorObject, BasedError } from '@based/types';
+declare const _default: (err: ErrorObject) => BasedError;
 export default _default;

package/dist/createError.js

@@ -23,9 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("@based/types");
 const printBasedObject_1 = __importStar(require("./printBasedObject"));
 exports.default = (err) => {
-    const x = new Error(err.message);
+    const x = new types_1.BasedError(err.message);
     x.name = err.name ? `${err.type} from ${err.name}` : err.type;
     x.stack = null;
     if (err.query || err.payload) {

package/dist/createError.js.map

@@ -1 +1 @@
-{"version":3,"file":"createError.js","sourceRoot":"","sources":["../src/createError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACA,uEAA4D;AAE5D,kBAAe,CAAC,GAAgB,EAA6B,EAAE;IAC7D,MAAM,CAAC,GAA8B,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,SAAS,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAA;IAC7D,CAAC,CAAC,KAAK,GAAG,IAAI,CAAA;IAEd,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO,EAAE;QAC5B,IAAI,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACjC,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,KAAK,CAAC,KAAK,EAAE,CAAA;SACd;QAED,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACzC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBACxB,UAAU,GAAG,CAAC,GAAG,CAAC,CAAA;gBAClB,MAAK;aACN;SACF;QACD,IAAI,UAAU,GAAG,CAAC,EAAE;YAClB,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAA;SAC9C;aAAM;YACL,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;SACnC;QACD,IAAI,GAAG,CAAC,IAAI,EAAE;YACZ,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;SAClB;QACD,CAAC,CAAC,OAAO;YACP,MAAM;gBACN,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;oBAC7C,CAAC,CAAC,KAAK,IAAA,wBAAK,EAAC,SAAS,EAAE,WAAW,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE;oBACrD,CAAC,CAAC,IAAA,0BAAgB,EACd,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,EACxB,CAAC,EACD,KAAK,EACL,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EACjC,IAAI,CACL;yBACE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC;yBACpB,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,MAAM;gBACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChB,MAAM,CAAA;KACT;IACD,OAAO,CAAC,CAAA;AACV,CAAC,CAAA"}
+{"version":3,"file":"createError.js","sourceRoot":"","sources":["../src/createError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wCAAsD;AACtD,uEAA4D;AAE5D,kBAAe,CAAC,GAAgB,EAAc,EAAE;IAC9C,MAAM,CAAC,GAAG,IAAI,kBAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACrC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,SAAS,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAA;IAC7D,CAAC,CAAC,KAAK,GAAG,IAAI,CAAA;IAEd,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO,EAAE;QAC5B,IAAI,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACjC,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,KAAK,CAAC,KAAK,EAAE,CAAA;SACd;QAED,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACzC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBACxB,UAAU,GAAG,CAAC,GAAG,CAAC,CAAA;gBAClB,MAAK;aACN;SACF;QACD,IAAI,UAAU,GAAG,CAAC,EAAE;YAClB,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAA;SAC9C;aAAM;YACL,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;SACnC;QACD,IAAI,GAAG,CAAC,IAAI,EAAE;YACZ,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;SAClB;QACD,CAAC,CAAC,OAAO;YACP,MAAM;gBACN,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;oBAC7C,CAAC,CAAC,KAAK,IAAA,wBAAK,EAAC,SAAS,EAAE,WAAW,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE;oBACrD,CAAC,CAAC,IAAA,0BAAgB,EACd,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,EACxB,CAAC,EACD,KAAK,EACL,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EACjC,IAAI,CACL;yBACE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC;yBACpB,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,MAAM;gBACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChB,MAAM,CAAA;KACT;IACD,OAAO,CAAC,CAAA;AACV,CAAC,CAAA"}