@dxos/hypercore 0.9.1-staging.ee54ba693a → 0.11.0

package/dist/lib/index.mjs

@@ -0,0 +1,161 @@
+import hypercore, { default as hypercore$1 } from "@dxos/vendor-hypercore/hypercore";
+import { callbackify, promisify } from "@dxos/node-std/util";
+import { verifySignature } from "@dxos/crypto";
+import { invariant } from "@dxos/invariant";
+import { arrayToBuffer } from "@dxos/util";
+import { StorageType, createStorage } from "@dxos/random-access-storage";
+import { Readable } from "readable-stream";
+//#region src/crypto.ts
+var __dxlog_file$1 = "/__w/dxos/dxos/packages/common/hypercore/src/crypto.ts";
+/**
+* Create encoding (e.g., from protobuf codec).
+*/
+var createCodecEncoding = (codec, opts) => ({
+	encode: (obj) => arrayToBuffer(codec.encode(obj, opts)),
+	decode: (buffer) => codec.decode(buffer, opts)
+});
+/**
+* Create a custom hypercore crypto signer.
+*/
+var createCrypto = (signer, publicKey) => {
+	invariant(signer, void 0, {
+		"~LogMeta": "~LogMeta",
+		F: __dxlog_file$1,
+		L: 27,
+		S: void 0,
+		A: ["signer", ""]
+	});
+	invariant(publicKey, void 0, {
+		"~LogMeta": "~LogMeta",
+		F: __dxlog_file$1,
+		L: 28,
+		S: void 0,
+		A: ["publicKey", ""]
+	});
+	return {
+		sign: (message, secretKey, cb) => {
+			callbackify(signer.sign.bind(signer))(publicKey, message, (err, result) => {
+				if (err) {
+					cb(err, null);
+					return;
+				}
+				cb(null, arrayToBuffer(result));
+			});
+		},
+		verify: async (message, signature, key, cb) => {
+			callbackify(verifySignature)(publicKey, message, signature, cb);
+		}
+	};
+};
+//#endregion
+//#region src/defaults.ts
+/**
+* https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-feed--hypercorestorage-key-options
+*/
+var defaultFeedOptions = {
+	createIfMissing: true,
+	valueEncoding: "binary"
+};
+/**
+* https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-stream--feedcreatereadstreamoptions
+*/
+var defaultReadStreamOptions = {
+	start: 0,
+	end: Infinity,
+	snapshot: true,
+	tail: false,
+	live: false,
+	timeout: 0,
+	wait: true,
+	batch: 1
+};
+/**
+* https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-stream--feedcreatewritestreamopts
+*/
+var defaultWriteStreamOptions = { maxBlockSize: Infinity };
+/**
+* https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-stream--feedreplicateisinitiator-options
+*/
+var defaultReplicateOptions = {
+	live: false,
+	ack: false,
+	download: true,
+	upload: true,
+	encrypted: true,
+	noise: true
+};
+//#endregion
+//#region src/util.ts
+var py = (obj, fn) => promisify(fn.bind(obj));
+//#endregion
+//#region src/hypercore-factory.ts
+var __dxlog_file = "/__w/dxos/dxos/packages/common/hypercore/src/hypercore-factory.ts";
+/**
+* Creates feeds with default properties.
+*/
+var HypercoreFactory = class {
+	_root;
+	_options;
+	constructor(_root = createStorage({ type: StorageType.RAM }).createDirectory(), _options) {
+		this._root = _root;
+		this._options = _options;
+		invariant(this._root, void 0, {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file,
+			L: 20,
+			S: this,
+			A: ["this._root", ""]
+		});
+	}
+	/**
+	* Creates a feed using a storage factory prefixed with the feed's key.
+	* NOTE: We have to use our `random-access-storage` implementation since the native ones
+	* do not behave uniformly across platforms.
+	*/
+	createFeed(publicKey, options) {
+		const directory = this._root.createDirectory(publicKey.toString("hex"));
+		const storage = (filename) => directory.getOrCreateFile(filename).native;
+		return hypercore$1(storage, publicKey, Object.assign({}, this._options, options));
+	}
+	/**
+	* Creates and opens a feed.
+	*/
+	async openFeed(publicKey, options) {
+		const feed = this.createFeed(publicKey, options);
+		await py(feed, feed.open)();
+		return feed;
+	}
+};
+//#endregion
+//#region src/iterator.ts
+/**
+* Wraps streamx.Readable (hypercore.createReadStream) to a standard Readable stream.
+*
+* The read-stream package is mirror of the streams implementations in Node.js 18.9.0.
+* This function is here to standardize the cast in case there are incompatibilities
+* across different platforms.
+*
+* Hypercore createReadStream returns a `streamx` Readable, which does not close properly on destroy.
+*
+* https://github.com/nodejs/readable-stream
+* https://nodejs.org/api/stream.html#readable-streams
+* https://nodejs.org/dist/v18.9.0/docs/api/stream.html#readablewrapstream
+*/
+var createReadable = (stream) => {
+	return new Readable({ objectMode: true }).wrap(stream);
+};
+/**
+* Converts streamx.Readable (hypercore.createReadStream) to an async iterator.
+*
+* https://github.com/tc39/proposal-async-iteration
+* https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-3.html#async-iteration
+* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators
+* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
+*/
+var createAsyncIterator = (stream) => {
+	return stream[Symbol.asyncIterator]();
+};
+//#endregion
+export { HypercoreFactory, createAsyncIterator, createCodecEncoding, createCrypto, createReadable, defaultFeedOptions, defaultReadStreamOptions, defaultReplicateOptions, defaultWriteStreamOptions, hypercore };
+
+//# sourceMappingURL=index.mjs.map

