@ethersphere/bee-js/dist/mjs/modules/bzz.js

Javascript client for Bee

import { Optional, Types } from 'cafe-utility';
import { Bytes } from "../utils/bytes.js";
import { assertCollection } from "../utils/collection.js";
import { prepareRequestHeaders, readFileHeaders } from "../utils/headers.js";
import { http } from "../utils/http.js";
import { uploadTar } from "../utils/tar-uploader.js";
import { isReadable, makeTagUid } from "../utils/type.js";
import { Reference } from "../utils/typed-bytes.js";
const bzzEndpoint = 'bzz';
/**
 * Upload single file
 *
 * @param requestOptions Options for making requests
 * @param data Files data
 * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
 * @param name Name that will be attached to the uploaded file. Wraps the data into manifest with set index document.
 * @param options
 */
export async function uploadFile(requestOptions, data, postageBatchId, name, options) {
  if (isReadable(data) && !options?.contentType) {
    if (!options) {
      options = {};
    }
    options.contentType = 'application/octet-stream';
  }
  const response = await http(requestOptions, {
    method: 'post',
    url: bzzEndpoint,
    data,
    headers: prepareRequestHeaders(postageBatchId, options),
    params: {
      name
    },
    responseType: 'json'
  });
  const body = Types.asObject(response.data, {
    name: 'response.data'
  });
  return {
    reference: new Reference(Types.asHexString(body.reference)),
    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
    historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
  };
}
/**
 * Download single file as a buffer
 *
 * @param requestOptions Options for making requests
 * @param hash Bee file or collection hash
 * @param path If hash is collection then this defines path to a single file in the collection
 */
export async function downloadFile(requestOptions, resource, path = '', options) {
  const response = await http(requestOptions, {
    method: 'GET',
    responseType: 'arraybuffer',
    url: `${bzzEndpoint}/${resource}/${path}`,
    headers: prepareRequestHeaders(null, options)
  });
  const file = {
    ...readFileHeaders(response.headers),
    data: new Bytes(response.data)
  };
  return file;
}
/**
 * Download single file as a readable stream
 *
 * @param requestOptions Options for making requests
 * @param hash Bee file or collection hash
 * @param path If hash is collection then this defines path to a single file in the collection
 */
export async function downloadFileReadable(requestOptions, reference, path = '', options) {
  reference = new Reference(reference);
  const response = await http(requestOptions, {
    method: 'GET',
    responseType: 'stream',
    url: `${bzzEndpoint}/${reference}/${path}`,
    headers: prepareRequestHeaders(null, options)
  });
  const file = {
    ...readFileHeaders(response.headers),
    data: response.data
  };
  return file;
}
/*******************************************************************************************************************/
// Collections
/**
 * Upload collection
 * @param requestOptions Options for making requests
 * @param collection Collection of Uint8Array buffers to upload
 * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
 * @param options
 */
export async function uploadCollection(requestOptions, collection, postageBatchId, options) {
  assertCollection(collection);
  const response = await uploadTar(requestOptions, collection, postageBatchId, options);
  const body = Types.asObject(response.data, {
    name: 'response.data'
  });
  return {
    reference: new Reference(Types.asHexString(body.reference)),
    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
    historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
  };
}