@based/client 3.3.0 → 4.0.1

package/dist/subscriptions/sendAllSubscriptions.js

@@ -1,114 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendAllSubscriptions = void 0;
-const types_1 = require("@based/types");
-const queue_1 = require("../queue");
-const sendAllSubscriptions = (client, reAuth = false) => {
-    for (const key in client.subscriptions) {
-        const subscriptionId = Number(key);
-        const subscription = client.subscriptions[key];
-        if (reAuth && !subscription.authError) {
-            // delete subscrption.authError
-            continue;
-        }
-        // for loop for has to include (for gets)
-        let getInQ;
-        let queued;
-        let getIndex;
-        for (let i = 0; i < client.subscriptionQueue.length; i++) {
-            const [type, id] = client.subscriptionQueue[i];
-            if (id === subscriptionId) {
-                if (type === types_1.RequestTypes.GetSubscription) {
-                    getIndex = i;
-                    getInQ = client.subscriptionQueue[i];
-                }
-                else if (type === types_1.RequestTypes.Subscription) {
-                    queued = client.subscriptionQueue[i];
-                }
-            }
-        }
-        if (getInQ && queued) {
-            console.error('GET IN Q AND SUB IN Q SHOULD BE IMPOSSIBLE');
-        }
-        const cache = client.cache[subscriptionId];
-        // console.info(getInQ, queued)
-        let x = false;
-        if (getInQ) {
-            let onlyGets = true;
-            for (const k in subscription.subscribers) {
-                const s = subscription.subscribers[k];
-                if (s.onData) {
-                    onlyGets = false;
-                    break;
-                }
-            }
-            if (onlyGets) {
-                x = true;
-            }
-            else {
-                console.info('not only gets remove get');
-                client.subscriptionQueue.splice(getIndex, 1);
-            }
-            if (cache && getInQ[3] !== cache.checksum) {
-                getInQ[3] = cache.checksum;
-            }
-        }
-        if (!x) {
-            if (queued) {
-                if (cache && queued[3] !== cache.checksum) {
-                    queued[3] = cache.checksum;
-                    if (getInQ) {
-                        queued[4] = 2;
-                    }
-                }
-            }
-            else {
-                const { name, query } = client.subscriptions[subscriptionId];
-                if (name) {
-                    if (cache) {
-                        (0, queue_1.addToQueue)(client, [
-                            types_1.RequestTypes.Subscription,
-                            subscriptionId,
-                            query,
-                            cache.checksum,
-                            getInQ ? 2 : 0,
-                            name,
-                        ]);
-                    }
-                    else {
-                        (0, queue_1.addToQueue)(client, [
-                            types_1.RequestTypes.Subscription,
-                            subscriptionId,
-                            query,
-                            0,
-                            getInQ ? 2 : 0,
-                            name,
-                        ]);
-                    }
-                }
-                else {
-                    if (cache) {
-                        (0, queue_1.addToQueue)(client, [
-                            types_1.RequestTypes.Subscription,
-                            subscriptionId,
-                            query,
-                            cache.checksum,
-                            getInQ ? 2 : 0,
-                        ]);
-                    }
-                    else {
-                        (0, queue_1.addToQueue)(client, [
-                            types_1.RequestTypes.Subscription,
-                            subscriptionId,
-                            query,
-                            0,
-                            getInQ ? 2 : 0,
-                        ]);
-                    }
-                }
-            }
-        }
-    }
-};
-exports.sendAllSubscriptions = sendAllSubscriptions;
-//# sourceMappingURL=sendAllSubscriptions.js.map

