rxdb-server 15.4.3

package/dist/types/plugins/replication-server/index.d.ts

@@ -0,0 +1,21 @@
+import { RxCollection, ReplicationPullOptions, ReplicationPushOptions, RxStorageDefaultCheckpoint, ById } from 'rxdb/plugins/core';
+import { RxReplicationState } from 'rxdb/plugins/replication';
+import { Subject } from 'rxjs';
+import { ServerSyncOptions } from './types.ts';
+export * from './types.ts';
+export declare class RxServerReplicationState<RxDocType> extends RxReplicationState<RxDocType, RxStorageDefaultCheckpoint> {
+    readonly replicationIdentifier: string;
+    readonly collection: RxCollection<RxDocType>;
+    readonly pull?: ReplicationPullOptions<RxDocType, RxStorageDefaultCheckpoint> | undefined;
+    readonly push?: ReplicationPushOptions<RxDocType> | undefined;
+    readonly live: boolean;
+    retryTime: number;
+    autoStart: boolean;
+    headers: ById<string>;
+    readonly outdatedClient$: Subject<void>;
+    readonly unauthorized$: Subject<void>;
+    readonly forbidden$: Subject<void>;
+    constructor(replicationIdentifier: string, collection: RxCollection<RxDocType>, pull?: ReplicationPullOptions<RxDocType, RxStorageDefaultCheckpoint> | undefined, push?: ReplicationPushOptions<RxDocType> | undefined, live?: boolean, retryTime?: number, autoStart?: boolean, headers?: ById<string>);
+    setHeaders(headers: ById<string>): void;
+}
+export declare function replicateServer<RxDocType>(options: ServerSyncOptions<RxDocType>): RxServerReplicationState<RxDocType>;

package/dist/types/plugins/replication-server/types.d.ts

@@ -0,0 +1,17 @@
+import type { ReplicationOptions, ReplicationPullOptions, ReplicationPushOptions, RxStorageDefaultCheckpoint } from 'rxdb/plugins/core';
+export type ServerSyncPullOptions<RxDocType> = Omit<ReplicationPullOptions<RxDocType, RxStorageDefaultCheckpoint>, 'handler' | 'stream$'> & {};
+export type ServerSyncPushOptions<RxDocType> = Omit<ReplicationPushOptions<RxDocType>, 'handler'> & {};
+export type ServerSyncOptions<RxDocType> = Omit<ReplicationOptions<RxDocType, any>, 'pull' | 'push'> & {
+    url: string;
+    headers?: {
+        [k: string]: string;
+    };
+    pull?: ServerSyncPullOptions<RxDocType>;
+    push?: ServerSyncPushOptions<RxDocType>;
+    /**
+     * If the EventSource API is not available
+     * on the runtime, pass an own implementation here.
+     * Mostly used with the "eventsource" npm package on Node.js.
+     */
+    eventSource?: typeof EventSource | any;
+};

package/dist/types/plugins/server/endpoint-replication.d.ts

@@ -0,0 +1,20 @@
+import { RxCollection, RxReplicationHandler, StringKeys } from 'rxdb/plugins/core';
+import type { RxServer } from './rx-server.ts';
+import type { RxServerChangeValidator, RxServerEndpoint, RxServerQueryModifier } from './types.ts';
+export type RxReplicationEndpointMessageType = {
+    id: string;
+    method: StringKeys<RxReplicationHandler<any, any>> | 'auth';
+    params: any[];
+};
+export declare class RxServerReplicationEndpoint<AuthType, RxDocType> implements RxServerEndpoint<AuthType, RxDocType> {
+    readonly server: RxServer<AuthType>;
+    readonly name: string;
+    readonly collection: RxCollection<RxDocType>;
+    readonly serverOnlyFields: string[];
+    readonly cors?: string | undefined;
+    readonly type = "replication";
+    readonly urlPath: string;
+    readonly changeValidator: RxServerChangeValidator<AuthType, RxDocType>;
+    readonly queryModifier: RxServerQueryModifier<AuthType, RxDocType>;
+    constructor(server: RxServer<AuthType>, name: string, collection: RxCollection<RxDocType>, queryModifier: RxServerQueryModifier<AuthType, RxDocType>, changeValidator: RxServerChangeValidator<AuthType, RxDocType>, serverOnlyFields: string[], cors?: string | undefined);
+}

package/dist/types/plugins/server/endpoint-rest.d.ts

