@wix/realtime 0.1.0

package/build/index.d.ts

@@ -0,0 +1 @@
+export * as site from './site/index.js';

package/build/index.js

@@ -0,0 +1 @@
+export * as site from './site/index.js';

package/build/site/index.d.ts

@@ -0,0 +1,5 @@
+import { PermissionsRouter } from './permissions-router.js';
+import type { Publisher } from './types.js';
+declare const permissionsRouter: PermissionsRouter;
+declare const publish: Publisher;
+export { permissionsRouter, publish };

package/build/site/index.js

@@ -0,0 +1,10 @@
+import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
+import { createPublisher } from './publisher.js';
+import { PermissionsRouter } from './permissions-router.js';
+const permissionsRouter = new PermissionsRouter();
+const publish = createRESTModule((httpClient) => createPublisher({
+    httpClient,
+    apiUrl: process.env.DUPLEXER_API_URL ||
+        'https://manage.wix.com/_api/wix-duplexer-api',
+}), true);
+export { permissionsRouter, publish };

package/build/site/permissions-router.d.ts

@@ -0,0 +1,9 @@
+import type { Channel, PermissionHandler, Subscriber } from './types.js';
+export declare class PermissionsRouter {
+    private readonly routes;
+    private defaultHandler;
+    constructor();
+    add(channel: Channel, permissionHandler: PermissionHandler): void;
+    default(permissionHandler: PermissionHandler): void;
+    check(channel: Channel, subscriber: Subscriber): Promise<import("./types.js").Permissions>;
+}

package/build/site/permissions-router.js

@@ -0,0 +1,36 @@
+export class PermissionsRouter {
+    routes;
+    defaultHandler;
+    constructor() {
+        this.routes = new Map();
+        this.defaultHandler = () => Promise.resolve({
+            read: true,
+            write: false,
+        });
+    }
+    add(channel, permissionHandler) {
+        if (!this.routes.has(channel.name)) {
+            this.routes.set(channel.name, new Map());
+        }
+        const resourceId = typeof channel.resourceId === 'string' ? channel.resourceId : '';
+        this.routes.get(channel.name)?.set(resourceId, permissionHandler);
+    }
+    default(permissionHandler) {
+        this.defaultHandler = permissionHandler;
+    }
+    check(channel, subscriber) {
+        if (this.routes.has(channel.name)) {
+            const channelNameRoutes = this.routes.get(channel.name);
+            if (typeof channel.resourceId === 'string' &&
+                channelNameRoutes?.has(channel.resourceId)) {
+                const handler = channelNameRoutes.get(channel.resourceId);
+                return handler(channel, subscriber);
+            }
+            if (channelNameRoutes?.has('')) {
+                const handler = channelNameRoutes.get('');
+                return handler(channel, subscriber);
+            }
+        }
+        return this.defaultHandler(channel, subscriber);
+    }
+}

package/build/site/publisher.d.ts

@@ -0,0 +1,6 @@
+import type { HttpClient } from '@wix/sdk-types';
+import type { Publisher } from './types.js';
+export declare function createPublisher({ apiUrl, httpClient, }: {
+    apiUrl: string;
+    httpClient: HttpClient;
+}): Publisher;

package/build/site/publisher.js

@@ -0,0 +1,51 @@
+import { getCurrentRequest } from './request.js';
+import { transformError } from '@wix/sdk-runtime/transform-error';
+export function createPublisher({ apiUrl, httpClient, }) {
+    return async function (channel, payload, { users: recipients, includePublisher } = {}) {
+        const isAddRevisionToChannelNameInRealtimeBackendEnabled = await shouldAddRevisionToChannelNameInRealtimeBackend();
+        const { userId, visitorId, viewMode, siteRevision } = getCurrentRequest();
+        const publisher = includePublisher
+            ? { uid: userId || visitorId }
+            : undefined;
+        let channels;
+        if (viewMode?.toLowerCase() !== 'site') {
+            channels = [`@preview-${channel.name}`];
+        }
+        else if (isAddRevisionToChannelNameInRealtimeBackendEnabled) {
+            channels = [`${siteRevision}-${channel.name}`];
+        }
+        else {
+            channels = [channel.name];
+        }
+        try {
+            await httpClient.fetchWithAuth(`${apiUrl}/v3/publish`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({
+                    channels,
+                    resourceId: channel.resourceId,
+                    event: 'message',
+                    payload: { payload },
+                    publisher,
+                    recipients,
+                }),
+            });
+        }
+        catch (err) {
+            const transformedError = transformError(err);
+            throw transformedError;
+        }
+    };
+}
+const shouldAddRevisionToChannelNameInRealtimeBackend = async () => {
+    // const currentRequest = getCurrentRequest();
+    // const petriClient = getPetriClient({ url: currentRequest.petriUrl });
+    // const result = await petriClient.conductExperiment(
+    //   'specs.core-services.AddRevisionToChannelNameInRealtime',
+    //   'false',
+    // );
+    // return result.toString() === 'true';
+    return false;
+};

