@hocuspocus/extension-s3 3.2.4

package/README.md

@@ -0,0 +1,167 @@
+# @hocuspocus/extension-s3
+
+A S3-compatible persistence driver for Hocuspocus that stores Y.js documents in Amazon S3 or S3-compatible storage services like MinIO, DigitalOcean Spaces, etc.
+
+## Installation
+
+```bash
+npm install @hocuspocus/extension-s3
+```
+
+## Quick Start
+
+### Basic AWS S3 Configuration
+
+```javascript
+import { Server } from '@hocuspocus/server'
+import { S3 } from '@hocuspocus/extension-s3'
+
+const server = new Server({
+  extensions: [
+    new S3({
+      bucket: 'my-documents-bucket',
+      region: 'us-east-1',
+      credentials: {
+        accessKeyId: 'your-access-key',
+        secretAccessKey: 'your-secret-key'
+      }
+    }),
+  ],
+})
+
+server.listen()
+```
+
+### MinIO Configuration
+
+For local development with MinIO, ensure you set `forcePathStyle: true`:
+
+```javascript
+const server = new Server({
+  extensions: [
+    new S3({
+      bucket: 'hocuspocus-documents',
+      endpoint: 'http://localhost:9000',
+      forcePathStyle: true,
+      credentials: {
+        accessKeyId: 'minioadmin',
+        secretAccessKey: 'minioadmin'
+      }
+    }),
+  ],
+})
+```
+
+## Configuration Options
+
+- **bucket** (required): S3 bucket name where documents will be stored
+- **region**: AWS region (default: 'us-east-1')
+- **prefix**: Key prefix for documents (default: 'hocuspocus-documents/')
+- **credentials**: AWS credentials object with accessKeyId and secretAccessKey
+- **endpoint**: S3 endpoint URL (for S3-compatible services)
+- **forcePathStyle**: Use path-style URLs (required for MinIO, default: false)
+- **s3Client**: Custom S3Client instance
+
+## Document Storage
+
+Documents are stored as binary files in S3 with the naming convention:
+`{prefix}{documentName}.bin`
+
+## Scaling with Redis
+
+For horizontal scaling, combine S3 with the Redis extension. Redis handles real-time synchronization while S3 provides persistent storage.
+
+```javascript
+import { Server } from '@hocuspocus/server'
+import { Logger } from '@hocuspocus/extension-logger'
+import { Redis } from '@hocuspocus/extension-redis'
+import { S3 } from '@hocuspocus/extension-s3'
+
+// Server 1
+const server1 = new Server({
+  name: "server-1",
+  port: 8001,
+  extensions: [
+    new Logger(),
+    new Redis({
+      host: "127.0.0.1",
+      port: 6379,
+    }),
+    new S3({
+      bucket: 'hocuspocus-documents',
+      endpoint: 'http://localhost:9000', // MinIO
+      forcePathStyle: true,
+      credentials: {
+        accessKeyId: 'minioadmin',
+        secretAccessKey: 'minioadmin'
+      }
+    }),
+  ],
+})
+
+// Server 2 - same configuration with different name/port
+const server2 = new Server({
+  name: "server-2", 
+  port: 8002,
+  extensions: [/* same extensions */],
+})
+
+server1.listen()
+server2.listen()
+```
+
+## CLI Usage
+
+You can also use the S3 extension with the Hocuspocus CLI:
+
+```bash
+# Basic usage
+hocuspocus --s3 --s3-bucket my-documents
+
+# MinIO setup (forcePathStyle automatically enabled)
+hocuspocus --s3 --s3-bucket hocuspocus-documents --s3-endpoint http://localhost:9000
+```
+
+## Development
+
+### Quick Start
+
+For local development with MinIO (S3-compatible storage):
+
+```bash
+# Set up development environment
+npm run dev:setup
+
+# Test S3 configuration  
+npm run dev:test-s3
+
+# Run S3 playground examples
+npm run playground:s3
+```
+
+## Complete Documentation
+
+For detailed documentation, examples, best practices, and troubleshooting, see:
+[📚 S3 Extension Documentation](https://tiptap.dev/docs/hocuspocus/server/extensions/s3)
+
+## IAM Permissions
+
+Your AWS credentials or IAM role needs the following permissions:
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": ["s3:GetObject", "s3:PutObject", "s3:HeadObject"],
+      "Resource": "arn:aws:s3:::your-bucket-name/*"
+    },
+    {
+      "Effect": "Allow", 
+      "Action": ["s3:HeadBucket"],
+      "Resource": "arn:aws:s3:::your-bucket-name"
+    }
+  ]
+}
+```

package/dist/hocuspocus-s3.cjs

@@ -0,0 +1,129 @@
+'use strict';
+
+var extensionDatabase = require('@hocuspocus/extension-database');
+var clientS3 = require('@aws-sdk/client-s3');
+var kleur = require('kleur');
+
+class S3 extends extensionDatabase.Database {
+    constructor(configuration) {
+        super({});
+        this.configuration = {
+            region: "us-east-1",
+            bucket: "",
+            prefix: "hocuspocus-documents/",
+            forcePathStyle: false,
+            fetch: async ({ documentName }) => {
+                var _a;
+                const key = this.getObjectKey(documentName);
+                try {
+                    const command = new clientS3.GetObjectCommand({
+                        Bucket: this.configuration.bucket,
+                        Key: key,
+                    });
+                    const response = await this.s3Client.send(command);
+                    if (response.Body) {
+                        // Convert stream to Uint8Array
+                        const chunks = [];
+                        const reader = response.Body.transformToWebStream().getReader();
+                        while (true) {
+                            const { done, value } = await reader.read();
+                            if (done)
+                                break;
+                            chunks.push(value);
+                        }
+                        // Combine all chunks into a single Uint8Array
+                        const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+                        const result = new Uint8Array(totalLength);
+                        let offset = 0;
+                        for (const chunk of chunks) {
+                            result.set(chunk, offset);
+                            offset += chunk.length;
+                        }
+                        return result;
+                    }
+                    return null;
+                }
+                catch (error) {
+                    if (error.name === 'NoSuchKey' || ((_a = error.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) === 404) {
+                        // Document doesn't exist yet, return null
+                        return null;
+                    }
+                    throw error;
+                }
+            },
+            store: async ({ documentName, state }) => {
+                const key = this.getObjectKey(documentName);
+                const command = new clientS3.PutObjectCommand({
+                    Bucket: this.configuration.bucket,
+                    Key: key,
+                    Body: state,
+                    ContentType: "application/octet-stream",
+                });
+                await this.s3Client.send(command);
+            },
+        };
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+        // Validate required configuration
+        if (!this.configuration.bucket) {
+            throw new Error("S3 bucket name is required");
+        }
+    }
+    getObjectKey(documentName) {
+        const prefix = this.configuration.prefix || "";
+        return `${prefix}${documentName}.bin`;
+    }
+    async onConfigure() {
+        var _a, _b;
+        // Use custom S3 client if provided, otherwise create one
+        if (this.configuration.s3Client) {
+            this.s3Client = this.configuration.s3Client;
+        }
+        else {
+            const clientConfig = {
+                region: this.configuration.region,
+            };
+            if (this.configuration.credentials) {
+                clientConfig.credentials = this.configuration.credentials;
+            }
+            if (this.configuration.endpoint) {
+                clientConfig.endpoint = this.configuration.endpoint;
+                clientConfig.forcePathStyle = this.configuration.forcePathStyle;
+            }
+            this.s3Client = new clientS3.S3Client(clientConfig);
+        }
+        // Test S3 connection by checking if bucket exists
+        try {
+            const command = new clientS3.HeadObjectCommand({
+                Bucket: this.configuration.bucket,
+                Key: "test-connection", // This will likely return 404, but that's fine
+            });
+            await this.s3Client.send(command);
+        }
+        catch (error) {
+            // 404 is expected for the test key, any other error indicates connection issues
+            if (((_a = error.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) !== 404) {
+                // Don't show credential errors as connection failures in development
+                if ((_b = error.message) === null || _b === void 0 ? void 0 : _b.includes('Could not load credentials')) {
+                    console.warn(`  ${kleur.yellow("S3 warning:")} ${error.message}`);
+                    console.warn(`  ${kleur.yellow("Note:")} Ensure AWS credentials are properly configured for production use`);
+                }
+                else {
+                    console.error(`  ${kleur.red("S3 connection failed:")} ${error.message}`);
+                }
+            }
+        }
+    }
+    async onListen() {
+        const endpoint = this.configuration.endpoint || `https://s3.${this.configuration.region}.amazonaws.com`;
+        console.log(`  ${kleur.green("S3 extension configured:")} bucket=${this.configuration.bucket}, endpoint=${endpoint}`);
+        if (this.configuration.prefix) {
+            console.log(`  ${kleur.blue("S3 key prefix:")} ${this.configuration.prefix}`);
+        }
+    }
+}
+
+exports.S3 = S3;
+//# sourceMappingURL=hocuspocus-s3.cjs.map

