@based/server 6.2.6 → 6.3.0

package/dist/types.d.ts

@@ -0,0 +1,129 @@
+/// <reference types="node" />
+import Client from './Client';
+import uws from '@based/uws';
+import { ConnectOptions } from '@saulx/selva';
+import Based from './BasedServerClient';
+import { Params } from './Params';
+import { BasedServer } from '.';
+import { ErrorObject, GenericObject, Based as BasedAdminClient } from '@based/client';
+import { Readable } from 'stream';
+export { Client };
+export declare type CallParams = Omit<Params, 'update'>;
+export declare type ObservableParams = Omit<Params, 'user'>;
+export declare type DataListener = (data: GenericObject, checksum: number, error?: ErrorObject) => void;
+export declare type ObservableFunction = {
+    function: (params: ObservableParams) => Promise<() => void>;
+    authorize?: (params: CallParams) => Promise<boolean>;
+    observable: true;
+    shared: boolean;
+    cnt?: number;
+    worker?: boolean;
+};
+export declare type CallFunction = {
+    observable: false;
+    authorize?: (params: CallParams) => Promise<boolean>;
+    function: (params: CallParams) => Promise<any>;
+    cnt?: number;
+    worker?: boolean;
+    headers?: (params: CallParams, result: any) => Promise<{
+        [key: string]: string;
+    }>;
+};
+export declare const isCallFunction: (fn: CallFunction | ObservableFunction) => fn is CallFunction;
+export declare const isObservableFunction: (fn: CallFunction | ObservableFunction) => fn is ObservableFunction;
+export declare type AuthorizeFn = (params: Params) => Promise<boolean>;
+export declare type LoginFn = (params: Params) => Promise<GenericObject>;
+export declare type LogoutFn = (params: Params) => Promise<GenericObject>;
+export declare type RenewTokenFn = (params: Params) => Promise<GenericObject>;
+export declare type FileOpts = {
+    based: Based;
+    stream: Readable;
+    mimeType: string;
+    id: string;
+    extension: string;
+    size: number;
+    user?: Client;
+};
+export declare type GetInitial = (server: BasedServer, name: string) => Promise<ObservableFunction | CallFunction | null>;
+export declare type Geo = {
+    iso: string;
+    long: number;
+    lat: number;
+    regions: string[];
+};
+export declare type Config = {
+    noAuth?: boolean;
+    getBasedKey?: () => Promise<string>;
+    getApiKeysPublicKey?: () => Promise<string>;
+    getGeo?: (ip: string) => Geo;
+    sendEmail?: (payload: {
+        to: string;
+        subject: string;
+        body: string;
+        from?: string;
+    }) => Promise<{
+        status: 'ok';
+        message?: string;
+    } | {
+        status: 'error';
+        message: string;
+    }>;
+    storeFile?: (opts: FileOpts) => Promise<{
+        src: string;
+        origin: string;
+        status: number;
+        statusText?: string;
+        thumb?: string;
+        version?: string;
+        mimeType?: string;
+    }>;
+    deleteFile?: (opts: {
+        based: Based;
+        id: string;
+        db?: string;
+    }) => Promise<boolean>;
+    getAdmin?: (key: string) => Promise<BasedAdminClient>;
+    functionConfig?: {
+        idleTimeout: number;
+        getInitial: GetInitial;
+        subscribeFunctions: (cb: (err: Error, d?: any) => void) => Promise<() => void>;
+        clear: (server: BasedServer, name: string) => Promise<void>;
+    };
+    secretsConfig?: {
+        secretTimeouts?: {
+            [name: string]: number;
+        };
+        idleTimeout: number;
+        getInitial: (server: BasedServer, name: string) => Promise<string | null>;
+        clear: (server: BasedServer, name: string) => Promise<void>;
+    };
+    secrets?: {
+        [key: string]: any;
+    };
+    authorizeConnection?: Authorize;
+    authorize?: AuthorizeFn;
+    defaultAuthorize?: AuthorizeFn;
+    login?: LoginFn;
+    logout?: LogoutFn;
+    renewToken?: RenewTokenFn;
+    functions?: {
+        [key: string]: ObservableFunction | CallFunction;
+    };
+    onOpen?: (...args: any[]) => void;
+    onClose?: (...args: any[]) => void;
+};
+export declare type Authorize = (req: uws.HttpRequest, ctx: uws.us_socket_context_t) => Promise<boolean>;
+export declare type ServerOptions = {
+    port?: number;
+    useLessMemory?: boolean;
+    key?: string;
+    cert?: string;
+    debug?: boolean;
+    db: ConnectOptions;
+    config?: Config;
+    state?: GenericObject;
+};
+export declare type SendTokenOptions = {
+    isBasedUser?: boolean;
+    isApiKey?: boolean;
+};