package/dist/subscriptions/sendAllSubscriptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sendAllSubscriptions.js","sourceRoot":"","sources":["../../src/subscriptions/sendAllSubscriptions.ts"],"names":[],"mappings":";;;AACA,wCAA2C;AAC3C,oCAAqC;AAE9B,MAAM,oBAAoB,GAAG,CAClC,MAAmB,EACnB,SAAkB,KAAK,EACvB,EAAE;IACF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE;QACtC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QAClC,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAC9C,IAAI,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE;YACrC,+BAA+B;YAC/B,SAAQ;SACT;QAED,yCAAyC;QAEzC,IAAI,MAAM,CAAA;QACV,IAAI,MAAM,CAAA;QACV,IAAI,QAAQ,CAAA;QAEZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxD,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;YAE9C,IAAI,EAAE,KAAK,cAAc,EAAE;gBACzB,IAAI,IAAI,KAAK,oBAAY,CAAC,eAAe,EAAE;oBACzC,QAAQ,GAAG,CAAC,CAAA;oBACZ,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;iBACrC;qBAAM,IAAI,IAAI,KAAK,oBAAY,CAAC,YAAY,EAAE;oBAC7C,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;iBACrC;aACF;SACF;QAED,IAAI,MAAM,IAAI,MAAM,EAAE;YACpB,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAA;SAC5D;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QAE1C,+BAA+B;QAE/B,IAAI,CAAC,GAAG,KAAK,CAAA;QAEb,IAAI,MAAM,EAAE;YACV,IAAI,QAAQ,GAAG,IAAI,CAAA;YACnB,KAAK,MAAM,CAAC,IAAI,YAAY,CAAC,WAAW,EAAE;gBACxC,MAAM,CAAC,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;gBACrC,IAAI,CAAC,CAAC,MAAM,EAAE;oBACZ,QAAQ,GAAG,KAAK,CAAA;oBAChB,MAAK;iBACN;aACF;YAED,IAAI,QAAQ,EAAE;gBACZ,CAAC,GAAG,IAAI,CAAA;aACT;iBAAM;gBACL,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA;gBACxC,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;aAC7C;YAED,IAAI,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,QAAQ,EAAE;gBACzC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAA;aAC3B;SACF;QAED,IAAI,CAAC,CAAC,EAAE;YACN,IAAI,MAAM,EAAE;gBACV,IAAI,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,QAAQ,EAAE;oBACzC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAA;oBAC1B,IAAI,MAAM,EAAE;wBACV,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;qBACd;iBACF;aACF;iBAAM;gBACL,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;gBAC5D,IAAI,IAAI,EAAE;oBACR,IAAI,KAAK,EAAE;wBACT,IAAA,kBAAU,EAAC,MAAM,EAAE;4BACjB,oBAAY,CAAC,YAAY;4BACzB,cAAc;4BACd,KAAK;4BACL,KAAK,CAAC,QAAQ;4BACd,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BACd,IAAI;yBACL,CAAC,CAAA;qBACH;yBAAM;wBACL,IAAA,kBAAU,EAAC,MAAM,EAAE;4BACjB,oBAAY,CAAC,YAAY;4BACzB,cAAc;4BACd,KAAK;4BACL,CAAC;4BACD,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BACd,IAAI;yBACL,CAAC,CAAA;qBACH;iBACF;qBAAM;oBACL,IAAI,KAAK,EAAE;wBACT,IAAA,kBAAU,EAAC,MAAM,EAAE;4BACjB,oBAAY,CAAC,YAAY;4BACzB,cAAc;4BACd,KAAK;4BACL,KAAK,CAAC,QAAQ;4BACd,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;yBACf,CAAC,CAAA;qBACH;yBAAM;wBACL,IAAA,kBAAU,EAAC,MAAM,EAAE;4BACjB,oBAAY,CAAC,YAAY;4BACzB,cAAc;4BACd,KAAK;4BACL,CAAC;4BACD,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;yBACf,CAAC,CAAA;qBACH;iBACF;aACF;SACF;KACF;AACH,CAAC,CAAA;AAnHY,QAAA,oBAAoB,wBAmHhC"}

package/dist/token.d.ts