package/build/site/request.d.ts

@@ -0,0 +1,8 @@
+import { ViewMode } from './types.js';
+export declare function getCurrentRequest(): {
+    serverIdentity?: string;
+    userId?: string;
+    visitorId?: string;
+    viewMode?: ViewMode;
+    siteRevision?: string;
+};

package/build/site/request.js

@@ -0,0 +1,18 @@
+export function getCurrentRequest() {
+    const maybeRequest = extractRequestFromContext();
+    const headers = maybeRequest?.headers ?? {};
+    return {
+        serverIdentity: headers['x-wix-server-identity'],
+        userId: headers['x-wix-user-id'],
+        visitorId: headers['x-wix-aid'],
+        viewMode: headers['x-wix-view-mode'],
+        siteRevision: headers['x-wix-site-revision'],
+    };
+}
+function extractRequestFromContext() {
+    if (global.__requestContext?.getStore()) {
+        return global.__requestContext?.getStore()?.request;
+    }
+    // @ts-expect-error domain is a custom property
+    return process.domain?.webMethodInfo?.request;
+}

package/build/site/types.d.ts

@@ -0,0 +1,36 @@
+import type { Request as ExpressRequest } from 'express';
+import type { AsyncLocalStorage } from 'node:async_hooks';
+export type Request = ExpressRequest;
+declare global {
+    var __requestContext: AsyncLocalStorage<{
+        request: Request;
+    }> | undefined;
+}
+export declare enum ViewMode {
+    Preview = "Preview",
+    Public = "Site"
+}
+export interface Channel {
+    name: string;
+    resourceId?: string;
+}
+export interface PublishOptions {
+    includePublisher?: boolean;
+    users?: string[];
+}
+export type Publisher = (channel: Channel, payload: unknown, options?: PublishOptions) => Promise<unknown>;
+export declare const enum SubscriberType {
+    USER = "USER",
+    SITEMEMBER = "MEMBER",
+    VISITOR = "VISITOR"
+}
+export interface Subscriber {
+    id: string;
+    type: SubscriberType;
+}
+export interface Permissions {
+    read: boolean;
+    write: boolean;
+}
+export type PermissionHandler = (channel: Channel, subscriber: Subscriber) => Promise<Permissions>;
+export type Routes = Map<string, Map<string, PermissionHandler>>;

package/build/site/types.js

@@ -0,0 +1,5 @@
+export var ViewMode;
+(function (ViewMode) {
+    ViewMode["Preview"] = "Preview";
+    ViewMode["Public"] = "Site";
+})(ViewMode || (ViewMode = {}));

package/cjs/build/index.d.ts

@@ -0,0 +1 @@
+export * as site from './site/index.js';

package/cjs/build/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.site = void 0;
+exports.site = __importStar(require("./site/index.js"));

package/cjs/build/site/index.d.ts

@@ -0,0 +1,5 @@
+import { PermissionsRouter } from './permissions-router.js';
+import type { Publisher } from './types.js';
+declare const permissionsRouter: PermissionsRouter;
+declare const publish: Publisher;
+export { permissionsRouter, publish };

package/cjs/build/site/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publish = exports.permissionsRouter = void 0;
+const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
+const publisher_js_1 = require("./publisher.js");
+const permissions_router_js_1 = require("./permissions-router.js");
+const permissionsRouter = new permissions_router_js_1.PermissionsRouter();
+exports.permissionsRouter = permissionsRouter;
+const publish = (0, rest_modules_1.createRESTModule)((httpClient) => (0, publisher_js_1.createPublisher)({
+    httpClient,
+    apiUrl: process.env.DUPLEXER_API_URL ||
+        'https://manage.wix.com/_api/wix-duplexer-api',
+}), true);
+exports.publish = publish;

