@hocuspocus/extension-s3 3.4.1 → 3.4.4

package/dist/packages/common/src/auth.d.ts

@@ -1,5 +1,6 @@
 import * as encoding from "lib0/encoding";
 import * as decoding from "lib0/decoding";
+import type { AuthorizedScope } from "../../provider/src";
 export declare enum AuthMessageType {
     Token = 0,
     PermissionDenied = 1,
@@ -7,6 +8,6 @@ export declare enum AuthMessageType {
 }
 export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
 export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
-export declare const writeAuthenticated: (encoder: encoding.Encoder, scope: "readonly" | "read-write") => void;
+export declare const writeAuthenticated: (encoder: encoding.Encoder, scope: AuthorizedScope) => void;
 export declare const writeTokenSyncRequest: (encoder: encoding.Encoder) => void;
 export declare const readAuthMessage: (decoder: decoding.Decoder, sendToken: () => void, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;

package/dist/packages/provider/src/HocuspocusProvider.d.ts

@@ -4,8 +4,8 @@ import * as Y from "yjs";
 import EventEmitter from "./EventEmitter.ts";
 import type { CompleteHocuspocusProviderWebsocketConfiguration } from "./HocuspocusProviderWebsocket.ts";
 import { HocuspocusProviderWebsocket } from "./HocuspocusProviderWebsocket.ts";
-import type { ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
-export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, "name">> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> | Required<Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">>);
+import type { AuthorizedScope, ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
+export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, "name">> & Partial<CompleteHocuspocusProviderConfiguration> & ((Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> & Partial<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "preserveTrailingSlash">>) | Required<Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">>);
 export interface CompleteHocuspocusProviderConfiguration {
     /**
      * The identifier/name of your document
@@ -60,7 +60,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     isSynced: boolean;
     unsyncedChanges: number;
     isAuthenticated: boolean;
-    authorizedScope: string | undefined;
+    authorizedScope: AuthorizedScope | undefined;
     manageSocket: boolean;
     private _isAttached;
     intervals: any;

package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts

@@ -16,6 +16,11 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
      * URL of your @hocuspocus/server instance
      */
     url: string;
+    /**
+     * By default, trailing slashes are removed from the URL. Set this to true
+     * to preserve trailing slashes if your server configuration requires them.
+     */
+    preserveTrailingSlash: boolean;
     /**
      * An optional WebSocket polyfill, for example for Node.js
      */

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

@@ -25,6 +25,7 @@ export declare enum WebSocketStatus {
     Connected = "connected",
     Disconnected = "disconnected"
 }
+export type AuthorizedScope = "read-write" | "readonly";
 export interface OutgoingMessageInterface {
     encoder: Encoder;
     type?: MessageType;
@@ -50,7 +51,7 @@ export type onAuthenticationFailedParameters = {
     reason: string;
 };
 export type onAuthenticatedParameters = {
-    scope: "read-write" | "readonly";
+    scope: AuthorizedScope;
 };
 export type onOpenParameters = {
     event: Event;

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

@@ -2,7 +2,7 @@ import type { IncomingMessage as HTTPIncomingMessage } from "node:http";
 import { type CloseEvent } from "@hocuspocus/common";
 import type WebSocket from "ws";
 import type Document from "./Document.ts";
-import type { beforeSyncPayload, onStatelessPayload, onTokenSyncPayload } from "./types.ts";
+import type { beforeSyncPayload, onStatelessPayload } from "./types.ts";
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
@@ -13,7 +13,9 @@ export declare class Connection {
         beforeHandleMessage: (connection: Connection, update: Uint8Array) => Promise<void>;
         beforeSync: (connection: Connection, payload: Pick<beforeSyncPayload, "type" | "payload">) => Promise<void>;
         statelessCallback: (payload: onStatelessPayload) => Promise<void>;
-        onTokenSyncCallback: (payload: Partial<onTokenSyncPayload>) => Promise<void>;
+        onTokenSyncCallback: (payload: {
+            token: string;
+        }) => Promise<void>;
     };
     socketId: string;
     readOnly: boolean;
@@ -40,7 +42,9 @@ export declare class Connection {
     /**
      * Set a callback that will be triggered when on token sync message is received
      */
-    onTokenSyncCallback(callback: (payload: onTokenSyncPayload) => Promise<void>): Connection;
+    onTokenSyncCallback(callback: (payload: {
+        token: string;
+    }) => Promise<void>): Connection;
     /**
      * Send the given message
      */

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

@@ -6,6 +6,6 @@ export declare class MessageReceiver {
     defaultTransactionOrigin?: string;
     constructor(message: IncomingMessage, defaultTransactionOrigin?: string);
     apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
-    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 1 | 2;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@hocuspocus/extension-s3",
 	"description": "a S3-compatible persistence driver for Hocuspocus",
-	"version": "3.4.1",
+	"version": "3.4.4",
 	"homepage": "https://hocuspocus.dev",
 	"keywords": [
 		"hocuspocus",
@@ -30,10 +30,13 @@
 	],
 	"dependencies": {
 		"@aws-sdk/client-s3": "^3.0.0",
-		"@hocuspocus/extension-database": "^3.4.1",
+		"@hocuspocus/extension-database": "^3.4.4",
 		"kleur": "^4.1.4"
 	},
 	"publishConfig": {
 		"access": "public"
+	},
+	"repository": {
+		"url": "https://github.com/ueberdosis/hocuspocus"
 	}
 }