@ethersphere/bee-js 5.0.0 → 6.0.0-pre.0

package/dist/mjs/modules/debug/status.js

@@ -1,182 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import { http } from "../../utils/http.js";
-import getMajorSemver from 'semver/functions/major.js'; // Following lines bellow are automatically updated with GitHub Action when Bee version is updated
-// so if you are changing anything about them change the `update_bee` action accordingly!
-
-export const SUPPORTED_BEE_VERSION_EXACT = '1.7.0-bbf13011';
-export const SUPPORTED_API_VERSION = '3.0.2';
-export const SUPPORTED_DEBUG_API_VERSION = '3.0.2';
-export const SUPPORTED_BEE_VERSION = SUPPORTED_BEE_VERSION_EXACT.substring(0, SUPPORTED_BEE_VERSION_EXACT.indexOf('-'));
-const NODE_INFO_URL = 'node';
-const HEALTH_URL = 'health';
-/**
- * Get health of node
- *
- * @param ky Ky debug instance
- */
-
-export function getHealth(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'get',
-      path: HEALTH_URL,
-      responseType: 'json'
-    });
-    return response.data;
-  });
-}
-/**
- * Get information about Bee node
- *
- * @param ky Ky debug instance
- */
-
-export function getNodeInfo(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'get',
-      path: NODE_INFO_URL,
-      responseType: 'json'
-    });
-    return response.data;
-  });
-}
-/**
- * Connects to a node and checks if it is a supported Bee version by the bee-js
- *
- * @param ky Ky debug instance
- *
- * @returns true if the Bee node version is supported
- * @deprecated Use `isSupportedExactVersion` instead
- */
-
-export function isSupportedVersion(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    return isSupportedExactVersion(ky);
-  });
-}
-/**
- * Connects to a node and checks if its version matches with the one that bee-js supports.
- *
- * Be aware that this is the most strict version check and most probably
- * you will want to use more relaxed API-versions based checks like
- * `isSupportedApiVersion`, `isSupportedMainApiVersion` or `isSupportedDebugApiVersion`
- * based on your use-case.
- *
- * @param ky
- */
-
-export function isSupportedExactVersion(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const {
-      version
-    } = yield getHealth(ky);
-    return version === SUPPORTED_BEE_VERSION_EXACT;
-  });
-}
-/**
- * Connects to a node and checks if its main's API version matches with the one that bee-js supports.
- *
- * This is useful if you are not using `BeeDebug` class (for anything else then this check)
- * and want to make sure about compatibility.
- *
- * @param ky
- */
-
-export function isSupportedMainApiVersion(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const {
-      apiVersion
-    } = yield getHealth(ky);
-    return getMajorSemver(apiVersion) === getMajorSemver(SUPPORTED_API_VERSION);
-  });
-}
-/**
- * Connects to a node and checks if its Debug API version matches with the one that bee-js supports.
- *
- * This is useful if you are not using `Bee` class in your application and want to make sure
- * about compatibility.
- *
- * @param ky
- */
-
-export function isSupportedDebugApiVersion(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const {
-      debugApiVersion
-    } = yield getHealth(ky);
-    return getMajorSemver(debugApiVersion) === getMajorSemver(SUPPORTED_DEBUG_API_VERSION);
-  });
-}
-/**
- * Connects to a node and checks if its Main and Debug API versions matches with the one that bee-js supports.
- *
- * This should be the main way how to check compatibility for your app and Bee node.
- *
- * @param ky
- */
-
-export function isSupportedApiVersion(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const {
-      apiVersion,
-      debugApiVersion
-    } = yield getHealth(ky);
-    return getMajorSemver(apiVersion) === getMajorSemver(SUPPORTED_API_VERSION) && getMajorSemver(debugApiVersion) === getMajorSemver(SUPPORTED_DEBUG_API_VERSION);
-  });
-}
-/**
- * Returns object with all versions specified by the connected Bee node (properties prefixed with `bee*`)
- * and versions that bee-js supports (properties prefixed with `supported*`).
- *
- * @param ky
- */
-
-export function getVersions(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const {
-      version,
-      apiVersion,
-      debugApiVersion
-    } = yield getHealth(ky);
-    return {
-      supportedBeeVersion: SUPPORTED_BEE_VERSION_EXACT,
-      supportedBeeApiVersion: SUPPORTED_API_VERSION,
-      supportedBeeDebugApiVersion: SUPPORTED_DEBUG_API_VERSION,
-      beeVersion: version,
-      beeApiVersion: apiVersion,
-      beeDebugApiVersion: debugApiVersion
-    };
-  });
-}

