@frictionless-ts/dataset 1.0.1

package/build/plugins/zenodo/package/load.spec.js

@@ -0,0 +1,15 @@
+import { describe, expect, it } from "vitest";
+import { useRecording } from "vitest-polly";
+import { loadPackageFromZenodo } from "./load.js";
+useRecording();
+describe("loadPackageFromZenodo", () => {
+    it("should load a package", async () => {
+        const datapackage = await loadPackageFromZenodo("https://zenodo.org/records/15525711");
+        expect(datapackage).toMatchSnapshot();
+    });
+    it("shoule merge datapackage.json if present", async () => {
+        const datapackage = await loadPackageFromZenodo("https://zenodo.org/records/10053903");
+        expect(datapackage).toMatchSnapshot();
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9hZC5zcGVjLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcGx1Z2lucy96ZW5vZG8vcGFja2FnZS9sb2FkLnNwZWMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLE1BQU0sUUFBUSxDQUFBO0FBQzdDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxjQUFjLENBQUE7QUFDM0MsT0FBTyxFQUFFLHFCQUFxQixFQUFFLE1BQU0sV0FBVyxDQUFBO0FBRWpELFlBQVksRUFBRSxDQUFBO0FBRWQsUUFBUSxDQUFDLHVCQUF1QixFQUFFLEdBQUcsRUFBRTtJQUNyQyxFQUFFLENBQUMsdUJBQXVCLEVBQUUsS0FBSyxJQUFJLEVBQUU7UUFDckMsTUFBTSxXQUFXLEdBQUcsTUFBTSxxQkFBcUIsQ0FDN0MscUNBQXFDLENBQ3RDLENBQUE7UUFFRCxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsZUFBZSxFQUFFLENBQUE7SUFDdkMsQ0FBQyxDQUFDLENBQUE7SUFFRixFQUFFLENBQUMsMENBQTBDLEVBQUUsS0FBSyxJQUFJLEVBQUU7UUFDeEQsTUFBTSxXQUFXLEdBQUcsTUFBTSxxQkFBcUIsQ0FDN0MscUNBQXFDLENBQ3RDLENBQUE7UUFFRCxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsZUFBZSxFQUFFLENBQUE7SUFDdkMsQ0FBQyxDQUFDLENBQUE7QUFDSixDQUFDLENBQUMsQ0FBQSIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGRlc2NyaWJlLCBleHBlY3QsIGl0IH0gZnJvbSBcInZpdGVzdFwiXG5pbXBvcnQgeyB1c2VSZWNvcmRpbmcgfSBmcm9tIFwidml0ZXN0LXBvbGx5XCJcbmltcG9ydCB7IGxvYWRQYWNrYWdlRnJvbVplbm9kbyB9IGZyb20gXCIuL2xvYWQudHNcIlxuXG51c2VSZWNvcmRpbmcoKVxuXG5kZXNjcmliZShcImxvYWRQYWNrYWdlRnJvbVplbm9kb1wiLCAoKSA9PiB7XG4gIGl0KFwic2hvdWxkIGxvYWQgYSBwYWNrYWdlXCIsIGFzeW5jICgpID0+IHtcbiAgICBjb25zdCBkYXRhcGFja2FnZSA9IGF3YWl0IGxvYWRQYWNrYWdlRnJvbVplbm9kbyhcbiAgICAgIFwiaHR0cHM6Ly96ZW5vZG8ub3JnL3JlY29yZHMvMTU1MjU3MTFcIixcbiAgICApXG5cbiAgICBleHBlY3QoZGF0YXBhY2thZ2UpLnRvTWF0Y2hTbmFwc2hvdCgpXG4gIH0pXG5cbiAgaXQoXCJzaG91bGUgbWVyZ2UgZGF0YXBhY2thZ2UuanNvbiBpZiBwcmVzZW50XCIsIGFzeW5jICgpID0+IHtcbiAgICBjb25zdCBkYXRhcGFja2FnZSA9IGF3YWl0IGxvYWRQYWNrYWdlRnJvbVplbm9kbyhcbiAgICAgIFwiaHR0cHM6Ly96ZW5vZG8ub3JnL3JlY29yZHMvMTAwNTM5MDNcIixcbiAgICApXG5cbiAgICBleHBlY3QoZGF0YXBhY2thZ2UpLnRvTWF0Y2hTbmFwc2hvdCgpXG4gIH0pXG59KVxuIl19

package/build/plugins/zenodo/package/save.d.ts

@@ -0,0 +1,13 @@
+import type { Package } from "@frictionless-ts/metadata";
+/**
+ * Save a package to Zenodo
+ * @param options Object containing the package to save and Zenodo API details
+ * @returns Object with the deposit URL and DOI
+ */
+export declare function savePackageToZenodo(dataPackage: Package, options: {
+    sandbox?: boolean;
+    apiKey: string;
+}): Promise<{
+    path: string;
+    datasetUrl: string;
+}>;

package/build/plugins/zenodo/package/save.js

@@ -0,0 +1,74 @@
+import { blob } from "node:stream/consumers";
+import { stringifyDescriptor } from "@frictionless-ts/metadata";
+import { convertPackageToDescriptor } from "@frictionless-ts/metadata";
+import { getPackageBasepath } from "../../../package/index.js";
+import { saveResourceFiles } from "../../../resource/index.js";
+import { loadFileStream } from "../../../stream/index.js";
+import { makeZenodoApiRequest } from "../zenodo/index.js";
+import { convertPackageToZenodo } from "./convert/toZenodo.js";
+/**
+ * Save a package to Zenodo
+ * @param options Object containing the package to save and Zenodo API details
+ * @returns Object with the deposit URL and DOI
+ */
+export async function savePackageToZenodo(dataPackage, options) {
+    const { apiKey, sandbox = false } = options;
+    const basepath = getPackageBasepath(dataPackage);
+    const newZenodoPackage = convertPackageToZenodo(dataPackage);
+    const zenodoPackage = (await makeZenodoApiRequest({
+        payload: newZenodoPackage,
+        endpoint: "/deposit/depositions",
+        method: "POST",
+        apiKey,
+        sandbox,
+    }));
+    const resourceDescriptors = [];
+    for (const resource of dataPackage.resources) {
+        if (!resource.path)
+            continue;
+        resourceDescriptors.push(await saveResourceFiles(resource, {
+            basepath,
+            withRemote: false,
+            withoutFolders: true,
+            saveFile: async (options) => {
+                const upload = {
+                    name: options.denormalizedPath,
+                    data: await blob(await loadFileStream(options.normalizedPath)),
+                };
+                // It seems that record and deposition files have different metadata
+                // structure, e.g. size vs filesize etc
+                await makeZenodoApiRequest({
+                    endpoint: `/deposit/depositions/${zenodoPackage.id}/files`,
+                    method: "POST",
+                    upload,
+                    apiKey,
+                    sandbox,
+                });
+                return options.denormalizedPath;
+            },
+        }));
+    }
+    const descriptor = {
+        ...convertPackageToDescriptor(dataPackage, { basepath }),
+        resources: resourceDescriptors,
+    };
+    for (const denormalizedPath of ["datapackage.json"]) {
+        const upload = {
+            name: denormalizedPath,
+            data: new Blob([stringifyDescriptor(descriptor)]),
+        };
+        await makeZenodoApiRequest({
+            endpoint: `/deposit/depositions/${zenodoPackage.id}/files`,
+            method: "POST",
+            upload,
+            apiKey,
+            sandbox,
+        });
+    }
+    const url = new URL(zenodoPackage.links.html);
+    return {
+        path: `${url.origin}/records/${zenodoPackage.id}/files/datapackage.json`,
+        datasetUrl: `${url.origin}/uploads/${zenodoPackage.id}`,
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2F2ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BsdWdpbnMvemVub2RvL3BhY2thZ2Uvc2F2ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsSUFBSSxFQUFFLE1BQU0sdUJBQXVCLENBQUE7QUFFNUMsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sMkJBQTJCLENBQUE7QUFDL0QsT0FBTyxFQUFFLDBCQUEwQixFQUFFLE1BQU0sMkJBQTJCLENBQUE7QUFDdEUsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sMkJBQTJCLENBQUE7QUFDOUQsT0FBTyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sNEJBQTRCLENBQUE7QUFDOUQsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLDBCQUEwQixDQUFBO0FBQ3pELE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLG9CQUFvQixDQUFBO0FBRXpELE9BQU8sRUFBRSxzQkFBc0IsRUFBRSxNQUFNLHVCQUF1QixDQUFBO0FBRTlEOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsS0FBSyxVQUFVLG1CQUFtQixDQUN2QyxXQUFvQixFQUNwQixPQUdDO0lBRUQsTUFBTSxFQUFFLE1BQU0sRUFBRSxPQUFPLEdBQUcsS0FBSyxFQUFFLEdBQUcsT0FBTyxDQUFBO0lBQzNDLE1BQU0sUUFBUSxHQUFHLGtCQUFrQixDQUFDLFdBQVcsQ0FBQyxDQUFBO0lBRWhELE1BQU0sZ0JBQWdCLEdBQUcsc0JBQXNCLENBQUMsV0FBVyxDQUFDLENBQUE7SUFDNUQsTUFBTSxhQUFhLEdBQUcsQ0FBQyxNQUFNLG9CQUFvQixDQUFDO1FBQ2hELE9BQU8sRUFBRSxnQkFBZ0I7UUFDekIsUUFBUSxFQUFFLHNCQUFzQjtRQUNoQyxNQUFNLEVBQUUsTUFBTTtRQUNkLE1BQU07UUFDTixPQUFPO0tBQ1IsQ0FBQyxDQUFrQixDQUFBO0lBRXBCLE1BQU0sbUJBQW1CLEdBQWlCLEVBQUUsQ0FBQTtJQUM1QyxLQUFLLE1BQU0sUUFBUSxJQUFJLFdBQVcsQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUM3QyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUk7WUFBRSxTQUFRO1FBRTVCLG1CQUFtQixDQUFDLElBQUksQ0FDdEIsTUFBTSxpQkFBaUIsQ0FBQyxRQUFRLEVBQUU7WUFDaEMsUUFBUTtZQUNSLFVBQVUsRUFBRSxLQUFLO1lBQ2pCLGNBQWMsRUFBRSxJQUFJO1lBQ3BCLFFBQVEsRUFBRSxLQUFLLEVBQUMsT0FBTyxFQUFDLEVBQUU7Z0JBQ3hCLE1BQU0sTUFBTSxHQUFHO29CQUNiLElBQUksRUFBRSxPQUFPLENBQUMsZ0JBQWdCO29CQUM5QixJQUFJLEVBQUUsTUFBTSxJQUFJLENBQUMsTUFBTSxjQUFjLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUFDO2lCQUMvRCxDQUFBO2dCQUVELG9FQUFvRTtnQkFDcEUsdUNBQXVDO2dCQUN2QyxNQUFNLG9CQUFvQixDQUFDO29CQUN6QixRQUFRLEVBQUUsd0JBQXdCLGFBQWEsQ0FBQyxFQUFFLFFBQVE7b0JBQzFELE1BQU0sRUFBRSxNQUFNO29CQUNkLE1BQU07b0JBQ04sTUFBTTtvQkFDTixPQUFPO2lCQUNSLENBQUMsQ0FBQTtnQkFFRixPQUFPLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQTtZQUNqQyxDQUFDO1NBQ0YsQ0FBQyxDQUNILENBQUE7SUFDSCxDQUFDO0lBRUQsTUFBTSxVQUFVLEdBQUc7UUFDakIsR0FBRywwQkFBMEIsQ0FBQyxXQUFXLEVBQUUsRUFBRSxRQUFRLEVBQUUsQ0FBQztRQUN4RCxTQUFTLEVBQUUsbUJBQW1CO0tBQy9CLENBQUE7SUFFRCxLQUFLLE1BQU0sZ0JBQWdCLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxFQUFFLENBQUM7UUFDcEQsTUFBTSxNQUFNLEdBQUc7WUFDYixJQUFJLEVBQUUsZ0JBQWdCO1lBQ3RCLElBQUksRUFBRSxJQUFJLElBQUksQ0FBQyxDQUFDLG1CQUFtQixDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUM7U0FDbEQsQ0FBQTtRQUVELE1BQU0sb0JBQW9CLENBQUM7WUFDekIsUUFBUSxFQUFFLHdCQUF3QixhQUFhLENBQUMsRUFBRSxRQUFRO1lBQzFELE1BQU0sRUFBRSxNQUFNO1lBQ2QsTUFBTTtZQUNOLE1BQU07WUFDTixPQUFPO1NBQ1IsQ0FBQyxDQUFBO0lBQ0osQ0FBQztJQUVELE1BQU0sR0FBRyxHQUFHLElBQUksR0FBRyxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUE7SUFDN0MsT0FBTztRQUNMLElBQUksRUFBRSxHQUFHLEdBQUcsQ0FBQyxNQUFNLFlBQVksYUFBYSxDQUFDLEVBQUUseUJBQXlCO1FBQ3hFLFVBQVUsRUFBRSxHQUFHLEdBQUcsQ0FBQyxNQUFNLFlBQVksYUFBYSxDQUFDLEVBQUUsRUFBRTtLQUN4RCxDQUFBO0FBQ0gsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGJsb2IgfSBmcm9tIFwibm9kZTpzdHJlYW0vY29uc3VtZXJzXCJcbmltcG9ydCB0eXBlIHsgRGVzY3JpcHRvciwgUGFja2FnZSB9IGZyb20gXCJAZnJpY3Rpb25sZXNzLXRzL21ldGFkYXRhXCJcbmltcG9ydCB7IHN0cmluZ2lmeURlc2NyaXB0b3IgfSBmcm9tIFwiQGZyaWN0aW9ubGVzcy10cy9tZXRhZGF0YVwiXG5pbXBvcnQgeyBjb252ZXJ0UGFja2FnZVRvRGVzY3JpcHRvciB9IGZyb20gXCJAZnJpY3Rpb25sZXNzLXRzL21ldGFkYXRhXCJcbmltcG9ydCB7IGdldFBhY2thZ2VCYXNlcGF0aCB9IGZyb20gXCIuLi8uLi8uLi9wYWNrYWdlL2luZGV4LnRzXCJcbmltcG9ydCB7IHNhdmVSZXNvdXJjZUZpbGVzIH0gZnJvbSBcIi4uLy4uLy4uL3Jlc291cmNlL2luZGV4LnRzXCJcbmltcG9ydCB7IGxvYWRGaWxlU3RyZWFtIH0gZnJvbSBcIi4uLy4uLy4uL3N0cmVhbS9pbmRleC50c1wiXG5pbXBvcnQgeyBtYWtlWmVub2RvQXBpUmVxdWVzdCB9IGZyb20gXCIuLi96ZW5vZG8vaW5kZXgudHNcIlxuaW1wb3J0IHR5cGUgeyBaZW5vZG9QYWNrYWdlIH0gZnJvbSBcIi4vUGFja2FnZS50c1wiXG5pbXBvcnQgeyBjb252ZXJ0UGFja2FnZVRvWmVub2RvIH0gZnJvbSBcIi4vY29udmVydC90b1plbm9kby50c1wiXG5cbi8qKlxuICogU2F2ZSBhIHBhY2thZ2UgdG8gWmVub2RvXG4gKiBAcGFyYW0gb3B0aW9ucyBPYmplY3QgY29udGFpbmluZyB0aGUgcGFja2FnZSB0byBzYXZlIGFuZCBaZW5vZG8gQVBJIGRldGFpbHNcbiAqIEByZXR1cm5zIE9iamVjdCB3aXRoIHRoZSBkZXBvc2l0IFVSTCBhbmQgRE9JXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBzYXZlUGFja2FnZVRvWmVub2RvKFxuICBkYXRhUGFja2FnZTogUGFja2FnZSxcbiAgb3B0aW9uczoge1xuICAgIHNhbmRib3g/OiBib29sZWFuXG4gICAgYXBpS2V5OiBzdHJpbmdcbiAgfSxcbikge1xuICBjb25zdCB7IGFwaUtleSwgc2FuZGJveCA9IGZhbHNlIH0gPSBvcHRpb25zXG4gIGNvbnN0IGJhc2VwYXRoID0gZ2V0UGFja2FnZUJhc2VwYXRoKGRhdGFQYWNrYWdlKVxuXG4gIGNvbnN0IG5ld1plbm9kb1BhY2thZ2UgPSBjb252ZXJ0UGFja2FnZVRvWmVub2RvKGRhdGFQYWNrYWdlKVxuICBjb25zdCB6ZW5vZG9QYWNrYWdlID0gKGF3YWl0IG1ha2VaZW5vZG9BcGlSZXF1ZXN0KHtcbiAgICBwYXlsb2FkOiBuZXdaZW5vZG9QYWNrYWdlLFxuICAgIGVuZHBvaW50OiBcIi9kZXBvc2l0L2RlcG9zaXRpb25zXCIsXG4gICAgbWV0aG9kOiBcIlBPU1RcIixcbiAgICBhcGlLZXksXG4gICAgc2FuZGJveCxcbiAgfSkpIGFzIFplbm9kb1BhY2thZ2VcblxuICBjb25zdCByZXNvdXJjZURlc2NyaXB0b3JzOiBEZXNjcmlwdG9yW10gPSBbXVxuICBmb3IgKGNvbnN0IHJlc291cmNlIG9mIGRhdGFQYWNrYWdlLnJlc291cmNlcykge1xuICAgIGlmICghcmVzb3VyY2UucGF0aCkgY29udGludWVcblxuICAgIHJlc291cmNlRGVzY3JpcHRvcnMucHVzaChcbiAgICAgIGF3YWl0IHNhdmVSZXNvdXJjZUZpbGVzKHJlc291cmNlLCB7XG4gICAgICAgIGJhc2VwYXRoLFxuICAgICAgICB3aXRoUmVtb3RlOiBmYWxzZSxcbiAgICAgICAgd2l0aG91dEZvbGRlcnM6IHRydWUsXG4gICAgICAgIHNhdmVGaWxlOiBhc3luYyBvcHRpb25zID0+IHtcbiAgICAgICAgICBjb25zdCB1cGxvYWQgPSB7XG4gICAgICAgICAgICBuYW1lOiBvcHRpb25zLmRlbm9ybWFsaXplZFBhdGgsXG4gICAgICAgICAgICBkYXRhOiBhd2FpdCBibG9iKGF3YWl0IGxvYWRGaWxlU3RyZWFtKG9wdGlvbnMubm9ybWFsaXplZFBhdGgpKSxcbiAgICAgICAgICB9XG5cbiAgICAgICAgICAvLyBJdCBzZWVtcyB0aGF0IHJlY29yZCBhbmQgZGVwb3NpdGlvbiBmaWxlcyBoYXZlIGRpZmZlcmVudCBtZXRhZGF0YVxuICAgICAgICAgIC8vIHN0cnVjdHVyZSwgZS5nLiBzaXplIHZzIGZpbGVzaXplIGV0Y1xuICAgICAgICAgIGF3YWl0IG1ha2VaZW5vZG9BcGlSZXF1ZXN0KHtcbiAgICAgICAgICAgIGVuZHBvaW50OiBgL2RlcG9zaXQvZGVwb3NpdGlvbnMvJHt6ZW5vZG9QYWNrYWdlLmlkfS9maWxlc2AsXG4gICAgICAgICAgICBtZXRob2Q6IFwiUE9TVFwiLFxuICAgICAgICAgICAgdXBsb2FkLFxuICAgICAgICAgICAgYXBpS2V5LFxuICAgICAgICAgICAgc2FuZGJveCxcbiAgICAgICAgICB9KVxuXG4gICAgICAgICAgcmV0dXJuIG9wdGlvbnMuZGVub3JtYWxpemVkUGF0aFxuICAgICAgICB9LFxuICAgICAgfSksXG4gICAgKVxuICB9XG5cbiAgY29uc3QgZGVzY3JpcHRvciA9IHtcbiAgICAuLi5jb252ZXJ0UGFja2FnZVRvRGVzY3JpcHRvcihkYXRhUGFja2FnZSwgeyBiYXNlcGF0aCB9KSxcbiAgICByZXNvdXJjZXM6IHJlc291cmNlRGVzY3JpcHRvcnMsXG4gIH1cblxuICBmb3IgKGNvbnN0IGRlbm9ybWFsaXplZFBhdGggb2YgW1wiZGF0YXBhY2thZ2UuanNvblwiXSkge1xuICAgIGNvbnN0IHVwbG9hZCA9IHtcbiAgICAgIG5hbWU6IGRlbm9ybWFsaXplZFBhdGgsXG4gICAgICBkYXRhOiBuZXcgQmxvYihbc3RyaW5naWZ5RGVzY3JpcHRvcihkZXNjcmlwdG9yKV0pLFxuICAgIH1cblxuICAgIGF3YWl0IG1ha2VaZW5vZG9BcGlSZXF1ZXN0KHtcbiAgICAgIGVuZHBvaW50OiBgL2RlcG9zaXQvZGVwb3NpdGlvbnMvJHt6ZW5vZG9QYWNrYWdlLmlkfS9maWxlc2AsXG4gICAgICBtZXRob2Q6IFwiUE9TVFwiLFxuICAgICAgdXBsb2FkLFxuICAgICAgYXBpS2V5LFxuICAgICAgc2FuZGJveCxcbiAgICB9KVxuICB9XG5cbiAgY29uc3QgdXJsID0gbmV3IFVSTCh6ZW5vZG9QYWNrYWdlLmxpbmtzLmh0bWwpXG4gIHJldHVybiB7XG4gICAgcGF0aDogYCR7dXJsLm9yaWdpbn0vcmVjb3Jkcy8ke3plbm9kb1BhY2thZ2UuaWR9L2ZpbGVzL2RhdGFwYWNrYWdlLmpzb25gLFxuICAgIGRhdGFzZXRVcmw6IGAke3VybC5vcmlnaW59L3VwbG9hZHMvJHt6ZW5vZG9QYWNrYWdlLmlkfWAsXG4gIH1cbn1cbiJdfQ==

package/build/plugins/zenodo/package/save.spec.d.ts

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