package/dist/hocuspocus-s3.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hocuspocus-s3.cjs","sources":["../src/S3.ts"],"sourcesContent":[null],"names":["Database","GetObjectCommand","PutObjectCommand","S3Client","HeadObjectCommand"],"mappings":";;;;;;AAuCM,MAAO,EAAG,SAAQA,0BAAQ,CAAA;AAkE/B,IAAA,WAAA,CAAY,aAAuC,EAAA;QAClD,KAAK,CAAC,EAAE,CAAC;AAhEV,QAAA,IAAA,CAAA,aAAa,GAAoB;AAChC,YAAA,MAAM,EAAE,WAAW;AACnB,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,uBAAuB;AAC/B,YAAA,cAAc,EAAE,KAAK;AACrB,YAAA,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAI;;gBACjC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;AAE3C,gBAAA,IAAI;AACH,oBAAA,MAAM,OAAO,GAAG,IAAIC,yBAAgB,CAAC;AACpC,wBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;AACjC,wBAAA,GAAG,EAAE,GAAG;AACR,qBAAA,CAAC;oBAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAS,CAAC,IAAI,CAAC,OAAO,CAAC;AAEnD,oBAAA,IAAI,QAAQ,CAAC,IAAI,EAAE;;wBAElB,MAAM,MAAM,GAAiB,EAAE;wBAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,EAAE;wBAE/D,OAAO,IAAI,EAAE;4BACZ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE;AAC3C,4BAAA,IAAI,IAAI;gCAAE;AACV,4BAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;;wBAInB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;AACxE,wBAAA,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC;wBAC1C,IAAI,MAAM,GAAG,CAAC;AAEd,wBAAA,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;AAC3B,4BAAA,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;AACzB,4BAAA,MAAM,IAAI,KAAK,CAAC,MAAM;;AAGvB,wBAAA,OAAO,MAAM;;AAGd,oBAAA,OAAO,IAAI;;gBACV,OAAO,KAAU,EAAE;AACpB,oBAAA,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,CAAA,CAAA,EAAA,GAAA,KAAK,CAAC,SAAS,MAAE,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,cAAc,MAAK,GAAG,EAAE;;AAE1E,wBAAA,OAAO,IAAI;;AAEZ,oBAAA,MAAM,KAAK;;aAEZ;YACD,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;gBACxC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;AAE3C,gBAAA,MAAM,OAAO,GAAG,IAAIC,yBAAgB,CAAC;AACpC,oBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;AACjC,oBAAA,GAAG,EAAE,GAAG;AACR,oBAAA,IAAI,EAAE,KAAK;AACX,oBAAA,WAAW,EAAE,0BAA0B;AACvC,iBAAA,CAAC;gBAEF,MAAM,IAAI,CAAC,QAAS,CAAC,IAAI,CAAC,OAAO,CAAC;aAClC;SACD;QAKA,IAAI,CAAC,aAAa,GAAG;YACpB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SAChB;;AAGD,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;AAC/B,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;;;AAIvC,IAAA,YAAY,CAAC,YAAoB,EAAA;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,IAAI,EAAE;AAC9C,QAAA,OAAO,CAAG,EAAA,MAAM,CAAG,EAAA,YAAY,MAAM;;AAGtC,IAAA,MAAM,WAAW,GAAA;;;AAEhB,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ;;aACrC;AACN,YAAA,MAAM,YAAY,GAAQ;AACzB,gBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;aACjC;AAED,YAAA,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;gBACnC,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW;;AAG1D,YAAA,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAChC,YAAY,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ;gBACnD,YAAY,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc;;YAGhE,IAAI,CAAC,QAAQ,GAAG,IAAIC,iBAAQ,CAAC,YAAY,CAAC;;;AAI3C,QAAA,IAAI;AACH,YAAA,MAAM,OAAO,GAAG,IAAIC,0BAAiB,CAAC;AACrC,gBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;gBACjC,GAAG,EAAE,iBAAiB;AACtB,aAAA,CAAC;YAEF,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;;QAChC,OAAO,KAAU,EAAE;;YAEpB,IAAI,CAAA,CAAA,EAAA,GAAA,KAAK,CAAC,SAAS,0CAAE,cAAc,MAAK,GAAG,EAAE;;gBAE5C,IAAI,CAAA,EAAA,GAAA,KAAK,CAAC,OAAO,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,QAAQ,CAAC,4BAA4B,CAAC,EAAE;AAC1D,oBAAA,OAAO,CAAC,IAAI,CAAC,CAAK,EAAA,EAAA,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;AACjE,oBAAA,OAAO,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAoE,kEAAA,CAAA,CAAC;;qBACtG;AACN,oBAAA,OAAO,CAAC,KAAK,CAAC,CAAK,EAAA,EAAA,KAAK,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;;;;;AAM7E,IAAA,MAAM,QAAQ,GAAA;AACb,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,IAAI,CAAA,WAAA,EAAc,IAAI,CAAC,aAAa,CAAC,MAAM,gBAAgB;QACvG,OAAO,CAAC,GAAG,CACV,CAAA,EAAA,EAAK,KAAK,CAAC,KAAK,CAAC,0BAA0B,CAAC,WAAW,IAAI,CAAC,aAAa,CAAC,MAAM,cAAc,QAAQ,CAAA,CAAE,CACxG;AAED,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;AAC9B,YAAA,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA,CAAE,CAAC;;;AAG/E;;;;"}