package/cjs/build/site/permissions-router.d.ts

@@ -0,0 +1,9 @@
+import type { Channel, PermissionHandler, Subscriber } from './types.js';
+export declare class PermissionsRouter {
+    private readonly routes;
+    private defaultHandler;
+    constructor();
+    add(channel: Channel, permissionHandler: PermissionHandler): void;
+    default(permissionHandler: PermissionHandler): void;
+    check(channel: Channel, subscriber: Subscriber): Promise<import("./types.js").Permissions>;
+}

package/cjs/build/site/permissions-router.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionsRouter = void 0;
+class PermissionsRouter {
+    routes;
+    defaultHandler;
+    constructor() {
+        this.routes = new Map();
+        this.defaultHandler = () => Promise.resolve({
+            read: true,
+            write: false,
+        });
+    }
+    add(channel, permissionHandler) {
+        if (!this.routes.has(channel.name)) {
+            this.routes.set(channel.name, new Map());
+        }
+        const resourceId = typeof channel.resourceId === 'string' ? channel.resourceId : '';
+        this.routes.get(channel.name)?.set(resourceId, permissionHandler);
+    }
+    default(permissionHandler) {
+        this.defaultHandler = permissionHandler;
+    }
+    check(channel, subscriber) {
+        if (this.routes.has(channel.name)) {
+            const channelNameRoutes = this.routes.get(channel.name);
+            if (typeof channel.resourceId === 'string' &&
+                channelNameRoutes?.has(channel.resourceId)) {
+                const handler = channelNameRoutes.get(channel.resourceId);
+                return handler(channel, subscriber);
+            }
+            if (channelNameRoutes?.has('')) {
+                const handler = channelNameRoutes.get('');
+                return handler(channel, subscriber);
+            }
+        }
+        return this.defaultHandler(channel, subscriber);
+    }
+}
+exports.PermissionsRouter = PermissionsRouter;

package/cjs/build/site/publisher.d.ts

@@ -0,0 +1,6 @@
+import type { HttpClient } from '@wix/sdk-types';
+import type { Publisher } from './types.js';
+export declare function createPublisher({ apiUrl, httpClient, }: {
+    apiUrl: string;
+    httpClient: HttpClient;
+}): Publisher;

package/cjs/build/site/publisher.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPublisher = createPublisher;
+const request_js_1 = require("./request.js");
+const transform_error_1 = require("@wix/sdk-runtime/transform-error");
+function createPublisher({ apiUrl, httpClient, }) {
+    return async function (channel, payload, { users: recipients, includePublisher } = {}) {
+        const isAddRevisionToChannelNameInRealtimeBackendEnabled = await shouldAddRevisionToChannelNameInRealtimeBackend();
+        const { userId, visitorId, viewMode, siteRevision } = (0, request_js_1.getCurrentRequest)();
+        const publisher = includePublisher
+            ? { uid: userId || visitorId }
+            : undefined;
+        let channels;
+        if (viewMode?.toLowerCase() !== 'site') {
+            channels = [`@preview-${channel.name}`];
+        }
+        else if (isAddRevisionToChannelNameInRealtimeBackendEnabled) {
+            channels = [`${siteRevision}-${channel.name}`];
+        }
+        else {
+            channels = [channel.name];
+        }
+        try {
+            await httpClient.fetchWithAuth(`${apiUrl}/v3/publish`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({
+                    channels,
+                    resourceId: channel.resourceId,
+                    event: 'message',
+                    payload: { payload },
+                    publisher,
+                    recipients,
+                }),
+            });
+        }
+        catch (err) {
+            const transformedError = (0, transform_error_1.transformError)(err);
+            throw transformedError;
+        }
+    };
+}
+const shouldAddRevisionToChannelNameInRealtimeBackend = async () => {
+    // const currentRequest = getCurrentRequest();
+    // const petriClient = getPetriClient({ url: currentRequest.petriUrl });
+    // const result = await petriClient.conductExperiment(
+    //   'specs.core-services.AddRevisionToChannelNameInRealtime',
+    //   'false',
+    // );
+    // return result.toString() === 'true';
+    return false;
+};

package/cjs/build/site/request.d.ts