package/dist/types.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObservableFunction = exports.isCallFunction = exports.Client = void 0;
+const Client_1 = __importDefault(require("./Client"));
+exports.Client = Client_1.default;
+const isCallFunction = (fn) => {
+    return fn.observable === false;
+};
+exports.isCallFunction = isCallFunction;
+const isObservableFunction = (fn) => {
+    return fn.observable === true;
+};
+exports.isObservableFunction = isObservableFunction;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAapB,iBAbF,gBAAM,CAaE;AAmCR,MAAM,cAAc,GAAG,CAC5B,EAAqC,EACjB,EAAE;IACtB,OAAO,EAAE,CAAC,UAAU,KAAK,KAAK,CAAA;AAChC,CAAC,CAAA;AAJY,QAAA,cAAc,kBAI1B;AAEM,MAAM,oBAAoB,GAAG,CAClC,EAAqC,EACX,EAAE;IAC5B,OAAO,EAAE,CAAC,UAAU,KAAK,IAAI,CAAA;AAC/B,CAAC,CAAA;AAJY,QAAA,oBAAoB,wBAIhC"}

package/dist/upgradeListener.d.ts

@@ -0,0 +1,4 @@
+import uws from '@based/uws';
+import { BasedServer } from '.';
+declare const _default: (server: BasedServer, res: uws.HttpResponse, req: uws.HttpRequest, ctx: uws.us_socket_context_t) => void;
+export default _default;

package/dist/upgradeListener.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (server, res, req, 
+// eslint-disable-next-line
+ctx) => {
+    let aborted;
+    const onAborted = () => {
+        aborted = true;
+    };
+    // res.writeStatus('101 Switching Protocols')
+    const onAuth = (authorized) => {
+        if (aborted) {
+            return;
+        }
+        if (authorized) {
+            const query = req.getQuery();
+            const url = req.getUrl();
+            const ua = req.getHeader('user-agent');
+            const ip = req.getHeader('x-forwarded-for') ||
+                Buffer.from(res.getRemoteAddressAsText()).toString();
+            const origin = req.getHeader('origin');
+            const secWebSocketKey = req.getHeader('sec-websocket-key');
+            const secWebSocketProtocol = req.getHeader('sec-websocket-protocol');
+            const secWebSocketExtensions = req.getHeader('sec-websocket-extensions');
+            res.writeStatus('101 Switching Protocols');
+            res.upgrade({
+                query,
+                origin,
+                url,
+                ua,
+                ip,
+            }, secWebSocketKey, secWebSocketProtocol, secWebSocketExtensions, ctx);
+        }
+        else {
+            res.writeStatus('401 Unauthorized');
+            res.end();
+        }
+    };
+    res.onAborted(onAborted);
+    if (server.config && server.config.authorizeConnection) {
+        server.config.authorizeConnection(req, ctx).then(onAuth);
+    }
+    else {
+        onAuth(true);
+    }
+};
+//# sourceMappingURL=upgradeListener.js.map

package/dist/upgradeListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgradeListener.js","sourceRoot":"","sources":["../src/upgradeListener.ts"],"names":[],"mappings":";;AAGA,kBAAe,CACb,MAAmB,EACnB,GAAqB,EACrB,GAAoB;AACpB,2BAA2B;AAC3B,GAA4B,EAC5B,EAAE;IACF,IAAI,OAAO,CAAA;IACX,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,OAAO,GAAG,IAAI,CAAA;IAChB,CAAC,CAAA;IACD,6CAA6C;IAE7C,MAAM,MAAM,GAAG,CAAC,UAAU,EAAE,EAAE;QAC5B,IAAI,OAAO,EAAE;YACX,OAAM;SACP;QACD,IAAI,UAAU,EAAE;YACd,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;YAC5B,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAA;YACxB,MAAM,EAAE,GAAG,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;YACtC,MAAM,EAAE,GACN,GAAG,CAAC,SAAS,CAAC,iBAAiB,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAA;YACtD,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;YACtC,MAAM,eAAe,GAAG,GAAG,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAA;YAC1D,MAAM,oBAAoB,GAAG,GAAG,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAA;YACpE,MAAM,sBAAsB,GAAG,GAAG,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAA;YAExE,GAAG,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAA;YAE1C,GAAG,CAAC,OAAO,CACT;gBACE,KAAK;gBACL,MAAM;gBACN,GAAG;gBACH,EAAE;gBACF,EAAE;aACH,EACD,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACtB,GAAG,CACJ,CAAA;SACF;aAAM;YACL,GAAG,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAA;YACnC,GAAG,CAAC,GAAG,EAAE,CAAA;SACV;IACH,CAAC,CAAA;IAED,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IAExB,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAE;QACtD,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KACzD;SAAM;QACL,MAAM,CAAC,IAAI,CAAC,CAAA;KACb;AACH,CAAC,CAAA"}