@@ -1,4 +0,0 @@
-import { BasedClient } from '.';
-import { SendTokenOptions } from '@based/types';
-declare const sendToken: (client: BasedClient, token?: string, options?: SendTokenOptions) => void;
-export default sendToken;

package/dist/token.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = require("@based/types");
-const idleTimeout_1 = __importDefault(require("./idleTimeout"));
-const subscriptions_1 = require("./subscriptions");
-const notUndefinedOrNull = (v) => typeof v !== 'undefined' && v !== null;
-const sendToken = (client, token, options) => {
-    client.beingAuth = true;
-    if (token) {
-        client.token = token;
-        client.sendTokenOptions = options;
-    }
-    else {
-        for (const id in client.cache) {
-            if (!client.subscriptions[id]) {
-                delete client.cache[id];
-            }
-        }
-        delete client.token;
-        delete client.sendTokenOptions;
-    }
-    if (client.connected) {
-        const message = token
-            ? [types_1.RequestTypes.Token, token, options].filter(notUndefinedOrNull)
-            : [types_1.RequestTypes.Token];
-        client.connection.ws.send(JSON.stringify(message));
-        (0, idleTimeout_1.default)(client);
-        (0, subscriptions_1.sendAllSubscriptions)(client, true);
-    }
-};
-exports.default = sendToken;
-//# sourceMappingURL=token.js.map

package/dist/token.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"token.js","sourceRoot":"","sources":["../src/token.ts"],"names":[],"mappings":";;;;;AACA,wCAA6D;AAC7D,gEAAuC;AAEvC,mDAAsD;AAEtD,MAAM,kBAAkB,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,WAAW,IAAI,CAAC,KAAK,IAAI,CAAA;AAE7E,MAAM,SAAS,GAAG,CAChB,MAAmB,EACnB,KAAc,EACd,OAA0B,EAC1B,EAAE;IACF,MAAM,CAAC,SAAS,GAAG,IAAI,CAAA;IACvB,IAAI,KAAK,EAAE;QACT,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAA;KAClC;SAAM;QACL,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,KAAK,EAAE;YAC7B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE;gBAC7B,OAAO,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;aACxB;SACF;QACD,OAAO,MAAM,CAAC,KAAK,CAAA;QACnB,OAAO,MAAM,CAAC,gBAAgB,CAAA;KAC/B;IACD,IAAI,MAAM,CAAC,SAAS,EAAE;QACpB,MAAM,OAAO,GAAG,KAAK;YACnB,CAAC,CAAC,CAAC,oBAAY,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC;YACjE,CAAC,CAAC,CAAC,oBAAY,CAAC,KAAK,CAAC,CAAA;QACxB,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;QAClD,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAA;QACnB,IAAA,oCAAoB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;KACnC;AACH,CAAC,CAAA;AAED,kBAAe,SAAS,CAAA"}

package/dist/track.d.ts

@@ -1,8 +0,0 @@
-import { BasedClient, TrackOpts } from '.';
-export declare const genKey: (type: string, params?: {
-    [key: string]: string | number | boolean;
-}) => string;
-declare const _default: (client: BasedClient, type: string, params?: {
-    [key: string]: string | number | boolean;
-}, untrack?: boolean, event?: boolean, opts?: TrackOpts, del?: boolean) => void;
-export default _default;

