@hocuspocus/extension-sqlite 3.2.2 → 3.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,44 @@
1
+ import type { DatabaseConfiguration } from "@hocuspocus/extension-database";
2
+ import { Database } from "@hocuspocus/extension-database";
3
+ import { S3Client } from "@aws-sdk/client-s3";
4
+ export interface S3Configuration extends DatabaseConfiguration {
5
+ /**
6
+ * AWS S3 region
7
+ */
8
+ region?: string;
9
+ /**
10
+ * S3 bucket name
11
+ */
12
+ bucket: string;
13
+ /**
14
+ * S3 key prefix for documents (optional)
15
+ */
16
+ prefix?: string;
17
+ /**
18
+ * AWS credentials
19
+ */
20
+ credentials?: {
21
+ accessKeyId: string;
22
+ secretAccessKey: string;
23
+ };
24
+ /**
25
+ * S3 endpoint URL (for S3-compatible services like MinIO)
26
+ */
27
+ endpoint?: string;
28
+ /**
29
+ * Force path style URLs (required for MinIO)
30
+ */
31
+ forcePathStyle?: boolean;
32
+ /**
33
+ * Custom S3 client
34
+ */
35
+ s3Client?: S3Client;
36
+ }
37
+ export declare class S3 extends Database {
38
+ private s3Client?;
39
+ configuration: S3Configuration;
40
+ constructor(configuration: Partial<S3Configuration>);
41
+ private getObjectKey;
42
+ onConfigure(): Promise<void>;
43
+ onListen(): Promise<void>;
44
+ }
@@ -0,0 +1 @@
1
+ export * from "./S3.ts";
@@ -39,7 +39,7 @@ export declare class Webhook implements Extension {
39
39
  /**
40
40
  * Send a request to the given url containing the given data
41
41
  */
42
- sendRequest(event: Events, payload: any): Promise<import("axios").AxiosResponse<any, any>>;
42
+ sendRequest(event: Events, payload: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
43
43
  /**
44
44
  * onChange hook
45
45
  */
@@ -4,7 +4,7 @@ import * as Y from "yjs";
4
4
  import EventEmitter from "./EventEmitter.ts";
5
5
  import type { CompleteHocuspocusProviderWebsocketConfiguration } from "./HocuspocusProviderWebsocket.ts";
6
6
  import { HocuspocusProviderWebsocket } from "./HocuspocusProviderWebsocket.ts";
7
- import type { ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
7
+ import type { ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
8
8
  export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, "name">> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> | Required<Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">>);
9
9
  export interface CompleteHocuspocusProviderConfiguration {
10
10
  /**
@@ -40,6 +40,7 @@ export interface CompleteHocuspocusProviderConfiguration {
40
40
  onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
41
41
  onOpen: (data: onOpenParameters) => void;
42
42
  onConnect: () => void;
43
+ onStatus: (data: onStatusParameters) => void;
43
44
  onMessage: (data: onMessageParameters) => void;
44
45
  onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
45
46
  onSynced: (data: onSyncedParameters) => void;
@@ -69,10 +70,11 @@ export declare class HocuspocusProvider extends EventEmitter {
69
70
  boundPageHide: () => void;
70
71
  boundOnOpen: (event: Event) => Promise<void>;
71
72
  boundOnClose: () => void;
72
- forwardConnect: (e: any) => this;
73
- forwardClose: (e: any) => this;
74
- forwardDisconnect: (e: any) => this;
75
- forwardDestroy: (e: any) => this;
73
+ forwardConnect: () => this;
74
+ forwardStatus: (e: onStatusParameters) => this;
75
+ forwardClose: (e: onCloseParameters) => this;
76
+ forwardDisconnect: (e: onDisconnectParameters) => this;
77
+ forwardDestroy: () => this;
76
78
  setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
77
79
  get document(): Y.Doc;
78
80
  get isAttached(): boolean;
@@ -2,11 +2,16 @@ import type { Event, MessageEvent } from "ws";
2
2
  import EventEmitter from "./EventEmitter.ts";
3
3
  import type { HocuspocusProvider } from "./HocuspocusProvider.ts";
4
4
  import { WebSocketStatus, type onAwarenessChangeParameters, type onAwarenessUpdateParameters, type onCloseParameters, type onDisconnectParameters, type onMessageParameters, type onOpenParameters, type onOutgoingMessageParameters, type onStatusParameters } from "./types.ts";
5
- export type HocusPocusWebSocket = WebSocket & {
5
+ export type HocuspocusWebSocket = WebSocket & {
6
6
  identifier: string;
7
7
  };
8
+ export type HocusPocusWebSocket = HocuspocusWebSocket;
8
9
  export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
9
10
  export interface CompleteHocuspocusProviderWebsocketConfiguration {
11
+ /**
12
+ * Whether to connect automatically when creating the provider instance. Default=true
13
+ */
14
+ autoConnect: boolean;
10
15
  /**
11
16
  * URL of your @hocuspocus/server instance
12
17
  */
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@hocuspocus/extension-sqlite",
3
3
  "description": "a generic Hocuspocus persistence driver for the sqlite",
4
- "version": "3.2.2",
4
+ "version": "3.2.4",
5
5
  "homepage": "https://hocuspocus.dev",
6
6
  "keywords": [
7
7
  "hocuspocus",
@@ -27,7 +27,7 @@
27
27
  "dist"
28
28
  ],
29
29
  "dependencies": {
30
- "@hocuspocus/extension-database": "^3.2.2",
30
+ "@hocuspocus/extension-database": "^3.2.4",
31
31
  "kleur": "^4.1.4",
32
32
  "sqlite3": "^5.1.7"
33
33
  },