@ethersphere/bee-js 8.1.0 → 8.3.0

package/dist/types/modules/soc.d.ts

@@ -10,4 +10,4 @@ import { BatchId, BeeRequestOptions, UploadOptions, UploadResult } from '../type
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-export declare function upload(requestOptions: BeeRequestOptions, owner: string, identifier: string, signature: string, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<UploadResult>;
+export declare function upload(requestOptions: BeeRequestOptions, owner: string, identifier: string, signature: string, data: Uint8Array, stamp: BatchId | Uint8Array | string, options?: UploadOptions): Promise<UploadResult>;

package/dist/types/types/index.d.ts

@@ -7,9 +7,6 @@ import type { BeeError } from '../utils/error';
 import type { EthAddress, HexEthAddress } from '../utils/eth';
 import type { HexString } from '../utils/hex';
 export * from './debug';
-export interface Dictionary<T> {
-    [Key: string]: T;
-}
 export declare const SPAN_SIZE = 8;
 export declare const SECTION_SIZE = 32;
 export declare const BRANCHES = 128;
@@ -73,6 +70,8 @@ export type BeeRequestOptions = {
     timeout?: number | false;
     headers?: Record<string, string>;
     onRequest?: (request: BeeRequest) => void;
+    httpAgent?: any;
+    httpsAgent?: any;
 };
 export interface BeeOptions extends BeeRequestOptions {
     /**
@@ -96,7 +95,6 @@ export interface UploadResultWithCid extends UploadResult {
      * 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;
 }
@@ -120,7 +118,6 @@ export interface UploadResult {
 export interface UploadOptions {
     /**
      * If set to true, an ACT will be created for the uploaded data.
-     *
      */
     act?: boolean;
     /**
@@ -295,6 +292,9 @@ export interface FileData<T> extends FileHeaders {
 export interface Pin {
     reference: string;
 }
+export interface ReferenceInformation {
+    contentLength: number;
+}
 /**
  * Helper interface that adds utility functions
  * to work more conveniently with bytes in normal
@@ -377,8 +377,6 @@ export interface FeedManifestResult {
     reference: Reference;
     /**
      * Function that converts the reference into Swarm Feed CID.
-     *
-     * @see https://github.com/ethersphere/swarm-cid-js
      */
     cid: () => string;
 }
@@ -446,7 +444,7 @@ export interface SOCWriter extends SOCReader {
      * @param data        The chunk payload data
      * @param options     Upload options
      */
-    upload: (postageBatchId: string | BatchId, identifier: Identifier, data: Uint8Array, options?: UploadOptions) => Promise<UploadResult>;
+    upload: (stamp: BatchId | Uint8Array | string, identifier: Identifier, data: Uint8Array, options?: UploadOptions) => Promise<UploadResult>;
 }
 /**
  * Interface representing Postage stamp batch.
@@ -519,6 +517,12 @@ export interface PostageBatchOptions {
      */
     waitForUsableTimeout?: number;
 }
+export interface Envelope {
+    issuer: Uint8Array;
+    index: Uint8Array;
+    timestamp: Uint8Array;
+    signature: Uint8Array;
+}
 /**
  * With this type a number should be represented in a string
  */

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

@@ -0,0 +1,9 @@
+import { Reference } from '..';
+export declare const SWARM_MANIFEST_CODEC = 250;
+export declare const SWARM_FEED_CODEC = 251;
+export type DecodedCID = {
+    type: 'feed' | 'manifest';
+    reference: Reference;
+};
+export declare function convertReferenceToCid(reference: Reference | string, type: 'feed' | 'manifest'): string;
+export declare function convertCidToReference(cid: string): DecodedCID;

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

@@ -0,0 +1,4 @@
+import { BatchId, Topic } from '..';
+export declare const SWARM_GATEWAY_URL = "https://api.gateway.ethswarm.org";
+export declare const NULL_STAMP: BatchId;
+export declare const NULL_TOPIC: Topic;

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

@@ -7,3 +7,4 @@ export { keccak256Hash } from './hash';
 export { makeMaxTarget } from './pss';
 export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampEffectiveBytes, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage, } from './stamps';
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from './redundancy';
+export { convertCidToReference, convertReferenceToCid } from './cid';

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

