@webda/fs 4.0.0-beta.3

package/lib/filestore.service.js

@@ -0,0 +1,423 @@
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+import * as fs from "fs";
+import * as path from "path";
+import { Store, StoreNotFoundError, StoreParameters, UpdateConditionFailError, MemoryRepository, EventRepository, InstanceCache, useModelMetadata } from "@webda/core";
+import { JSONUtils } from "@webda/utils";
+/** Configuration parameters for the JSON-file-backed store. */
+export class FileStoreParameters extends StoreParameters {
+    /**
+     * Local path where to store all `json` files
+     */
+    folder;
+    /**
+     * Parameter sent to JSON.stringify when storing the json
+     */
+    beautify;
+}
+/**
+ * A Map-like storage backend backed by filesystem JSON files.
+ * Keys are UUIDs; values are JSON strings of stored objects.
+ */
+class FileBackedMap extends Map {
+    folder;
+    extension;
+    /** Create a new FileBackedMap.
+     * @param folder - the directory to store files in
+     * @param extension - the file extension to use
+     */
+    constructor(folder, extension = ".json") {
+        super();
+        this.folder = folder;
+        this.extension = extension;
+    }
+    /**
+     * Build the full filesystem path for a given key.
+     *
+     * @param key - the storage key
+     * @returns the full file path
+     */
+    filePath(key) {
+        return path.join(this.folder, `${key}${this.extension}`);
+    }
+    /**
+     * Check whether a JSON file exists for the given key.
+     *
+     * @param key - the storage key
+     * @returns true if the file exists
+     */
+    has(key) {
+        return fs.existsSync(this.filePath(key));
+    }
+    /**
+     * Read and return the JSON content for a key, or undefined if missing.
+     *
+     * @param key - the storage key
+     * @returns the JSON content or undefined
+     */
+    get(key) {
+        const p = this.filePath(key);
+        if (!fs.existsSync(p))
+            return undefined;
+        return fs.readFileSync(p, "utf-8");
+    }
+    /**
+     * Write a JSON string value to the file for the given key.
+     *
+     * @param key - the storage key
+     * @param value - the JSON string to write
+     * @returns this map for chaining
+     */
+    set(key, value) {
+        fs.writeFileSync(this.filePath(key), value, "utf-8");
+        return this;
+    }
+    /**
+     * Remove the JSON file for the given key, returning true if it existed.
+     *
+     * @param key - the storage key
+     * @returns true if the file was deleted
+     */
+    delete(key) {
+        const p = this.filePath(key);
+        if (!fs.existsSync(p))
+            return false;
+        fs.unlinkSync(p);
+        return true;
+    }
+    /** Delete all JSON files in the backing folder. */
+    clear() {
+        if (fs.existsSync(this.folder)) {
+            for (const f of fs.readdirSync(this.folder)) {
+                if (f.endsWith(this.extension)) {
+                    fs.unlinkSync(path.join(this.folder, f));
+                }
+            }
+        }
+    }
+    /**
+     * Iterate over all stored keys by listing JSON files in the folder.
+     *
+     * @returns an iterator of storage keys
+     */
+    keys() {
+        if (!fs.existsSync(this.folder))
+            return [].values();
+        const ext = this.extension;
+        const files = fs
+            .readdirSync(this.folder)
+            .filter(f => f.endsWith(ext))
+            .map(f => f.slice(0, f.length - ext.length));
+        return files.values();
+    }
+    /**
+     * Iterate over all key-value pairs stored in the folder.
+     *
+     * @returns an iterator of key-value pairs
+     */
+    [Symbol.iterator]() {
+        const entries = [...this.keys()].map(key => [key, this.get(key)]);
+        return entries.values();
+    }
+}
+/**
+ * Simple file storage of object
+ *
+ * Storage structure
+ *   /folder/{uuid}
+ *
+ * Parameters:
+ *  folder: to store to
+ *
+ * @category CoreServices
+ * @WebdaModda
+ */
+let FileStore = (() => {
+    let _classSuper = Store;
+    let _instanceExtraInitializers = [];
+    let _getRepository_decorators;
+    return class FileStore extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _getRepository_decorators = [InstanceCache()];
+            __esDecorate(this, null, _getRepository_decorators, { kind: "method", name: "getRepository", static: false, private: false, access: { has: obj => "getRepository" in obj, get: obj => obj.getRepository }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        static EXTENSION = ".json";
+        /**
+         * Load the parameters for a service
+         *
+         * @param params - raw parameter values
+         * @returns the loaded parameters
+         */
+        loadParameters(params) {
+            return new FileStoreParameters().load(params);
+        }
+        /**
+         * Create the storage folder if does not exist
+         */
+        computeParameters() {
+            super.computeParameters();
+            if (!fs.existsSync(this.parameters.folder)) {
+                fs.mkdirSync(this.parameters.folder);
+            }
+        }
+        /**
+         * Get the file path of an object
+         *
+         * @param uid - the object unique identifier
+         * @returns the file path
+         */
+        file(uid) {
+            return `${this.parameters.folder}/${uid}${FileStore.EXTENSION}`;
+        }
+        /**
+         * @override
+         */
+        async _exists(uid) {
+            return fs.existsSync(this.file(uid));
+        }
+        /**
+         * @override
+         */
+        async find(query) {
+            const files = fs
+                .readdirSync(this.parameters.folder)
+                .filter(file => {
+                return !fs.statSync(path.join(this.parameters.folder, file)).isDirectory();
+            })
+                .map(f => f.substring(0, f.length - FileStore.EXTENSION.length))
+                .sort();
+            // Use the repository for this store's model to simulate a find
+            const repo = this.getRepository(this._models[0]);
+            return MemoryRepository.simulateFind(query, files, repo);
+        }
+        /**
+         * @override
+         */
+        async _create(uuid, object) {
+            const fh = fs.openSync(this.file(uuid), "wx");
+            fs.writeSync(fh, JSON.stringify(object, undefined, this.parameters.beautify));
+            fs.closeSync(fh);
+            return object;
+        }
+        /**
+         * Store in file the object
+         *
+         * @param uuid - the object unique identifier
+         * @param object - the object to persist
+         * @returns the persisted object
+         */
+        async persist(uuid, object) {
+            fs.writeFileSync(this.file(uuid), JSON.stringify(object, undefined, this.parameters.beautify));
+            return object;
+        }
+        /**
+         * Verify optimistic locking update condition
+         *
+         * @param uuid - the object unique identifier
+         * @param stored - the currently stored object
+         * @param writeConditionField - field to check for condition
+         * @param writeCondition - expected value of the field
+         */
+        checkUpdateCondition(uuid, stored, writeConditionField, writeCondition) {
+            if (writeConditionField && stored[writeConditionField] !== writeCondition) {
+                throw new UpdateConditionFailError(uuid, writeConditionField, writeCondition);
+            }
+        }
+        /**
+         * Verify collection item update condition
+         *
+         * @param stored - the currently stored object
+         * @param prop - the collection property name
+         * @param itemWriteConditionField - field to check on the item
+         * @param itemWriteCondition - expected value of the field
+         * @param index - index of the item in the collection
+         */
+        checkCollectionUpdateCondition(stored, prop, itemWriteConditionField, itemWriteCondition, index) {
+            if (itemWriteCondition !== undefined &&
+                Array.isArray(stored[prop]) &&
+                index < stored[prop].length &&
+                stored[prop][index][itemWriteConditionField] !== itemWriteCondition) {
+                throw new UpdateConditionFailError(stored.uuid || stored._id || "unknown", itemWriteConditionField, itemWriteCondition);
+            }
+        }
+        /**
+         * @override
+         */
+        async _upsertItemToCollection(uid, prop, item, index, itemWriteCondition, itemWriteConditionField, updateDate) {
+            let data;
+            try {
+                data = JSONUtils.loadFile(this.file(uid));
+            }
+            catch (err) {
+                throw new StoreNotFoundError(uid, this.getName());
+            }
+            if (data === undefined) {
+                throw new StoreNotFoundError(uid, this.getName());
+            }
+            this.checkCollectionUpdateCondition(data, prop, itemWriteConditionField, itemWriteCondition, index);
+            data[prop] ??= [];
+            if (typeof index === "number") {
+                data[prop][index] = item;
+            }
+            else {
+                data[prop].push(item);
+            }
+            data._lastUpdate = updateDate;
+            return this.persist(uid, data);
+        }
+        /**
+         * @override
+         */
+        async _removeAttribute(uuid, attribute, writeCondition, writeConditionField) {
+            const res = await this._get(uuid, true);
+            this.checkUpdateCondition(uuid, res, writeConditionField, writeCondition);
+            delete res[attribute];
+            await this.persist(uuid, res);
+        }
+        /**
+         * @override
+         */
+        async _deleteItemFromCollection(uid, prop, index, itemWriteCondition, itemWriteConditionField, updateDate) {
+            const res = await this._get(uid, true);
+            this.checkCollectionUpdateCondition(res, prop, itemWriteConditionField, itemWriteCondition, index);
+            res[prop].splice(index, 1);
+            res._lastUpdate = updateDate;
+            return this.persist(uid, res);
+        }
+        /**
+         * @override
+         */
+        async _delete(uid) {
+            const filePath = this.file(uid);
+            if (fs.existsSync(filePath)) {
+                fs.unlinkSync(filePath);
+            }
+        }
+        /**
+         * @override
+         */
+        async _patch(object, uid, writeCondition, writeConditionField) {
+            const stored = await this._get(uid, true);
+            this.checkUpdateCondition(uid, stored, writeConditionField, writeCondition);
+            for (const prop in object) {
+                stored[prop] = object[prop];
+            }
+            return this.persist(uid, stored);
+        }
+        /**
+         * @override
+         */
+        async _update(object, uid, writeCondition, writeConditionField) {
+            const stored = await this._get(uid, true);
+            this.checkUpdateCondition(uid, stored, writeConditionField, writeCondition);
+            return this.persist(uid, object);
+        }
+        /**
+         * @override
+         */
+        async getAll(uids) {
+            if (!uids) {
+                uids = [];
+                const files = fs.readdirSync(this.parameters.folder);
+                for (const file in files) {
+                    uids.push(files[file].substring(0, files[file].length - FileStore.EXTENSION.length));
+                }
+            }
+            const result = [];
+            for (const i in uids) {
+                const model = this._get(uids[i]);
+                result.push(model);
+            }
+            return (await Promise.all(result)).filter(f => f !== undefined);
+        }
+        /**
+         * @override
+         */
+        async _get(uid, raiseIfNotFound = false) {
+            const res = await this._exists(uid);
+            if (res) {
+                const data = JSON.parse(fs.readFileSync(this.file(uid)).toString());
+                if (this.parameters.strict && this._modelsHierarchy[data.__type] !== 0) {
+                    return undefined;
+                }
+                return data;
+            }
+            else if (raiseIfNotFound) {
+                throw new StoreNotFoundError(uid, this.getName());
+            }
+        }
+        /**
+         * @override
+         */
+        async _incrementAttributes(uid, params, updateDate) {
+            const stored = await this._get(uid, true);
+            params.forEach(({ property: prop, value }) => {
+                if (stored[prop] === undefined) {
+                    stored[prop] = 0;
+                }
+                stored._lastUpdate = updateDate;
+                stored[prop] += value;
+            });
+            stored._lastUpdate = updateDate;
+            return this.persist(uid, stored);
+        }
+        /**
+         * @override
+         */
+        getRepository(model) {
+            const meta = useModelMetadata(model);
+            const storage = new FileBackedMap(this.parameters.folder, FileStore.EXTENSION);
+            const inner = new MemoryRepository(model, meta.PrimaryKey, undefined, storage);
+            // Wrap in EventRepository so typed CRUD events fire; consumers reach them
+            // via useRepository(model).on(...). simulateFind() only calls repo.get(),
+            // which EventRepository proxies, so find() is unaffected.
+            return new EventRepository(model, meta.PrimaryKey, inner);
+        }
+        /**
+         * @override
+         */
+        async __clean() {
+            (await import("fs-extra")).emptyDirSync(this.parameters.folder);
+        }
+        constructor() {
+            super(...arguments);
+            __runInitializers(this, _instanceExtraInitializers);
+        }
+    };
+})();
+export { FileStore };
+//# sourceMappingURL=filestore.service.js.map

package/lib/filestore.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filestore.service.js","sourceRoot":"","sources":["../src/filestore.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EACL,KAAK,EAEL,kBAAkB,EAClB,eAAe,EACf,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EAGf,aAAa,EACb,gBAAgB,EACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,+DAA+D;AAC/D,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD;;OAEG;IACH,MAAM,CAAS;IACf;;OAEG;IACH,QAAQ,CAAmB;CAC5B;AAED;;;GAGG;AACH,MAAM,aAAc,SAAQ,GAAmB;IAMnC,MAAM;IACN,SAAS;IANnB;;;OAGG;IACH,YACU,MAAc,EACd,SAAS,GAAW,OAAO;QAEnC,KAAK,EAAE,CAAC;sBAHA,MAAM;yBACN,SAAS;IAGnB,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CAAC,GAAW;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,GAAW;QACb,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,GAAW;QACb,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACxC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,GAAW,EAAE,KAAa;QAC5B,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAW;QAChB,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mDAAmD;IACnD,KAAK;QACH,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/B,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC/B,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC3C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC;QAC3B,MAAM,KAAK,GAAG,EAAE;aACb,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;aACxB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;aAC5B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAE,CAAqB,CAAC,CAAC;QACvF,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;;;;GAWG;IACU,SAAS;sBAA8D,KAAK;;;iBAA5E,SAA+D,SAAQ,WAAQ;;;yCAgRzF,aAAa,EAAE;YAChB,0LAAA,aAAa,6DAQZ;;;QAxRD,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,MAAW;YACxB,OAAU,IAAI,mBAAmB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC;QAED;;WAEG;QACH,iBAAiB;YACf,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC1B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAED;;;;;WAKG;QACH,IAAI,CAAC,GAAG;YACN,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,GAAG,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;QAClE,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,OAAO,CAAC,GAAG;YACf,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,IAAI,CAAC,KAAoB;YAC7B,MAAM,KAAK,GAAG,EAAE;iBACb,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;iBACnC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACb,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7E,CAAC,CAAC;iBACD,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;iBAC/D,IAAI,EAAE,CAAC;YAEV,+DAA+D;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAA0B,CAAC;YAC1E,OAAO,gBAAgB,CAAC,YAAY,CAAC,KAAY,EAAE,KAAK,EAAE,IAAW,CAAC,CAAC;QACzE,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,MAAW;YACrC,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;YAC9C,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9E,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED;;;;;;WAMG;QACO,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,MAAW;YAC/C,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/F,OAAO,MAAM,CAAC;QAChB,CAAC;QAED;;;;;;;WAOG;QACO,oBAAoB,CAAC,IAAY,EAAE,MAAW,EAAE,mBAA4B,EAAE,cAAoB;YAC1G,IAAI,mBAAmB,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,cAAc,EAAE,CAAC;gBAC1E,MAAM,IAAI,wBAAwB,CAAC,IAAW,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;QAED;;;;;;;;WAQG;QACO,8BAA8B,CACtC,MAAW,EACX,IAAY,EACZ,uBAA+B,EAC/B,kBAAuB,EACvB,KAAa;YAEb,IACE,kBAAkB,KAAK,SAAS;gBAChC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3B,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM;gBAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,uBAAuB,CAAC,KAAK,kBAAkB,EACnE,CAAC;gBACD,MAAM,IAAI,wBAAwB,CAChC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,IAAK,SAAiB,EAC/C,uBAAuB,EACvB,kBAAkB,CACnB,CAAC;YACJ,CAAC;QACH,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,uBAAuB,CAC3B,GAAW,EACX,IAAY,EACZ,IAAS,EACT,KAAa,EACb,kBAAuB,EACvB,uBAA+B,EAC/B,UAAgB;YAEhB,IAAI,IAAS,CAAC;YACd,IAAI,CAAC;gBACH,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,kBAAkB,CAAC,GAAU,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YAC3D,CAAC;YACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,IAAI,kBAAkB,CAAC,GAAU,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YAC3D,CAAC;YACD,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,IAAI,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;YACpG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;YACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACjC,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,SAAiB,EAAE,cAAoB,EAAE,mBAA4B;YACxG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;YAC1E,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC;YACtB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChC,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,yBAAyB,CAC7B,GAAW,EACX,IAAY,EACZ,KAAa,EACb,kBAAuB,EACvB,uBAA+B,EAC/B,UAAgB;YAEhB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,8BAA8B,CAAC,GAAG,EAAE,IAAI,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;YACnG,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC3B,GAAG,CAAC,WAAW,GAAG,UAAU,CAAC;YAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChC,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,OAAO,CAAC,GAAW;YACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,MAAM,CAAC,MAAW,EAAE,GAAW,EAAE,cAAoB,EAAE,mBAA4B;YACvF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;YAC5E,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,cAAoB,EAAE,mBAA4B;YACxF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,MAAM,CAAC,IAAe;YAC1B,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,IAAI,GAAG,EAAE,CAAC;gBACV,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBACrD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvF,CAAC;YACH,CAAC;YACD,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;YACD,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QAClE,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,eAAe,GAAY,KAAK;YACtD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACpE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvE,OAAO,SAAS,CAAC;gBACnB,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,eAAe,EAAE,CAAC;gBAC3B,MAAM,IAAI,kBAAkB,CAAC,GAAU,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,oBAAoB,CACxB,GAAW,EACX,MAA6C,EAC7C,UAAgB;YAEhB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACnB,CAAC;gBACD,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;YACxB,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;YAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QAED;;WAEG;QAEH,aAAa,CAAuB,KAAQ;YAC1C,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;YACrC,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;YAC/E,MAAM,KAAK,GAAG,IAAI,gBAAgB,CAAI,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,EAAE,OAAc,CAAC,CAAC;YACzF,0EAA0E;YAC1E,0EAA0E;YAC1E,0DAA0D;YAC1D,OAAO,IAAI,eAAe,CAAI,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAA6B,CAAC;QAC3F,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,OAAO;YACX,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClE,CAAC;;;YAhSU,mDAAS;;;;SAAT,SAAS"}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./filebinary.service.js";
+export * from "./filequeue.service.js";
+export * from "./filestore.service.js";
+export * from "./socketpubsub.service.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC"}