package/dist/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/crypto.ts","../../src/defaults.ts","../../src/util.ts","../../src/hypercore-factory.ts","../../src/iterator.ts"],"sourcesContent":["//\n// Copyright 2022 DXOS.org\n//\n\nimport { callbackify } from 'node:util';\n\nimport { type Codec, type EncodingOptions } from '@dxos/codec-protobuf';\nimport { type Signer, verifySignature } from '@dxos/crypto';\nimport { invariant } from '@dxos/invariant';\nimport { type PublicKey } from '@dxos/keys';\nimport { arrayToBuffer } from '@dxos/util';\nimport { type AbstractValueEncoding, type Crypto } from '@dxos/vendor-hypercore/hypercore';\n\n/**\n * Create encoding (e.g., from protobuf codec).\n */\nexport const createCodecEncoding = <T>(codec: Codec<T>, opts?: EncodingOptions): AbstractValueEncoding<T> => ({\n  encode: (obj: T) => arrayToBuffer(codec.encode(obj, opts)),\n  decode: (buffer: Buffer) => codec.decode(buffer, opts),\n});\n\n/**\n * Create a custom hypercore crypto signer.\n */\n// TODO(burdon): Create test without adding deps.\nexport const createCrypto = (signer: Signer, publicKey: PublicKey): Crypto => {\n  invariant(signer);\n  invariant(publicKey);\n\n  return {\n    sign: (message, secretKey, cb) => {\n      callbackify(signer.sign.bind(signer!))(publicKey, message, (err, result) => {\n        if (err) {\n          cb(err, null);\n          return;\n        }\n\n        cb(null, arrayToBuffer(result));\n      });\n    },\n\n    verify: async (message, signature, key, cb) => {\n      // NOTE: Uses the public key passed into function.\n      callbackify(verifySignature)(publicKey, message, signature, cb);\n    },\n  };\n};\n","//\n// Copyright 2022 DXOS.org\n//\n\nimport type {\n  HypercoreOptions,\n  ReadStreamOptions,\n  ReplicationOptions,\n  WriteStreamOptions,\n} from '@dxos/vendor-hypercore/hypercore';\n\n/**\n * https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-feed--hypercorestorage-key-options\n */\nexport const defaultFeedOptions: HypercoreOptions = {\n  createIfMissing: true,\n  valueEncoding: 'binary',\n};\n\n/**\n * https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-stream--feedcreatereadstreamoptions\n */\nexport const defaultReadStreamOptions: ReadStreamOptions = {\n  start: 0,\n  end: Infinity,\n  snapshot: true,\n  tail: false,\n  live: false,\n  timeout: 0,\n  wait: true,\n  batch: 1,\n};\n\n/**\n * https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-stream--feedcreatewritestreamopts\n */\nexport const defaultWriteStreamOptions: WriteStreamOptions = {\n  maxBlockSize: Infinity,\n};\n\n/**\n * https://github.com/hypercore-protocol/hypercore/tree/v9.12.0#var-stream--feedreplicateisinitiator-options\n */\nexport const defaultReplicateOptions: ReplicationOptions = {\n  live: false,\n  ack: false,\n  download: true,\n  upload: true,\n  encrypted: true,\n  noise: true,\n};\n","//\n// Copyright 2022 DXOS.org\n//\n\nimport { promisify } from 'node:util';\n\nexport const py = (obj: any, fn: Function) => promisify(fn.bind(obj));\n","//\n// Copyright 2022 DXOS.org\n//\n\nimport { invariant } from '@dxos/invariant';\nimport { type Directory, StorageType, createStorage } from '@dxos/random-access-storage';\nimport hypercore from '@dxos/vendor-hypercore/hypercore';\nimport type { Hypercore, HypercoreOptions } from '@dxos/vendor-hypercore/hypercore';\n\nimport { py } from './util';\n\n/**\n * Creates feeds with default properties.\n */\nexport class HypercoreFactory<T> {\n  constructor(\n    private readonly _root: Directory = createStorage({ type: StorageType.RAM }).createDirectory(),\n    private readonly _options?: HypercoreOptions,\n  ) {\n    invariant(this._root);\n  }\n\n  /**\n   * Creates a feed using a storage factory prefixed with the feed's key.\n   * NOTE: We have to use our `random-access-storage` implementation since the native ones\n   * do not behave uniformly across platforms.\n   */\n  createFeed(publicKey: Buffer, options?: HypercoreOptions): Hypercore<T> {\n    const directory = this._root.createDirectory(publicKey.toString('hex'));\n    const storage = (filename: string) => directory.getOrCreateFile(filename).native;\n    return hypercore(storage, publicKey, Object.assign({}, this._options, options));\n  }\n\n  /**\n   * Creates and opens a feed.\n   */\n  async openFeed(publicKey: Buffer, options?: HypercoreOptions): Promise<Hypercore<T>> {\n    const feed = this.createFeed(publicKey, options);\n    await py(feed, feed.open)(); // TODO(burdon): Sometimes strange bug if done inside function.\n    return feed;\n  }\n}\n","//\n// Copyright 2022 DXOS.org\n//\n\nimport { Readable } from 'readable-stream';\nimport { type Readable as StreamXReadable } from 'streamx';\n\n/**\n * Wraps streamx.Readable (hypercore.createReadStream) to a standard Readable stream.\n *\n * The read-stream package is mirror of the streams implementations in Node.js 18.9.0.\n * This function is here to standardize the cast in case there are incompatibilities\n * across different platforms.\n *\n * Hypercore createReadStream returns a `streamx` Readable, which does not close properly on destroy.\n *\n * https://github.com/nodejs/readable-stream\n * https://nodejs.org/api/stream.html#readable-streams\n * https://nodejs.org/dist/v18.9.0/docs/api/stream.html#readablewrapstream\n */\nexport const createReadable = (stream: StreamXReadable): Readable => {\n  return new Readable({ objectMode: true }).wrap(stream as any);\n};\n\n/**\n * Converts streamx.Readable (hypercore.createReadStream) to an async iterator.\n *\n * https://github.com/tc39/proposal-async-iteration\n * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-3.html#async-iteration\n * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators\n * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols\n */\nexport const createAsyncIterator = (stream: Readable): AsyncIterator<any> => {\n  return stream[Symbol.asyncIterator]();\n};\n"],"mappings":";;;;;;;;;;;;AAgBA,IAAa,uBAA0B,OAAiB,UAAsD;CAC5G,SAAS,QAAW,cAAc,MAAM,OAAO,KAAK,IAAI,CAAC;CACzD,SAAS,WAAmB,MAAM,OAAO,QAAQ,IAAI;AACvD;;;;AAMA,IAAa,gBAAgB,QAAgB,cAAiC;CAC5E,UAAU,QAAK,KAAA,GAAA;EAAA,YAAA;EAAA,GAAA;EAAA,GAAA;EAAA,GAAA,KAAA;EAAA,GAAA,CAAA,UAAA,EAAA;CAAA,CAAC;CAChB,UAAU,WAAQ,KAAA,GAAA;EAAA,YAAA;EAAA,GAAA;EAAA,GAAA;EAAA,GAAA,KAAA;EAAA,GAAA,CAAA,aAAA,EAAA;CAAA,CAAC;CAEnB,OAAO;EACL,OAAO,SAAS,WAAW,OAAO;GAChC,YAAY,OAAO,KAAK,KAAK,MAAO,CAAC,CAAC,CAAC,WAAW,UAAU,KAAK,WAAW;IAC1E,IAAI,KAAK;KACP,GAAG,KAAK,IAAI;KACZ;IACF;IAEA,GAAG,MAAM,cAAc,MAAM,CAAC;GAChC,CAAC;EACH;EAEA,QAAQ,OAAO,SAAS,WAAW,KAAK,OAAO;GAE7C,YAAY,eAAe,CAAC,CAAC,WAAW,SAAS,WAAW,EAAE;EAChE;CACF;AACF;;;;;;AChCA,IAAa,qBAAuC;CAClD,iBAAiB;CACjB,eAAe;AACjB;;;;AAKA,IAAa,2BAA8C;CACzD,OAAO;CACP,KAAK;CACL,UAAU;CACV,MAAM;CACN,MAAM;CACN,SAAS;CACT,MAAM;CACN,OAAO;AACT;;;;AAKA,IAAa,4BAAgD,EAC3D,cAAc,SAChB;;;;AAKA,IAAa,0BAA8C;CACzD,MAAM;CACN,KAAK;CACL,UAAU;CACV,QAAQ;CACR,WAAW;CACX,OAAO;AACT;;;AC5CA,IAAa,MAAM,KAAU,OAAiB,UAAU,GAAG,KAAK,GAAG,CAAC;;;;;;;ACQpE,IAAa,mBAAb,MAAiC;CAEZ;CACA;CAFnB,YACE,QAAoC,cAAc,EAAE,MAAM,YAAY,IAAI,CAAC,CAAC,CAAC,gBAAgB,GAC7F,UACA;EAFiB,KAAA,QAAA;EACA,KAAA,WAAA;EAEjB,UAAU,KAAK,OAAI,KAAA,GAAA;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,cAAA,EAAA;EAAA,CAAC;CACtB;;;;;;CAOA,WAAW,WAAmB,SAA0C;EACtE,MAAM,YAAY,KAAK,MAAM,gBAAgB,UAAU,SAAS,KAAK,CAAC;EACtE,MAAM,WAAW,aAAqB,UAAU,gBAAgB,QAAQ,CAAC,CAAC;EAC1E,OAAO,YAAU,SAAS,WAAW,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,OAAO,CAAC;CAChF;;;;CAKA,MAAM,SAAS,WAAmB,SAAmD;EACnF,MAAM,OAAO,KAAK,WAAW,WAAW,OAAO;EAC/C,MAAM,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC;EAC1B,OAAO;CACT;AACF;;;;;;;;;;;;;;;;ACrBA,IAAa,kBAAkB,WAAsC;CACnE,OAAO,IAAI,SAAS,EAAE,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,MAAa;AAC9D;;;;;;;;;AAUA,IAAa,uBAAuB,WAAyC;CAC3E,OAAO,OAAO,OAAO,cAAc,CAAC;AACtC"}