package/dist/mjs/modules/debug/tag.js

@@ -1,50 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import { http } from "../../utils/http.js";
-const endpoint = 'tags';
-/**
- * Retrieve tag with extended information from Bee node
- *
- * @param ky Ky debug instance
- * @param uid UID of tag to be retrieved
- */
-
-export function retrieveExtendedTag(ky, uid) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      path: `${endpoint}/${uid}`,
-      responseType: 'json'
-    });
-    return response.data;
-  });
-}

package/dist/mjs/modules/debug/transactions.js

@@ -1,103 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import { http } from "../../utils/http.js";
-const transactionsEndpoint = 'transactions';
-/**
- * Get list of all pending transactions
- *
- * @param ky   Debug Ky instance
- */
-
-export function getAllTransactions(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      path: transactionsEndpoint,
-      responseType: 'json'
-    });
-    return response.data.pendingTransactions;
-  });
-}
-/**
- * Get information for specific pending transactions
- *
- * @param ky   Debug Ky instance
- * @param transactionHash Hash of the transaction
- */
-
-export function getTransaction(ky, transactionHash) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      path: `${transactionsEndpoint}/${transactionHash}`,
-      responseType: 'json'
-    });
-    return response.data;
-  });
-}
-/**
- * Rebroadcast existing transaction
- *
- * @param ky   Debug Ky instance
- * @param transactionHash Hash of the transaction
- */
-
-export function rebroadcastTransaction(ky, transactionHash) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'post',
-      path: `${transactionsEndpoint}/${transactionHash}`,
-      responseType: 'json'
-    });
-    return response.data.transactionHash;
-  });
-}
-/**
- * Cancel existing transaction
- *
- * @param ky   Debug Ky instance
- * @param transactionHash Hash of the transaction
- * @param gasPrice Optional gas price
- */
-
-export function cancelTransaction(ky, transactionHash, gasPrice) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'delete',
-      headers: {
-        'gas-price': gasPrice
-      },
-      path: `${transactionsEndpoint}/${transactionHash}`,
-      responseType: 'json'
-    });
-    return response.data.transactionHash;
-  });
-}

package/dist/mjs/modules/feed.js

@@ -1,101 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import { filterHeaders, http } from "../utils/http.js";
-import { extractUploadHeaders } from "../utils/headers.js";
-import { BeeError } from "../utils/error.js";
-const feedEndpoint = 'feeds';
-/**
- * Create an initial feed root manifest
- *
- * @param ky Ky instance
- * @param owner           Owner's ethereum address in hex
- * @param topic           Topic in hex
- * @param postageBatchId  Postage BatchId to be used to create the Feed Manifest
- * @param options         Additional options, like type (default: 'sequence')
- */
-
-export function createFeedManifest(ky, owner, topic, postageBatchId, options) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'post',
-      responseType: 'json',
-      path: `${feedEndpoint}/${owner}/${topic}`,
-      searchParams: filterHeaders(options),
-      headers: extractUploadHeaders(postageBatchId)
-    });
-    return response.data.reference;
-  });
-}
-
-function readFeedUpdateHeaders(headers) {
-  const feedIndex = headers.get('swarm-feed-index');
-  const feedIndexNext = headers.get('swarm-feed-index-next');
-
-  if (!feedIndex) {
-    throw new BeeError('Response did not contain expected swarm-feed-index!');
-  }
-
-  if (!feedIndexNext) {
-    throw new BeeError('Response did not contain expected swarm-feed-index-next!');
-  }
-
-  return {
-    feedIndex,
-    feedIndexNext
-  };
-}
-/**
- * Find and retrieve feed update
- *
- * The feed consists of updates. This endpoint looks up an
- * update that matches the provided parameters and returns
- * the reference it contains along with its index and the
- * index of the subsequent update.
- *
- * @param ky Ky instance
- * @param owner       Owner's ethereum address in hex
- * @param topic       Topic in hex
- * @param options     Additional options, like index, at, type
- */
-
-
-export function fetchLatestFeedUpdate(ky, owner, topic, options) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      responseType: 'json',
-      path: `${feedEndpoint}/${owner}/${topic}`,
-      searchParams: filterHeaders(options)
-    });
-    return Object.assign(Object.assign({}, response.data), readFeedUpdateHeaders(response.headers));
-  });
-}

package/dist/mjs/modules/pinning.js

