kubo-rpc-client/dist/src/lib/multipart-request.node.js

A client library for the Kubo RPC API

import { logger } from '@libp2p/logger';
import itPeekable from 'it-peekable';
// @ts-expect-error no types
import toStream from 'it-to-stream';
import mergeOpts from 'merge-options';
import { nanoid } from 'nanoid';
import { normaliseInput } from './files/normalise-input-multiple.js';
import { modeToString } from './mode-to-string.js';
const merge = mergeOpts.bind({ ignoreUndefined: true });
const log = logger('ipfs:core-utils:multipart-request');
/**
 * @typedef {import('ipfs-core-types/src/utils').ImportCandidateStream} ImportCandidateStream
 */
/**
 * @param {ImportCandidateStream} source
 * @param {AbortController} abortController
 * @param {Headers|Record<string, string>} [headers]
 * @param {string} [boundary]
 */
export async function multipartRequest(source, abortController, headers = {}, boundary = `-----------------------------${nanoid()}`) {
    async function* streamFiles(source) {
        try {
            let index = 0;
            // @ts-expect-error source may not be async iterable
            for await (const { content, path, mode, mtime } of source) {
                let fileSuffix = '';
                const type = content != null ? 'file' : 'dir';
                if (index > 0) {
                    yield '\r\n';
                    fileSuffix = `-${index}`;
                }
                let fieldName = type + fileSuffix;
                const qs = [];
                if (mode !== null && mode !== undefined) {
                    qs.push(`mode=${modeToString(mode)}`);
                }
                if (mtime != null) {
                    const { secs, nsecs } = mtime;
                    qs.push(`mtime=${secs}`);
                    if (nsecs != null) {
                        qs.push(`mtime-nsecs=${nsecs}`);
                    }
                }
                if (qs.length > 0) {
                    fieldName = `${fieldName}?${qs.join('&')}`;
                }
                yield `--${boundary}\r\n`;
                yield `Content-Disposition: form-data; name="${fieldName}"; filename="${encodeURIComponent(path ?? '')}"\r\n`;
                yield `Content-Type: ${content != null ? 'application/octet-stream' : 'application/x-directory'}\r\n`;
                yield '\r\n';
                if (content != null) {
                    yield* content;
                }
                index++;
            }
        }
        catch (err) {
            log(err);
            // workaround for https://github.com/node-fetch/node-fetch/issues/753
            abortController.abort();
        }
        finally {
            yield `\r\n--${boundary}--\r\n`;
        }
    }
    // peek at the first value in order to get the input stream moving
    // and to validate its contents.
    // We cannot do this in the `for await..of` in streamFiles due to
    // https://github.com/node-fetch/node-fetch/issues/753
    const peekable = itPeekable(normaliseInput(source));
    const { value, done } = await peekable.peek();
    if (done !== true) {
        peekable.push(value);
    }
    return {
        // @ts-expect-error streaming upload so parts are unknown
        parts: null,
        total: -1,
        headers: merge(headers, {
            'Content-Type': `multipart/form-data; boundary=${boundary}`
        }),
        body: toStream(streamFiles(peekable))
    };
}
//# sourceMappingURL=multipart-request.node.js.map