@hocuspocus/common 1.0.0-alpha.2

package/dist/packages/server/src/types.d.ts

@@ -0,0 +1,146 @@
+/// <reference types="node" />
+import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
+import { URLSearchParams } from 'url';
+import { Socket } from 'net';
+import Document from './Document';
+import { Hocuspocus } from './Hocuspocus';
+export declare enum MessageType {
+    Unknown = -1,
+    Sync = 0,
+    Awareness = 1,
+    Auth = 2
+}
+/**
+ * State of the WebSocket connection.
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
+ */
+export declare enum WsReadyStates {
+    Connecting = 0,
+    Open = 1,
+    Closing = 2,
+    Closed = 3
+}
+export interface AwarenessUpdate {
+    added: Array<any>;
+    updated: Array<any>;
+    removed: Array<any>;
+}
+export interface ConnectionConfig {
+    readOnly: boolean;
+    isAuthenticated: boolean;
+}
+export interface Extension {
+    onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    onChange?(data: onChangePayload): Promise<any>;
+    onConnect?(data: onConnectPayload): Promise<any>;
+    onConfigure?(data: onConfigurePayload): Promise<any>;
+    /**
+     * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+     */
+    onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onDestroy?(data: onDestroyPayload): Promise<any>;
+    onDisconnect?(data: onDisconnectPayload): Promise<any>;
+    onListen?(data: onListenPayload): Promise<any>;
+    onRequest?(data: onRequestPayload): Promise<any>;
+    onUpgrade?(data: onUpgradePayload): Promise<any>;
+}
+export declare type Hook = 'onAuthenticate' | 'onChange' | 'onConnect' | 'onConfigure' | 
+/**
+ * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+ */
+'onCreateDocument' | 'onLoadDocument' | 'onDestroy' | 'onDisconnect' | 'onListen' | 'onRequest' | 'onUpgrade';
+export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
+    /**
+     * A list of hocuspocus extenions.
+     */
+    extensions: Array<Extension>;
+    /**
+     * The port which the server listens on.
+     */
+    port: number | null;
+    /**
+     * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
+     */
+    timeout: number;
+}
+export interface onAuthenticatePayload {
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    token: string;
+    connection: ConnectionConfig;
+}
+export interface onConnectPayload {
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfig;
+}
+export interface onLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfig;
+}
+export interface onChangePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+}
+export interface onDisconnectPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+}
+export interface onRequestPayload {
+    request: IncomingMessage;
+    response: ServerResponse;
+    instance: Hocuspocus;
+}
+export interface onUpgradePayload {
+    head: any;
+    request: IncomingMessage;
+    socket: Socket;
+    instance: Hocuspocus;
+}
+export interface onListenPayload {
+    port: number;
+}
+export interface onDestroyPayload {
+    instance: Hocuspocus;
+}
+export interface onConfigurePayload {
+    configuration: Configuration;
+    version: string;
+    yjsVersion: string;
+    instance: Hocuspocus;
+}
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}

package/dist/packages/transformer/src/Prosemirror.d.ts

@@ -0,0 +1,11 @@
+import { Doc } from 'yjs';
+import { Schema } from 'prosemirror-model';
+import { Transformer } from './types';
+declare class Prosemirror implements Transformer {
+    defaultSchema: Schema;
+    schema(schema: Schema): Prosemirror;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, schema?: Schema): Doc;
+}
+export declare const ProsemirrorTransformer: Prosemirror;
+export {};

package/dist/packages/transformer/src/Tiptap.d.ts

@@ -0,0 +1,10 @@
+import { Doc } from 'yjs';
+import { Extensions } from '@tiptap/core/dist/packages/core/src/types';
+import { Transformer } from './types';
+export declare class Tiptap implements Transformer {
+    defaultExtensions: Extensions;
+    extensions(extensions: Extensions): Tiptap;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, extensions?: Extensions): Doc;
+}
+export declare const TiptapTransformer: Tiptap;

package/dist/packages/transformer/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Prosemirror';
+export * from './Tiptap';
+export * from './types';

package/dist/packages/transformer/src/types.d.ts

@@ -0,0 +1,5 @@
+import { Doc } from 'yjs';
+export interface Transformer {
+    fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
+    toYdoc: (document: any, fieldName: string) => Doc;
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@hocuspocus/common",
+  "description": "shared code for multiple Hocuspocus packages",
+  "version": "1.0.0-alpha.2",
+  "homepage": "https://hocuspocus.dev",
+  "keywords": [
+    "hocuspocus"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/hocuspocus-common.esm.js",
+  "module": "dist/hocuspocus-common.esm.js",
+  "types": "dist/packages/common/src/index.d.ts",
+  "exports": {
+    "source": {
+      "import": "./src"
+    },
+    "default": {
+      "import": "./dist/hocuspocus-common.esm.js",
+      "require": "./dist/hocuspocus-common.cjs"
+    }
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "gitHead": "0d060abd95ec14eb7e404270e1e2338b2a0db332",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/auth.ts

@@ -0,0 +1,40 @@
+import * as encoding from 'lib0/encoding'
+import * as decoding from 'lib0/decoding'
+
+enum AuthMessageType {
+  Token = 0,
+  PermissionDenied = 1,
+  Authenticated = 2,
+}
+
+export const writeAuthentication = (encoder: encoding.Encoder, auth: string) => {
+  encoding.writeVarUint(encoder, AuthMessageType.Token)
+  encoding.writeVarString(encoder, auth)
+}
+
+export const writePermissionDenied = (encoder: encoding.Encoder, reason: string) => {
+  encoding.writeVarUint(encoder, AuthMessageType.PermissionDenied)
+  encoding.writeVarString(encoder, reason)
+}
+
+export const writeAuthenticated = (encoder: encoding.Encoder) => {
+  encoding.writeVarUint(encoder, AuthMessageType.Authenticated)
+}
+
+export const readAuthMessage = (
+  decoder: decoding.Decoder,
+  permissionDeniedHandler: (reason: string) => void,
+  authenticatedHandler: () => void,
+) => {
+  switch (decoding.readVarUint(decoder)) {
+    case AuthMessageType.PermissionDenied: {
+      permissionDeniedHandler(decoding.readVarString(decoder))
+      break
+    }
+    case AuthMessageType.Authenticated: {
+      authenticatedHandler()
+      break
+    }
+    default:
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './auth'