package/dist/track.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.genKey = void 0;
-const queue_1 = require("./queue");
-const types_1 = require("@based/types");
-const hash_1 = require("@saulx/hash");
-const notUnique = new Set();
-const isUnique = (x) => {
-    if (typeof window !== 'undefined') {
-        if (notUnique.has(x)) {
-            return false;
-        }
-        notUnique.add(x);
-        try {
-            const name = '_ba:' + (0, hash_1.hashCompact)(x);
-            if (localStorage.getItem(name)) {
-                return false;
-            }
-            localStorage.setItem(name, '1');
-            return true;
-        }
-        catch (err) {
-            return false;
-        }
-    }
-    return false;
-};
-const genKey = (type, params) => {
-    if (params) {
-        let str = `${type}`;
-        const keys = Object.keys(params).sort();
-        for (const k of keys) {
-            str += '_' + k + '_' + params[k];
-        }
-        return str;
-    }
-    else {
-        return type;
-    }
-};
-exports.genKey = genKey;
-exports.default = (client, type, params, untrack, event, opts, del) => {
-    const k = (0, exports.genKey)(type, params);
-    const payload = { t: k };
-    if (del) {
-        payload.r = 1;
-    }
-    if (event) {
-        payload.e = 1;
-        if (opts) {
-            payload.o = opts;
-        }
-    }
-    if (untrack) {
-        payload.s = 1;
-        client.tracking.delete(k);
-    }
-    else if (!del) {
-        if (!event) {
-            if (!client.tracking) {
-                client.tracking = new Set();
-            }
-            client.tracking.add(k);
-        }
-        if (isUnique(k)) {
-            payload.u = 1;
-        }
-    }
-    (0, queue_1.addToQueue)(client, [types_1.RequestTypes.Track, payload]);
-};
-//# sourceMappingURL=track.js.map

package/dist/track.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"track.js","sourceRoot":"","sources":["../src/track.ts"],"names":[],"mappings":";;;AACA,mCAAoC;AACpC,wCAA2C;AAC3C,sCAAyC;AAEzC,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAA;AAExC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAW,EAAE;IACtC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACpB,OAAO,KAAK,CAAA;SACb;QACD,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QAChB,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,GAAG,IAAA,kBAAW,EAAC,CAAC,CAAC,CAAA;YACpC,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC9B,OAAO,KAAK,CAAA;aACb;YACD,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAC/B,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,KAAK,CAAA;SACb;KACF;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAEM,MAAM,MAAM,GAAG,CACpB,IAAY,EACZ,MAAqD,EAC7C,EAAE;IACV,IAAI,MAAM,EAAE;QACV,IAAI,GAAG,GAAG,GAAG,IAAI,EAAE,CAAA;QACnB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAA;QACvC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;YACpB,GAAG,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;SACjC;QACD,OAAO,GAAG,CAAA;KACX;SAAM;QACL,OAAO,IAAI,CAAA;KACZ;AACH,CAAC,CAAA;AAdY,QAAA,MAAM,UAclB;AAED,kBAAe,CACb,MAAmB,EACnB,IAAY,EACZ,MAAqD,EACrD,OAAiB,EACjB,KAAe,EACf,IAAgB,EAChB,GAAa,EACb,EAAE;IACF,MAAM,CAAC,GAAG,IAAA,cAAM,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC9B,MAAM,OAAO,GAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;IACtC,IAAI,GAAG,EAAE;QACP,OAAO,CAAC,CAAC,GAAG,CAAC,CAAA;KACd;IACD,IAAI,KAAK,EAAE;QACT,OAAO,CAAC,CAAC,GAAG,CAAC,CAAA;QACb,IAAI,IAAI,EAAE;YACR,OAAO,CAAC,CAAC,GAAG,IAAI,CAAA;SACjB;KACF;IACD,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,CAAC,GAAG,CAAC,CAAA;QACb,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;KAC1B;SAAM,IAAI,CAAC,GAAG,EAAE;QACf,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACpB,MAAM,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAA;aAC5B;YACD,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;SACvB;QAED,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE;YACf,OAAO,CAAC,CAAC,GAAG,CAAC,CAAA;SACd;KACF;IACD,IAAA,kBAAU,EAAC,MAAM,EAAE,CAAC,oBAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACnD,CAAC,CAAA"}

package/docs/auth-based-ui-howto.md

