@lokalise/node-core 9.21.0 → 9.22.0

package/dist/index.d.ts

@@ -24,3 +24,5 @@ export { type FreeformRecord } from './src/common/commonTypes';
 export { type ValidationError, type CommonErrorParams, type OptionalMessageErrorParams, RequestValidationError, AccessDeniedError, EntityNotFoundError, EntityGoneError, AuthFailedError, } from './src/errors/publicErrors';
 export { waitAndRetry } from './src/utils/waitUtils';
 export * from './src/observability/observabilityTypes';
+export * from './src/utils/checksumUtils';
+export * from './src/utils/streamUtils';

package/dist/index.js

@@ -81,4 +81,6 @@ Object.defineProperty(exports, "AuthFailedError", { enumerable: true, get: funct
 var waitUtils_1 = require("./src/utils/waitUtils");
 Object.defineProperty(exports, "waitAndRetry", { enumerable: true, get: function () { return waitUtils_1.waitAndRetry; } });
 tslib_1.__exportStar(require("./src/observability/observabilityTypes"), exports);
+tslib_1.__exportStar(require("./src/utils/checksumUtils"), exports);
+tslib_1.__exportStar(require("./src/utils/streamUtils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;AAAA,oDAe8B;AAd5B,qGAAA,OAAO,OAAA;AACP,2GAAA,aAAa,OAAA;AACb,wGAAA,UAAU,OAAA;AACV,uGAAA,SAAS,OAAA;AACT,qGAAA,OAAO,OAAA;AACP,sGAAA,QAAQ,OAAA;AACR,4GAAA,cAAc,OAAA;AACd,wGAAA,UAAU,OAAA;AACV,yGAAA,WAAW,OAAA;AAKX,0GAAA,YAAY,OAAA;AAGd,oFAG+C;AAF7C,sIAAA,yBAAyB,OAAA;AAI3B,4DAImC;AAHjC,8GAAA,aAAa,OAAA;AAIf,wEAAsE;AAA7D,0HAAA,mBAAmB,OAAA;AAC5B,gEAAuF;AAA9E,wHAAA,qBAAqB,OAAA;AAAE,oHAAA,iBAAiB,OAAA;AAEjD,wDAAsD;AAA7C,0GAAA,WAAW,OAAA;AACpB,sEAA+E;AAAtE,mIAAA,6BAA6B,OAAA;AACtC,kEAAoE;AAA3D,wHAAA,oBAAoB,OAAA;AAQ7B,8CAO4B;AAJ1B,iGAAA,OAAO,OAAA;AACP,iGAAA,OAAO,OAAA;AACP,mGAAA,SAAS,OAAA;AACT,mGAAA,SAAS,OAAA;AAGX,mEAAiE;AAAxD,sHAAA,iBAAiB,OAAA;AAE1B,qDAAuF;AAA9E,mGAAA,KAAK,OAAA;AAAE,yGAAA,WAAW,OAAA;AAAE,yGAAA,WAAW,OAAA;AAAE,2GAAA,aAAa,OAAA;AACvD,uDAWgC;AAV9B,sGAAA,OAAO,OAAA;AACP,0GAAA,WAAW,OAAA;AACX,4GAAA,aAAa,OAAA;AACb,mGAAA,IAAI,OAAA;AACJ,mHAAA,oBAAoB,OAAA;AACpB,mHAAA,oBAAoB,OAAA;AACpB,+GAAA,gBAAgB,OAAA;AAChB,4GAAA,aAAa,OAAA;AACb,2HAAA,4BAA4B,OAAA;AAC5B,wGAAA,SAAS,OAAA;AAGX,mDAO8B;AAN5B,oGAAA,OAAO,OAAA;AACP,4GAAA,eAAe,OAAA;AACf,gHAAA,mBAAmB,OAAA;AACnB,qGAAA,QAAQ,OAAA;AACR,wHAAA,2BAA2B,OAAA;AAC3B,uGAAA,UAAU,OAAA;AAIZ,mDAAiF;AAAxE,yGAAA,YAAY,OAAA;AAAE,0GAAA,aAAa,OAAA;AAAE,yGAAA,YAAY,OAAA;AAElD,2EAG2C;AAFzC,kIAAA,0BAA0B,OAAA;AAC1B,0IAAA,kCAAkC,OAAA;AAUpC,sEAMwC;AALtC,uIAAA,iCAAiC,OAAA;AACjC,kIAAA,4BAA4B,OAAA;AAC5B,2IAAA,qCAAqC,OAAA;AACrC,kHAAA,YAAY,OAAA;AACZ,iIAAA,2BAA2B,OAAA;AAK7B,0DASkC;AALhC,sHAAA,sBAAsB,OAAA;AACtB,iHAAA,iBAAiB,OAAA;AACjB,mHAAA,mBAAmB,OAAA;AACnB,+GAAA,eAAe,OAAA;AACf,+GAAA,eAAe,OAAA;AAGjB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA;AAErB,iFAAsD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;AAAA,oDAe8B;AAd5B,qGAAA,OAAO,OAAA;AACP,2GAAA,aAAa,OAAA;AACb,wGAAA,UAAU,OAAA;AACV,uGAAA,SAAS,OAAA;AACT,qGAAA,OAAO,OAAA;AACP,sGAAA,QAAQ,OAAA;AACR,4GAAA,cAAc,OAAA;AACd,wGAAA,UAAU,OAAA;AACV,yGAAA,WAAW,OAAA;AAKX,0GAAA,YAAY,OAAA;AAGd,oFAG+C;AAF7C,sIAAA,yBAAyB,OAAA;AAI3B,4DAImC;AAHjC,8GAAA,aAAa,OAAA;AAIf,wEAAsE;AAA7D,0HAAA,mBAAmB,OAAA;AAC5B,gEAAuF;AAA9E,wHAAA,qBAAqB,OAAA;AAAE,oHAAA,iBAAiB,OAAA;AAEjD,wDAAsD;AAA7C,0GAAA,WAAW,OAAA;AACpB,sEAA+E;AAAtE,mIAAA,6BAA6B,OAAA;AACtC,kEAAoE;AAA3D,wHAAA,oBAAoB,OAAA;AAQ7B,8CAO4B;AAJ1B,iGAAA,OAAO,OAAA;AACP,iGAAA,OAAO,OAAA;AACP,mGAAA,SAAS,OAAA;AACT,mGAAA,SAAS,OAAA;AAGX,mEAAiE;AAAxD,sHAAA,iBAAiB,OAAA;AAE1B,qDAAuF;AAA9E,mGAAA,KAAK,OAAA;AAAE,yGAAA,WAAW,OAAA;AAAE,yGAAA,WAAW,OAAA;AAAE,2GAAA,aAAa,OAAA;AACvD,uDAWgC;AAV9B,sGAAA,OAAO,OAAA;AACP,0GAAA,WAAW,OAAA;AACX,4GAAA,aAAa,OAAA;AACb,mGAAA,IAAI,OAAA;AACJ,mHAAA,oBAAoB,OAAA;AACpB,mHAAA,oBAAoB,OAAA;AACpB,+GAAA,gBAAgB,OAAA;AAChB,4GAAA,aAAa,OAAA;AACb,2HAAA,4BAA4B,OAAA;AAC5B,wGAAA,SAAS,OAAA;AAGX,mDAO8B;AAN5B,oGAAA,OAAO,OAAA;AACP,4GAAA,eAAe,OAAA;AACf,gHAAA,mBAAmB,OAAA;AACnB,qGAAA,QAAQ,OAAA;AACR,wHAAA,2BAA2B,OAAA;AAC3B,uGAAA,UAAU,OAAA;AAIZ,mDAAiF;AAAxE,yGAAA,YAAY,OAAA;AAAE,0GAAA,aAAa,OAAA;AAAE,yGAAA,YAAY,OAAA;AAElD,2EAG2C;AAFzC,kIAAA,0BAA0B,OAAA;AAC1B,0IAAA,kCAAkC,OAAA;AAUpC,sEAMwC;AALtC,uIAAA,iCAAiC,OAAA;AACjC,kIAAA,4BAA4B,OAAA;AAC5B,2IAAA,qCAAqC,OAAA;AACrC,kHAAA,YAAY,OAAA;AACZ,iIAAA,2BAA2B,OAAA;AAK7B,0DASkC;AALhC,sHAAA,sBAAsB,OAAA;AACtB,iHAAA,iBAAiB,OAAA;AACjB,mHAAA,mBAAmB,OAAA;AACnB,+GAAA,eAAe,OAAA;AACf,+GAAA,eAAe,OAAA;AAGjB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA;AAErB,iFAAsD;AAEtD,oEAAyC;AACzC,kEAAuC"}

package/dist/src/utils/checksumUtils.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { BinaryLike } from 'node:crypto';
+import type { Readable } from 'node:stream';
+export declare function generateChecksumForBufferOrString(data: BinaryLike): string;
+export declare function generateChecksumForObject(object: object): string;
+export declare function generateChecksumForReadable(readable: Readable): Promise<string>;

package/dist/src/utils/checksumUtils.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateChecksumForReadable = exports.generateChecksumForObject = exports.generateChecksumForBufferOrString = void 0;
+const node_crypto_1 = require("node:crypto");
+const HASH_ALGORITHM = 'md5';
+function generateChecksumForBufferOrString(data) {
+    return (0, node_crypto_1.createHash)(HASH_ALGORITHM).update(data).digest('hex');
+}
+exports.generateChecksumForBufferOrString = generateChecksumForBufferOrString;
+function generateChecksumForObject(object) {
+    const objectAsString = JSON.stringify(object);
+    return generateChecksumForBufferOrString(objectAsString);
+}
+exports.generateChecksumForObject = generateChecksumForObject;
+function generateChecksumForReadable(readable) {
+    return new Promise((resolve, reject) => {
+        const hashCreator = (0, node_crypto_1.createHash)(HASH_ALGORITHM);
+        readable.on('data', function (data) {
+            if (Buffer.isBuffer(data)) {
+                hashCreator.update(data);
+            }
+            else {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                hashCreator.update(Buffer.from(data));
+            }
+        });
+        readable.on('end', function () {
+            const hash = hashCreator.digest('hex');
+            resolve(hash);
+        });
+        readable.on('error', function (err) {
+            /* c8 ignore next 1 */
+            reject(err);
+        });
+    });
+}
+exports.generateChecksumForReadable = generateChecksumForReadable;
+//# sourceMappingURL=checksumUtils.js.map

package/dist/src/utils/checksumUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checksumUtils.js","sourceRoot":"","sources":["../../../src/utils/checksumUtils.ts"],"names":[],"mappings":";;;AACA,6CAAwC;AAGxC,MAAM,cAAc,GAAG,KAAK,CAAA;AAE5B,SAAgB,iCAAiC,CAAC,IAAgB;IAChE,OAAO,IAAA,wBAAU,EAAC,cAAc,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC9D,CAAC;AAFD,8EAEC;AAED,SAAgB,yBAAyB,CAAC,MAAc;IACtD,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC7C,OAAO,iCAAiC,CAAC,cAAc,CAAC,CAAA;AAC1D,CAAC;AAHD,8DAGC;AAED,SAAgB,2BAA2B,CAAC,QAAkB;IAC5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,WAAW,GAAG,IAAA,wBAAU,EAAC,cAAc,CAAC,CAAA;QAC9C,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,IAAI;YAChC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC1B,CAAC;iBAAM,CAAC;gBACN,iEAAiE;gBACjE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;YACvC,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;YACjB,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YACtC,OAAO,CAAC,IAAI,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,GAAG;YAChC,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AArBD,kEAqBC"}

package/dist/src/utils/streamUtils.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" />
+import type { Readable } from 'node:stream';
+export type ReadableProvider = {
+    /**
+     * Guarantees to provide a new stream every time this is called, before `destroy` is invoked.
+     */
+    createStream(): Promise<Readable>;
+    /**
+     * Returns size of the persisted content
+     */
+    getContentLength(): Promise<number>;
+    /**
+     * Remove the persisted value. No new streams can be created after this is called
+     */
+    destroy(): Promise<void>;
+};
+export type PersistToFsOptions = {
+    targetFile: string;
+    sourceReadable: Readable;
+};
+export type FsReadableProviderOptions = {
+    storageFile: string;
+};
+export declare class FsReadableProvider implements ReadableProvider {
+    readonly storageFile: string;
+    constructor(options: FsReadableProviderOptions);
+    fileExists(): Promise<boolean>;
+    getContentLength(): Promise<number>;
+    createStream(): Promise<Readable>;
+    destroy(): Promise<void>;
+    protected persist(sourceReadable: Readable): Promise<void>;
+    static persistReadableToFs(options: PersistToFsOptions): Promise<FsReadableProvider>;
+}
+export declare function getReadableContentLength(readable: Readable): Promise<number>;

package/dist/src/utils/streamUtils.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReadableContentLength = exports.FsReadableProvider = void 0;
+const node_constants_1 = require("node:constants");
+const node_fs_1 = require("node:fs");
+const promises_1 = require("node:fs/promises");
+const node_stream_1 = require("node:stream");
+class FsReadableProvider {
+    storageFile;
+    constructor(options) {
+        this.storageFile = options.storageFile;
+    }
+    fileExists() {
+        return new Promise((resolve) => {
+            (0, node_fs_1.access)(this.storageFile, node_constants_1.F_OK, (err) => {
+                return resolve(!err);
+            });
+        });
+    }
+    async getContentLength() {
+        if (!(await this.fileExists())) {
+            throw new Error(`File ${this.storageFile} was already deleted.`);
+        }
+        const stats = await (0, promises_1.stat)(this.storageFile);
+        return stats.size;
+    }
+    async createStream() {
+        if (!(await this.fileExists())) {
+            throw new Error(`File ${this.storageFile} was already deleted.`);
+        }
+        return (0, node_fs_1.createReadStream)(this.storageFile);
+    }
+    async destroy() {
+        if (!(await this.fileExists())) {
+            // nothing to do here
+            return;
+        }
+        return (0, promises_1.unlink)(this.storageFile);
+    }
+    async persist(sourceReadable) {
+        const writable = (0, node_fs_1.createWriteStream)(this.storageFile);
+        return new Promise((resolve, reject) => {
+            (0, node_stream_1.pipeline)(sourceReadable, writable, (err) => {
+                if (err) {
+                    /* c8 ignore next 1 */
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    static async persistReadableToFs(options) {
+        const provider = new FsReadableProvider({
+            storageFile: options.targetFile,
+        });
+        await provider.persist(options.sourceReadable);
+        return provider;
+    }
+}
+exports.FsReadableProvider = FsReadableProvider;
+function getReadableContentLength(readable) {
+    return new Promise((resolve, reject) => {
+        let size = 0;
+        readable.on('data', (chunk) => {
+            if (typeof chunk === 'string' || Buffer.isBuffer(chunk)) {
+                size += Buffer.byteLength(chunk);
+            }
+        });
+        readable.on('end', () => {
+            resolve(size);
+        });
+        readable.on('error', (error) => {
+            /* c8 ignore next 1 */
+            reject(error);
+        });
+    });
+}
+exports.getReadableContentLength = getReadableContentLength;
+//# sourceMappingURL=streamUtils.js.map

package/dist/src/utils/streamUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamUtils.js","sourceRoot":"","sources":["../../../src/utils/streamUtils.ts"],"names":[],"mappings":";;;AAAA,mDAAqC;AACrC,qCAAqE;AACrE,+CAA+C;AAE/C,6CAAsC;AA4BtC,MAAa,kBAAkB;IACb,WAAW,CAAQ;IACnC,YAAY,OAAkC;QAC5C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;IACxC,CAAC;IAED,UAAU;QACR,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAA,gBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,qBAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBACrC,OAAO,OAAO,CAAC,CAAC,GAAG,CAAC,CAAA;YACtB,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,WAAW,uBAAuB,CAAC,CAAA;QAClE,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAC1C,OAAO,KAAK,CAAC,IAAI,CAAA;IACnB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,WAAW,uBAAuB,CAAC,CAAA;QAClE,CAAC;QAED,OAAO,IAAA,0BAAgB,EAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YAC/B,qBAAqB;YACrB,OAAM;QACR,CAAC;QAED,OAAO,IAAA,iBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACjC,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,cAAwB;QAC9C,MAAM,QAAQ,GAAG,IAAA,2BAAiB,EAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAA,sBAAQ,EAAC,cAAc,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;gBACzC,IAAI,GAAG,EAAE,CAAC;oBACR,sBAAsB;oBACtB,MAAM,CAAC,GAAG,CAAC,CAAA;gBACb,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAA;gBACX,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,mBAAmB,CACrC,OAA2B;QAE3B,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC;YACtC,WAAW,EAAE,OAAO,CAAC,UAAU;SAChC,CAAC,CAAA;QACF,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAC9C,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AA9DD,gDA8DC;AAED,SAAgB,wBAAwB,CAAC,QAAkB;IACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,IAAI,GAAG,CAAC,CAAA;QACZ,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxD,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAC,CAAA;QACF,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACtB,OAAO,CAAC,IAAI,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC7B,sBAAsB;YACtB,MAAM,CAAC,KAAK,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAhBD,4DAgBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/node-core",
-  "version": "9.21.0",
+  "version": "9.22.0",
   "author": {
     "name": "Lokalise",
     "url": "https://lokalise.com/"
@@ -43,6 +43,7 @@
   },
   "devDependencies": {
     "@types/node": "^20.12.8",
+    "@types/tmp": "^0.2.6",
     "@typescript-eslint/eslint-plugin": "^7.8.0",
     "@typescript-eslint/parser": "^7.8.0",
     "@vitest/coverage-v8": "1.6.0",
@@ -51,6 +52,7 @@
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-vitest": "0.4.1",
     "prettier": "^3.2.5",
+    "tmp": "^0.2.3",
     "typescript": "^5.4.5",
     "vitest": "1.6.0"
   }