package/dist/hocuspocus-s3.esm.js

@@ -0,0 +1,127 @@
+import { Database } from '@hocuspocus/extension-database';
+import { PutObjectCommand, GetObjectCommand, S3Client, HeadObjectCommand } from '@aws-sdk/client-s3';
+import kleur from 'kleur';
+
+class S3 extends Database {
+    constructor(configuration) {
+        super({});
+        this.configuration = {
+            region: "us-east-1",
+            bucket: "",
+            prefix: "hocuspocus-documents/",
+            forcePathStyle: false,
+            fetch: async ({ documentName }) => {
+                var _a;
+                const key = this.getObjectKey(documentName);
+                try {
+                    const command = new GetObjectCommand({
+                        Bucket: this.configuration.bucket,
+                        Key: key,
+                    });
+                    const response = await this.s3Client.send(command);
+                    if (response.Body) {
+                        // Convert stream to Uint8Array
+                        const chunks = [];
+                        const reader = response.Body.transformToWebStream().getReader();
+                        while (true) {
+                            const { done, value } = await reader.read();
+                            if (done)
+                                break;
+                            chunks.push(value);
+                        }
+                        // Combine all chunks into a single Uint8Array
+                        const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+                        const result = new Uint8Array(totalLength);
+                        let offset = 0;
+                        for (const chunk of chunks) {
+                            result.set(chunk, offset);
+                            offset += chunk.length;
+                        }
+                        return result;
+                    }
+                    return null;
+                }
+                catch (error) {
+                    if (error.name === 'NoSuchKey' || ((_a = error.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) === 404) {
+                        // Document doesn't exist yet, return null
+                        return null;
+                    }
+                    throw error;
+                }
+            },
+            store: async ({ documentName, state }) => {
+                const key = this.getObjectKey(documentName);
+                const command = new PutObjectCommand({
+                    Bucket: this.configuration.bucket,
+                    Key: key,
+                    Body: state,
+                    ContentType: "application/octet-stream",
+                });
+                await this.s3Client.send(command);
+            },
+        };
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+        // Validate required configuration
+        if (!this.configuration.bucket) {
+            throw new Error("S3 bucket name is required");
+        }
+    }
+    getObjectKey(documentName) {
+        const prefix = this.configuration.prefix || "";
+        return `${prefix}${documentName}.bin`;
+    }
+    async onConfigure() {
+        var _a, _b;
+        // Use custom S3 client if provided, otherwise create one
+        if (this.configuration.s3Client) {
+            this.s3Client = this.configuration.s3Client;
+        }
+        else {
+            const clientConfig = {
+                region: this.configuration.region,
+            };
+            if (this.configuration.credentials) {
+                clientConfig.credentials = this.configuration.credentials;
+            }
+            if (this.configuration.endpoint) {
+                clientConfig.endpoint = this.configuration.endpoint;
+                clientConfig.forcePathStyle = this.configuration.forcePathStyle;
+            }
+            this.s3Client = new S3Client(clientConfig);
+        }
+        // Test S3 connection by checking if bucket exists
+        try {
+            const command = new HeadObjectCommand({
+                Bucket: this.configuration.bucket,
+                Key: "test-connection", // This will likely return 404, but that's fine
+            });
+            await this.s3Client.send(command);
+        }
+        catch (error) {
+            // 404 is expected for the test key, any other error indicates connection issues
+            if (((_a = error.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) !== 404) {
+                // Don't show credential errors as connection failures in development
+                if ((_b = error.message) === null || _b === void 0 ? void 0 : _b.includes('Could not load credentials')) {
+                    console.warn(`  ${kleur.yellow("S3 warning:")} ${error.message}`);
+                    console.warn(`  ${kleur.yellow("Note:")} Ensure AWS credentials are properly configured for production use`);
+                }
+                else {
+                    console.error(`  ${kleur.red("S3 connection failed:")} ${error.message}`);
+                }
+            }
+        }
+    }
+    async onListen() {
+        const endpoint = this.configuration.endpoint || `https://s3.${this.configuration.region}.amazonaws.com`;
+        console.log(`  ${kleur.green("S3 extension configured:")} bucket=${this.configuration.bucket}, endpoint=${endpoint}`);
+        if (this.configuration.prefix) {
+            console.log(`  ${kleur.blue("S3 key prefix:")} ${this.configuration.prefix}`);
+        }
+    }
+}
+
+export { S3 };
+//# sourceMappingURL=hocuspocus-s3.esm.js.map

package/dist/hocuspocus-s3.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hocuspocus-s3.esm.js","sources":["../src/S3.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAuCM,MAAO,EAAG,SAAQ,QAAQ,CAAA;AAkE/B,IAAA,WAAA,CAAY,aAAuC,EAAA;QAClD,KAAK,CAAC,EAAE,CAAC;AAhEV,QAAA,IAAA,CAAA,aAAa,GAAoB;AAChC,YAAA,MAAM,EAAE,WAAW;AACnB,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,uBAAuB;AAC/B,YAAA,cAAc,EAAE,KAAK;AACrB,YAAA,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAI;;gBACjC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;AAE3C,gBAAA,IAAI;AACH,oBAAA,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;AACpC,wBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;AACjC,wBAAA,GAAG,EAAE,GAAG;AACR,qBAAA,CAAC;oBAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAS,CAAC,IAAI,CAAC,OAAO,CAAC;AAEnD,oBAAA,IAAI,QAAQ,CAAC,IAAI,EAAE;;wBAElB,MAAM,MAAM,GAAiB,EAAE;wBAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,EAAE;wBAE/D,OAAO,IAAI,EAAE;4BACZ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE;AAC3C,4BAAA,IAAI,IAAI;gCAAE;AACV,4BAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;;wBAInB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;AACxE,wBAAA,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC;wBAC1C,IAAI,MAAM,GAAG,CAAC;AAEd,wBAAA,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;AAC3B,4BAAA,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;AACzB,4BAAA,MAAM,IAAI,KAAK,CAAC,MAAM;;AAGvB,wBAAA,OAAO,MAAM;;AAGd,oBAAA,OAAO,IAAI;;gBACV,OAAO,KAAU,EAAE;AACpB,oBAAA,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,CAAA,CAAA,EAAA,GAAA,KAAK,CAAC,SAAS,MAAE,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,cAAc,MAAK,GAAG,EAAE;;AAE1E,wBAAA,OAAO,IAAI;;AAEZ,oBAAA,MAAM,KAAK;;aAEZ;YACD,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;gBACxC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;AAE3C,gBAAA,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;AACpC,oBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;AACjC,oBAAA,GAAG,EAAE,GAAG;AACR,oBAAA,IAAI,EAAE,KAAK;AACX,oBAAA,WAAW,EAAE,0BAA0B;AACvC,iBAAA,CAAC;gBAEF,MAAM,IAAI,CAAC,QAAS,CAAC,IAAI,CAAC,OAAO,CAAC;aAClC;SACD;QAKA,IAAI,CAAC,aAAa,GAAG;YACpB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SAChB;;AAGD,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;AAC/B,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;;;AAIvC,IAAA,YAAY,CAAC,YAAoB,EAAA;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,IAAI,EAAE;AAC9C,QAAA,OAAO,CAAG,EAAA,MAAM,CAAG,EAAA,YAAY,MAAM;;AAGtC,IAAA,MAAM,WAAW,GAAA;;;AAEhB,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ;;aACrC;AACN,YAAA,MAAM,YAAY,GAAQ;AACzB,gBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;aACjC;AAED,YAAA,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;gBACnC,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW;;AAG1D,YAAA,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAChC,YAAY,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ;gBACnD,YAAY,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc;;YAGhE,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC;;;AAI3C,QAAA,IAAI;AACH,YAAA,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC;AACrC,gBAAA,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;gBACjC,GAAG,EAAE,iBAAiB;AACtB,aAAA,CAAC;YAEF,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;;QAChC,OAAO,KAAU,EAAE;;YAEpB,IAAI,CAAA,CAAA,EAAA,GAAA,KAAK,CAAC,SAAS,0CAAE,cAAc,MAAK,GAAG,EAAE;;gBAE5C,IAAI,CAAA,EAAA,GAAA,KAAK,CAAC,OAAO,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,QAAQ,CAAC,4BAA4B,CAAC,EAAE;AAC1D,oBAAA,OAAO,CAAC,IAAI,CAAC,CAAK,EAAA,EAAA,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;AACjE,oBAAA,OAAO,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAoE,kEAAA,CAAA,CAAC;;qBACtG;AACN,oBAAA,OAAO,CAAC,KAAK,CAAC,CAAK,EAAA,EAAA,KAAK,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;;;;;AAM7E,IAAA,MAAM,QAAQ,GAAA;AACb,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,IAAI,CAAA,WAAA,EAAc,IAAI,CAAC,aAAa,CAAC,MAAM,gBAAgB;QACvG,OAAO,CAAC,GAAG,CACV,CAAA,EAAA,EAAK,KAAK,CAAC,KAAK,CAAC,0BAA0B,CAAC,WAAW,IAAI,CAAC,aAAa,CAAC,MAAM,cAAc,QAAQ,CAAA,CAAE,CACxG;AAED,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;AAC9B,YAAA,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA,CAAE,CAAC;;;AAG/E;;;;"}

package/dist/node_modules/@tiptap/pm/model/index.d.ts

@@ -0,0 +1 @@
+export * from 'prosemirror-model';

package/dist/node_modules/@tiptap/pm/state/index.d.ts

@@ -0,0 +1 @@
+export * from 'prosemirror-state';

package/dist/node_modules/@tiptap/pm/transform/index.d.ts

@@ -0,0 +1 @@
+export * from 'prosemirror-transform';

package/dist/node_modules/@tiptap/pm/view/index.d.ts

@@ -0,0 +1 @@
+export * from 'prosemirror-view';

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

@@ -0,0 +1,29 @@
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}
+/**
+ * The server is terminating the connection because a data frame was received
+ * that is too large.
+ * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
+ */
+export declare const MessageTooBig: CloseEvent;
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export declare const ResetConnection: CloseEvent;
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export declare const Unauthorized: CloseEvent;
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export declare const Forbidden: CloseEvent;
+/**
+ * The server timed out waiting for the request.
+ */
+export declare const ConnectionTimeout: CloseEvent;

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

@@ -0,0 +1,6 @@
+import * as encoding from "lib0/encoding";
+import * as decoding from "lib0/decoding";
+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 readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;

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

@@ -0,0 +1,3 @@
+export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
+    clientId: number;
+}[];

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * 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
+}

