@plitzi/sdk-shared 0.30.19

package/dist/websockets/RTCodec.d.ts

@@ -0,0 +1,134 @@
+import { SubscriptionCollaborator } from '../types';
+export declare enum RTEventCloseCode {
+    NORMAL = 1000,
+    AWAY = 1001,
+    ABNORMAL = 1002,
+    UNSUPPORTED = 1003,
+    UNKNOWN = 4000,
+    NOT_AUTHORISED = 4001,
+    INSTANCE_ID_NOT_FOUND = 4002,
+    USER_TOKEN_NOT_FOUND = 4003
+}
+export declare enum RTEvent {
+    INIT = 0,
+    KA = 1,
+    MOUSE = 10,
+    ELEMENT = 11,
+    COLLABORATOR_CONNECTED = 12,
+    COLLABORATOR_DISCONNECTED = 13
+}
+export declare const isRTEvent: (value: unknown) => value is RTEvent;
+export type RTMessageManagedClient = {
+    type: RTEvent.INIT;
+    payload: undefined;
+} | {
+    type: RTEvent.KA;
+    payload: undefined;
+} | {
+    type: RTEvent.MOUSE;
+    payload: {
+        action: 'mouseEnter';
+        rootId: string;
+    } | {
+        action: 'mouseLeave';
+        rootId: string;
+    } | {
+        action: 'mouseMove';
+        x: number;
+        y: number;
+        zoom: number;
+        rootId: string;
+    };
+} | {
+    type: RTEvent.ELEMENT;
+    payload: {
+        action: 'hovered';
+        rootId: string;
+        id?: string;
+    } | {
+        action: 'selected';
+        rootId: string;
+        id?: string;
+    };
+} | {
+    type: RTEvent.COLLABORATOR_CONNECTED;
+    payload: SubscriptionCollaborator;
+} | {
+    type: RTEvent.COLLABORATOR_DISCONNECTED;
+    payload: SubscriptionCollaborator;
+};
+export type RTMessageManagedServer = {
+    type: RTEvent.INIT;
+    payload: {
+        collaborators: SubscriptionCollaborator[];
+    } & {
+        instanceId: string;
+    };
+} | {
+    type: RTEvent.KA;
+    payload: undefined;
+} | {
+    type: RTEvent.MOUSE;
+    payload: {
+        action: 'mouseEnter';
+        rootId: string;
+        instanceId: string;
+    } | {
+        action: 'mouseLeave';
+        rootId: string;
+        instanceId: string;
+    } | {
+        action: 'mouseMove';
+        x: number;
+        y: number;
+        zoom: number;
+        rootId: string;
+        instanceId: string;
+    };
+} | {
+    type: RTEvent.ELEMENT;
+    payload: {
+        action: 'hovered';
+        rootId: string;
+        id?: string;
+        instanceId: string;
+    } | {
+        action: 'selected';
+        rootId: string;
+        id?: string;
+        instanceId: string;
+    };
+} | {
+    type: RTEvent.COLLABORATOR_CONNECTED;
+    payload: SubscriptionCollaborator;
+} | {
+    type: RTEvent.COLLABORATOR_DISCONNECTED;
+    payload: SubscriptionCollaborator;
+};
+export type RTCallback = (...args: any[]) => void;
+export type RTMessage<T = unknown> = {
+    type: RTEvent;
+    payload: T;
+};
+/**
+ * Realtime binary codec (no globals)
+ */
+export default class RTCodec {
+    private readonly encoder;
+    private readonly decoder;
+    constructor();
+    /**
+     * Encode ANY payload to binary
+     *
+     * | 1 byte | 4 bytes | N bytes |
+     * | type   | length  | payload |
+     */
+    encode<T>(type: RTEvent, payload?: T): ArrayBuffer;
+    /**
+     * Decode binary to typed message
+     */
+    decode<T = unknown>(data: ArrayBuffer): RTMessage<T>;
+}
+export declare const setInstance: (instance?: RTCodec) => void;
+export declare function getInstance(autoInit?: true): RTCodec;
+export declare function getInstance(autoInit: false): RTCodec | undefined;

package/dist/websockets/RTCodec.mjs

@@ -0,0 +1,35 @@
+//#region src/websockets/RTCodec.ts
+var e = /* @__PURE__ */ function(e) {
+	return e[e.NORMAL = 1e3] = "NORMAL", e[e.AWAY = 1001] = "AWAY", e[e.ABNORMAL = 1002] = "ABNORMAL", e[e.UNSUPPORTED = 1003] = "UNSUPPORTED", e[e.UNKNOWN = 4e3] = "UNKNOWN", e[e.NOT_AUTHORISED = 4001] = "NOT_AUTHORISED", e[e.INSTANCE_ID_NOT_FOUND = 4002] = "INSTANCE_ID_NOT_FOUND", e[e.USER_TOKEN_NOT_FOUND = 4003] = "USER_TOKEN_NOT_FOUND", e;
+}({}), t = /* @__PURE__ */ function(e) {
+	return e[e.INIT = 0] = "INIT", e[e.KA = 1] = "KA", e[e.MOUSE = 10] = "MOUSE", e[e.ELEMENT = 11] = "ELEMENT", e[e.COLLABORATOR_CONNECTED = 12] = "COLLABORATOR_CONNECTED", e[e.COLLABORATOR_DISCONNECTED = 13] = "COLLABORATOR_DISCONNECTED", e;
+}({}), n = (e) => typeof e == "number" && e in t, r = class {
+	encoder;
+	decoder;
+	constructor() {
+		this.encoder = new TextEncoder(), this.decoder = new TextDecoder();
+	}
+	encode(e, t) {
+		let n = t !== void 0, r = n ? JSON.stringify(t) : "", i = n ? this.encoder.encode(r) : new Uint8Array(), a = new ArrayBuffer(5 + i.length), o = new DataView(a);
+		return o.setUint8(0, e), o.setUint32(1, i.length), i.length > 0 && new Uint8Array(a, 5).set(i), a;
+	}
+	decode(e) {
+		let t = new DataView(e), n = t.getUint8(0), r = t.getUint32(1);
+		if (r === 0) return {
+			type: n,
+			payload: void 0
+		};
+		let i = new Uint8Array(e, 5, r);
+		return {
+			type: n,
+			payload: JSON.parse(this.decoder.decode(i))
+		};
+	}
+}, i = void 0, a = (e) => {
+	i = e;
+};
+function o(e = !0) {
+	return e && !i && (i = new r()), i;
+}
+//#endregion
+export { t as RTEvent, e as RTEventCloseCode, r as default, o as getInstance, n as isRTEvent, a as setInstance };

