npm - @data-fair/lib-node-registry - Versions diffs - 0.1.1 → 0.1.3 - Mend

@data-fair/lib-node-registry 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/index.d.ts ADDED Viewed

@@ -0,0 +1,28 @@
+import type { Readable } from 'node:stream';
+export interface EnsureArtefactOpts {
+    registryUrl: string;
+    secretKey: string;
+    artefactId: string;
+    version: string;
+    cacheDir: string;
+}
+export interface EnsureArtefactResult {
+    path: string;
+    version: string;
+    downloaded: boolean;
+}
+export declare function ensureArtefact(opts: EnsureArtefactOpts): Promise<EnsureArtefactResult>;
+export interface EnsureArtefactFileOpts {
+    registryUrl: string;
+    secretKey: string;
+    artefactId: string;
+    cacheDir: string;
+    /** defaults to artefactId */
+    fileName?: string;
+}
+export interface EnsureArtefactFileResult {
+    path: string;
+    downloaded: boolean;
+}
+export declare function ensureArtefactFile(opts: EnsureArtefactFileOpts): Promise<EnsureArtefactFileResult>;
+export declare function extractTarball(stream: Readable, destDir: string): Promise<void>;

package/index.js ADDED Viewed

@@ -0,0 +1,134 @@
+import { createGunzip } from 'node:zlib';
+import { pipeline } from 'node:stream/promises';
+import { createWriteStream } from 'node:fs';
+import { mkdir, readFile, writeFile, rm, rename, stat, utimes } from 'node:fs/promises';
+import { join, dirname } from 'node:path';
+import * as tar from 'tar-stream';
+import resolvePath from 'resolve-path';
+import { axiosBuilder } from '@data-fair/lib-node/axios.js';
+export async function ensureArtefact(opts) {
+    const ax = axiosBuilder({
+        baseURL: opts.registryUrl,
+        headers: { 'x-secret-key': opts.secretKey }
+    });
+    const encodedId = encodeURIComponent(opts.artefactId);
+    const versionRes = await ax.get(`/api/v1/artefacts/${encodedId}/versions/${opts.version}`);
+    const resolvedVersion = versionRes.data.version;
+    const artefactDir = join(opts.cacheDir, opts.artefactId);
+    const metaPath = join(artefactDir, '.current-version.json');
+    const extractDir = join(artefactDir, resolvedVersion);
+    // Check cache
+    try {
+        const raw = await readFile(metaPath, 'utf-8');
+        const meta = JSON.parse(raw);
+        if (meta.version === resolvedVersion) {
+            return { path: extractDir, version: resolvedVersion, downloaded: false };
+        }
+    }
+    catch {
+        // no cache or invalid metadata
+    }
+    // Download tarball
+    const tarballRes = await ax.get(`/api/v1/artefacts/${encodedId}/versions/${resolvedVersion}/tarball`, { responseType: 'stream' });
+    // Extract to temp dir then atomic rename
+    const tmpDir = `${extractDir}.tmp.${process.pid}`;
+    await rm(tmpDir, { recursive: true, force: true });
+    await mkdir(tmpDir, { recursive: true });
+    try {
+        await extractTarball(tarballRes.data, tmpDir);
+    }
+    catch (err) {
+        await rm(tmpDir, { recursive: true, force: true });
+        throw err;
+    }
+    await rm(extractDir, { recursive: true, force: true });
+    await rename(tmpDir, extractDir);
+    // Clean up old version
+    try {
+        const raw = await readFile(metaPath, 'utf-8');
+        const oldMeta = JSON.parse(raw);
+        if (oldMeta.version !== resolvedVersion) {
+            await rm(join(artefactDir, oldMeta.version), { recursive: true, force: true });
+        }
+    }
+    catch {
+        // no old version to clean
+    }
+    // Write cache metadata
+    await writeFile(metaPath, JSON.stringify({ version: resolvedVersion }));
+    return { path: extractDir, version: resolvedVersion, downloaded: true };
+}
+export async function ensureArtefactFile(opts) {
+    const ax = axiosBuilder({
+        baseURL: opts.registryUrl,
+        headers: { 'x-secret-key': opts.secretKey }
+    });
+    const destPath = join(opts.cacheDir, opts.fileName ?? opts.artefactId);
+    let prevMtime;
+    try {
+        const st = await stat(destPath);
+        prevMtime = st.mtime;
+    }
+    catch { /* cold cache */ }
+    const headers = {};
+    if (prevMtime)
+        headers['if-modified-since'] = prevMtime.toUTCString();
+    const res = await ax.get(`/api/v1/artefacts/${encodeURIComponent(opts.artefactId)}/download`, { responseType: 'stream', headers, validateStatus: s => s === 200 || s === 304 });
+    if (res.status === 304) {
+        ;
+        res.data.destroy();
+        return { path: destPath, downloaded: false };
+    }
+    await mkdir(dirname(destPath), { recursive: true });
+    const tmpPath = `${destPath}.tmp.${process.pid}`;
+    await rm(tmpPath, { force: true });
+    try {
+        await pipeline(res.data, createWriteStream(tmpPath));
+    }
+    catch (err) {
+        await rm(tmpPath, { force: true });
+        throw err;
+    }
+    await rename(tmpPath, destPath);
+    const lastModified = res.headers['last-modified'];
+    if (lastModified) {
+        const mtime = new Date(lastModified);
+        if (!isNaN(mtime.getTime())) {
+            await utimes(destPath, new Date(), mtime);
+        }
+    }
+    return { path: destPath, downloaded: true };
+}
+export async function extractTarball(stream, destDir) {
+    const extract = tar.extract();
+    const entries = [];
+    extract.on('entry', (header, entryStream, next) => {
+        // npm tarballs prefix entries with "package/"
+        const entryPath = header.name.replace(/^package\//, '');
+        if (header.type === 'directory') {
+            entries.push(mkdir(resolvePath(destDir, entryPath), { recursive: true }).then(() => { }));
+            entryStream.resume();
+            entryStream.on('end', next);
+        }
+        else if (header.type === 'file') {
+            const fullPath = resolvePath(destDir, entryPath);
+            const p = mkdir(dirname(fullPath), { recursive: true }).then(() => {
+                return new Promise((resolve, reject) => {
+                    const ws = createWriteStream(fullPath);
+                    entryStream.pipe(ws);
+                    ws.on('finish', resolve);
+                    ws.on('error', reject);
+                });
+            });
+            entries.push(p);
+            entryStream.on('end', next);
+        }
+        else {
+            entryStream.resume();
+            entryStream.on('end', next);
+        }
+    });
+    await pipeline(stream, createGunzip(), extract);
+    await Promise.all(entries);
+}
+//# sourceMappingURL=index.js.map

package/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACvF,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,GAAG,MAAM,YAAY,CAAA;AACjC,OAAO,WAAW,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAqB3D,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,IAAwB;IAC5D,MAAM,EAAE,GAAG,YAAY,CAAC;QACtB,OAAO,EAAE,IAAI,CAAC,WAAW;QACzB,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,SAAS,EAAE;KAC5C,CAAC,CAAA;IAEF,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACrD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,qBAAqB,SAAS,aAAa,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IAC1F,MAAM,eAAe,GAAW,UAAU,CAAC,IAAI,CAAC,OAAO,CAAA;IAEvD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAA;IAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;IAErD,cAAc;IACd,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC7C,MAAM,IAAI,GAAc,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,IAAI,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;YACrC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;QAC1E,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,+BAA+B;IACjC,CAAC;IAED,mBAAmB;IACnB,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,GAAG,CAC7B,qBAAqB,SAAS,aAAa,eAAe,UAAU,EACpE,EAAE,YAAY,EAAE,QAAQ,EAAE,CAC3B,CAAA;IAED,yCAAyC;IACzC,MAAM,MAAM,GAAG,GAAG,UAAU,QAAQ,OAAO,CAAC,GAAG,EAAE,CAAA;IACjD,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAClD,MAAM,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACxC,IAAI,CAAC;QACH,MAAM,cAAc,CAAC,UAAU,CAAC,IAAgB,EAAE,MAAM,CAAC,CAAA;IAC3D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,MAAM,GAAG,CAAA;IACX,CAAC;IACD,MAAM,EAAE,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACtD,MAAM,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAEhC,uBAAuB;IACvB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC7C,MAAM,OAAO,GAAc,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC1C,IAAI,OAAO,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;YACxC,MAAM,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAChF,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,0BAA0B;IAC5B,CAAC;IAED,uBAAuB;IACvB,MAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,eAAe,EAAsB,CAAC,CAAC,CAAA;IAE3F,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACzE,CAAC;AAgBD,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAE,IAA4B;IACpE,MAAM,EAAE,GAAG,YAAY,CAAC;QACtB,OAAO,EAAE,IAAI,CAAC,WAAW;QACzB,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,SAAS,EAAE;KAC5C,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAA;IAEtE,IAAI,SAA2B,CAAA;IAC/B,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC/B,SAAS,GAAG,EAAE,CAAC,KAAK,CAAA;IACtB,CAAC;IAAC,MAAM,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAE5B,MAAM,OAAO,GAA2B,EAAE,CAAA;IAC1C,IAAI,SAAS;QAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC,WAAW,EAAE,CAAA;IAErE,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,GAAG,CACtB,qBAAqB,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EACnE,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CACjF,CAAA;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QACvB,CAAC;QAAC,GAAG,CAAC,IAAiB,CAAC,OAAO,EAAE,CAAA;QACjC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;IAC9C,CAAC;IAED,MAAM,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACnD,MAAM,OAAO,GAAG,GAAG,QAAQ,QAAQ,OAAO,CAAC,GAAG,EAAE,CAAA;IAChD,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAClC,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,GAAG,CAAC,IAAgB,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAA;IAClE,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAClC,MAAM,GAAG,CAAA;IACX,CAAC;IACD,MAAM,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE/B,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IACjD,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,CAAA;QACpC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YAC5B,MAAM,MAAM,CAAC,QAAQ,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AAC7C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,MAAgB,EAAE,OAAe;IACrE,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,CAAA;IAE7B,MAAM,OAAO,GAAoB,EAAE,CAAA;IAEnC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QAChD,8CAA8C;QAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;QAEvD,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAA;YACxF,WAAW,CAAC,MAAM,EAAE,CAAA;YACpB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAC7B,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAChD,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChE,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC3C,MAAM,EAAE,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAA;oBACtC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;oBACpB,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;oBACxB,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;gBACxB,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACf,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAC7B,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,MAAM,EAAE,CAAA;YACpB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,OAAO,CAAC,CAAA;IAC/C,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC","sourcesContent":["import { createGunzip } from 'node:zlib'\nimport { pipeline } from 'node:stream/promises'\nimport { createWriteStream } from 'node:fs'\nimport { mkdir, readFile, writeFile, rm, rename, stat, utimes } from 'node:fs/promises'\nimport { join, dirname } from 'node:path'\nimport * as tar from 'tar-stream'\nimport resolvePath from 'resolve-path'\nimport { axiosBuilder } from '@data-fair/lib-node/axios.js'\nimport type { Readable } from 'node:stream'\n\nexport interface EnsureArtefactOpts {\n registryUrl: string\n secretKey: string\n artefactId: string\n version: string\n cacheDir: string\n}\n\nexport interface EnsureArtefactResult {\n path: string\n version: string\n downloaded: boolean\n}\n\ninterface CacheMeta {\n version: string\n}\n\nexport async function ensureArtefact (opts: EnsureArtefactOpts): Promise<EnsureArtefactResult> {\n const ax = axiosBuilder({\n baseURL: opts.registryUrl,\n headers: { 'x-secret-key': opts.secretKey }\n })\n\n const encodedId = encodeURIComponent(opts.artefactId)\n const versionRes = await ax.get(`/api/v1/artefacts/${encodedId}/versions/${opts.version}`)\n const resolvedVersion: string = versionRes.data.version\n\n const artefactDir = join(opts.cacheDir, opts.artefactId)\n const metaPath = join(artefactDir, '.current-version.json')\n const extractDir = join(artefactDir, resolvedVersion)\n\n // Check cache\n try {\n const raw = await readFile(metaPath, 'utf-8')\n const meta: CacheMeta = JSON.parse(raw)\n if (meta.version === resolvedVersion) {\n return { path: extractDir, version: resolvedVersion, downloaded: false }\n }\n } catch {\n // no cache or invalid metadata\n }\n\n // Download tarball\n const tarballRes = await ax.get(\n `/api/v1/artefacts/${encodedId}/versions/${resolvedVersion}/tarball`,\n { responseType: 'stream' }\n )\n\n // Extract to temp dir then atomic rename\n const tmpDir = `${extractDir}.tmp.${process.pid}`\n await rm(tmpDir, { recursive: true, force: true })\n await mkdir(tmpDir, { recursive: true })\n try {\n await extractTarball(tarballRes.data as Readable, tmpDir)\n } catch (err) {\n await rm(tmpDir, { recursive: true, force: true })\n throw err\n }\n await rm(extractDir, { recursive: true, force: true })\n await rename(tmpDir, extractDir)\n\n // Clean up old version\n try {\n const raw = await readFile(metaPath, 'utf-8')\n const oldMeta: CacheMeta = JSON.parse(raw)\n if (oldMeta.version !== resolvedVersion) {\n await rm(join(artefactDir, oldMeta.version), { recursive: true, force: true })\n }\n } catch {\n // no old version to clean\n }\n\n // Write cache metadata\n await writeFile(metaPath, JSON.stringify({ version: resolvedVersion } satisfies CacheMeta))\n\n return { path: extractDir, version: resolvedVersion, downloaded: true }\n}\n\nexport interface EnsureArtefactFileOpts {\n registryUrl: string\n secretKey: string\n artefactId: string\n cacheDir: string\n /** defaults to artefactId */\n fileName?: string\n}\n\nexport interface EnsureArtefactFileResult {\n path: string\n downloaded: boolean\n}\n\nexport async function ensureArtefactFile (opts: EnsureArtefactFileOpts): Promise<EnsureArtefactFileResult> {\n const ax = axiosBuilder({\n baseURL: opts.registryUrl,\n headers: { 'x-secret-key': opts.secretKey }\n })\n\n const destPath = join(opts.cacheDir, opts.fileName ?? opts.artefactId)\n\n let prevMtime: Date | undefined\n try {\n const st = await stat(destPath)\n prevMtime = st.mtime\n } catch { /* cold cache */ }\n\n const headers: Record<string, string> = {}\n if (prevMtime) headers['if-modified-since'] = prevMtime.toUTCString()\n\n const res = await ax.get(\n `/api/v1/artefacts/${encodeURIComponent(opts.artefactId)}/download`,\n { responseType: 'stream', headers, validateStatus: s => s === 200 || s === 304 }\n )\n\n if (res.status === 304) {\n ;(res.data as Readable).destroy()\n return { path: destPath, downloaded: false }\n }\n\n await mkdir(dirname(destPath), { recursive: true })\n const tmpPath = `${destPath}.tmp.${process.pid}`\n await rm(tmpPath, { force: true })\n try {\n await pipeline(res.data as Readable, createWriteStream(tmpPath))\n } catch (err) {\n await rm(tmpPath, { force: true })\n throw err\n }\n await rename(tmpPath, destPath)\n\n const lastModified = res.headers['last-modified']\n if (lastModified) {\n const mtime = new Date(lastModified)\n if (!isNaN(mtime.getTime())) {\n await utimes(destPath, new Date(), mtime)\n }\n }\n\n return { path: destPath, downloaded: true }\n}\n\nexport async function extractTarball (stream: Readable, destDir: string): Promise<void> {\n const extract = tar.extract()\n\n const entries: Promise<void>[] = []\n\n extract.on('entry', (header, entryStream, next) => {\n // npm tarballs prefix entries with \"package/\"\n const entryPath = header.name.replace(/^package\\//, '')\n\n if (header.type === 'directory') {\n entries.push(mkdir(resolvePath(destDir, entryPath), { recursive: true }).then(() => {}))\n entryStream.resume()\n entryStream.on('end', next)\n } else if (header.type === 'file') {\n const fullPath = resolvePath(destDir, entryPath)\n const p = mkdir(dirname(fullPath), { recursive: true }).then(() => {\n return new Promise<void>((resolve, reject) => {\n const ws = createWriteStream(fullPath)\n entryStream.pipe(ws)\n ws.on('finish', resolve)\n ws.on('error', reject)\n })\n })\n entries.push(p)\n entryStream.on('end', next)\n } else {\n entryStream.resume()\n entryStream.on('end', next)\n }\n })\n\n await pipeline(stream, createGunzip(), extract)\n await Promise.all(entries)\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,15 +1,22 @@
 {
   "name": "@data-fair/lib-node-registry",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Node.js client library for the data-fair registry service.",
   "type": "module",
   "license": "MIT",
+  "main": "index.js",
   "exports": {
-    ".": "./index.ts"
+    ".": "./index.js"
   },
   "files": [
-    "*.ts"
+    "**/*.js",
+    "**/*.js.map",
+    "**/*.d.ts"
   ],
+  "scripts": {
+    "prepublishOnly": "cd .. && npm run build-lib-node",
+    "build": "cd .. && npm run build-lib-node"
+  },
   "peerDependencies": {
     "@data-fair/lib-node": ">=2.8.0"
   },

package/index.ts DELETED Viewed

@@ -1,185 +0,0 @@
-import { createGunzip } from 'node:zlib'
-import { pipeline } from 'node:stream/promises'
-import { createWriteStream } from 'node:fs'
-import { mkdir, readFile, writeFile, rm, rename, stat, utimes } from 'node:fs/promises'
-import { join, dirname } from 'node:path'
-import * as tar from 'tar-stream'
-import resolvePath from 'resolve-path'
-import { axiosBuilder } from '@data-fair/lib-node/axios.js'
-import type { Readable } from 'node:stream'
-export interface EnsureArtefactOpts {
-  registryUrl: string
-  secretKey: string
-  artefactId: string
-  version: string
-  cacheDir: string
-}
-export interface EnsureArtefactResult {
-  path: string
-  version: string
-  downloaded: boolean
-}
-interface CacheMeta {
-  version: string
-}
-export async function ensureArtefact (opts: EnsureArtefactOpts): Promise<EnsureArtefactResult> {
-  const ax = axiosBuilder({
-    baseURL: opts.registryUrl,
-    headers: { 'x-secret-key': opts.secretKey }
-  })
-  const encodedId = encodeURIComponent(opts.artefactId)
-  const versionRes = await ax.get(`/api/v1/artefacts/${encodedId}/versions/${opts.version}`)
-  const resolvedVersion: string = versionRes.data.version
-  const artefactDir = join(opts.cacheDir, opts.artefactId)
-  const metaPath = join(artefactDir, '.current-version.json')
-  const extractDir = join(artefactDir, resolvedVersion)
-  // Check cache
-  try {
-    const raw = await readFile(metaPath, 'utf-8')
-    const meta: CacheMeta = JSON.parse(raw)
-    if (meta.version === resolvedVersion) {
-      return { path: extractDir, version: resolvedVersion, downloaded: false }
-    }
-  } catch {
-    // no cache or invalid metadata
-  }
-  // Download tarball
-  const tarballRes = await ax.get(
-    `/api/v1/artefacts/${encodedId}/versions/${resolvedVersion}/tarball`,
-    { responseType: 'stream' }
-  )
-  // Extract to temp dir then atomic rename
-  const tmpDir = `${extractDir}.tmp.${process.pid}`
-  await rm(tmpDir, { recursive: true, force: true })
-  await mkdir(tmpDir, { recursive: true })
-  try {
-    await extractTarball(tarballRes.data as Readable, tmpDir)
-  } catch (err) {
-    await rm(tmpDir, { recursive: true, force: true })
-    throw err
-  }
-  await rm(extractDir, { recursive: true, force: true })
-  await rename(tmpDir, extractDir)
-  // Clean up old version
-  try {
-    const raw = await readFile(metaPath, 'utf-8')
-    const oldMeta: CacheMeta = JSON.parse(raw)
-    if (oldMeta.version !== resolvedVersion) {
-      await rm(join(artefactDir, oldMeta.version), { recursive: true, force: true })
-    }
-  } catch {
-    // no old version to clean
-  }
-  // Write cache metadata
-  await writeFile(metaPath, JSON.stringify({ version: resolvedVersion } satisfies CacheMeta))
-  return { path: extractDir, version: resolvedVersion, downloaded: true }
-}
-export interface EnsureArtefactFileOpts {
-  registryUrl: string
-  secretKey: string
-  artefactId: string
-  cacheDir: string
-  /** defaults to artefactId */
-  fileName?: string
-}
-export interface EnsureArtefactFileResult {
-  path: string
-  downloaded: boolean
-}
-export async function ensureArtefactFile (opts: EnsureArtefactFileOpts): Promise<EnsureArtefactFileResult> {
-  const ax = axiosBuilder({
-    baseURL: opts.registryUrl,
-    headers: { 'x-secret-key': opts.secretKey }
-  })
-  const destPath = join(opts.cacheDir, opts.fileName ?? opts.artefactId)
-  let prevMtime: Date | undefined
-  try {
-    const st = await stat(destPath)
-    prevMtime = st.mtime
-  } catch { /* cold cache */ }
-  const headers: Record<string, string> = {}
-  if (prevMtime) headers['if-modified-since'] = prevMtime.toUTCString()
-  const res = await ax.get(
-    `/api/v1/artefacts/${encodeURIComponent(opts.artefactId)}/download`,
-    { responseType: 'stream', headers, validateStatus: s => s === 200 || s === 304 }
-  )
-  if (res.status === 304) {
-    return { path: destPath, downloaded: false }
-  }
-  await mkdir(dirname(destPath), { recursive: true })
-  const tmpPath = `${destPath}.tmp.${process.pid}`
-  await rm(tmpPath, { force: true })
-  try {
-    await pipeline(res.data as Readable, createWriteStream(tmpPath))
-  } catch (err) {
-    await rm(tmpPath, { force: true })
-    throw err
-  }
-  await rename(tmpPath, destPath)
-  const lastModified = res.headers['last-modified']
-  if (lastModified) {
-    const mtime = new Date(lastModified)
-    if (!isNaN(mtime.getTime())) {
-      await utimes(destPath, new Date(), mtime)
-    }
-  }
-  return { path: destPath, downloaded: true }
-}
-export async function extractTarball (stream: Readable, destDir: string): Promise<void> {
-  const extract = tar.extract()
-  const entries: Promise<void>[] = []
-  extract.on('entry', (header, entryStream, next) => {
-    // npm tarballs prefix entries with "package/"
-    const entryPath = header.name.replace(/^package\//, '')
-    if (header.type === 'directory') {
-      entries.push(mkdir(resolvePath(destDir, entryPath), { recursive: true }).then(() => {}))
-      entryStream.resume()
-      entryStream.on('end', next)
-    } else if (header.type === 'file') {
-      const fullPath = resolvePath(destDir, entryPath)
-      const p = mkdir(dirname(fullPath), { recursive: true }).then(() => {
-        return new Promise<void>((resolve, reject) => {
-          const ws = createWriteStream(fullPath)
-          entryStream.pipe(ws)
-          ws.on('finish', resolve)
-          ws.on('error', reject)
-        })
-      })
-      entries.push(p)
-      entryStream.on('end', next)
-    } else {
-      entryStream.resume()
-      entryStream.on('end', next)
-    }
-  })
-  await pipeline(stream, createGunzip(), extract)
-  await Promise.all(entries)
-}