@waku/interfaces 0.0.11 → 0.0.13

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The file is maintained by [Release Please](https://github.com/googleapis/release-please) based on [Conventional Commits](https://www.conventionalcommits.org) specification,
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.13](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.12...interfaces-v0.0.13) (2023-05-18)
+
+
+### Features
+
+* Add 1MB restriction to LightPush and Relay ([#1351](https://github.com/waku-org/js-waku/issues/1351)) ([72f97d4](https://github.com/waku-org/js-waku/commit/72f97d4545512f92936b1a9b50fa0b53f8603f9d))
+* Expose `meta` on `IDecodedMessage` ([5724bb2](https://github.com/waku-org/js-waku/commit/5724bb2b21367e4e397acbc5530b3a2bf315194e))
+
+## [0.0.12](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.11...interfaces-v0.0.12) (2023-05-09)
+
+
+### Features
+
+* ToSubscriptionIterator impl for IReceiver ([#1307](https://github.com/waku-org/js-waku/issues/1307)) ([7daa9d0](https://github.com/waku-org/js-waku/commit/7daa9d05bf44b33296b56df214f5d5901887a129))
+
 ## [0.0.11](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.10...interfaces-v0.0.11) (2023-04-03)
 
 

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export * from "./waku.js";
 export * from "./connection_manager.js";
 export * from "./sender.js";
 export * from "./receiver.js";
+export * from "./misc.js";

package/dist/index.js

@@ -10,4 +10,5 @@ export * from "./waku.js";
 export * from "./connection_manager.js";
 export * from "./sender.js";
 export * from "./receiver.js";
+export * from "./misc.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC"}

package/dist/message.d.ts

@@ -61,6 +61,7 @@ export interface IDecodedMessage {
     timestamp: Date | undefined;
     rateLimitProof: IRateLimitProof | undefined;
     ephemeral: boolean | undefined;
+    meta: Uint8Array | undefined;
 }
 export interface IDecoder<T extends IDecodedMessage> {
     contentTopic: string;

package/dist/misc.d.ts

@@ -0,0 +1,8 @@
+import type { IDecodedMessage } from "./message.js";
+export interface IAsyncIterator<T extends IDecodedMessage> {
+    iterator: AsyncIterator<T>;
+    stop: Unsubscribe;
+}
+export type Unsubscribe = () => void | Promise<void>;
+export type PubSubTopic = string;
+export type ContentTopic = string;

package/dist/misc.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=misc.js.map

package/dist/misc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"misc.js","sourceRoot":"","sources":["../src/misc.ts"],"names":[],"mappings":""}

package/dist/protocols.d.ts

@@ -53,6 +53,14 @@ export type ProtocolOptions = {
     peerId?: PeerId;
 };
 export type Callback<T extends IDecodedMessage> = (msg: T) => void | Promise<void>;
+export declare enum SendError {
+    GENERIC_FAIL = "Generic error",
+    ENCODE_FAILED = "Failed to encode",
+    DECODE_FAILED = "Failed to decode",
+    SIZE_TOO_BIG = "Size is too big",
+    NO_RPC_RESPONSE = "No RPC response"
+}
 export interface SendResult {
+    error?: SendError;
     recipients: PeerId[];
 }

package/dist/protocols.js

@@ -5,4 +5,12 @@ export var Protocols;
     Protocols["LightPush"] = "lightpush";
     Protocols["Filter"] = "filter";
 })(Protocols || (Protocols = {}));
+export var SendError;
+(function (SendError) {
+    SendError["GENERIC_FAIL"] = "Generic error";
+    SendError["ENCODE_FAILED"] = "Failed to encode";
+    SendError["DECODE_FAILED"] = "Failed to decode";
+    SendError["SIZE_TOO_BIG"] = "Size is too big";
+    SendError["NO_RPC_RESPONSE"] = "No RPC response";
+})(SendError || (SendError = {}));
 //# sourceMappingURL=protocols.js.map

package/dist/protocols.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB"}
+{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAqDD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,2CAA8B,CAAA;IAC9B,+CAAkC,CAAA;IAClC,+CAAkC,CAAA;IAClC,6CAAgC,CAAA;IAChC,gDAAmC,CAAA;AACrC,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB"}

package/dist/receiver.d.ts

@@ -1,11 +1,9 @@
 import type { IDecodedMessage, IDecoder } from "./message.js";
+import type { ContentTopic, IAsyncIterator, PubSubTopic, Unsubscribe } from "./misc.js";
 import type { Callback, ProtocolOptions } from "./protocols.js";
-type Unsubscribe = () => void | Promise<void>;
-type PubSubTopic = string;
-type ContentTopic = string;
 export type ActiveSubscriptions = Map<PubSubTopic, ContentTopic[]>;
 export interface IReceiver {
+    toSubscriptionIterator: <T extends IDecodedMessage>(decoders: IDecoder<T> | IDecoder<T>[], opts?: ProtocolOptions) => Promise<IAsyncIterator<T>>;
     subscribe: <T extends IDecodedMessage>(decoders: IDecoder<T> | IDecoder<T>[], callback: Callback<T>, opts?: ProtocolOptions) => Unsubscribe | Promise<Unsubscribe>;
     getActiveSubscriptions: () => ActiveSubscriptions;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/interfaces",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Definition of Waku interfaces",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -35,11 +35,9 @@
     "build": "run-s build:**",
     "build:esm": "tsc",
     "fix": "run-s fix:*",
-    "fix:prettier": "prettier . --write",
     "fix:lint": "eslint src --fix",
     "check": "run-s check:*",
     "check:lint": "eslint src",
-    "check:prettier": "prettier . --list-different",
     "check:spelling": "cspell \"{README.md,src/**/*.ts}\"",
     "check:tsc": "tsc -p tsconfig.dev.json",
     "prepublish": "npm run build",
@@ -68,8 +66,8 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.8.4",
-    "typescript": "^4.9.5"
+    "prettier": "^2.8.8",
+    "typescript": "^5.0.4"
   },
   "typedoc": {
     "entryPoint": "./src/index.ts"

package/src/index.ts

@@ -10,3 +10,4 @@ export * from "./waku.js";
 export * from "./connection_manager.js";
 export * from "./sender.js";
 export * from "./receiver.js";
+export * from "./misc.js";

package/src/message.ts

@@ -65,6 +65,7 @@ export interface IDecodedMessage {
   timestamp: Date | undefined;
   rateLimitProof: IRateLimitProof | undefined;
   ephemeral: boolean | undefined;
+  meta: Uint8Array | undefined;
 }
 
 export interface IDecoder<T extends IDecodedMessage> {

package/src/misc.ts

@@ -0,0 +1,11 @@
+import type { IDecodedMessage } from "./message.js";
+
+export interface IAsyncIterator<T extends IDecodedMessage> {
+  iterator: AsyncIterator<T>;
+  stop: Unsubscribe;
+}
+
+export type Unsubscribe = () => void | Promise<void>;
+
+export type PubSubTopic = string;
+export type ContentTopic = string;

package/src/protocols.ts

@@ -62,6 +62,15 @@ export type Callback<T extends IDecodedMessage> = (
   msg: T
 ) => void | Promise<void>;
 
+export enum SendError {
+  GENERIC_FAIL = "Generic error",
+  ENCODE_FAILED = "Failed to encode",
+  DECODE_FAILED = "Failed to decode",
+  SIZE_TOO_BIG = "Size is too big",
+  NO_RPC_RESPONSE = "No RPC response",
+}
+
 export interface SendResult {
+  error?: SendError;
   recipients: PeerId[];
 }

package/src/receiver.ts

@@ -1,13 +1,19 @@
 import type { IDecodedMessage, IDecoder } from "./message.js";
+import type {
+  ContentTopic,
+  IAsyncIterator,
+  PubSubTopic,
+  Unsubscribe,
+} from "./misc.js";
 import type { Callback, ProtocolOptions } from "./protocols.js";
 
-type Unsubscribe = () => void | Promise<void>;
-type PubSubTopic = string;
-type ContentTopic = string;
-
 export type ActiveSubscriptions = Map<PubSubTopic, ContentTopic[]>;
 
 export interface IReceiver {
+  toSubscriptionIterator: <T extends IDecodedMessage>(
+    decoders: IDecoder<T> | IDecoder<T>[],
+    opts?: ProtocolOptions
+  ) => Promise<IAsyncIterator<T>>;
   subscribe: <T extends IDecodedMessage>(
     decoders: IDecoder<T> | IDecoder<T>[],
     callback: Callback<T>,