@rsdk/nats.object-storage 5.4.0-next.10

package/dist/patch.js

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const nats_1 = require("nats");
+const objectstore_1 = require("nats/lib/jetstream/objectstore");
+const codec_1 = require("nats/lib/nats-base-client/codec");
+const queued_iterator_1 = require("nats/lib/nats-base-client/queued_iterator");
+const sha256_1 = require("nats/lib/nats-base-client/sha256");
+function emptyReadableStream() {
+    return new ReadableStream({
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        pull(c) {
+            c.enqueue(new Uint8Array(0));
+            c.close();
+        },
+    });
+}
+class ObjectInfoImpl {
+    info;
+    hdrs;
+    constructor(oi) {
+        this.info = oi;
+    }
+    get name() {
+        return this.info.name;
+    }
+    get description() {
+        return this.info.description ?? '';
+    }
+    get headers() {
+        if (!this.hdrs) {
+            this.hdrs = nats_1.MsgHdrsImpl.fromRecord(this.info.headers || {});
+        }
+        return this.hdrs;
+    }
+    get options() {
+        return this.info.options;
+    }
+    get bucket() {
+        return this.info.bucket;
+    }
+    get chunks() {
+        return this.info.chunks;
+    }
+    get deleted() {
+        return this.info.deleted ?? false;
+    }
+    get digest() {
+        return this.info.digest;
+    }
+    get mtime() {
+        return this.info.mtime;
+    }
+    get nuid() {
+        return this.info.nuid;
+    }
+    get size() {
+        return this.info.size;
+    }
+    get revision() {
+        return this.info.revision;
+    }
+    get metadata() {
+        return this.info.metadata || {};
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    isLink() {
+        return (this.info.options?.link !== undefined && this.info.options?.link !== null);
+    }
+}
+objectstore_1.ObjectStoreImpl.prototype.get = async function get(name) {
+    const info = await this.rawInfo(name);
+    if (info === null) {
+        return null;
+    }
+    if (info.deleted) {
+        return null;
+    }
+    if (info.options && info.options.link) {
+        const ln = info.options.link.name || ' ';
+        if (ln === '') {
+            throw new Error('link is a bucket');
+        }
+        const os = info.options.link.bucket === this.name
+            ? this
+            : await objectstore_1.ObjectStoreImpl.create(this.js, info.options.link.bucket);
+        return os.get(ln);
+    }
+    const d = (0, nats_1.deferred)();
+    const r = {
+        info: new ObjectInfoImpl(info),
+        error: d,
+    };
+    if (info.size === 0) {
+        r.data = emptyReadableStream();
+        d.resolve(null);
+        return r;
+    }
+    let controller;
+    const oc = (0, nats_1.consumerOpts)();
+    oc.orderedConsumer();
+    const sha = new sha256_1.SHA256();
+    const subj = `$O.${this.name}.C.${info.nuid}`;
+    let sub;
+    try {
+        // eslint-disable-next-line deprecation/deprecation
+        sub = await this.js.subscribe(subj, oc);
+    }
+    catch (error) {
+        if (error.message !== 'no stream matches subject') {
+            throw error;
+        }
+        const oc = (0, nats_1.consumerOpts)({
+            ack_policy: nats_1.AckPolicy.None,
+        });
+        oc.orderedConsumer();
+        oc.bindStream('OBJ_' + this.name);
+        // HACK: for mirrored ObjectStore
+        // eslint-disable-next-line deprecation/deprecation
+        sub = await this.js.subscribe(subj, oc);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    (async () => {
+        for await (const jm of sub) {
+            if (jm.data.length > 0) {
+                sha.update(jm.data);
+                controller.enqueue(jm.data);
+            }
+            if (jm.info.pending === 0) {
+                const hash = sha.digest('base64');
+                // go pads the hash - which should be multiple of 3 - otherwise pads with '='
+                const pad = hash.length % 3;
+                const padding = pad > 0 ? '='.repeat(pad) : '';
+                const digest = `${objectstore_1.digestType}${hash}${padding}`;
+                if (digest === info.digest) {
+                    controller.close();
+                }
+                else {
+                    controller.error(new Error(`received a corrupt object, digests do not match received: ${info.digest} calculated ${digest}`));
+                }
+                sub.unsubscribe();
+            }
+        }
+    })()
+        .then(() => {
+        d.resolve();
+    })
+        .catch((error) => {
+        controller.error(error);
+        d.reject(error);
+    });
+    r.data = new ReadableStream({
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        start(c) {
+            controller = c;
+        },
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        cancel() {
+            sub.unsubscribe();
+        },
+    });
+    return r;
+};
+objectstore_1.ObjectStoreImpl.prototype.watch = async function watch(opts = {}) {
+    opts.includeHistory = opts.includeHistory ?? false;
+    opts.ignoreDeletes = opts.ignoreDeletes ?? false;
+    let initialized = false;
+    const qi = new queued_iterator_1.QueuedIteratorImpl();
+    const subj = this._metaSubjectAll();
+    try {
+        await this.jsm.streams.getMessage(this.stream, { last_by_subj: subj });
+    }
+    catch (error) {
+        if (error.code === '404') {
+            qi.push(null);
+            initialized = true;
+        }
+        else {
+            qi.stop(error);
+        }
+    }
+    const jc = (0, codec_1.JSONCodec)();
+    const copts = (0, nats_1.consumerOpts)();
+    copts.orderedConsumer();
+    if (opts.includeHistory) {
+        copts.deliverLastPerSubject();
+    }
+    else {
+        // FIXME: Go's implementation doesn't seem correct - if history is not desired
+        //  the watch should only be giving notifications on new entries
+        initialized = true;
+        copts.deliverNew();
+    }
+    copts.callback((err, jm) => {
+        if (err) {
+            qi.stop(err);
+            return;
+        }
+        if (jm !== null) {
+            const oi = jc.decode(jm.data);
+            if (oi.deleted && opts.ignoreDeletes === true) {
+                // do nothing
+            }
+            else {
+                qi.push(oi);
+            }
+            if (jm.info?.pending === 0 && !initialized) {
+                initialized = true;
+                qi.push(null);
+            }
+        }
+    });
+    let sub;
+    try {
+        // eslint-disable-next-line deprecation/deprecation
+        sub = await this.js.subscribe(subj, copts);
+    }
+    catch (error) {
+        if (error.message !== 'no stream matches subject') {
+            throw error;
+        }
+        copts.bindStream('OBJ_' + this.name);
+        // HACK: for mirrored ObjectStore
+        // eslint-disable-next-line deprecation/deprecation
+        sub = await this.js.subscribe(subj, copts);
+    }
+    qi._data = sub;
+    qi.iterClosed.then(() => {
+        sub.unsubscribe();
+    });
+    sub.closed
+        .then(() => {
+        qi.stop();
+    })
+        .catch((error) => {
+        qi.stop(error);
+    });
+    return qi;
+};
+//# sourceMappingURL=patch.js.map

package/dist/patch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.js","sourceRoot":"","sources":["../src/patch.ts"],"names":[],"mappings":";;AAQA,+BAAsE;AAEtE,gEAA6E;AAC7E,2DAA4D;AAC5D,+EAA+E;AAC/E,6DAA0D;AAE1D,SAAS,mBAAmB;IAC1B,OAAO,IAAI,cAAc,CAAC;QACxB,4EAA4E;QAC5E,IAAI,CAAC,CAAC;YACJ,CAAC,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,CAAC,KAAK,EAAE,CAAC;QACZ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,cAAc;IAClB,IAAI,CAAmB;IACvB,IAAI,CAAW;IACf,YAAY,EAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;IACrC,CAAC;IAED,IAAI,OAAO;QACT,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,GAAG,kBAAW,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC;IACpC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IAClC,CAAC;IAED,4EAA4E;IAC5E,MAAM;QACJ,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,CAC1E,CAAC;IACJ,CAAC;CACF;AAED,6BAAe,CAAC,SAAS,CAAC,GAAG,GAAG,KAAK,UAAU,GAAG,CAChD,IAAY;IAEZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACtC,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC;QACzC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,EAAE,GACN,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI;YACpC,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,MAAM,6BAAe,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,eAAQ,GAAgB,CAAC;IAEnC,MAAM,CAAC,GAA0B;QAC/B,IAAI,EAAE,IAAI,cAAc,CAAC,IAAI,CAAC;QAC9B,KAAK,EAAE,CAAC;KACT,CAAC;IACF,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACpB,CAAC,CAAC,IAAI,GAAG,mBAAmB,EAAE,CAAC;QAC/B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,OAAO,CAAiB,CAAC;IAC3B,CAAC;IAED,IAAI,UAA2C,CAAC;IAEhD,MAAM,EAAE,GAAG,IAAA,mBAAY,GAAE,CAAC;IAE1B,EAAE,CAAC,eAAe,EAAE,CAAC;IACrB,MAAM,GAAG,GAAG,IAAI,eAAM,EAAE,CAAC;IACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,IAAI,GAAG,CAAC;IAER,IAAI,CAAC;QACH,mDAAmD;QACnD,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,OAAO,KAAK,2BAA2B,EAAE,CAAC;YAClD,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,EAAE,GAAG,IAAA,mBAAY,EAAC;YACtB,UAAU,EAAE,gBAAS,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,EAAE,CAAC,eAAe,EAAE,CAAC;QACrB,EAAE,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAElC,iCAAiC;QACjC,mDAAmD;QACnD,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,4EAA4E;IAC5E,CAAC,KAAK,IAAI,EAAE;QACV,IAAI,KAAK,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBACpB,UAAW,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAElC,6EAA6E;gBAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC5B,MAAM,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/C,MAAM,MAAM,GAAG,GAAG,wBAAU,GAAG,IAAI,GAAG,OAAO,EAAE,CAAC;gBAChD,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC3B,UAAW,CAAC,KAAK,EAAE,CAAC;gBACtB,CAAC;qBAAM,CAAC;oBACN,UAAW,CAAC,KAAK,CACf,IAAI,KAAK,CACP,6DAA6D,IAAI,CAAC,MAAM,eAAe,MAAM,EAAE,CAChG,CACF,CAAC;gBACJ,CAAC;gBACD,GAAG,CAAC,WAAW,EAAE,CAAC;YACpB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,EAAE;SACD,IAAI,CAAC,GAAG,EAAE;QACT,CAAC,CAAC,OAAO,EAAE,CAAC;IACd,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,UAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEL,CAAC,CAAC,IAAI,GAAG,IAAI,cAAc,CAAC;QAC1B,4EAA4E;QAC5E,KAAK,CAAC,CAAC;YACL,UAAU,GAAG,CAAC,CAAC;QACjB,CAAC;QACD,4EAA4E;QAC5E,MAAM;YACJ,GAAG,CAAC,WAAW,EAAE,CAAC;QACpB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,6BAAe,CAAC,SAAS,CAAC,KAAK,GAAG,KAAK,UAAU,KAAK,CACpD,OAGK,EAAE;IAEP,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC;IACnD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,KAAK,CAAC;IACjD,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,EAAE,GAAG,IAAI,oCAAkB,EAAqB,CAAC;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;IAEpC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IACD,MAAM,EAAE,GAAG,IAAA,iBAAS,GAAc,CAAC;IACnC,MAAM,KAAK,GAAG,IAAA,mBAAY,GAAE,CAAC;IAE7B,KAAK,CAAC,eAAe,EAAE,CAAC;IACxB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,KAAK,CAAC,qBAAqB,EAAE,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,8EAA8E;QAC9E,gEAAgE;QAChE,WAAW,GAAG,IAAI,CAAC;QACnB,KAAK,CAAC,UAAU,EAAE,CAAC;IACrB,CAAC;IACD,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAqB,EAAE,EAAgB,EAAE,EAAE;QACzD,IAAI,GAAG,EAAE,CAAC;YACR,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACb,OAAO;QACT,CAAC;QACD,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAChB,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC9C,aAAa;YACf,CAAC;iBAAM,CAAC;gBACN,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,CAAC;YACD,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC3C,WAAW,GAAG,IAAI,CAAC;gBACnB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,GAAG,CAAC;IAER,IAAI,CAAC;QACH,mDAAmD;QACnD,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,OAAO,KAAK,2BAA2B,EAAE,CAAC;YAClD,MAAM,KAAK,CAAC;QACd,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAErC,iCAAiC;QACjC,mDAAmD;QACnD,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC;IACf,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE;QACtB,GAAG,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,MAAM;SACP,IAAI,CAAC,GAAG,EAAE;QACT,EAAE,CAAC,IAAI,EAAE,CAAC;IACZ,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEL,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC"}

package/dist/tokens.fn.d.ts

@@ -0,0 +1,2 @@
+export declare const createObjectStorageServiceToken: (connectionName?: string) => string;
+export declare const createObjectStorageToken: (bucketName: string, connectionName?: string) => string;

package/dist/tokens.fn.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createObjectStorageToken = exports.createObjectStorageServiceToken = void 0;
+const createObjectStorageServiceToken = (connectionName) => `NATS_OBJECT_STORAGE_SERVICE${connectionName ? `_${connectionName}` : ''}`;
+exports.createObjectStorageServiceToken = createObjectStorageServiceToken;
+const createObjectStorageToken = (bucketName, connectionName) => `NATS_OBJECT_STORAGE_${bucketName}${connectionName ? `_${connectionName}` : ''}`;
+exports.createObjectStorageToken = createObjectStorageToken;
+//# sourceMappingURL=tokens.fn.js.map

package/dist/tokens.fn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.fn.js","sourceRoot":"","sources":["../src/tokens.fn.ts"],"names":[],"mappings":";;;AAAO,MAAM,+BAA+B,GAAG,CAC7C,cAAuB,EACf,EAAE,CACV,8BAA8B,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAHhE,QAAA,+BAA+B,mCAGiC;AAEtE,MAAM,wBAAwB,GAAG,CACtC,UAAkB,EAClB,cAAuB,EACf,EAAE,CACV,uBAAuB,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAJtE,QAAA,wBAAwB,4BAI8C"}

package/dist/watch-object-storage.decorator.d.ts

@@ -0,0 +1,23 @@
+import type { ObjectInfo } from 'nats';
+export type WatchConfig = {
+    bucket: string;
+    ignoreDeletes?: boolean;
+    includeHistory?: boolean;
+    connectionName?: string;
+};
+export interface ObjectStorageWatcher {
+    onDelete(entry: ObjectInfo | null): Promise<void>;
+    onPut(entry: ObjectInfo | null): Promise<void>;
+}
+/**
+ * Key used to mark class as a watcher for object storage.
+ */
+export declare const WATCH_NATS_OBJECT_STORAGE_KEY = "WATCH_NATS_OBJECT_STORAGE";
+/**
+ * Decorator used to mark class as a watcher for object storage.
+ * Needs to be used in conjunction with the `ObjectStorageWatcher` interface.
+ *
+ * @param {WatchConfig} config - The configuration for watching object storage.
+ * @returns {void}
+ */
+export declare const WatchObjectStorage: import("@nestjs/core").ReflectableDecorator<WatchConfig, WatchConfig>;

package/dist/watch-object-storage.decorator.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchObjectStorage = exports.WATCH_NATS_OBJECT_STORAGE_KEY = void 0;
+const core_1 = require("@nestjs/core");
+/**
+ * Key used to mark class as a watcher for object storage.
+ */
+exports.WATCH_NATS_OBJECT_STORAGE_KEY = 'WATCH_NATS_OBJECT_STORAGE';
+/**
+ * Decorator used to mark class as a watcher for object storage.
+ * Needs to be used in conjunction with the `ObjectStorageWatcher` interface.
+ *
+ * @param {WatchConfig} config - The configuration for watching object storage.
+ * @returns {void}
+ */
+exports.WatchObjectStorage = core_1.Reflector.createDecorator({
+    key: exports.WATCH_NATS_OBJECT_STORAGE_KEY,
+});
+//# sourceMappingURL=watch-object-storage.decorator.js.map

package/dist/watch-object-storage.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch-object-storage.decorator.js","sourceRoot":"","sources":["../src/watch-object-storage.decorator.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AAezC;;GAEG;AACU,QAAA,6BAA6B,GAAG,2BAA2B,CAAC;AAEzE;;;;;;GAMG;AACU,QAAA,kBAAkB,GAAG,gBAAS,CAAC,eAAe,CAAc;IACvE,GAAG,EAAE,qCAA6B;CACnC,CAAC,CAAC"}

package/dist/watch-object-storage.service.d.ts

@@ -0,0 +1,45 @@
+import { DiscoveryService } from '@nestjs/core';
+import { ILogger } from '@rsdk/logging';
+import type { ObjectInfo, ObjectStore } from 'nats';
+import { NatsObjectStorageService } from './nats-object-storage.service';
+export declare class WatchObjectStorageService {
+    private readonly logger;
+    private readonly discovery;
+    private readonly client;
+    private readonly connectionName?;
+    constructor(logger: ILogger, discovery: DiscoveryService, client: NatsObjectStorageService, connectionName?: string | undefined);
+    /**
+     * Runs the watches for the object storage service.
+     * Waits for buckets to exist and starts the watch operation for each bucket.
+     */
+    runWatches(): Promise<void>;
+    /**
+     * Stops all watches.
+     *
+     * @note This method is not implemented yet.
+     */
+    stopWatches(): Promise<void>;
+    /**
+     * Register watcher callback for object storage
+     */
+    watch(storage: ObjectStore, callback: (entry: ObjectInfo | null) => Promise<void>, opts?: {
+        ignoreDeletes?: boolean;
+        includeHistory?: boolean;
+    }): Promise<void>;
+    /**
+     * Runs the watch operation for the given metadata and watcher.
+     *
+     * @param config - The watch configuration.
+     * @param watcher - The ObjectStorageWatcher instance.
+     * @returns A Promise that resolves when the watch operation is complete.
+     */
+    private runWatch;
+    /**
+     * Discovers and returns an array of ObjectStorageWatcher instances
+     * along with their corresponding metadata.
+     *
+     * @returns An array of objects containing the ObjectStorageWatcher
+     * instance and its metadata.
+     */
+    private discoverWatchers;
+}

package/dist/watch-object-storage.service.js

@@ -0,0 +1,112 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchObjectStorageService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const core_2 = require("@rsdk/core");
+const nats_object_storage_service_1 = require("./nats-object-storage.service");
+const watch_object_storage_decorator_1 = require("./watch-object-storage.decorator");
+let WatchObjectStorageService = class WatchObjectStorageService {
+    logger;
+    discovery;
+    client;
+    connectionName;
+    constructor(logger, discovery, client, connectionName) {
+        this.logger = logger;
+        this.discovery = discovery;
+        this.client = client;
+        this.connectionName = connectionName;
+    }
+    /**
+     * Runs the watches for the object storage service.
+     * Waits for buckets to exist and starts the watch operation for each bucket.
+     */
+    async runWatches() {
+        const watchers = await this.discoverWatchers();
+        await Promise.all(watchers.map(async ({ instance, metadata }) => {
+            await this.client.waitForBucketExists(metadata.bucket, 5000);
+            await this.runWatch(metadata, instance);
+            this.logger.info('Nats object storage watcher started', { metadata });
+        }));
+    }
+    /**
+     * Stops all watches.
+     *
+     * @note This method is not implemented yet.
+     */
+    async stopWatches() {
+        // TODO: Implement
+    }
+    /**
+     * Register watcher callback for object storage
+     */
+    async watch(storage, callback, opts) {
+        for await (const entry of await storage.watch(opts)) {
+            callback(entry).catch((error) => {
+                this.logger.error('Error processing object storage entry', {
+                    entry: entry,
+                    err: error,
+                });
+            });
+        }
+    }
+    /**
+     * Runs the watch operation for the given metadata and watcher.
+     *
+     * @param config - The watch configuration.
+     * @param watcher - The ObjectStorageWatcher instance.
+     * @returns A Promise that resolves when the watch operation is complete.
+     */
+    async runWatch({ bucket, ...options }, watcher) {
+        const storage = await this.client.bind({ bucketName: bucket });
+        this.watch(storage.getRawStorage(), async (event) => {
+            if (!event)
+                return;
+            await (event.deleted ? watcher.onDelete(event) : watcher.onPut(event));
+        }, options);
+    }
+    /**
+     * Discovers and returns an array of ObjectStorageWatcher instances
+     * along with their corresponding metadata.
+     *
+     * @returns An array of objects containing the ObjectStorageWatcher
+     * instance and its metadata.
+     */
+    discoverWatchers() {
+        return this.discovery.getProviders().reduce((acc, watcher) => {
+            /**
+             * NOTE: This is a fix for TypeError in call .getMetadataByDecorator() above
+             * because some tokens are not instances of classes and have no constructor.
+             * */
+            const clsRef = watcher.instance?.constructor ?? watcher.metatype;
+            if (!clsRef) {
+                return acc;
+            }
+            const metadata = this.discovery.getMetadataByDecorator(watch_object_storage_decorator_1.WatchObjectStorage, watcher);
+            if (metadata && metadata.connectionName === this.connectionName) {
+                acc.push({ instance: watcher.instance, metadata });
+            }
+            return acc;
+        }, []);
+    }
+};
+exports.WatchObjectStorageService = WatchObjectStorageService;
+exports.WatchObjectStorageService = WatchObjectStorageService = __decorate([
+    __param(0, (0, core_2.InjectLogger)(WatchObjectStorageService)),
+    __param(3, (0, common_1.Inject)('CONNECTION_NAME')),
+    __metadata("design:paramtypes", [Object, core_1.DiscoveryService,
+        nats_object_storage_service_1.NatsObjectStorageService, String])
+], WatchObjectStorageService);
+//# sourceMappingURL=watch-object-storage.service.js.map

package/dist/watch-object-storage.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch-object-storage.service.js","sourceRoot":"","sources":["../src/watch-object-storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,uCAAgD;AAChD,qCAA0C;AAI1C,+EAAyE;AAKzE,qFAAsE;AAEtE,IAAa,yBAAyB,GAAtC,MAAa,yBAAyB;IAGjB;IACA;IACA;IAEA;IANnB,YAEmB,MAAe,EACf,SAA2B,EAC3B,MAAgC,EAEhC,cAAuB;QAJvB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAkB;QAC3B,WAAM,GAAN,MAAM,CAA0B;QAEhC,mBAAc,GAAd,cAAc,CAAS;IACvC,CAAC;IAEJ;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE/C,MAAM,OAAO,CAAC,GAAG,CACf,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC7D,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxE,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,kBAAkB;IACpB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK,CAChB,OAAoB,EACpB,QAAqD,EACrD,IAGC;QAED,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE;oBACzD,KAAK,EAAE,KAAK;oBACZ,GAAG,EAAE,KAAK;iBACX,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ,CACpB,EAAE,MAAM,EAAE,GAAG,OAAO,EAAe,EACnC,OAA6B;QAE7B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,KAAK,CACR,OAAO,CAAC,aAAa,EAAE,EACvB,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,CAAC,KAAK;gBAAE,OAAO;YAEnB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACzE,CAAC,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,gBAAgB;QAItB,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,MAAM,CACzC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YACf;;;iBAGK;YACL,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;YACjE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,GAAG,CAAC;YACb,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,sBAAsB,CACpD,mDAAkB,EAClB,OAAO,CACR,CAAC;YAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;gBAChE,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAiE,CAClE,CAAC;IACJ,CAAC;CACF,CAAA;AAnHY,8DAAyB;oCAAzB,yBAAyB;IAEjC,WAAA,IAAA,mBAAY,EAAC,yBAAyB,CAAC,CAAA;IAIvC,WAAA,IAAA,eAAM,EAAC,iBAAiB,CAAC,CAAA;6CAFE,uBAAgB;QACnB,sDAAwB;GALxC,yBAAyB,CAmHrC"}

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config');

package/jest.config.unit.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.unit');

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@rsdk/nats.object-storage",
+  "version": "5.4.0-next.10",
+  "description": "Nats NestJS object storage",
+  "main": "dist/index.js",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "dependencies": {
+    "@nestjs-plugins/nestjs-nats-jetstream-transport": "^2.2.6",
+    "lodash": "^4.17.21",
+    "nats": "^2.28.0",
+    "typescript": "5.5.4"
+  },
+  "peerDependencies": {
+    "@grpc/grpc-js": "^1.10.11",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.2.3",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/microservices": "^10.0.0",
+    "@opentelemetry/api": "1.9.0",
+    "@rsdk/actx": "*",
+    "@rsdk/autodoc.protocol": "*",
+    "@rsdk/common": "*",
+    "@rsdk/common.nestjs": "*",
+    "@rsdk/common.node": "*",
+    "@rsdk/core": "*",
+    "@rsdk/decorators": "*",
+    "@rsdk/logging": "*",
+    "@rsdk/metadata": "*",
+    "@rsdk/nats.common": "*",
+    "@rsdk/nest-tools": "*",
+    "reflect-metadata": "^0.1.12 || ^0.2.0",
+    "rxjs": "^7.8.1"
+  },
+  "nx": {},
+  "gitHead": "e069174778f5d22396099fddfe3b10c4f30b467d"
+}

package/src/constants.ts

@@ -0,0 +1 @@
+export const NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE = 'nats-object-storages';

package/src/index.ts

@@ -0,0 +1,12 @@
+import './patch';
+
+export { NatsObjectStorageService } from './nats-object-storage.service';
+export {
+  WatchObjectStorage,
+  type ObjectStorageWatcher,
+} from './watch-object-storage.decorator';
+export { NatsObjectStorageModule } from './nats-object-storage.module';
+export { ObjectStorage } from './object-storage';
+export * from './inject-object-storage-service.decorator';
+export * from './tokens.fn';
+export { NatsObjectStorageModuleGenerator } from './nats-object-storage-module.generator';

package/src/inject-object-storage-service.decorator.ts

@@ -0,0 +1,45 @@
+import { Inject } from '@nestjs/common';
+import {
+  PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+  RsdkMetadata,
+} from '@rsdk/metadata';
+
+import { NatsObjectStorageModuleGenerator } from './nats-object-storage-module.generator';
+import {
+  createObjectStorageServiceToken,
+  createObjectStorageToken,
+} from './tokens.fn';
+
+export const InjectObjectStorageService = (
+  connectionName?: string,
+): ParameterDecorator =>
+  Inject(createObjectStorageServiceToken(connectionName));
+
+export const InjectNatsObjectStorage = (
+  bucketName: string,
+  connectionName?: string,
+): ParameterDecorator => {
+  return (target, propertyKey, parameterIndex) => {
+    Inject(createObjectStorageToken(bucketName, connectionName))(
+      target,
+      propertyKey,
+      parameterIndex,
+    );
+
+    const key = `nats-kv:${bucketName}${connectionName ? `:${connectionName}` : ''}`;
+    const moduleDefinition =
+      NatsObjectStorageModuleGenerator.createClientModuleDefinition(
+        target,
+        bucketName,
+        connectionName,
+      );
+
+    RsdkMetadata.setWithScope(
+      target,
+      PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+      key,
+      moduleDefinition,
+      true,
+    );
+  };
+};

package/src/nats-object-storage-module.generator.ts

@@ -0,0 +1,52 @@
+import type { DynamicModule, FactoryProvider } from '@nestjs/common';
+import { RsdkMetadata } from '@rsdk/metadata';
+
+import { NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE } from './constants';
+import { NatsObjectStorageModule } from './nats-object-storage.module';
+import type { NatsObjectStorageService } from './nats-object-storage.service';
+import type { ObjectStorage } from './object-storage';
+import {
+  createObjectStorageServiceToken,
+  createObjectStorageToken,
+} from './tokens.fn';
+
+export class NatsObjectStorageModuleGenerator {
+  static createClientModuleDefinition(
+    target: object,
+    bucketName: string,
+    connectionName?: string,
+  ): DynamicModule {
+    const provider = NatsObjectStorageModuleGenerator.createClientProvider(
+      bucketName,
+      connectionName,
+    );
+
+    const moduleDefinition: DynamicModule = {
+      global: true,
+      imports: [NatsObjectStorageModule.forFeature(connectionName)],
+      module: NatsObjectStorageModuleGenerator,
+      providers: [provider],
+      exports: [provider],
+    };
+
+    RsdkMetadata.add(
+      target,
+      { bucketName, connectionName },
+      NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE,
+    );
+
+    return moduleDefinition;
+  }
+
+  static createClientProvider(
+    bucketName: string,
+    connectionName?: string,
+  ): FactoryProvider {
+    return {
+      provide: createObjectStorageToken(bucketName, connectionName),
+      inject: [createObjectStorageServiceToken(connectionName)],
+      useFactory: (service: NatsObjectStorageService): Promise<ObjectStorage> =>
+        service.bind({ bucketName }),
+    };
+  }
+}