@@ -0,0 +1,8 @@
+import { ViewMode } from './types.js';
+export declare function getCurrentRequest(): {
+    serverIdentity?: string;
+    userId?: string;
+    visitorId?: string;
+    viewMode?: ViewMode;
+    siteRevision?: string;
+};

package/cjs/build/site/request.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentRequest = getCurrentRequest;
+function getCurrentRequest() {
+    const maybeRequest = extractRequestFromContext();
+    const headers = maybeRequest?.headers ?? {};
+    return {
+        serverIdentity: headers['x-wix-server-identity'],
+        userId: headers['x-wix-user-id'],
+        visitorId: headers['x-wix-aid'],
+        viewMode: headers['x-wix-view-mode'],
+        siteRevision: headers['x-wix-site-revision'],
+    };
+}
+function extractRequestFromContext() {
+    if (global.__requestContext?.getStore()) {
+        return global.__requestContext?.getStore()?.request;
+    }
+    // @ts-expect-error domain is a custom property
+    return process.domain?.webMethodInfo?.request;
+}

package/cjs/build/site/types.d.ts

@@ -0,0 +1,36 @@
+import type { Request as ExpressRequest } from 'express';
+import type { AsyncLocalStorage } from 'node:async_hooks';
+export type Request = ExpressRequest;
+declare global {
+    var __requestContext: AsyncLocalStorage<{
+        request: Request;
+    }> | undefined;
+}
+export declare enum ViewMode {
+    Preview = "Preview",
+    Public = "Site"
+}
+export interface Channel {
+    name: string;
+    resourceId?: string;
+}
+export interface PublishOptions {
+    includePublisher?: boolean;
+    users?: string[];
+}
+export type Publisher = (channel: Channel, payload: unknown, options?: PublishOptions) => Promise<unknown>;
+export declare const enum SubscriberType {
+    USER = "USER",
+    SITEMEMBER = "MEMBER",
+    VISITOR = "VISITOR"
+}
+export interface Subscriber {
+    id: string;
+    type: SubscriberType;
+}
+export interface Permissions {
+    read: boolean;
+    write: boolean;
+}
+export type PermissionHandler = (channel: Channel, subscriber: Subscriber) => Promise<Permissions>;
+export type Routes = Map<string, Map<string, PermissionHandler>>;

package/cjs/build/site/types.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewMode = void 0;
+var ViewMode;
+(function (ViewMode) {
+    ViewMode["Preview"] = "Preview";
+    ViewMode["Public"] = "Site";
+})(ViewMode || (exports.ViewMode = ViewMode = {}));

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/cjs/tsconfig.cjs.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/site/index.ts","../src/site/permissions-router.ts","../src/site/publisher.ts","../src/site/request.ts","../src/site/types.ts"],"version":"5.7.3"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@wix/realtime",
+  "version": "0.1.0",
+  "license": "MIT",
+  "main": "cjs/build/index.js",
+  "module": "build/index.mjs",
+  "type": "module",
+  "files": [
+    "build",
+    "cjs"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.cjs.json && yarn docs",
+    "docs": "docs-ts-model --entryPoint src/index.ts --outDir ./docs --modelName docs-ts-model.json",
+    "test": "tsx --test test/*.spec.ts",
+    "lint": "eslint",
+    "lint:fix": "eslint --max-warnings=0 . --fix",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35"
+  },
+  "optionalDependencies": {
+    "@wix/docs-ts-model": "^1.30.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.4.0",
+    "@types/chance": "^1",
+    "@types/express": "^5.0.0",
+    "@types/node": "^20.14.2",
+    "@wix/sdk": "^1.10.0",
+    "@wix/sdk-types": "^1.8.0",
+    "chance": "^1.1.11",
+    "eslint": "9.x",
+    "eslint-plugin-prettier": "^5.1.3",
+    "fetch-mock": "^9.11.0",
+    "globals": "^15.4.0",
+    "node-fetch": "^3.3.2",
+    "prettier": "^3.3.1",
+    "tsx": "^4.15.1",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.1"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress.sdk",
+      "artifactId": "realtime"
+    },
+    "validations": {
+      "source": [
+        "lint"
+      ],
+      "postDependenciesBuild": [
+        "typecheck"
+      ]
+    }
+  },
+  "falconPackageHash": "fe736bc3e3d36aa9b5e1637e2251fd15e16f94739adf2bc816ca55e9"
+}