@@ -0,0 +1,16 @@
+import { RxCollection } from 'rxdb/plugins/core';
+import type { RxServer } from './rx-server.ts';
+import type { RxServerChangeValidator, RxServerEndpoint, RxServerQueryModifier } from './types.ts';
+export declare const REST_PATHS: readonly ["query", "query/observe", "get", "set", "delete"];
+export declare class RxServerRestEndpoint<AuthType, RxDocType> implements RxServerEndpoint<AuthType, RxDocType> {
+    readonly server: RxServer<AuthType>;
+    readonly name: string;
+    readonly collection: RxCollection<RxDocType>;
+    readonly serverOnlyFields: string[];
+    readonly cors?: string | undefined;
+    readonly type = "rest";
+    readonly urlPath: string;
+    readonly changeValidator: RxServerChangeValidator<AuthType, RxDocType>;
+    readonly queryModifier: RxServerQueryModifier<AuthType, RxDocType>;
+    constructor(server: RxServer<AuthType>, name: string, collection: RxCollection<RxDocType>, queryModifier: RxServerQueryModifier<AuthType, RxDocType>, changeValidator: RxServerChangeValidator<AuthType, RxDocType>, serverOnlyFields: string[], cors?: string | undefined);
+}

package/dist/types/plugins/server/helper.d.ts

@@ -0,0 +1,23 @@
+import { RxServer } from './rx-server';
+import type { Request, Response } from 'express';
+import { RxServerAuthData, RxServerEndpoint } from './types';
+import { MangoQuerySelector, RxDocumentData } from 'rxdb/plugins/core';
+export declare function setCors(server: RxServer<any>, path: string, cors?: string): void;
+/**
+ * "block" the previous version urls and send a 426 on them so that
+ * the clients know they must update.
+ */
+export declare function blockPreviousVersionPaths(server: RxServer<any>, path: string, currentVersion: number): void;
+export declare function closeConnection(response: Response, code: number, message: string): Promise<void>;
+export declare function addAuthMiddleware<AuthType>(server: RxServer<AuthType>, path: string): WeakMap<Request, RxServerAuthData<AuthType>>;
+export declare function getDocAllowedMatcher<RxDocType, AuthType>(endpoint: RxServerEndpoint<AuthType, RxDocType>, authData: RxServerAuthData<AuthType>): import("rxdb/plugins/core").QueryMatcher<RxDocumentData<RxDocType>>;
+export declare function writeSSEHeaders(res: Response): void;
+export declare function docContainsServerOnlyFields(serverOnlyFields: string[], doc: any): string | undefined;
+export declare function removeServerOnlyFieldsMonad<RxDocType>(serverOnlyFields: string[]): (docData?: RxDocType | RxDocumentData<RxDocType>) => any;
+export declare function mergeServerDocumentFieldsMonad<RxDocType>(serverOnlyFields: string[]): (clientDoc: RxDocType | RxDocumentData<RxDocType>, serverDoc?: RxDocType | RxDocumentData<RxDocType>) => RxDocType | RxDocumentData<RxDocType>;
+/**
+ * $regex queries are dangerous because they can dos-attach the
+ *
+ * @param selector
+ */
+export declare function doesContainRegexQuerySelector(selector: MangoQuerySelector<any> | any): boolean;

package/dist/types/plugins/server/index.d.ts

@@ -0,0 +1,7 @@
+import { RxServer } from './rx-server.ts';
+import { RxServerOptions } from './types.ts';
+export * from './types.ts';
+export * from './endpoint-replication.ts';
+export * from './endpoint-rest.ts';
+export * from './helper.ts';
+export declare function startRxServer<AuthType>(options: RxServerOptions<AuthType>): Promise<RxServer<AuthType>>;