package/dist/websockets/index.d.ts

@@ -0,0 +1,3 @@
+import { default as RTCodec } from './RTCodec';
+export * from './RTCodec';
+export { RTCodec };

package/dist/websockets/index.mjs

@@ -0,0 +1,2 @@
+import e, { RTEvent as t, RTEventCloseCode as n, getInstance as r, isRTEvent as i, setInstance as a } from "./RTCodec.mjs";
+export { e as RTCodec, t as RTEvent, n as RTEventCloseCode, r as getInstance, i as isRTEvent, a as setInstance };

package/eslint.config.mjs

@@ -0,0 +1,85 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import tsEslint from 'typescript-eslint';
+import react from 'eslint-plugin-react';
+import prettier from 'eslint-plugin-prettier';
+import storybook from 'eslint-plugin-storybook';
+import importEslint from 'eslint-plugin-import';
+import { globalIgnores } from 'eslint/config';
+
+export default tsEslint.config({
+  extends: [js.configs.recommended, ...tsEslint.configs.strictTypeChecked, globalIgnores(['**/*.js'])],
+  files: ['**/*.{ts,tsx}'],
+  ignores: ['node_modules', 'node_modules/*', './node_modules/**', '**/node_modules/**', 'dist', 'coverage', '.yarn/*'],
+  languageOptions: {
+    ecmaVersion: 2023,
+    globals: globals.browser,
+    parserOptions: {
+      projectService: {
+        allowDefaultProject: ['.storybook/*.ts', '.storybook/*.tsx'],
+        defaultProject: './tsconfig.json'
+      },
+      tsconfigRootDir: import.meta.dirname
+    }
+  },
+  plugins: {
+    import: importEslint,
+    'react-hooks': reactHooks,
+    'react-refresh': reactRefresh,
+    react,
+    prettier,
+    jsxRuntime: react.configs.flat['jsx-runtime'],
+    storybook
+  },
+  rules: {
+    ...reactHooks.configs.recommended.rules,
+    'no-useless-assignment': 'off',
+    '@typescript-eslint/no-deprecated': 'off',
+    '@typescript-eslint/no-useless-default-assignment': 'off',
+    '@typescript-eslint/consistent-type-imports': [
+      'warn',
+      {
+        disallowTypeAnnotations: false,
+        fixStyle: 'separate-type-imports',
+        prefer: 'type-imports'
+      }
+    ],
+    '@typescript-eslint/no-unnecessary-type-arguments': 'off',
+    '@typescript-eslint/no-misused-promises': ['error', { checksVoidReturn: { attributes: false, arguments: false } }],
+    '@typescript-eslint/no-confusing-void-expression': 'off', // ['error', { ignoreArrowShorthand: true, ignoreVoidOperator: true }],
+    'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
+    'no-var': 'error',
+    curly: 'error',
+    // indent: ['warn', 2],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    'prefer-const': ['error', { destructuring: 'any', ignoreReadBeforeAssign: false }],
+    // semi: ['warn', 'never'],
+    'react/jsx-key': ['warn', { checkFragmentShorthand: true }],
+    'react-hooks/refs': 'off', // @todo: review later
+    'react-hooks/immutability': 'off', // @todo: review later
+    'react-hooks/set-state-in-effect': 'off', // @todo: review later
+    'react-hooks/preserve-manual-memoization': 'off', // @todo: review later
+    'prettier/prettier': ['warn', { trailingComma: 'none' }],
+    '@typescript-eslint/restrict-template-expressions': ['error', { allowNumber: true }],
+    'import/order': [
+      'error',
+      {
+        groups: ['builtin', 'external', 'internal', ['parent', 'sibling', 'index'], 'type'],
+        pathGroups: [
+          { pattern: '@plitzi/sdk-*/**', group: 'internal' },
+          { pattern: '@plitzi/sdk-*', group: 'internal' }
+          // { pattern: '@icons/**', group: 'internal' },
+          // { pattern: '@components/**', group: 'internal' },
+          // { pattern: '@hooks/**', group: 'internal' },
+          // { pattern: '@/**', group: 'internal' } // , position: 'before'
+        ],
+        pathGroupsExcludedImportTypes: ['type'],
+        alphabetize: { order: 'asc', caseInsensitive: true },
+        'newlines-between': 'always'
+      }
+    ]
+  }
+});