@@ -1,5 +1,5 @@
 import { BatchId, DownloadRedundancyOptions, FileHeaders, UploadOptions, UploadRedundancyOptions } from '../types';
 export declare function readFileHeaders(headers: Record<string, string>): FileHeaders;
-export declare function extractUploadHeaders(postageBatchId: BatchId, options?: UploadOptions): Record<string, string>;
+export declare function extractUploadHeaders(stamp: BatchId | Uint8Array | string, options?: UploadOptions): Record<string, string>;
 export declare function extractRedundantUploadHeaders(postageBatchId: BatchId, options?: UploadOptions & UploadRedundancyOptions): Record<string, string>;
 export declare function extractDownloadHeaders(options?: DownloadRedundancyOptions): Record<string, string>;

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

@@ -1,4 +1,4 @@
-import { NumberString } from '../types';
+import { BatchId, Envelope, NumberString } from '../types';
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
  *
@@ -62,3 +62,5 @@ export declare function getAmountForTtl(days: number): NumberString;
  * @returns {number} The calculated depth necessary to achieve the specified capacity.
  */
 export declare function getDepthForCapacity(gigabytes: number): number;
+export declare function convertEnvelopeToMarshaledStamp(batchID: BatchId, envelope: Envelope): Uint8Array;
+export declare function marshalStamp(signature: Uint8Array, batchID: Uint8Array, timestamp: Uint8Array, index: Uint8Array): Uint8Array;

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

@@ -1,9 +1,7 @@
 /// <reference types="node" />
-import { ReferenceType } from '@ethersphere/swarm-cid';
 import { Readable } from 'stream';
 import { Address, AddressPrefix, AllTagsOptions, BatchId, BeeRequestOptions, CashoutOptions, CollectionUploadOptions, FileUploadOptions, NumberString, PostageBatchOptions, PssMessageHandler, PublicKey, Reference, ReferenceOrEns, Tag, TransactionHash, TransactionOptions, UploadOptions } from '../types';
 export declare function isReadable(obj: unknown): obj is Readable;
-export declare function isUint8Array(obj: unknown): obj is Uint8Array;
 export declare function isInteger(value: unknown): value is number | NumberString;
 export declare function isObject(value: unknown): value is Record<string, unknown>;
 export declare function isStrictlyObject(value: unknown): value is Record<string, unknown>;
@@ -26,15 +24,15 @@ export declare function assertReferenceOrEns(value: unknown): asserts value is R
  * @param value
  * @param expectedCidType
  */
-export declare function makeReferenceOrEns(value: unknown, expectedCidType: ReferenceType): ReferenceOrEns;
+export declare function makeReferenceOrEns(value: unknown, expectedCidType: 'feed' | 'manifest'): ReferenceOrEns;
 /**
  * Function that adds getter which converts the reference into CID base32 encoded string.
  * @param result
- * @param cidType Type as described in the @ethersphere/swarm-cids-js -> ReferenceType
+ * @param cidType feed or manifest
  */
 export declare function addCidConversionFunction<T extends {
     reference: string;
-}>(result: T, cidType: ReferenceType): T & {
+}>(result: T, cidType: 'feed' | 'manifest'): T & {
     cid: () => string;
 };
 export declare function assertAddress(value: unknown): asserts value is Address;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "8.1.0",
+  "version": "8.3.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -61,9 +61,8 @@
     "bee": "npx @fairdatasociety/fdp-play@3.2.0 start --detach --fresh"
   },
   "dependencies": {
-    "@ethersphere/swarm-cid": "^0.1.0",
     "axios": "^0.28.1",
-    "cafe-utility": "^21.3.1",
+    "cafe-utility": "^23.10.0",
     "elliptic": "^6.5.4",
     "isomorphic-ws": "^4.0.1",
     "js-sha3": "^0.8.0",
@@ -79,7 +78,6 @@
     "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.4.2",
-    "@fluffy-spoon/substitute": "^1.208.0",
     "@jest/types": "^29.6.3",
     "@naholyr/cross-env": "^1.0.0",
     "@types/elliptic": "^6.4.14",
@@ -100,7 +98,6 @@
     "husky": "^8.0.1",
     "jest": "^29.7.0",
     "nock": "^13.3.0",
-    "playwright-test": "^8.1.2",
     "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^5.3.1",