package/dist/types/plugins/server/rx-server.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import type { RxCollection, RxDatabase } from 'rxdb/plugins/core';
+import { RxServerReplicationEndpoint } from './endpoint-replication.ts';
+import type { RxServerAuthHandler, RxServerChangeValidator, RxServerEndpoint, RxServerQueryModifier } from './types.ts';
+import { Server as HttpServer } from 'http';
+import { Express } from 'express';
+import { RxServerRestEndpoint } from './endpoint-rest.ts';
+export declare class RxServer<AuthType> {
+    readonly database: RxDatabase;
+    readonly authHandler: RxServerAuthHandler<AuthType>;
+    readonly httpServer: HttpServer;
+    readonly expressApp: Express;
+    readonly cors: string;
+    readonly endpoints: RxServerEndpoint<AuthType, any>[];
+    private closeFn;
+    constructor(database: RxDatabase, authHandler: RxServerAuthHandler<AuthType>, httpServer: HttpServer, expressApp: Express, cors?: string);
+    addReplicationEndpoint<RxDocType>(opts: {
+        name: string;
+        collection: RxCollection<RxDocType>;
+        queryModifier?: RxServerQueryModifier<AuthType, RxDocType>;
+        changeValidator?: RxServerChangeValidator<AuthType, RxDocType>;
+        /**
+         * Set a origin for allowed CORS requests.
+         * Overwrites the cors option of the server.
+         * [default='*']
+         */
+        cors?: '*' | string;
+        serverOnlyFields?: string[];
+    }): Promise<RxServerReplicationEndpoint<AuthType, RxDocType>>;
+    addRestEndpoint<RxDocType>(opts: {
+        name: string;
+        collection: RxCollection<RxDocType>;
+        queryModifier?: RxServerQueryModifier<AuthType, RxDocType>;
+        changeValidator?: RxServerChangeValidator<AuthType, RxDocType>;
+        /**
+         * Set a origin for allowed CORS requests.
+         * Overwrites the cors option of the server.
+         * [default='*']
+         */
+        cors?: '*' | string;
+        serverOnlyFields?: string[];
+    }): Promise<RxServerRestEndpoint<AuthType, RxDocType>>;
+    close(): Promise<void>;
+}

package/dist/types/plugins/server/types.d.ts

@@ -0,0 +1,66 @@
+/// <reference types="node" />
+import type { FilledMangoQuery, RxDatabase, RxReplicationWriteToMasterRow, MaybePromise, RxCollection } from 'rxdb/plugins/core';
+import { IncomingHttpHeaders } from 'http';
+import { Express } from 'express';
+export type RxServerOptions<AuthType> = {
+    database: RxDatabase;
+    authHandler?: RxServerAuthHandler<AuthType>;
+    serverApp?: Express;
+    appOptions?: any;
+    /**
+     * [default=localhost]
+     */
+    hostname?: 'localhost' | '0.0.0.0' | string;
+    port: number;
+    /**
+     * Set a origin for allowed CORS requests.
+     * Can be overwritten by the cors option of the endpoints.
+     * [default='*']
+     */
+    cors?: '*' | string;
+};
+export type RxServerAuthData<AuthType> = {
+    data: AuthType;
+    validUntil: number;
+};
+/**
+ * Returns the auth state by the given request headers.
+ * Throws if auth not valid.
+ */
+export type RxServerAuthHandler<AuthType> = (headers: IncomingHttpHeaders) => MaybePromise<RxServerAuthData<AuthType>>;
+/**
+ * Modifies a given query in a way to limit the results
+ * to what the authenticated user is allowed to see.
+ * For example the query selector
+ * input: {
+ *   selector: {
+ *     myField: { $gt: 100 }
+ *   }
+ * }
+ * could be modified to restrict the results to only return
+ * documents that are "owned" by the user
+ * return: {
+ *   selector: {
+ *     myField: { $gt: 100 },
+ *     userId: { $eq: authData.userId }
+ *   }
+ * }
+ *
+ *
+ */
+export type RxServerQueryModifier<AuthType, RxDocType> = (authData: RxServerAuthData<AuthType>, query: FilledMangoQuery<RxDocType>) => FilledMangoQuery<RxDocType>;
+/**
+ * Validates if a given change is allowed to be performed on the server.
+ * Returns true if allowed, false if not.
+ * If a client tries to make a non-allowed change,
+ * the client will be disconnected.
+ */
+export type RxServerChangeValidator<AuthType, RxDocType> = (authData: RxServerAuthData<AuthType>, change: RxReplicationWriteToMasterRow<RxDocType>) => boolean;
+export interface RxServerEndpoint<AuthType, RxDocType> {
+    collection: RxCollection<RxDocType>;
+    name: string;
+    type: 'replication' | 'rest' | string;
+    urlPath: string;
+    queryModifier?: RxServerQueryModifier<AuthType, RxDocType>;
+    changeValidator?: RxServerChangeValidator<AuthType, RxDocType>;
+}

package/package.json