@@ -1,100 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import { http } from "../utils/http.js";
-const PINNING_ENDPOINT = 'pins';
-/**
- * Pin data with given reference
- *
- * @param ky Ky instance for given Bee class instance
- * @param reference Bee data reference
- */
-
-export function pin(ky, reference) {
-  return __awaiter(this, void 0, void 0, function* () {
-    yield http(ky, {
-      method: 'post',
-      responseType: 'json',
-      path: `${PINNING_ENDPOINT}/${reference}`
-    });
-  });
-}
-/**
- * Unpin data with given reference
- *
- * @param ky Ky instance for given Bee class instance
- * @param reference Bee data reference
- */
-
-export function unpin(ky, reference) {
-  return __awaiter(this, void 0, void 0, function* () {
-    yield http(ky, {
-      method: 'delete',
-      responseType: 'json',
-      path: `${PINNING_ENDPOINT}/${reference}`
-    });
-  });
-}
-/**
- * Get pin status for specific address.
- *
- * @param ky Ky instance
- * @param reference
- * @throws Error if given address is not pinned
- */
-
-export function getPin(ky, reference) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'get',
-      responseType: 'json',
-      path: `${PINNING_ENDPOINT}/${reference}`
-    });
-    return response.data;
-  });
-}
-/**
- * Get list of all pins
- *
- * @param ky Ky instance
- */
-
-export function getAllPins(ky) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'get',
-      responseType: 'json',
-      path: `${PINNING_ENDPOINT}`
-    });
-    return response.data.references;
-  });
-}

package/dist/mjs/modules/pss.js

@@ -1,74 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import WebSocket from 'isomorphic-ws';
-import { prepareData } from "../utils/data.js";
-import { http } from "../utils/http.js";
-import { extractUploadHeaders } from "../utils/headers.js";
-const endpoint = 'pss';
-/**
- * Send to recipient or target with Postal Service for Swarm
- *
- * @param ky Ky instance for given Bee class instance
- * @param topic Topic name
- * @param target Target message address prefix
- * @param data
- * @param postageBatchId Postage BatchId that will be assigned to sent message
- * @param recipient Recipient public key
- *
- */
-
-export function send(ky, topic, target, data, postageBatchId, recipient) {
-  return __awaiter(this, void 0, void 0, function* () {
-    yield http(ky, {
-      method: 'post',
-      path: `${endpoint}/send/${topic}/${target}`,
-      body: yield prepareData(data),
-      responseType: 'json',
-      searchParams: {
-        recipient
-      },
-      headers: extractUploadHeaders(postageBatchId)
-    });
-  });
-}
-/**
- * Subscribe for messages on the given topic
- *
- * @param url Bee node URL
- * @param topic Topic name
- */
-
-export function subscribe(url, topic) {
-  const wsUrl = url.replace(/^http/i, 'ws');
-  return new WebSocket(`${wsUrl}/${endpoint}/subscribe/${topic}`);
-}

package/dist/mjs/modules/soc.js

@@ -1,64 +0,0 @@
-var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
-  function adopt(value) {
-    return value instanceof P ? value : new P(function (resolve) {
-      resolve(value);
-    });
-  }
-
-  return new (P || (P = Promise))(function (resolve, reject) {
-    function fulfilled(value) {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function rejected(value) {
-      try {
-        step(generator["throw"](value));
-      } catch (e) {
-        reject(e);
-      }
-    }
-
-    function step(result) {
-      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-    }
-
-    step((generator = generator.apply(thisArg, _arguments || [])).next());
-  });
-};
-
-import { extractUploadHeaders } from "../utils/headers.js";
-import { http } from "../utils/http.js";
-const socEndpoint = 'soc';
-/**
- * Upload single owner chunk (SOC) to a Bee node
- *
- * @param ky Ky instance
- * @param owner           Owner's ethereum address in hex
- * @param identifier      Arbitrary identifier in hex
- * @param signature       Signature in hex
- * @param data            Content addressed chunk data to be uploaded
- * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
- * @param options         Additional options like tag, encryption, pinning
- */
-
-export function upload(ky, owner, identifier, signature, data, postageBatchId, options) {
-  return __awaiter(this, void 0, void 0, function* () {
-    const response = yield http(ky, {
-      method: 'post',
-      path: `${socEndpoint}/${owner}/${identifier}`,
-      body: data,
-      headers: Object.assign({
-        'content-type': 'application/octet-stream'
-      }, extractUploadHeaders(postageBatchId, options)),
-      responseType: 'json',
-      searchParams: {
-        sig: signature
-      }
-    });
-    return response.data.reference;
-  });
-}