package/dist/packages/extension-database/src/Database.d.ts

@@ -0,0 +1,30 @@
+import type { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } from "@hocuspocus/server";
+export interface DatabaseConfiguration {
+    /**
+     * Pass a Promise to retrieve updates from your database. The Promise should resolve to
+     * an array of items with Y.js-compatible binary data.
+     */
+    fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    store: (data: storePayload) => Promise<void>;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onStoreDocument(data: onChangePayload): Promise<void>;
+}

package/dist/packages/extension-database/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./Database.ts";

package/dist/packages/extension-logger/src/Logger.d.ts

@@ -0,0 +1,67 @@
+import type { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from "@hocuspocus/server";
+export interface LoggerConfiguration {
+    /**
+     * Prepend all logging message with a string.
+     *
+     * @deprecated
+     */
+    prefix: null | string;
+    /**
+     * Whether to log something for the `onLoadDocument` hook.
+     */
+    onLoadDocument: boolean;
+    /**
+     * Whether to log something for the `onChange` hook.
+     */
+    onChange: boolean;
+    /**
+     * Whether to log something for the `onStoreDocument` hook.
+     */
+    onStoreDocument: boolean;
+    /**
+     * Whether to log something for the `onConnect` hook.
+     */
+    onConnect: boolean;
+    /**
+     * Whether to log something for the `onDisconnect` hook.
+     */
+    onDisconnect: boolean;
+    /**
+     * Whether to log something for the `onUpgrade` hook.
+     */
+    onUpgrade: boolean;
+    /**
+     * Whether to log something for the `onRequest` hook.
+     */
+    onRequest: boolean;
+    /**
+     * Whether to log something for the `onDestroy` hook.
+     */
+    onDestroy: boolean;
+    /**
+     * Whether to log something for the `onConfigure` hook.
+     */
+    onConfigure: boolean;
+    /**
+     * A log function, if none is provided output will go to console
+     */
+    log: (...args: any[]) => void;
+}
+export declare class Logger implements Extension {
+    name: string | null;
+    configuration: LoggerConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<LoggerConfiguration>);
+    onConfigure(data: onConfigurePayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    onChange(data: onChangePayload): Promise<void>;
+    onStoreDocument(data: onDisconnectPayload): Promise<void>;
+    onConnect(data: onConnectPayload): Promise<void>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onUpgrade(data: onUpgradePayload): Promise<void>;
+    onRequest(data: onRequestPayload): Promise<void>;
+    onDestroy(data: onDestroyPayload): Promise<void>;
+    private log;
+}

package/dist/packages/extension-logger/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./Logger.ts";