@hocuspocus/extension-webhook 1.0.0-alpha.34

package/CHANGELOG.md

@@ -0,0 +1,272 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [1.0.0-alpha.34](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.33...@hocuspocus/extension-webhook@1.0.0-alpha.34) (2021-09-14)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.33](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.32...@hocuspocus/extension-webhook@1.0.0-alpha.33) (2021-09-01)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.32](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.31...@hocuspocus/extension-webhook@1.0.0-alpha.32) (2021-09-01)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.31](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.30...@hocuspocus/extension-webhook@1.0.0-alpha.31) (2021-08-31)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.30](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.29...@hocuspocus/extension-webhook@1.0.0-alpha.30) (2021-08-29)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.29](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.28...@hocuspocus/extension-webhook@1.0.0-alpha.29) (2021-08-27)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.28](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.27...@hocuspocus/extension-webhook@1.0.0-alpha.28) (2021-08-19)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.27](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.26...@hocuspocus/extension-webhook@1.0.0-alpha.27) (2021-08-19)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.26](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.25...@hocuspocus/extension-webhook@1.0.0-alpha.26) (2021-08-13)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.25](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.24...@hocuspocus/extension-webhook@1.0.0-alpha.25) (2021-07-13)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.24](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.23...@hocuspocus/extension-webhook@1.0.0-alpha.24) (2021-07-07)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.23](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.22...@hocuspocus/extension-webhook@1.0.0-alpha.23) (2021-06-23)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.22](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.21...@hocuspocus/extension-webhook@1.0.0-alpha.22) (2021-06-22)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.21](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.20...@hocuspocus/extension-webhook@1.0.0-alpha.21) (2021-06-11)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.20](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.19...@hocuspocus/extension-webhook@1.0.0-alpha.20) (2021-06-09)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.19](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.18...@hocuspocus/extension-webhook@1.0.0-alpha.19) (2021-06-09)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.18](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.17...@hocuspocus/extension-webhook@1.0.0-alpha.18) (2021-06-08)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.17](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.16...@hocuspocus/extension-webhook@1.0.0-alpha.17) (2021-06-08)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.16](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.15...@hocuspocus/extension-webhook@1.0.0-alpha.16) (2021-05-15)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.15](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.14...@hocuspocus/extension-webhook@1.0.0-alpha.15) (2021-04-20)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.14](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.13...@hocuspocus/extension-webhook@1.0.0-alpha.14) (2021-04-20)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.13](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.12...@hocuspocus/extension-webhook@1.0.0-alpha.13) (2021-04-20)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.12](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.11...@hocuspocus/extension-webhook@1.0.0-alpha.12) (2021-04-20)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.11](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.10...@hocuspocus/extension-webhook@1.0.0-alpha.11) (2021-04-20)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.10](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.9...@hocuspocus/extension-webhook@1.0.0-alpha.10) (2021-04-15)
+
+
+### Features
+
+* add request headers and parameters to onCreateDocument ([47a8b95](https://github.com/ueberdosis/hocuspocus/commit/47a8b95baf8dd22ebd71c56565420179402cdaa4))
+
+
+
+
+
+# [1.0.0-alpha.9](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.8...@hocuspocus/extension-webhook@1.0.0-alpha.9) (2021-04-14)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.8](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.7...@hocuspocus/extension-webhook@1.0.0-alpha.8) (2021-04-12)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.7](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.6...@hocuspocus/extension-webhook@1.0.0-alpha.7) (2021-04-08)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.6](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.5...@hocuspocus/extension-webhook@1.0.0-alpha.6) (2021-04-08)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.5](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.4...@hocuspocus/extension-webhook@1.0.0-alpha.5) (2021-04-07)
+
+
+### Features
+
+* add connect event to webhook extension ([d907354](https://github.com/ueberdosis/hocuspocus/commit/d907354561ca31130061b6393c240598d67259b1))
+* add create event to import documents from api ([240a032](https://github.com/ueberdosis/hocuspocus/commit/240a032a8d839144f9662c1ec947958823abfd45))
+* add disconnect event to webhook extension ([81679dd](https://github.com/ueberdosis/hocuspocus/commit/81679dd7828e96fc6e0a279880379eb16b28d788))
+
+
+
+
+
+# [1.0.0-alpha.4](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.3...@hocuspocus/extension-webhook@1.0.0-alpha.4) (2021-04-06)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# [1.0.0-alpha.3](https://github.com/ueberdosis/hocuspocus/compare/@hocuspocus/extension-webhook@1.0.0-alpha.2...@hocuspocus/extension-webhook@1.0.0-alpha.3) (2021-04-06)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook
+
+
+
+
+
+# 1.0.0-alpha.2 (2021-03-29)
+
+**Note:** Version bump only for package @hocuspocus/extension-webhook

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, überdosis GbR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/demos/backend/src/create-document.d.ts

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

package/dist/demos/backend/src/express.d.ts

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

package/dist/demos/backend/src/koa.d.ts

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

package/dist/demos/backend/src/minimal.d.ts

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

package/dist/demos/backend/src/monitor.d.ts

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

package/dist/demos/backend/src/redis.d.ts

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

package/dist/demos/backend/src/slow.d.ts

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

package/dist/demos/backend/src/webhook.d.ts

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

package/dist/hocuspocus-webhook.cjs

@@ -0,0 +1,158 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var crypto = require('crypto');
+var transformer = require('@hocuspocus/transformer');
+var axios = require('axios');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+
+exports.Events = void 0;
+(function (Events) {
+    Events["onChange"] = "change";
+    Events["onConnect"] = "connect";
+    Events["onCreate"] = "create";
+    Events["onDisconnect"] = "disconnect";
+})(exports.Events || (exports.Events = {}));
+class Webhook {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
+        this.configuration = {
+            debounce: 2000,
+            debounceMaxWait: 10000,
+            secret: '',
+            transformer: transformer.TiptapTransformer,
+            url: '',
+            events: [
+                exports.Events.onChange,
+            ],
+        };
+        this.debounced = new Map();
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+        if (!this.configuration.url) {
+            throw new Error('url is required!');
+        }
+    }
+    /**
+     * Create a signature for the response body
+     */
+    createSignature(body) {
+        const hmac = crypto.createHmac('sha256', this.configuration.secret);
+        return `sha256=${hmac.update(body).digest('hex')}`;
+    }
+    /**
+     * debounce the given function, using the given identifier
+     */
+    debounce(id, func) {
+        const old = this.debounced.get(id);
+        const start = (old === null || old === void 0 ? void 0 : old.start) || Date.now();
+        const run = () => {
+            this.debounced.delete(id);
+            func();
+        };
+        if (old === null || old === void 0 ? void 0 : old.timeout)
+            clearTimeout(old.timeout);
+        if (Date.now() - start >= this.configuration.debounceMaxWait)
+            return run();
+        this.debounced.set(id, {
+            start,
+            timeout: setTimeout(run, this.configuration.debounce),
+        });
+    }
+    /**
+     * Send a request to the given url containing the given data
+     */
+    async sendRequest(event, payload) {
+        const json = JSON.stringify({ event, payload });
+        return axios__default['default'].post(this.configuration.url, json, { headers: { 'X-Hocuspocus-Signature-256': this.createSignature(json) } });
+    }
+    /**
+     * onChange hook
+     */
+    async onChange(data) {
+        if (!this.configuration.events.includes(exports.Events.onChange)) {
+            return;
+        }
+        const save = () => {
+            this.sendRequest(exports.Events.onChange, {
+                document: this.configuration.transformer.fromYdoc(data.document),
+                documentName: data.documentName,
+                context: data.context,
+                requestHeaders: data.requestHeaders,
+                requestParameters: Object.fromEntries(data.requestParameters.entries()),
+            });
+        };
+        if (!this.configuration.debounce) {
+            return save();
+        }
+        this.debounce(data.documentName, save);
+    }
+    /**
+     * onCreateDocument hook
+     */
+    async onCreateDocument(data) {
+        if (!this.configuration.events.includes(exports.Events.onCreate)) {
+            return;
+        }
+        const response = await this.sendRequest(exports.Events.onCreate, {
+            documentName: data.documentName,
+            requestHeaders: data.requestHeaders,
+            requestParameters: Object.fromEntries(data.requestParameters.entries()),
+        });
+        if (response.status !== 200 || !response.data)
+            return;
+        const document = typeof response.data === 'string'
+            ? JSON.parse(response.data)
+            : response.data;
+        // eslint-disable-next-line guard-for-in,no-restricted-syntax
+        for (const fieldName in document) {
+            if (data.document.isEmpty(fieldName)) {
+                data.document.merge(this.configuration.transformer.toYdoc(document[fieldName], fieldName));
+            }
+        }
+    }
+    /**
+     * onConnect hook
+     */
+    async onConnect(data) {
+        if (!this.configuration.events.includes(exports.Events.onConnect)) {
+            return;
+        }
+        try {
+            const response = await this.sendRequest(exports.Events.onConnect, {
+                documentName: data.documentName,
+                requestHeaders: data.requestHeaders,
+                requestParameters: Object.fromEntries(data.requestParameters.entries()),
+            });
+            return typeof response.data === 'string'
+                ? JSON.parse(response.data)
+                : response.data;
+        }
+        catch (e) {
+            // eslint-disable-next-line no-throw-literal
+            throw null;
+        }
+    }
+    async onDisconnect(data) {
+        if (!this.configuration.events.includes(exports.Events.onConnect)) {
+            return;
+        }
+        await this.sendRequest(exports.Events.onDisconnect, {
+            documentName: data.documentName,
+            requestHeaders: data.requestHeaders,
+            requestParameters: Object.fromEntries(data.requestParameters.entries()),
+            context: data.context,
+        });
+    }
+}
+
+exports.Webhook = Webhook;
+//# sourceMappingURL=hocuspocus-webhook.cjs.map