@hocuspocus/common 1.0.0-alpha.10

package/dist/tests/provider/onDisconnect.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/provider/onMessage.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/provider/onOpen.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/provider/onSynced.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/address.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/afterStoreDocument.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/closeConnections.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/getConnectionsCount.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/getDocumentName.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/getDocumentsCount.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/getMessageLogs.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/listen.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onAuthenticate.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onAwarenessUpdate.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onChange.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onConfigure.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onConnect.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onDestroy.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onDisconnect.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onListen.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onLoadDocument.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onRequest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onStoreDocument.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/onUpgrade.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server/requiresAuthentication.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/transformer/TiptapTransformer.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils/createDirectory.d.ts

@@ -0,0 +1 @@
+export declare const createDirectory: (dir: string) => void;

package/dist/tests/utils/flushRedis.d.ts

@@ -0,0 +1 @@
+export declare const flushRedis: () => Promise<string>;

package/dist/tests/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from './createDirectory';
+export * from './flushRedis';
+export * from './newHocuspocus';
+export * from './newHocuspocusProvider';
+export * from './redisConnectionSettings';
+export * from './removeDirectory';
+export * from './sleep';

package/dist/tests/utils/newHocuspocus.d.ts

@@ -0,0 +1,2 @@
+import { Hocuspocus, Configuration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Hocuspocus;

package/dist/tests/utils/newHocuspocusProvider.d.ts

@@ -0,0 +1,3 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from '@hocuspocus/provider';
+import { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderConfiguration, 'url'>>) => HocuspocusProvider;

package/dist/tests/utils/redisConnectionSettings.d.ts

@@ -0,0 +1,4 @@
+export declare const redisConnectionSettings: {
+    host: string;
+    port: number;
+};

package/dist/tests/utils/removeDirectory.d.ts

@@ -0,0 +1 @@
+export declare const removeDirectory: (dir: string) => void;

package/dist/tests/utils/sleep.d.ts

@@ -0,0 +1 @@
+export declare const sleep: (time: number) => Promise<unknown>;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@hocuspocus/common",
+  "description": "shared code for multiple Hocuspocus packages",
+  "version": "1.0.0-alpha.10",
+  "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": "1fc2a6cff1b5fd626b8dd7c486755111965da20d",
+  "dependencies": {
+    "lib0": "^0.2.47"
+  }
+}

package/src/CloseEvents.ts

@@ -0,0 +1,39 @@
+export interface CloseEvent {
+  code: number,
+  reason: string,
+}
+
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export const ResetConnection: CloseEvent = {
+  code: 4205,
+  reason: 'Reset Connection',
+}
+
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export const Unauthorized: CloseEvent = {
+  code: 4401,
+  reason: 'Unauthorized',
+}
+
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export const Forbidden: CloseEvent = {
+  code: 4403,
+  reason: 'Forbidden',
+}
+
+/**
+ * The server timed out waiting for the request.
+ */
+export const ConnectionTimeout: CloseEvent = {
+  code: 4408,
+  reason: 'Connection Timeout',
+}

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/awarenessStatesToArray.ts

@@ -0,0 +1,8 @@
+export const awarenessStatesToArray = (states: Map<number, Record<string, any>>) => {
+  return Array.from(states.entries()).map(([key, value]) => {
+    return {
+      clientId: key,
+      ...value,
+    }
+  })
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './auth'
+export * from './CloseEvents'
+export * from './awarenessStatesToArray'
+export * from './types'

package/src/types.ts

@@ -0,0 +1,10 @@
+/**
+ * State of the WebSocket connection.
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
+ */
+export enum WsReadyStates {
+  Connecting = 0,
+  Open = 1,
+  Closing = 2,
+  Closed = 3,
+}