@ethersphere/bee-js 4.1.0 → 5.0.0

package/dist/mjs/{src/bee-debug.js → bee-debug.js}

@@ -44,7 +44,7 @@ import { STAMPS_DEPTH_MAX, STAMPS_DEPTH_MIN } from "./types/index.js";
 import * as tag from "./modules/debug/tag.js";
 import * as stamps from "./modules/debug/stamps.js";
 import { makeDefaultKy, wrapRequestClosure, wrapResponseClosure } from "./utils/http.js";
-import { sleep } from "../test/utils.js";
+import { sleep } from "./utils/sleep.js";
 export class BeeDebug {
   constructor(url, options) {
     var _a;
@@ -550,7 +550,7 @@ export class BeeDebug {
 
       const stamp = yield stamps.createPostageBatch(this.getKy(options), amount, depth, options);
 
-      if (options === null || options === void 0 ? void 0 : options.waitForUsable) {
+      if ((options === null || options === void 0 ? void 0 : options.waitForUsable) !== false) {
         yield this.waitForUsablePostageStamp(stamp, options === null || options === void 0 ? void 0 : options.waitForUsableTimeout);
       }
 

package/dist/mjs/{src/bee.js → bee.js}

@@ -833,7 +833,6 @@ export class Bee {
    *
    * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
    * @see [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post)
-   * TODO: Once breaking add support for Feed CID
    */
 
 
@@ -844,9 +843,12 @@ export class Bee {
       assertBatchId(postageBatchId);
       const canonicalTopic = makeTopic(topic);
       const canonicalOwner = makeHexEthAddress(owner);
-      return createFeedManifest(this.getKy(options), canonicalOwner, canonicalTopic, postageBatchId, {
+      const reference = yield createFeedManifest(this.getKy(options), canonicalOwner, canonicalTopic, postageBatchId, {
         type
       });
+      return addCidConversionFunction({
+        reference
+      }, ReferenceType.FEED);
     });
   }
   /**

package/dist/mjs/{src/modules → modules}/debug/connectivity.js

@@ -46,7 +46,7 @@ export function getPeers(ky) {
       path: 'peers',
       responseType: 'json'
     });
-    return response.data.peers || [];
+    return response.data.peers;
   });
 }
 export function getBlocklist(ky) {
@@ -55,7 +55,7 @@ export function getBlocklist(ky) {
       path: 'blocklist',
       responseType: 'json'
     });
-    return response.data.peers || [];
+    return response.data.peers;
   });
 }
 export function removePeer(ky, peer) {

package/dist/mjs/{src/modules → modules}/debug/stamps.js

@@ -39,7 +39,7 @@ export function getAllPostageBatches(ky) {
       path: `${STAMPS_ENDPOINT}`,
       responseType: 'json'
     });
-    return response.data.stamps || [];
+    return response.data.stamps;
   });
 }
 export function getPostageBatch(ky, postageBatchId) {

package/dist/mjs/{src/modules → modules}/debug/status.js

@@ -34,9 +34,9 @@ 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.6.0-6ceadd35';
-export const SUPPORTED_API_VERSION = '3.0.1';
-export const SUPPORTED_DEBUG_API_VERSION = '2.0.1';
+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';

package/dist/mjs/{src/modules → modules}/pinning.js

@@ -95,12 +95,6 @@ export function getAllPins(ky) {
       responseType: 'json',
       path: `${PINNING_ENDPOINT}`
     });
-    const result = response.data.references;
-
-    if (result === null) {
-      return [];
-    }
-
-    return result;
+    return response.data.references;
   });
 }

package/dist/mjs/utils/sleep.js

@@ -0,0 +1,43 @@
+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());
+  });
+};
+/**
+ * Sleep for N miliseconds
+ *
+ * @param ms Number of miliseconds to sleep
+ */
+
+
+export function sleep(ms) {
+  return __awaiter(this, void 0, void 0, function* () {
+    return new Promise(resolve => setTimeout(() => resolve(), ms));
+  });
+}

package/dist/mjs/{src/utils → utils}/type.js

@@ -151,7 +151,7 @@ export function makeReferenceOrEns(value, expectedCidType) {
 
 export function addCidConversionFunction(result, cidType) {
   return Object.assign(Object.assign({}, result), {
-    get cid() {
+    cid() {
       return encodeReference(result.reference, cidType).toString();
     }
 

package/dist/types/{src/bee.d.ts → bee.d.ts}

@@ -2,7 +2,7 @@ import { Index, IndexBytes } from './feed';
 import { FeedType } from './feed/type';
 import { EthAddress } from './utils/eth';
 import type { AddressPrefix, AnyJson, BatchId, BeeOptions, CollectionUploadOptions, Data, FeedReader, FeedWriter, FileData, FileUploadOptions, JsonFeedOptions, Pin, PssMessageHandler, PssSubscription, PublicKey, Reference, Signer, SOCReader, SOCWriter, Tag, Topic, UploadOptions, UploadResultWithCid } from './types';
-import { AllTagsOptions, Collection, Readable, ReferenceCidOrEns, ReferenceOrEns, RequestOptions, UploadResult } from './types';
+import { AllTagsOptions, Collection, FeedManifestResult, Readable, ReferenceCidOrEns, ReferenceOrEns, RequestOptions, UploadResult } from './types';
 /**
  * The main component that abstracts operations available on the main Bee API.
  *
@@ -411,9 +411,8 @@ export declare class Bee {
      *
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
      * @see [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post)
-     * TODO: Once breaking add support for Feed CID
      */
-    createFeedManifest(postageBatchId: string | BatchId, type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string, options?: RequestOptions): Promise<Reference>;
+    createFeedManifest(postageBatchId: string | BatchId, type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string, options?: RequestOptions): Promise<FeedManifestResult>;
     /**
      * Make a new feed reader for downloading feed updates.
      *

package/dist/types/{src/modules → modules}/debug/status.d.ts

@@ -1,9 +1,9 @@
 import type { Health, NodeInfo } from '../../types/debug';
 import { Ky } from '../../types';
 import { BeeVersions } from '../../types/debug';
-export declare const SUPPORTED_BEE_VERSION_EXACT = "1.6.0-6ceadd35";
-export declare const SUPPORTED_API_VERSION = "3.0.1";
-export declare const SUPPORTED_DEBUG_API_VERSION = "2.0.1";
+export declare const SUPPORTED_BEE_VERSION_EXACT = "1.7.0-bbf13011";
+export declare const SUPPORTED_API_VERSION = "3.0.2";
+export declare const SUPPORTED_DEBUG_API_VERSION = "3.0.2";
 export declare const SUPPORTED_BEE_VERSION: string;
 /**
  * Get health of node

package/dist/types/{src/modules → modules}/pinning.d.ts

@@ -1,6 +1,6 @@
 import type { Ky, Pin, Reference } from '../types';
 export interface GetAllPinResponse {
-    references: Reference[] | null;
+    references: Reference[];
 }
 /**
  * Pin data with given reference

package/dist/types/{src/types → types}/debug.d.ts

@@ -161,11 +161,6 @@ export interface NodeInfo {
      */
     swapEnabled: boolean;
 }
-/**
- * Information about Bee node and its configuration
- * @deprecated Use NodeInfo instead
- */
-export declare type NodesInfo = NodeInfo;
 export interface RemovePeerResponse {
     message: string;
     code: 0;
@@ -173,8 +168,8 @@ export interface RemovePeerResponse {
 export interface Bin {
     population: number;
     connected: number;
-    disconnectedPeers: Peer[] | null;
-    connectedPeers: Peer[] | null;
+    disconnectedPeers: Peer[];
+    connectedPeers: Peer[];
 }
 export interface Topology {
     baseAddr: string;

package/dist/types/{src/types → types}/index.d.ts

@@ -124,7 +124,13 @@ export interface BeeOptions extends RequestOptions {
     onResponse?: HookCallback<BeeResponse>;
 }
 export interface UploadResultWithCid extends UploadResult {
-    cid: string;
+    /**
+     * Function that converts the reference into Swarm CIDs
+     *
+     * @throws TypeError if the reference is encrypted reference (eq. 128 chars long) which is not supported in CID
+     * @see https://github.com/ethersphere/swarm-cid-js
+     */
+    cid: () => string;
 }
 /**
  * Result of upload calls.
@@ -332,6 +338,21 @@ export declare const TOPIC_HEX_LENGTH = 64;
  * Hex string of length 64 chars without prefix that specifies topics for feed.
  */
 export declare type Topic = HexString<typeof TOPIC_HEX_LENGTH>;
+/**
+ * Result of upload calls.
+ */
+export interface FeedManifestResult {
+    /**
+     * Reference of the uploaded data
+     */
+    reference: Reference;
+    /**
+     * Function that converts the reference into Swarm Feed CID.
+     *
+     * @see https://github.com/ethersphere/swarm-cid-js
+     */
+    cid: () => string;
+}
 /**
  * FeedReader is an interface for downloading feed updates
  */
@@ -417,10 +438,6 @@ export interface PostageBatch {
     batchTTL: number;
     exists: boolean;
 }
-/**
- * @deprecated Use PostageBatch instead.
- */
-export declare type DebugPostageBatch = PostageBatch;
 export interface BatchBucket {
     bucketID: number;
     collisions: number;
@@ -459,12 +476,12 @@ export interface PostageBatchOptions extends RequestOptions {
     /**
      * The returned Promise will await until the purchased Postage Batch is usable.
      * In other word, it has to have enough block confirmations that Bee pronounce it usable.
-     * If turned on, this significantly prolong the creation of postage batch!
+     * When turned on, this significantly prolongs the creation of postage batch!
+     *
      * If you plan to use the stamp right away for some action with Bee (like uploading using this stamp) it is
      * highly recommended to use this option, otherwise you might get errors "stamp not usable" from Bee.
      *
-     * In next breaking release this option will be turned on by default.
-     * @default false
+     * @default true
      */
     waitForUsable?: boolean;
     /**

package/dist/types/utils/sleep.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Sleep for N miliseconds
+ *
+ * @param ms Number of miliseconds to sleep
+ */
+export declare function sleep(ms: number): Promise<void>;

package/dist/types/{src/utils → utils}/type.d.ts

@@ -1,4 +1,4 @@
-import { Address, AddressPrefix, AllTagsOptions, BatchId, CollectionUploadOptions, FileUploadOptions, NumberString, PssMessageHandler, PublicKey, Readable, Reference, Tag, UploadOptions, TransactionHash, RequestOptions, PostageBatchOptions, CashoutOptions, ReferenceOrEns, UploadResult, UploadResultWithCid } from '../types';
+import { Address, AddressPrefix, AllTagsOptions, BatchId, CollectionUploadOptions, FileUploadOptions, NumberString, PssMessageHandler, PublicKey, Readable, Reference, Tag, UploadOptions, TransactionHash, RequestOptions, PostageBatchOptions, CashoutOptions, ReferenceOrEns } from '../types';
 import { ReferenceType } from '@ethersphere/swarm-cid';
 export declare function isUint8Array(obj: unknown): obj is Uint8Array;
 export declare function isInteger(value: unknown): value is number | NumberString;
@@ -38,7 +38,11 @@ export declare function makeReferenceOrEns(value: unknown, expectedCidType: Refe
  * @param result
  * @param cidType Type as described in the @ethersphere/swarm-cids-js -> ReferenceType
  */
-export declare function addCidConversionFunction(result: UploadResult, cidType: ReferenceType): UploadResultWithCid;
+export declare function addCidConversionFunction<T extends {
+    reference: string;
+}>(result: T, cidType: ReferenceType): T & {
+    cid: () => string;
+};
 export declare function assertAddress(value: unknown): asserts value is Address;
 export declare function assertBatchId(value: unknown): asserts value is BatchId;
 export declare function assertRequestOptions(value: unknown, name?: string): asserts value is RequestOptions;