package/dist/workers/index.js

@@ -0,0 +1,20 @@
+// make a based server thing useFunctionWorker
+// workerConfig = {
+//  concurrency: 5
+//  maxCrashRate: [5, 1000] // 20 per second
+// logs in a special way
+// }
+// import workerify from './workerify'
+/*
+import { CallFunction, ObservableFunction } from '@based/server/src/types'
+
+export default (
+  fn: ObservableFunction | CallFunction
+): ObservableFunction | CallFunction => {
+  console.info('GO GO GO', fn)
+
+  return fn
+}
+
+*/
+//# sourceMappingURL=index.js.map

package/dist/workers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/workers/index.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,mBAAmB;AACnB,kBAAkB;AAClB,4CAA4C;AAC5C,wBAAwB;AACxB,IAAI;AACJ,sCAAsC;AAEtC;;;;;;;;;;;EAWE"}

package/dist/workers/workerCode.d.ts

@@ -0,0 +1,12 @@
+declare class WorkerClient {
+    constructor(id: number);
+}
+declare class WorkerBasedClient {
+}
+declare class WorkerParams {
+    private _clientId;
+    payload: any;
+    callStack: any[];
+    get user(): WorkerClient;
+    get based(): WorkerBasedClient;
+}

package/dist/workers/workerCode.js

@@ -0,0 +1,46 @@
+// import { Client } from '@based/server/src/types'
+// import { BasedServerClient } from '@based/server'
+// export type CallParams = {
+//   payload: any
+//   based: BasedServerClient
+//   user: Client
+//   callStack: string[]
+// }
+// export type ObservableParams = {
+//   payload: any
+//   based: BasedServerClient
+//   user?: Client
+//   callStack: string[]
+//   // error later...
+//   update: (value: any, checksum?: number) => void
+// }
+// workers
+// in the worker we are going to run the code with getters
+// e.g.
+// fn({ user, payload, update, based }) // we add error later
+// fn({ user, payload, based })
+// WorkerParams object - mimic normal params object
+// this all has to be part of based server
+// mimic normal client
+class WorkerClient {
+    constructor(id) {
+        // yes number
+        console.info(id);
+    }
+}
+// has to wrap every method
+class WorkerBasedClient {
+}
+class WorkerParams {
+    constructor() {
+        this.callStack = [];
+    }
+    get user() {
+        // also pair it with other functions potentialy
+        return new WorkerClient(this._clientId);
+    }
+    get based() {
+        return new WorkerBasedClient();
+    }
+}
+//# sourceMappingURL=workerCode.js.map

package/dist/workers/workerCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workerCode.js","sourceRoot":"","sources":["../../src/workers/workerCode.ts"],"names":[],"mappings":"AAAA,mDAAmD;AACnD,oDAAoD;AAEpD,6BAA6B;AAC7B,iBAAiB;AACjB,6BAA6B;AAC7B,iBAAiB;AACjB,wBAAwB;AACxB,IAAI;AAEJ,mCAAmC;AACnC,iBAAiB;AACjB,6BAA6B;AAC7B,kBAAkB;AAClB,wBAAwB;AACxB,sBAAsB;AACtB,oDAAoD;AACpD,IAAI;AAEJ,UAAU;AAEV,0DAA0D;AAE1D,OAAO;AAEP,6DAA6D;AAE7D,+BAA+B;AAE/B,mDAAmD;AAEnD,0CAA0C;AAE1C,sBAAsB;AACtB,MAAM,YAAY;IAChB,YAAY,EAAU;QACpB,aAAa;QACb,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAClB,CAAC;CAEF;AAED,2BAA2B;AAC3B,MAAM,iBAAiB;CAEtB;AAED,MAAM,YAAY;IAAlB;QAKS,cAAS,GAAG,EAAE,CAAA;IAUvB,CAAC;IARC,IAAI,IAAI;QACN,+CAA+C;QAC/C,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACzC,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,iBAAiB,EAAE,CAAA;IAChC,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@based/server",
-  "version": "6.2.6",
+  "version": "6.3.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "files": [