@@ -0,0 +1,139 @@
+{
+  "name": "rxdb-server",
+  "version": "15.4.3",
+  "description": "RxDB Server Plugin",
+  "license": "SSPL",
+  "author": "pubkey",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pubkey/rxdb"
+  },
+  "homepage": "https://rxdb.info/rx-server.html",
+  "keywords": [
+    "rxdb",
+    "server"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "types": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./plugins/server": {
+      "types": "./dist/types/plugins/server/index.d.ts",
+      "require": "./dist/cjs/plugins/server/index.js",
+      "import": "./dist/esm/plugins/server/index.js",
+      "default": "./dist/esm/plugins/server/index.js"
+    },
+    "./plugins/replication-server": {
+      "types": "./dist/types/plugins/replication-server/index.d.ts",
+      "require": "./dist/cjs/plugins/replication-server/index.js",
+      "import": "./dist/esm/plugins/replication-server/index.js",
+      "default": "./dist/esm/plugins/replication-server/index.js"
+    },
+    "./plugins/client-rest": {
+      "types": "./dist/types/plugins/client-rest/index.d.ts",
+      "require": "./dist/cjs/plugins/client-rest/index.js",
+      "import": "./dist/esm/plugins/client-rest/index.js",
+      "default": "./dist/esm/plugins/client-rest/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "prebuild:scripts": "rimraf -rf scripts/generate-plugins-package-json.mjs && cp node_modules/rxdb/scripts/generate-plugins-package-json.mjs scripts/generate-plugins-package-json.mjs",
+    "prebuild:babel": "rimraf -rf babel.config.js && cp node_modules/rxdb/babel.config.js babel.config.js",
+    "prebuild": "npm run prebuild:babel && npm run prebuild:scripts",
+    "build:cjs": "rimraf -rf dist/cjs && cross-env NODE_ENV=es5 babel src --out-dir dist/cjs --source-maps --extensions \".ts,.js\"",
+    "build:es": "rimraf -rf dist/esm && cross-env NODE_ENV=es6 babel src --out-dir dist/esm --source-maps --extensions \".ts,.js\" && echo '{ \"type\": \"module\", \"sideEffects\": false }' > dist/esm/package.json",
+    "build:types": "rimraf -rf ./dist/types && tsc --project ./config/tsconfig.types.json",
+    "build": "npm run prebuild && rimraf -rf ./dist && npm run build:plugins && concurrently \"npm run build:cjs\" \"npm run build:es\" \"npm run build:types\" --success all",
+    "build:plugins": "node ./scripts/generate-plugins-package-json.mjs",
+    "// build:bundle": "bundles the npm module so it can be installed into other folder to run tests",
+    "build:bundle": "rimraf -rf rxdb-server.tgz && npx yarn@1.22.10 pack ./ --filename ./rxdb-server.tgz",
+    "version": "node ./scripts/version.js",
+    "check-types": "npm run build && tsc",
+    "test:unit": "npm run build && ts-mocha ./test/unit.test.ts --bail --exit",
+    "test:integration:init": "(cd ./scripts && bash test-integration-init.sh)",
+    "test:integration:memory": "(cd test-integration && npm run transpile && npm run test:node:memory)",
+    "test:integration:foundationdb": "(cd test-integration && npm run transpile && npm run test:node:foundationdb)",
+    "test:integration:mongodb": "(cd test-integration && npm run transpile && npm run test:node:mongodb)"
+  },
+  "peerDependencies": {
+    "rxdb": "*",
+    "rxjs": "*"
+  },
+  "dependencies": {
+    "@types/eventsource": "1.1.15",
+    "@types/express": "4.17.21",
+    "array-push-at-sort-position": "4.0.1",
+    "async-test-util": "2.2.1",
+    "eth-crypto": "2.6.0",
+    "eventsource": "2.0.2",
+    "percom": "1.1.3",
+    "web-locks": "0.0.8",
+    "web-worker": "1.2.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.23.4",
+    "@babel/core": "7.23.6",
+    "@babel/plugin-external-helpers": "7.23.3",
+    "@babel/plugin-proposal-class-properties": "7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "7.20.7",
+    "@babel/plugin-transform-literals": "7.23.3",
+    "@babel/plugin-transform-member-expression-literals": "7.23.3",
+    "@babel/plugin-transform-modules-commonjs": "7.23.3",
+    "@babel/plugin-transform-property-literals": "7.23.3",
+    "@babel/plugin-transform-runtime": "7.23.6",
+    "@babel/plugin-transform-spread": "7.23.3",
+    "@babel/plugin-transform-template-literals": "7.23.3",
+    "@babel/plugin-transform-typescript": "7.23.3",
+    "@babel/polyfill": "7.12.1",
+    "@babel/preset-env": "7.23.3",
+    "@babel/preset-typescript": "7.23.3",
+    "@babel/types": "7.23.5",
+    "@faker-js/faker": "8.3.1",
+    "@types/mocha": "10.0.6",
+    "@types/node": "20.10.5",
+    "@types/sqlite3": "3.1.11",
+    "@types/websql": "0.0.30",
+    "babel-loader": "9.1.3",
+    "babel-plugin-transform-class-properties": "6.24.1",
+    "concurrently": "8.2.2",
+    "cross-env": "7.0.3",
+    "detect-browser": "5.3.0",
+    "express": "4.18.2",
+    "get-port": "5.1.1",
+    "http-server": "14.1.1",
+    "karma": "6.4.2",
+    "karma-chrome-launcher": "3.2.0",
+    "karma-detect-browsers": "2.3.3",
+    "karma-firefox-launcher": "2.1.2",
+    "karma-mocha": "2.0.1",
+    "karma-sourcemap-loader": "0.4.0",
+    "karma-spec-reporter": "0.0.36",
+    "karma-typescript": "5.5.4",
+    "karma-webpack": "5.0.0",
+    "mini-css-extract-plugin": "2.7.6",
+    "minify-all-js": "0.1.9",
+    "mocha": "10.2.0",
+    "rimraf": "5.0.5",
+    "rxdb": "15.4.3",
+    "rxjs": "7.8.1",
+    "ts-loader": "9.5.1",
+    "ts-mocha": "10.0.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.3.3",
+    "webpack": "5.89.0",
+    "webpack-bundle-analyzer": "4.10.1",
+    "webpack-cli": "5.1.4",
+    "webpack-dev-server": "4.15.1"
+  }
+}

