@libp2p/peer-collections 0.0.0

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,49 @@
+# libp2p-peer-connections <!-- omit in toc -->
+
+> store values against peer ids
+
+## Table of Contents <!-- omit in toc -->
+
+- [Description](#description)
+- [Example](#example)
+- [Installation](#installation)
+- [License](#license)
+  - [Contribution](#contribution)
+
+## Description
+
+ We can't use PeerIds as collection keys because collection keys are compared using same-value-zero equality, so this is just a group of collections that stringifies PeerIds before storing them.
+
+ PeerIds cache stringified versions of themselves so this should be a cheap operation.
+
+## Example
+
+```JavaScript
+import { peerMap, peerSet, peerList } from '@libp2p/peer-collections'
+
+const map = peerMap<string>()
+map.set(peerId, 'value')
+
+const set = peerSet()
+set.add(peerId)
+
+const list = peerList()
+list.push(peerId)
+```
+
+## Installation
+
+```console
+$ npm i @libp2p/peer-collections
+```
+
+## License
+
+Licensed under either of
+
+ * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export { PeerMap, peerMap } from './map.js';
+export { PeerSet, peerSet } from './set.js';
+export { PeerList, peerList } from './list.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA"}

package/dist/src/index.js

@@ -0,0 +1,4 @@
+export { PeerMap, peerMap } from './map.js';
+export { PeerSet, peerSet } from './set.js';
+export { PeerList, peerList } from './list.js';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA"}

package/dist/src/list.d.ts

@@ -0,0 +1,30 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+/**
+ * We can't use PeerIds as list entries because list entries are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export declare class PeerList {
+    private readonly list;
+    constructor(list?: PeerList);
+    [Symbol.iterator](): IterableIterator<PeerId>;
+    concat(list: PeerList): PeerList;
+    entries(): IterableIterator<[number, PeerId]>;
+    every(predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): boolean;
+    filter(predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): PeerList;
+    find(predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): PeerId | undefined;
+    findIndex(predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): number;
+    forEach(predicate: (peerId: PeerId, index: number, arr: PeerList) => void): void;
+    includes(peerId: PeerId): boolean;
+    indexOf(peerId: PeerId): number;
+    pop(): PeerId | undefined;
+    push(...peerIds: PeerId[]): void;
+    shift(): PeerId | undefined;
+    unshift(...peerIds: PeerId[]): number;
+    get length(): number;
+}
+export declare function peerList(map?: PeerList): PeerList;
+//# sourceMappingURL=list.d.ts.map

package/dist/src/list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../src/list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAIxD;;;;;;;GAOG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAU;gBAElB,IAAI,CAAC,EAAE,QAAQ;IAU5B,CAAC,MAAM,CAAC,QAAQ,CAAC;IASjB,MAAM,CAAE,IAAI,EAAE,QAAQ;IAUtB,OAAO,IAAK,gBAAgB,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAS9C,KAAK,CAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,GAAG,OAAO;IAMrF,MAAM,CAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,GAAG,QAAQ;IAcvF,IAAI,CAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,GAAG,MAAM,GAAG,SAAS;IAY/F,SAAS,CAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,GAAG,MAAM;IAMxF,OAAO,CAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;IAMjF,QAAQ,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAIlC,OAAO,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAIhC,GAAG,IAAK,MAAM,GAAG,SAAS;IAU1B,IAAI,CAAE,GAAG,OAAO,EAAE,MAAM,EAAE;IAM1B,KAAK,IAAK,MAAM,GAAG,SAAS;IAU5B,OAAO,CAAE,GAAG,OAAO,EAAE,MAAM,EAAE;IAU7B,IAAI,MAAM,WAET;CACF;AAED,wBAAgB,QAAQ,CAAE,GAAG,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAElD"}

package/dist/src/list.js

@@ -0,0 +1,110 @@
+import { peerIdFromString } from '@libp2p/peer-id';
+import { mapIterable } from './util.js';
+/**
+ * We can't use PeerIds as list entries because list entries are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export class PeerList {
+    constructor(list) {
+        this.list = [];
+        if (list != null) {
+            for (const value of list) {
+                this.list.push(value.toString());
+            }
+        }
+    }
+    [Symbol.iterator]() {
+        return mapIterable(this.list.entries(), (val) => {
+            return peerIdFromString(val[1]);
+        });
+    }
+    concat(list) {
+        const output = new PeerList(this);
+        for (const value of list) {
+            output.push(value);
+        }
+        return output;
+    }
+    entries() {
+        return mapIterable(this.list.entries(), (val) => {
+            return [val[0], peerIdFromString(val[1])];
+        });
+    }
+    every(predicate) {
+        return this.list.every((str, index) => {
+            return predicate(peerIdFromString(str), index, this);
+        });
+    }
+    filter(predicate) {
+        const output = new PeerList();
+        this.list.forEach((str, index) => {
+            const peerId = peerIdFromString(str);
+            if (predicate(peerId, index, this)) {
+                output.push(peerId);
+            }
+        });
+        return output;
+    }
+    find(predicate) {
+        const str = this.list.find((str, index) => {
+            return predicate(peerIdFromString(str), index, this);
+        });
+        if (str == null) {
+            return undefined;
+        }
+        return peerIdFromString(str);
+    }
+    findIndex(predicate) {
+        return this.list.findIndex((str, index) => {
+            return predicate(peerIdFromString(str), index, this);
+        });
+    }
+    forEach(predicate) {
+        this.list.forEach((str, index) => {
+            predicate(peerIdFromString(str), index, this);
+        });
+    }
+    includes(peerId) {
+        return this.list.includes(peerId.toString());
+    }
+    indexOf(peerId) {
+        return this.list.indexOf(peerId.toString());
+    }
+    pop() {
+        const str = this.list.pop();
+        if (str == null) {
+            return undefined;
+        }
+        return peerIdFromString(str);
+    }
+    push(...peerIds) {
+        for (const peerId of peerIds) {
+            this.list.push(peerId.toString());
+        }
+    }
+    shift() {
+        const str = this.list.shift();
+        if (str == null) {
+            return undefined;
+        }
+        return peerIdFromString(str);
+    }
+    unshift(...peerIds) {
+        let len = this.list.length;
+        for (let i = peerIds.length - 1; i > -1; i--) {
+            len = this.list.unshift(peerIds[i].toString());
+        }
+        return len;
+    }
+    get length() {
+        return this.list.length;
+    }
+}
+export function peerList(map) {
+    return new PeerList(map);
+}
+//# sourceMappingURL=list.js.map

package/dist/src/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../src/list.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,OAAO,QAAQ;IAGnB,YAAa,IAAe;QAC1B,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,IAAI,IAAI,IAAI,IAAI,EAAE;YAChB,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE;gBACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;aACjC;SACF;IACH,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,WAAW,CAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EACnB,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACjC,CAAC,CACF,CAAA;IACH,CAAC;IAED,MAAM,CAAE,IAAc;QACpB,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAA;QAEjC,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE;YACxB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACnB;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,OAAO;QACL,OAAO,WAAW,CAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EACnB,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3C,CAAC,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAE,SAAoE;QACzE,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACpC,OAAO,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QACtD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAE,SAAoE;QAC1E,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAA;QAE7B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC/B,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAA;YAEpC,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE;gBAClC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACpB;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC;IAED,IAAI,CAAE,SAAoE;QACxE,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACxC,OAAO,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QACtD,CAAC,CAAC,CAAA;QAEF,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,SAAS,CAAE,SAAoE;QAC7E,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACxC,OAAO,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QACtD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,CAAE,SAAiE;QACxE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC/B,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QAC/C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAE,MAAc;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED,OAAO,CAAE,MAAc;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7C,CAAC;IAED,GAAG;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QAE3B,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,IAAI,CAAE,GAAG,OAAiB;QACxB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;SAClC;IACH,CAAC;IAED,KAAK;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;QAE7B,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,OAAO,CAAE,GAAG,OAAiB;QAC3B,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QAE1B,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5C,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;SAC/C;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;IACzB,CAAC;CACF;AAED,MAAM,UAAU,QAAQ,CAAE,GAAc;IACtC,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAA;AAC1B,CAAC"}

package/dist/src/map.d.ts

@@ -0,0 +1,26 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+/**
+ * We can't use PeerIds as map keys because map keys are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export declare class PeerMap<T> {
+    private readonly map;
+    constructor(map?: PeerMap<T>);
+    [Symbol.iterator](): IterableIterator<[PeerId, T]>;
+    clear(): void;
+    delete(peer: PeerId): void;
+    entries(): IterableIterator<[PeerId, T]>;
+    forEach(fn: (value: T, key: PeerId, map: PeerMap<T>) => void): void;
+    get(peer: PeerId): T | undefined;
+    has(peer: PeerId): boolean;
+    set(peer: PeerId, value: T): void;
+    keys(): IterableIterator<PeerId>;
+    values(): IterableIterator<T>;
+    get size(): number;
+}
+export declare function peerMap<T>(map?: PeerMap<T>): PeerMap<T>;
+//# sourceMappingURL=map.d.ts.map

package/dist/src/map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAIxD;;;;;;;GAOG;AACH,qBAAa,OAAO,CAAE,CAAC;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAgB;gBAEvB,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAU7B,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB,KAAK;IAIL,MAAM,CAAE,IAAI,EAAE,MAAM;IAIpB,OAAO,IAAK,gBAAgB,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IASzC,OAAO,CAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IAMpE,GAAG,CAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIjC,GAAG,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3B,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAI3B,IAAI,IAAK,gBAAgB,CAAC,MAAM,CAAC;IASjC,MAAM;IAIN,IAAI,IAAI,WAEP;CACF;AAED,wBAAgB,OAAO,CAAE,CAAC,EAAG,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAEzD"}

package/dist/src/map.js

@@ -0,0 +1,63 @@
+import { peerIdFromString } from '@libp2p/peer-id';
+import { mapIterable } from './util.js';
+/**
+ * We can't use PeerIds as map keys because map keys are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export class PeerMap {
+    constructor(map) {
+        this.map = new Map();
+        if (map != null) {
+            for (const [key, value] of map.entries()) {
+                this.map.set(key.toString(), value);
+            }
+        }
+    }
+    [Symbol.iterator]() {
+        return this.entries();
+    }
+    clear() {
+        this.map.clear();
+    }
+    delete(peer) {
+        this.map.delete(peer.toString());
+    }
+    entries() {
+        return mapIterable(this.map.entries(), (val) => {
+            return [peerIdFromString(val[0]), val[1]];
+        });
+    }
+    forEach(fn) {
+        this.map.forEach((value, key) => {
+            fn(value, peerIdFromString(key), this);
+        });
+    }
+    get(peer) {
+        return this.map.get(peer.toString());
+    }
+    has(peer) {
+        return this.map.has(peer.toString());
+    }
+    set(peer, value) {
+        this.map.set(peer.toString(), value);
+    }
+    keys() {
+        return mapIterable(this.map.keys(), (val) => {
+            return peerIdFromString(val);
+        });
+    }
+    values() {
+        return this.map.values();
+    }
+    get size() {
+        return this.map.size;
+    }
+}
+export function peerMap(map) {
+    return new PeerMap(map);
+}
+//# sourceMappingURL=map.js.map

package/dist/src/map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.js","sourceRoot":"","sources":["../../src/map.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,OAAO,OAAO;IAGlB,YAAa,GAAgB;QAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAA;QAEpB,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE;gBACxC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAA;aACpC;SACF;IACH,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,OAAO,EAAE,CAAA;IACvB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAA;IAClB,CAAC;IAED,MAAM,CAAE,IAAY;QAClB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IAClC,CAAC;IAED,OAAO;QACL,OAAO,WAAW,CAChB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAClB,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3C,CAAC,CACF,CAAA;IACH,CAAC;IAED,OAAO,CAAE,EAAoD;QAC3D,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC9B,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CAAE,IAAY;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IACtC,CAAC;IAED,GAAG,CAAE,IAAY;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IACtC,CAAC;IAED,GAAG,CAAE,IAAY,EAAE,KAAQ;QACzB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAA;IACtC,CAAC;IAED,IAAI;QACF,OAAO,WAAW,CAChB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EACf,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC,CACF,CAAA;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAA;IAC1B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AAED,MAAM,UAAU,OAAO,CAAM,GAAgB;IAC3C,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;AACzB,CAAC"}

package/dist/src/set.d.ts

@@ -0,0 +1,23 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+/**
+ * We can't use PeerIds as set entries because set entries are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export declare class PeerSet {
+    private readonly set;
+    constructor(set?: PeerSet);
+    get size(): number;
+    [Symbol.iterator](): IterableIterator<PeerId>;
+    add(peer: PeerId): void;
+    clear(): void;
+    delete(peer: PeerId): void;
+    entries(): IterableIterator<[PeerId, PeerId]>;
+    has(peer: PeerId): boolean;
+    values(): IterableIterator<PeerId>;
+}
+export declare function peerSet(set?: PeerSet): PeerSet;
+//# sourceMappingURL=set.d.ts.map

package/dist/src/set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../src/set.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAIxD;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAa;gBAEpB,GAAG,CAAC,EAAE,OAAO;IAU1B,IAAI,IAAI,WAEP;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB,GAAG,CAAE,IAAI,EAAE,MAAM;IAIjB,KAAK;IAIL,MAAM,CAAE,IAAI,EAAE,MAAM;IAIpB,OAAO,IAAK,gBAAgB,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAW9C,GAAG,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3B,MAAM;CAQP;AAED,wBAAgB,OAAO,CAAE,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAE/C"}

package/dist/src/set.js

@@ -0,0 +1,53 @@
+import { peerIdFromString } from '@libp2p/peer-id';
+import { mapIterable } from './util.js';
+/**
+ * We can't use PeerIds as set entries because set entries are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export class PeerSet {
+    constructor(set) {
+        this.set = new Set();
+        if (set != null) {
+            for (const key of set) {
+                this.set.add(key.toString());
+            }
+        }
+    }
+    get size() {
+        return this.set.size;
+    }
+    [Symbol.iterator]() {
+        return this.values();
+    }
+    add(peer) {
+        this.set.add(peer.toString());
+    }
+    clear() {
+        this.set.clear();
+    }
+    delete(peer) {
+        this.set.delete(peer.toString());
+    }
+    entries() {
+        return mapIterable(this.set.entries(), (val) => {
+            const peerId = peerIdFromString(val[0]);
+            return [peerId, peerId];
+        });
+    }
+    has(peer) {
+        return this.set.has(peer.toString());
+    }
+    values() {
+        return mapIterable(this.set.values(), (val) => {
+            return peerIdFromString(val);
+        });
+    }
+}
+export function peerSet(set) {
+    return new PeerSet(set);
+}
+//# sourceMappingURL=set.js.map

package/dist/src/set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set.js","sourceRoot":"","sources":["../../src/set.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,OAAO,OAAO;IAGlB,YAAa,GAAa;QACxB,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAA;QAEpB,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;aAC7B;SACF;IACH,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;IACtB,CAAC;IAED,GAAG,CAAE,IAAY;QACf,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC/B,CAAC;IAED,KAAK;QACH,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAA;IAClB,CAAC;IAED,MAAM,CAAE,IAAY;QAClB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IAClC,CAAC;IAED,OAAO;QACL,OAAO,WAAW,CAChB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAClB,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YAEvC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzB,CAAC,CACF,CAAA;IACH,CAAC;IAED,GAAG,CAAE,IAAY;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IACtC,CAAC;IAED,MAAM;QACJ,OAAO,WAAW,CAChB,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,EACjB,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC,CACF,CAAA;IACH,CAAC;CACF;AAED,MAAM,UAAU,OAAO,CAAE,GAAa;IACpC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;AACzB,CAAC"}

package/dist/src/util.d.ts

@@ -0,0 +1,2 @@
+export declare function mapIterable<T, R>(iter: IterableIterator<T>, map: (val: T) => R): IterableIterator<R>;
+//# sourceMappingURL=util.d.ts.map

package/dist/src/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AACA,wBAAgB,WAAW,CAAE,CAAC,EAAE,CAAC,EAAG,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CA0BtG"}

package/dist/src/util.js

@@ -0,0 +1,24 @@
+export function mapIterable(iter, map) {
+    const iterator = {
+        [Symbol.iterator]: () => {
+            return iterator;
+        },
+        next: () => {
+            const next = iter.next();
+            const val = next.value;
+            if (next.done === true || val == null) {
+                const result = {
+                    done: true,
+                    value: undefined
+                };
+                return result;
+            }
+            return {
+                done: false,
+                value: map(val)
+            };
+        }
+    };
+    return iterator;
+}
+//# sourceMappingURL=util.js.map

package/dist/src/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AACA,MAAM,UAAU,WAAW,CAAS,IAAyB,EAAE,GAAkB;IAC/E,MAAM,QAAQ,GAAwB;QACpC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE;YACtB,OAAO,QAAQ,CAAA;QACjB,CAAC;QACD,IAAI,EAAE,GAAG,EAAE;YACT,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAA;YAEtB,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,GAAG,IAAI,IAAI,EAAE;gBACrC,MAAM,MAAM,GAA8B;oBACxC,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,SAAS;iBACjB,CAAA;gBAED,OAAO,MAAM,CAAA;aACd;YAED,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC;aAChB,CAAA;QACH,CAAC;KACF,CAAA;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC"}

package/package.json

@@ -0,0 +1,142 @@
+{
+  "name": "@libp2p/peer-collections",
+  "version": "0.0.0",
+  "description": "Stores values against a peer id",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-peer-collections#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-interfaces.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-interfaces/issues"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test -f ./dist/test/*.js -f ./dist/test/**/*.js",
+    "test:chrome": "npm run test -- -t browser",
+    "test:chrome-webworker": "npm run test -- -t webworker",
+    "test:firefox": "npm run test -- -t browser -- --browser firefox",
+    "test:firefox-webworker": "npm run test -- -t webworker -- --browser firefox",
+    "test:node": "npm run test -- -t node --cov",
+    "test:electron-main": "npm run test -- -t electron-main"
+  },
+  "dependencies": {
+    "@libp2p/interfaces": "^1.3.0"
+  },
+  "devDependencies": {
+    "@libp2p/peer-id": "^1.1.0",
+    "@libp2p/peer-id-factory": "^1.0.0",
+    "aegir": "^36.1.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export { PeerMap, peerMap } from './map.js'
+export { PeerSet, peerSet } from './set.js'
+export { PeerList, peerList } from './list.js'

package/src/list.ts

@@ -0,0 +1,149 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id'
+import { peerIdFromString } from '@libp2p/peer-id'
+import { mapIterable } from './util.js'
+
+/**
+ * We can't use PeerIds as list entries because list entries are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export class PeerList {
+  private readonly list: string[]
+
+  constructor (list?: PeerList) {
+    this.list = []
+
+    if (list != null) {
+      for (const value of list) {
+        this.list.push(value.toString())
+      }
+    }
+  }
+
+  [Symbol.iterator] () {
+    return mapIterable<[number, string], PeerId>(
+      this.list.entries(),
+      (val) => {
+        return peerIdFromString(val[1])
+      }
+    )
+  }
+
+  concat (list: PeerList) {
+    const output = new PeerList(this)
+
+    for (const value of list) {
+      output.push(value)
+    }
+
+    return output
+  }
+
+  entries (): IterableIterator<[number, PeerId]> {
+    return mapIterable<[number, string], [number, PeerId]>(
+      this.list.entries(),
+      (val) => {
+        return [val[0], peerIdFromString(val[1])]
+      }
+    )
+  }
+
+  every (predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): boolean {
+    return this.list.every((str, index) => {
+      return predicate(peerIdFromString(str), index, this)
+    })
+  }
+
+  filter (predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): PeerList {
+    const output = new PeerList()
+
+    this.list.forEach((str, index) => {
+      const peerId = peerIdFromString(str)
+
+      if (predicate(peerId, index, this)) {
+        output.push(peerId)
+      }
+    })
+
+    return output
+  }
+
+  find (predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): PeerId | undefined {
+    const str = this.list.find((str, index) => {
+      return predicate(peerIdFromString(str), index, this)
+    })
+
+    if (str == null) {
+      return undefined
+    }
+
+    return peerIdFromString(str)
+  }
+
+  findIndex (predicate: (peerId: PeerId, index: number, arr: PeerList) => boolean): number {
+    return this.list.findIndex((str, index) => {
+      return predicate(peerIdFromString(str), index, this)
+    })
+  }
+
+  forEach (predicate: (peerId: PeerId, index: number, arr: PeerList) => void): void {
+    this.list.forEach((str, index) => {
+      predicate(peerIdFromString(str), index, this)
+    })
+  }
+
+  includes (peerId: PeerId): boolean {
+    return this.list.includes(peerId.toString())
+  }
+
+  indexOf (peerId: PeerId): number {
+    return this.list.indexOf(peerId.toString())
+  }
+
+  pop (): PeerId | undefined {
+    const str = this.list.pop()
+
+    if (str == null) {
+      return undefined
+    }
+
+    return peerIdFromString(str)
+  }
+
+  push (...peerIds: PeerId[]) {
+    for (const peerId of peerIds) {
+      this.list.push(peerId.toString())
+    }
+  }
+
+  shift (): PeerId | undefined {
+    const str = this.list.shift()
+
+    if (str == null) {
+      return undefined
+    }
+
+    return peerIdFromString(str)
+  }
+
+  unshift (...peerIds: PeerId[]) {
+    let len = this.list.length
+
+    for (let i = peerIds.length - 1; i > -1; i--) {
+      len = this.list.unshift(peerIds[i].toString())
+    }
+
+    return len
+  }
+
+  get length () {
+    return this.list.length
+  }
+}
+
+export function peerList (map?: PeerList): PeerList {
+  return new PeerList(map)
+}

package/src/map.ts

@@ -0,0 +1,85 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id'
+import { peerIdFromString } from '@libp2p/peer-id'
+import { mapIterable } from './util.js'
+
+/**
+ * We can't use PeerIds as map keys because map keys are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export class PeerMap <T> {
+  private readonly map: Map<string, T>
+
+  constructor (map?: PeerMap<T>) {
+    this.map = new Map()
+
+    if (map != null) {
+      for (const [key, value] of map.entries()) {
+        this.map.set(key.toString(), value)
+      }
+    }
+  }
+
+  [Symbol.iterator] () {
+    return this.entries()
+  }
+
+  clear () {
+    this.map.clear()
+  }
+
+  delete (peer: PeerId) {
+    this.map.delete(peer.toString())
+  }
+
+  entries (): IterableIterator<[PeerId, T]> {
+    return mapIterable<[string, T], [PeerId, T]>(
+      this.map.entries(),
+      (val) => {
+        return [peerIdFromString(val[0]), val[1]]
+      }
+    )
+  }
+
+  forEach (fn: (value: T, key: PeerId, map: PeerMap<T>) => void): void {
+    this.map.forEach((value, key) => {
+      fn(value, peerIdFromString(key), this)
+    })
+  }
+
+  get (peer: PeerId): T | undefined {
+    return this.map.get(peer.toString())
+  }
+
+  has (peer: PeerId): boolean {
+    return this.map.has(peer.toString())
+  }
+
+  set (peer: PeerId, value: T) {
+    this.map.set(peer.toString(), value)
+  }
+
+  keys (): IterableIterator<PeerId> {
+    return mapIterable<string, PeerId>(
+      this.map.keys(),
+      (val) => {
+        return peerIdFromString(val)
+      }
+    )
+  }
+
+  values () {
+    return this.map.values()
+  }
+
+  get size () {
+    return this.map.size
+  }
+}
+
+export function peerMap <T> (map?: PeerMap<T>): PeerMap<T> {
+  return new PeerMap(map)
+}

package/src/set.ts

@@ -0,0 +1,73 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id'
+import { peerIdFromString } from '@libp2p/peer-id'
+import { mapIterable } from './util.js'
+
+/**
+ * We can't use PeerIds as set entries because set entries are
+ * compared using same-value-zero equality, so this is just
+ * a map that stringifies the PeerIds before storing them.
+ *
+ * PeerIds cache stringified versions of themselves so this
+ * should be a cheap operation.
+ */
+export class PeerSet {
+  private readonly set: Set<string>
+
+  constructor (set?: PeerSet) {
+    this.set = new Set()
+
+    if (set != null) {
+      for (const key of set) {
+        this.set.add(key.toString())
+      }
+    }
+  }
+
+  get size () {
+    return this.set.size
+  }
+
+  [Symbol.iterator] () {
+    return this.values()
+  }
+
+  add (peer: PeerId) {
+    this.set.add(peer.toString())
+  }
+
+  clear () {
+    this.set.clear()
+  }
+
+  delete (peer: PeerId) {
+    this.set.delete(peer.toString())
+  }
+
+  entries (): IterableIterator<[PeerId, PeerId]> {
+    return mapIterable<[string, string], [PeerId, PeerId]>(
+      this.set.entries(),
+      (val) => {
+        const peerId = peerIdFromString(val[0])
+
+        return [peerId, peerId]
+      }
+    )
+  }
+
+  has (peer: PeerId): boolean {
+    return this.set.has(peer.toString())
+  }
+
+  values () {
+    return mapIterable<string, PeerId>(
+      this.set.values(),
+      (val) => {
+        return peerIdFromString(val)
+      }
+    )
+  }
+}
+
+export function peerSet (set?: PeerSet): PeerSet {
+  return new PeerSet(set)
+}

package/src/util.ts

@@ -0,0 +1,28 @@
+
+export function mapIterable <T, R> (iter: IterableIterator<T>, map: (val: T) => R): IterableIterator<R> {
+  const iterator: IterableIterator<R> = {
+    [Symbol.iterator]: () => {
+      return iterator
+    },
+    next: () => {
+      const next = iter.next()
+      const val = next.value
+
+      if (next.done === true || val == null) {
+        const result: IteratorReturnResult<any> = {
+          done: true,
+          value: undefined
+        }
+
+        return result
+      }
+
+      return {
+        done: false,
+        value: map(val)
+      }
+    }
+  }
+
+  return iterator
+}