@@ -1,74 +0,0 @@
-## JWT Auth Flow HowTo using based/ui
-
-This guide shows how to implement authentication using [based/ui](https://github.com/atelier-saulx/ui) UI library and its authentication components.
-The tutorial example files can be found in [this repository](https://github.com/atelier-saulx/auth-demo).
-
-### Imports
-
-Components can be imported or required from the [`@based/ui`](https://www.npmjs.com/package/@based/ui) npm package.
-```bash
-$ npm install @based/ui
-```
-
-```javascript
-import { Provider, Authorize } from '@based/ui'
-```
-
-### Provider
-
-The first step is to wrap the app with a `<Provider />` component. This will set up the app to handle third-party auth provider callbacks and handle overlays and themes from the `based/ui` library.
-The `<Provider />` component expects the main app component as a child and a [based client](https://github.com/atelier-saulx/based/blob/main/packages/client/README.md) as the `client` argument.
-
-```javascript
-const client = based(basedConfig)
-render(
-  <Provider client={client}>
-    <App />
-  </Provider>,
-  rootEl
-)
-```
-
-### Authorize component
-
-The Authorize component renders other components only when a user is authenticated. If the user is not authenticated, it will show a login/register dialog.
-Email, Google, Microsoft, and Github provider handler functions are installed in new environments by default. We encourage you to check these [templates](https://github.com/atelier-saulx/based/tree/main/packages/templates/jwtAuth/functions) and adapt them to your needs by adding the [data functions](https://github.com/atelier-saulx/based/tree/main/packages/templates/jwtAuth/functions) to your project and [deploying](https://github.com/atelier-saulx/based/blob/main/packages/cli/README.md#deploy) them with the [based CLI](https://github.com/atelier-saulx/based/blob/main/packages/cli/README.md).
-
-```javascript
-  <Authorize
-    // googleClientId="<your_google_client_id>"
-    // microsoftClientId="<your_microsoft_client_id>"
-    // githubClientId="<your_github_client_id>"
-    app={LoggedinBody}
-  />
-```
-
-The protected sections of your site should be wrapped in a component passed to the `app` argument. 
-The component is passed as an argument instead of `children`, so the protected components are never rendered if the user is not authenticated.
-
-### Email provider
-
-New environments came by default, with a `user` type ready to receive email registrations. The [`register` user data function](https://github.com/atelier-saulx/based/blob/main/packages/templates/jwtAuth/functions/registerUser/index.ts) registers new users using the name and email address, sends a confirmation email, and waits for the new user to click the email message he received confirming the email address.
-
-### Google provider
-
-To enable the Sign In with Google provider and button, you need to configure the google client id and google client secret.
-Follow the instructions in [this](https://developers.google.com/identity/sign-in/web/sign-in) page to the point where you have both.
-The client id is configured in the `<Authorize />` component as the `googleClientId` argument.
-The client secret should be saved as a [secret](https://github.com/atelier-saulx/based/tree/main/packages/cli#secrets) with the name `google-client-secret-<project>-<env>` where `<project>` and `<env>` should be replaced with the name of your project and environment.
-The Google credential should be configured with your domain and `https://<your_domain>/auth-google` as the callback address.
-
-### Microsoft provider
-
-To enable the Microsoft Identity Platform provider, you need to configure a Microsoft client id.
-Follow the instructions in [this](https://docs.microsoft.com/en-us/azure/active-directory/develop/web-api-quickstart?pivots=devlang-aspnet) page until you have the Microsoft client id.
-The client id is configured in the `<Authorize />` component with the `microsoftClientId` argument.
-The Azure application should be configured with your domain and `https://<your_domain>/auth-microsoft` as the callback address.
-
-### GitHub provider
-
-To enable the GitHub Oauth provider, your need to configure your GitHub client id and client secret.
-Follow the instructions in [this](https://docs.github.com/en/developers/apps/building-github-apps/creating-a-github-app) page to get both.
-Be sure to de your domain name and user `https://<your_domain>/auth-github` as the callback address.
-The client id should be configured in the `<Authorize />` component using the `githubClientId` argument. The client secret should be saved as a [secret](https://github.com/atelier-saulx/based/tree/main/packages/cli#secrets) with the name `github-client-secret-<project>-<env>` where `<project>` and `<env>` should be replaced with the name of your project and environment.
-

package/docs/auth-howto.md

@@ -1,166 +0,0 @@
-## JWT Auth Flow HowTo
-
-A short guide to setting up the JWT authentication flow using based.
-An example with the info on this guide can be foud [here](https://github.com/atelier-saulx/auth-demo)
-
-If you created an environment using the based website, the JWT auth flow template is installed by default. This template includes the `user` type schema, the public and private keys, and the default `authorize`, `login`, `logout`, and `renewToken` data functions.
-
-These default data functions can be customized to your needs. Add them to your project from [here](https://github.com/atelier-saulx/based/tree/main/packages/auth-templates/jwt) and deploy with the [based cli `deploy` command](https://github.com/atelier-saulx/based/tree/main/packages/cli#deploy).
-
-### Adding a user to the database
-
-You now need to add a user to the database so that he can log in.
-There are several ways to do this, including the data editor in the Based website admin area.
-We'll add it through a script from the developer's computer environment as it also shows how you can add this functionality from your own apps.
-
-The `user` type installed by default has the following schema:
-
-```
-  ...
-  types: {
-    user: {
-      prefix: 'us',
-      fields: {
-        name: { type: 'string' },
-        email: { type: 'email' },
-        password: { type: 'digest' },
-      },
-    },
-  },
-```
-
-It is ready to accept users with an email, name string, and hashed password.
-Let's create a user from a script.
-
-#### Setting up an apiKey 
-
-If we try to add a user now from a script, we get into a chicken and the egg issue. We don't have an authenticated user to add the user itself. You can work around this while developing using the apiKey functionality.
-This feature lets us create an apikey so we can use based in utility scripts and commands using the [based cli](https://github.com/atelier-saulx/based/tree/main/packages/cli).
-
-```bash
-$ npx based apiKeys add --name auth-demo-api-key --file ./apiKey.key
-```
-
-This command will create an apiKey called "auth-demo-api-key" and saves its value to a file we can load from the script or use as an argument in the [based cli](https://github.com/atelier-saulx/based/tree/main/packages/cli).
-
-**Note:** You should never store apiKeys as plain text in repositories or use them to make based connections client side.
-
-#### Setting a user with a script
-
-With the apiKey, we can now run a simple script to add a new user:
-
-```javascript
-// scripts/createUser.ts
-
-import fs from 'fs'
-import based from '@based/client'
-
-// Loads the based config file that sets up your based connection
-const basedConfig = JSON.parse(fs.readFileSync('../based.json', 'utf8'))
-
-// Loads apiKey so we can have based access from a script
-// Note: apiKeys should only be used for util scripts or server/server connections
-const apiKey = fs.readFileSync('../apiKey.key', 'utf8')
-
-;(async () => {
-  // Create a based client
-  const client = based(basedConfig)
-
-  // Authenticate client with an apiKey
-  await client.auth(apiKey, { isApiKey: true })
-
-  // Add our user
-  const { id } = await client.set({
-    type: 'user',
-    name: 'Demo User',
-    email: 'demo@wawa.com',
-    password: 'superStrongPassword',
-  })
-  console.log('Added user ' + id)
-
-  process.exit()
-})()
-```
-
-And lets run it:
-```bash
-$ cd scripts
-$ npx ts-node scripts/createUser.ts
-Added user us1b3d5a36
-```
-
-## Adding login functionality to your app.
-
-To login a user from your app, you should create a login UI, and use the based client `.login()` method to validate your user and password.
-Example:
-
-```javascript
-import based from '@based/client'
-
-// ...
-
-
-  <button
-    onClick={async () => {
-      const { token, refreshToken } = await client.login({
-        email,
-        password,
-      })
-      setToken(token)
-      setRefreshToken(refreshToken)
-    }}
-  >
-    Login
-  </button>
-```
-
-The `.login()` method takes the email and password supplied by the user, passes it to the `login` data function, and returns the result. Usually, a token and refreshToken if it was successful.
-You should also store your token and refreshToken if you want the session to persist.
-
-## Authenticating the user with a persisted token
-
-If your user already logged in and you persisted the tokens, you can authenticate it with the still valid token instead of login in.
-Example:
-```javascript
-  // ...
-  if (token) {
-    await client.auth(token, { refreshToken })
-  }
-```
-
-The `refreshToken` is also stored by the based client so it can be requested by the based servers if the token is expired and it tries to renew the token automatically.
-
-## Login out user
-
-You should run the based client `.logout()` method to explicitly log out a user. This method will clear the tokens on the based client and run the `logout` data function meant to perform clean-up actions like invalidating the current refreshToken.
-
-Example:
-```javascript
-  // ...
-  <button
-    onClick={async () => {
-      await client.logout()
-      setToken(null)
-      setRefreshToken(null)
-    }}
-  >
-    Logout
-  </button>
-```
-
-You should also clean the stored token and refreshToken from the browser.
-
-## Handling automatic token renewal
-
-The default template already has in place JWT token renewal using a refreshToken. You should however store the new token locally when this happens.
-For this we have the `renewToken` based client event that we can listen.
-Example:
-
-```javascript
-  // ...
-  const renewHandler = ({ token: newToken }: { token: string }) => {
-    setToken(newToken)
-  }
-
-  client.on('renewToken', renewHandler)
-```

package/docs/auth.md

@@ -1,93 +0,0 @@
-# The Auth System
-
-The *Based Auth* system helps developers add a security layer to their data. It does not enforce any logic itself, instead relies on a set of user-configurable *data functions* that restrict data access and implement whatever security strategy the user needs. Be it a 3rd party implementation or its own.
-
-The central concept is that all messages through based go through a [`authorize`](https://github.com/atelier-saulx/based/blob/main/packages/client/docs/authorize.md) function that implements the security logic and decides if each specific call to data should continue or be blocked.
-Within the data request, a "token" is also sent. This token is passed along to the `authorize` function for context, and it is what identifies the user in most implementations.
-
-There are no assumptions about the "token" format. It is up to the user to choose what implementation it wants or needs. However, we provide templates for JSON Web Tokens (JWT) authorization and will soon offer session-based authentication templates. These templates provide minimal authorization strategy implementation and are meant to be tweaked and updated by the user.
-Along with the `authorize` function, these templates also implement more optional functions that make a login flow more straightforward and more semantic. `login`, `logout`, and `renewToken`. 
-
-The *Based* client also catches exceptions triggered by token expiration. When this happens, it tries to call a `renewToken` function sending it a renew payload that includes, for example, the "refreshToken" used for JWT authorization flow. If that's successful and it returns a new token, it will re-request the data with the new token for transparent renewal.
-
-## Auth data functions
-
-### `authorize`
-
-This data function runs every time the based client tries to call, get, modify or observe data.
-It approves or denies the request depending on its context. See [`authorize`](https://github.com/atelier-saulx/based/blob/main/packages/client/docs/authorize.md)
-Returns boolean value allowing or disallowing the connection.
-
-Example: see [here](https://github.com/atelier-saulx/based/blob/main/packages/templates/jwtAuth/functions/authorize/index.ts)
-
-### `login`
-
-Called then the client [login()]() method is called. It should authenticate the user and generate the tokens. Authentication flow is up to the user.
-For example, in a JWT flow, this function will validate the user in the data, sign a token and refreshToken returning them to the client.
-
-Example: see [here](https://github.com/atelier-saulx/based/blob/main/packages/templates/jwtAuth/functions/login/index.ts)
-
-### `logout`
-
-When your app logs out a user, it should call the `client.logout()` method. This method calls this data function if it exists. It is meant to have token invalidation and any cleanup that should happen when a user logs out.
-
-Example: see [here](https://github.com/atelier-saulx/based/blob/main/packages/templates/jwtAuth/functions/logout/index.ts)
-
-### `renewToken`
-
-For auth flows that rely on token renewal. This data function runs when a specific error is triggered in the `authorize` function.
-The result is returned to the client using the `renewToken` client event.
-
-Example: see [here](https://github.com/atelier-saulx/based/blob/main/packages/templates/jwtAuth/functions/renewToken/index.ts)
-
-## Based client methods
-
-### `client.auth()`
-
-Sets the token to be sent during client/server messages. The token will be passed to the `authorize` function and can be decoded from it with `based.token()`.
-
-#### Usage
-```javascript
-// Setting token
-await client.auth(token)
-
-// Setting token and refreshToken for JWT flow
-await client.auth(token, { 
-	renewOptions: { refreshToken }
-})
-```
-
-### `client.login()`
-
-This data function sends the email and password to the `login` data function for authentication.
-Returns tokens if successful. Also, it will automatically set the returned token on the current client connection.
-
-#### Usage
-```javascript
-const tokens = await client.login({email, password}) 
-```
-
-### `client.logout()`
-
-Clears the tokens stored by the client and calls the `logout` data function if it exists.
-
-#### Usage
-```javascript
-await client.logout() 
-```
-
-### `client.on('renewToken', fn)`
-
-This event is called when the renewToken data function is run. It is used to handle and persist the newly generated tokens.
-
-#### Usage
-```javascript
-	client.on('renewToken', (renewTokenResult) => {})
-```
-
-
-## How to use
-
-Check the guides bellow for examples of how the use:
-- [React](https://github.com/atelier-saulx/based/blob/main/packages/client/docs/auth-howto.md)
-- [React with based/ui library](https://github.com/atelier-saulx/based/blob/main/packages/client/docs/auth-based-ui-howto.md)

package/docs/authorize.md

@@ -1,56 +0,0 @@
-# `Authorize` data function
-
-The authorize data function is a special function that serves as an authorization gatekeeper for the based queries and calls to data functions. It is run every time one is requested and blocks or allows access to the data.
-It works and has the same signature as normal data functions and should return a Promise with `true` or `false` boolean. 
-You can have your access logic here. For example, checking if the user is authenticated or if it matches whatever criteria you need for your application.
-
-example:
-```javascript
-export default async ({ based, user, payload, name, type, callstack}) => {
-	// ...
-	return true // or false
-}
-```
-
-### Exposed parameters
-
-| Parameter   | Description                                                                                                                                                                    |
-|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `based`     | Based client                                                                                                                                                                   |
-| `user`      | User object. Exposes token information about the user                                                                                                                          |
-| `payload`   | The query requested or the payload sent to the function                                                                                                                        |
-| `name`      | Name of the function. Empty in case of a query                                                                                                                                 |
-| `type`      | Type of call. `function` or `query` usually                                                                                                                                    |
-| `callstack` | Array with the names of the data function call stack. If one function calls another, the first function name will show in the callstack of the second function and so on. |
-
-
-## `user.token()`
-
-The `user` parameter exposes functionality to identify the user. If a user is authenticated, the based client will send an authorization token in the message. You can validate the token and decode it using the `user.token()`
-Will return `undefined` in case of an invalid token.
-
-Example:
-```javascript
-export default async ({ based, user, payload, name, type, callstack}) => {
-	// Leve this for now. Identifies a user as an UI user.
-	if (user.isBased) return true
-	
-	const token = user.token('publicKeySecret')
-	if (token.id) {
-		return true
-	}
-
-	return false
-}
-```
-
-## How to setup?
-The `authorize` function can be created directly on the Functions section of the Based UI or deployed using the CLI with the [`based deploy`](https://github.com/atelier-saulx/based/blob/main/packages/cli/README.md#deploy) command.
-It should be set as a non-observable function with the following config:
-
-```json
-{
-  "name": "authorize",
-  "observable": false
-}
-```