package/plugins/client-rest/index.cjs

@@ -0,0 +1,2 @@
+const pkg = require('../../dist/cjs/plugins/client-rest/index.js');
+module.exports = pkg;

package/plugins/client-rest/index.d.cts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/client-rest/index';

package/plugins/client-rest/index.d.mts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/client-rest/index';

package/plugins/client-rest/index.mjs

@@ -0,0 +1 @@
+export * from '../../dist/esm/plugins/client-rest/index.js';

package/plugins/client-rest/index.ts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/client-rest/index';

package/plugins/client-rest/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "rxdb-plugins-client-rest",
+    "description": "This package.json file is generated by the \"npm run build:plugins\" script, do not edit it manually!",
+    "sideEffects": false,
+    "types": "../../dist/types/plugins/client-rest/index.d.ts",
+    "exports": {
+        ".": {
+            "default": {
+                "types": "./index.d.ts",
+                "import": "./index.mjs",
+                "default": "./index.cjs"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "./index.cjs",
+    "module": "./index.mjs"
+}

package/plugins/replication-server/index.cjs

@@ -0,0 +1,2 @@
+const pkg = require('../../dist/cjs/plugins/replication-server/index.js');
+module.exports = pkg;

package/plugins/replication-server/index.d.cts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/replication-server/index';

package/plugins/replication-server/index.d.mts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/replication-server/index';

package/plugins/replication-server/index.mjs

@@ -0,0 +1 @@
+export * from '../../dist/esm/plugins/replication-server/index.js';

package/plugins/replication-server/index.ts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/replication-server/index';

package/plugins/replication-server/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "rxdb-plugins-replication-server",
+    "description": "This package.json file is generated by the \"npm run build:plugins\" script, do not edit it manually!",
+    "sideEffects": false,
+    "types": "../../dist/types/plugins/replication-server/index.d.ts",
+    "exports": {
+        ".": {
+            "default": {
+                "types": "./index.d.ts",
+                "import": "./index.mjs",
+                "default": "./index.cjs"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "./index.cjs",
+    "module": "./index.mjs"
+}

package/plugins/server/index.cjs

@@ -0,0 +1,2 @@
+const pkg = require('../../dist/cjs/plugins/server/index.js');
+module.exports = pkg;

package/plugins/server/index.d.cts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/server/index';

package/plugins/server/index.d.mts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/server/index';

package/plugins/server/index.mjs

@@ -0,0 +1 @@
+export * from '../../dist/esm/plugins/server/index.js';

package/plugins/server/index.ts

@@ -0,0 +1 @@
+export * from '../../dist/types/plugins/server/index';

package/plugins/server/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "rxdb-plugins-server",
+    "description": "This package.json file is generated by the \"npm run build:plugins\" script, do not edit it manually!",
+    "sideEffects": false,
+    "types": "../../dist/types/plugins/server/index.d.ts",
+    "exports": {
+        ".": {
+            "default": {
+                "types": "./index.d.ts",
+                "import": "./index.mjs",
+                "default": "./index.cjs"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "./index.cjs",
+    "module": "./index.mjs"
+}