package/lib/index.js

@@ -0,0 +1,5 @@
+export * from "./filebinary.service.js";
+export * from "./filequeue.service.js";
+export * from "./filestore.service.js";
+export * from "./socketpubsub.service.js";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC"}

package/lib/socketpubsub.service.d.ts

@@ -0,0 +1,150 @@
+import { PubSubService, ServiceParameters } from "@webda/core";
+import { CancelablePromise } from "@webda/utils";
+import * as net from "net";
+/**
+ * Configuration for {@link SocketPubSubService}.
+ */
+export declare class SocketPubSubParameters extends ServiceParameters {
+    /**
+     * Filesystem path of the unix-domain socket. The first peer to bind this
+     * path becomes the broker; subsequent peers connect as clients.
+     */
+    path: string;
+    /**
+     * Reconnect delay in milliseconds when the broker disconnects. A small
+     * random jitter is added on top to avoid stampedes when several clients
+     * race to bind a new socket.
+     *
+     * @default 100
+     */
+    reconnectDelay?: number;
+    /**
+     * @override
+     * @param params - the input parameters
+     * @returns this
+     */
+    load(params?: any): this;
+}
+interface Subscriber<T> {
+    callback: (event: T) => Promise<void>;
+    proto?: {
+        new (): T;
+    };
+}
+/**
+ * Pub/sub backed by a unix-domain socket. Designed for single-host IPC:
+ * one peer binds the socket file and acts as broker, fanning each
+ * published message out to every connected client; other peers connect as
+ * clients. Any peer can publish — non-broker publishers send through the
+ * socket and the broker fanouts. Every connected peer (publisher
+ * included) receives every message, so the in-process semantics match the
+ * cross-process ones.
+ *
+ * If the broker disconnects, surviving clients reconnect after a short
+ * randomized delay; one of them wins the bind race and becomes the new
+ * broker. Stale socket files left by killed brokers are detected via
+ * `connect()` returning ECONNREFUSED and unlinked before re-binding.
+ *
+ * Wire format: 4-byte big-endian uint32 length prefix followed by a UTF-8
+ * JSON payload.
+ *
+ * @WebdaModda SocketPubSub
+ */
+export default class SocketPubSubService<T = any, K extends SocketPubSubParameters = SocketPubSubParameters> extends PubSubService<T, K> {
+    /**
+     * Broker-mode listener. Set when this peer is the broker, undefined
+     * otherwise. Mutually exclusive with {@link clientSocket}.
+     */
+    protected server?: net.Server;
+    /**
+     * Outbound socket to the broker, when this peer is a client.
+     */
+    protected clientSocket?: net.Socket;
+    /**
+     * Active subscriber sockets the broker fans messages out to.
+     */
+    protected subscribers: Set<net.Socket>;
+    /**
+     * Local callback registrations made via {@link consume}. The broker
+     * dispatches to these directly; client-mode peers feed them from the
+     * broker socket's incoming frames.
+     */
+    protected callbacks: Set<Subscriber<T>>;
+    /**
+     * Set during {@link stop} so disconnect handlers don't try to reconnect
+     * after we've torn down.
+     */
+    protected stopping: boolean;
+    /**
+     * @override
+     * @returns this service
+     */
+    init(): Promise<this>;
+    /**
+     * Connect to an existing broker, or bind ourselves as broker if there
+     * isn't one. Handles the EADDRINUSE race by retrying as a client.
+     */
+    protected connect(): Promise<void>;
+    /**
+     * Bind the socket file and start listening. On every accepted connection
+     * we frame-decode incoming bytes, fanout the raw frame to all OTHER
+     * subscribers, and dispatch the parsed payload to local callbacks.
+     * @param path - filesystem path of the unix socket
+     * @returns resolves once the listener is up
+     */
+    protected bindAsBroker(path: string): Promise<void>;
+    /**
+     * Open a client socket to the broker.
+     * @param path - filesystem path of the unix socket
+     * @returns resolves once connected, rejects on the first connection error
+     */
+    protected connectAsClient(path: string): Promise<void>;
+    /**
+     * Schedule a reconnect attempt after a randomized backoff. The jitter
+     * keeps surviving clients from all racing to bind the new socket on the
+     * same tick.
+     */
+    protected handleBrokerDisconnect(): void;
+    /**
+     * Write a framed payload to every subscriber except the optional sender
+     * (used to avoid echoing a client's own message back to it via the
+     * broker — the client receives it via its local callback dispatch
+     * instead).
+     * @param buf - the unframed JSON payload bytes
+     * @param except - optional socket to exclude from fanout
+     */
+    protected fanout(buf: Buffer, except?: net.Socket): void;
+    /**
+     * Decode a JSON frame and run every registered callback against it.
+     * Errors thrown by callbacks are swallowed (logged + counted) so one bad
+     * subscriber doesn't break others.
+     * @param buf - the unframed JSON payload bytes
+     */
+    protected dispatchToCallbacks(buf: Buffer): void;
+    /**
+     * @override
+     * @param event - the event to publish
+     */
+    sendMessage(event: T): Promise<void>;
+    /**
+     * @override
+     * @returns 0 — pub/sub is transient, no queueing
+     */
+    size(): Promise<number>;
+    /**
+     * @override
+     * @param callback - invoked with each event received
+     * @param eventPrototype - optional class to rehydrate JSON into
+     * @param onBind - invoked once the subscription is registered
+     * @returns a cancelable subscription handle
+     */
+    consume(callback: (event: T) => Promise<void>, eventPrototype?: {
+        new (): T;
+    }, onBind?: () => void): CancelablePromise;
+    /**
+     * @override
+     */
+    stop(): Promise<void>;
+}
+export { SocketPubSubService };
+//# sourceMappingURL=socketpubsub.service.d.ts.map

package/lib/socketpubsub.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketpubsub.service.d.ts","sourceRoot":"","sources":["../src/socketpubsub.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAa,MAAM,cAAc,CAAC;AAG5D,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAG3B;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,iBAAiB;IAC3D;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAI3B;CACF;AAED,UAAU,UAAU,CAAC,CAAC;IACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB,CACtC,CAAC,GAAG,GAAG,EACP,CAAC,SAAS,sBAAsB,GAAG,sBAAsB,CACzD,SAAQ,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAa;IACnD;;;;OAIG;IACH,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAa;IACpD;;;OAGG;IACH,SAAS,CAAC,QAAQ,UAAS;IAE3B;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAI1B;IAED;;;OAGG;IACH,UAAgB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CA2BvC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBlD;IAED;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBrD;IAED;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,IAAI,IAAI,CAQvC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAMvD;IAED;;;;;OAKG;IACH,SAAS,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAuB/C;IAED;;;OAGG;IACG,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAezC;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAE5B;IAED;;;;;;OAMG;IACH,OAAO,CACL,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,EACrC,cAAc,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,EAC9B,MAAM,CAAC,EAAE,MAAM,IAAI,GAClB,iBAAiB,CAenB;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAoB1B;CACF;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}