@dxos/keys - npm Package Compare versions

Comparing version 0.5.8 to 0.5.9-main.8359215

dist/lib/browser/meta.json

@@ -1,1 +0,1 @@
-{"inputs":{"packages/common/keys/src/public-key.ts":{"bytes":29335,"imports":[{"path":"@dxos/node-std/util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/node-std/crypto","kind":"require-call","external":true}],"format":"esm"},"packages/common/keys/src/types.ts":{"bytes":673,"imports":[],"format":"esm"},"packages/common/keys/src/index.ts":{"bytes":579,"imports":[{"path":"packages/common/keys/src/public-key.ts","kind":"import-statement","original":"./public-key"},{"path":"packages/common/keys/src/types.ts","kind":"import-statement","original":"./types"}],"format":"esm"}},"outputs":{"packages/common/keys/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":13773},"packages/common/keys/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/node-std/util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/node-std/crypto","kind":"require-call","external":true}],"exports":["PUBLIC_KEY_LENGTH","PublicKey","SECRET_KEY_LENGTH"],"entryPoint":"packages/common/keys/src/index.ts","inputs":{"packages/common/keys/src/public-key.ts":{"bytesInOutput":7265},"packages/common/keys/src/index.ts":{"bytesInOutput":0}},"bytes":7778}}}
+{"inputs":{"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js":{"bytes":1217,"imports":[],"format":"cjs"},"node_modules/.pnpm/to-data-view@2.0.0/node_modules/to-data-view/index.js":{"bytes":410,"imports":[],"format":"esm"},"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js":{"bytes":1266,"imports":[{"path":"node_modules/.pnpm/to-data-view@2.0.0/node_modules/to-data-view/index.js","kind":"import-statement","original":"to-data-view"}],"format":"esm"},"packages/common/keys/src/random-bytes.ts":{"bytes":1792,"imports":[{"path":"@dxos/node-std/crypto","kind":"require-call","external":true}],"format":"esm"},"packages/common/keys/src/public-key.ts":{"bytes":30143,"imports":[{"path":"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js","kind":"import-statement","original":"base32-decode"},{"path":"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js","kind":"import-statement","original":"base32-encode"},{"path":"@dxos/node-std/util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"packages/common/keys/src/random-bytes.ts","kind":"import-statement","original":"./random-bytes"}],"format":"esm"},"packages/common/keys/src/types.ts":{"bytes":528,"imports":[],"format":"esm"},"packages/common/keys/src/space-id.ts":{"bytes":5162,"imports":[{"path":"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js","kind":"import-statement","original":"base32-decode"},{"path":"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js","kind":"import-statement","original":"base32-encode"},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"packages/common/keys/src/random-bytes.ts","kind":"import-statement","original":"./random-bytes"}],"format":"esm"},"packages/common/keys/src/index.ts":{"bytes":667,"imports":[{"path":"packages/common/keys/src/public-key.ts","kind":"import-statement","original":"./public-key"},{"path":"packages/common/keys/src/types.ts","kind":"import-statement","original":"./types"},{"path":"packages/common/keys/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"format":"esm"}},"outputs":{"packages/common/keys/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":22643},"packages/common/keys/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/node-std/util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/node-std/crypto","kind":"require-call","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"exports":["PUBLIC_KEY_LENGTH","PublicKey","SECRET_KEY_LENGTH","SpaceId"],"entryPoint":"packages/common/keys/src/index.ts","inputs":{"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js":{"bytesInOutput":1554},"packages/common/keys/src/public-key.ts":{"bytesInOutput":7653},"node_modules/.pnpm/to-data-view@2.0.0/node_modules/to-data-view/index.js":{"bytesInOutput":395},"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js":{"bytesInOutput":1206},"packages/common/keys/src/random-bytes.ts":{"bytesInOutput":214},"packages/common/keys/src/index.ts":{"bytesInOutput":0},"packages/common/keys/src/space-id.ts":{"bytesInOutput":1431}},"bytes":14705}}}

dist/lib/node/meta.json

@@ -1,1 +0,1 @@
-{"inputs":{"packages/common/keys/src/public-key.ts":{"bytes":29335,"imports":[{"path":"node:util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"node:crypto","kind":"require-call","external":true}],"format":"esm"},"packages/common/keys/src/types.ts":{"bytes":673,"imports":[],"format":"esm"},"packages/common/keys/src/index.ts":{"bytes":579,"imports":[{"path":"packages/common/keys/src/public-key.ts","kind":"import-statement","original":"./public-key"},{"path":"packages/common/keys/src/types.ts","kind":"import-statement","original":"./types"}],"format":"esm"}},"outputs":{"packages/common/keys/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":13772},"packages/common/keys/dist/lib/node/index.cjs":{"imports":[{"path":"node:util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"node:crypto","kind":"require-call","external":true}],"exports":["PUBLIC_KEY_LENGTH","PublicKey","SECRET_KEY_LENGTH"],"entryPoint":"packages/common/keys/src/index.ts","inputs":{"packages/common/keys/src/public-key.ts":{"bytesInOutput":7245},"packages/common/keys/src/index.ts":{"bytesInOutput":0}},"bytes":7758}}}
+{"inputs":{"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js":{"bytes":1217,"imports":[],"format":"cjs"},"node_modules/.pnpm/to-data-view@2.0.0/node_modules/to-data-view/index.js":{"bytes":410,"imports":[],"format":"esm"},"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js":{"bytes":1266,"imports":[{"path":"node_modules/.pnpm/to-data-view@2.0.0/node_modules/to-data-view/index.js","kind":"import-statement","original":"to-data-view"}],"format":"esm"},"packages/common/keys/src/random-bytes.ts":{"bytes":1792,"imports":[{"path":"node:crypto","kind":"require-call","external":true}],"format":"esm"},"packages/common/keys/src/public-key.ts":{"bytes":30143,"imports":[{"path":"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js","kind":"import-statement","original":"base32-decode"},{"path":"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js","kind":"import-statement","original":"base32-encode"},{"path":"node:util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"packages/common/keys/src/random-bytes.ts","kind":"import-statement","original":"./random-bytes"}],"format":"esm"},"packages/common/keys/src/types.ts":{"bytes":528,"imports":[],"format":"esm"},"packages/common/keys/src/space-id.ts":{"bytes":5162,"imports":[{"path":"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js","kind":"import-statement","original":"base32-decode"},{"path":"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js","kind":"import-statement","original":"base32-encode"},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"packages/common/keys/src/random-bytes.ts","kind":"import-statement","original":"./random-bytes"}],"format":"esm"},"packages/common/keys/src/index.ts":{"bytes":667,"imports":[{"path":"packages/common/keys/src/public-key.ts","kind":"import-statement","original":"./public-key"},{"path":"packages/common/keys/src/types.ts","kind":"import-statement","original":"./types"},{"path":"packages/common/keys/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"format":"esm"}},"outputs":{"packages/common/keys/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":22642},"packages/common/keys/dist/lib/node/index.cjs":{"imports":[{"path":"node:util","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"node:crypto","kind":"require-call","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"exports":["PUBLIC_KEY_LENGTH","PublicKey","SECRET_KEY_LENGTH","SpaceId"],"entryPoint":"packages/common/keys/src/index.ts","inputs":{"node_modules/.pnpm/base32-decode@1.0.0/node_modules/base32-decode/index.js":{"bytesInOutput":1554},"packages/common/keys/src/public-key.ts":{"bytesInOutput":7643},"node_modules/.pnpm/to-data-view@2.0.0/node_modules/to-data-view/index.js":{"bytesInOutput":395},"node_modules/.pnpm/base32-encode@2.0.0/node_modules/base32-encode/index.js":{"bytesInOutput":1206},"packages/common/keys/src/random-bytes.ts":{"bytesInOutput":204},"packages/common/keys/src/index.ts":{"bytesInOutput":0},"packages/common/keys/src/space-id.ts":{"bytesInOutput":1431}},"bytes":14685}}}

dist/types/src/index.d.ts

 export * from './public-key';
 export * from './types';
+export * from './space-id';
 //# sourceMappingURL=index.d.ts.map

dist/types/src/public-key.d.ts

@@ -38,2 +38,3 @@ /// <reference types="node" />
     static random(): PublicKey;
+    static randomOfLength(length: number): PublicKey;
     static randomSequence(): Generator<PublicKey>;
@@ -69,2 +70,3 @@ /**
     static hash(key: PublicKey): string;
+    static fromMultibase32(encoded: string): PublicKey;
     constructor(_value: Uint8Array);
@@ -76,2 +78,3 @@ toString(): string;
     toHex(): string;
+    toMultibase32(): string;
     truncate(length?: undefined): string;
@@ -78,0 +81,0 @@ asBuffer(): Buffer;

package.json

 {
   "name": "@dxos/keys",
-  "version": "0.5.8",
+  "version": "0.5.9-main.8359215",
   "description": "Key utils and definitions.",
@@ -24,6 +24,10 @@ "homepage": "https://dxos.org",
   "dependencies": {
-    "@dxos/debug": "0.5.8",
-    "@dxos/invariant": "0.5.8",
-    "@dxos/node-std": "0.5.8"
+    "@dxos/invariant": "0.5.9-main.8359215",
+    "@dxos/debug": "0.5.9-main.8359215",
+    "@dxos/node-std": "0.5.9-main.8359215"
   },
+  "devDependencies": {
+    "base32-decode": "^1.0.0",
+    "base32-encode": "^2.0.0"
+  },
   "publishConfig": {
@@ -30,0 +34,0 @@ "access": "public"

src/index.ts

@@ -7,1 +7,2 @@ //
 export * from './types';
+export * from './space-id';

src/public-key.test.ts

@@ -63,2 +63,9 @@ //
   });
+
+  test('base32', () => {
+    const key = PublicKey.randomOfLength(20); // Space keys will be cut to first 20 bytes of sha-256 hash.
+    const encoded = key.toMultibase32();
+
+    expect(PublicKey.fromMultibase32(encoded).toHex()).to.equal(key.toHex());
+  });
 });

src/public-key.ts

@@ -5,2 +5,4 @@ //
 
+import base32Decode from 'base32-decode';
+import base32Encode from 'base32-encode';
 import { inspect, type InspectOptionsStylized } from 'node:util';
@@ -11,2 +13,4 @@
 
+import { randomBytes } from './random-bytes';
+
 export const PUBLIC_KEY_LENGTH = 32;
@@ -94,2 +98,6 @@ export const SECRET_KEY_LENGTH = 64;
 
+  static randomOfLength(length: number): PublicKey {
+    return PublicKey.from(randomBytes(length));
+  }
+
   static *randomSequence(): Generator<PublicKey> {
@@ -163,2 +171,8 @@ for (let i = 0; i < 1_0000; i++) {
 
+  static fromMultibase32(encoded: string): PublicKey {
+    invariant(encoded.startsWith('B'), 'Invalid multibase32 encoding');
+
+    return new PublicKey(new Uint8Array(base32Decode(encoded.slice(1), 'RFC4648')));
+  }
+
   constructor(private readonly _value: Uint8Array) {
@@ -190,2 +204,6 @@ if (!(_value instanceof Uint8Array)) {
 
+  toMultibase32(): string {
+    return 'B' + base32Encode(this._value, 'RFC4648');
+  }
+
   truncate(length = undefined) {
@@ -299,11 +317,1 @@ return truncateKey(this, length);
 }
-
-const randomBytes = (length: number) => {
-  // globalThis.crypto is not available in Node.js when running in vitest even though the documentation says it should be.
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const webCrypto = globalThis.crypto ?? require('node:crypto').webcrypto;
-
-  const bytes = new Uint8Array(length);
-  webCrypto.getRandomValues(bytes);
-  return bytes;
-};

src/types.ts

@@ -5,3 +5,2 @@ //
 
-// TODO(burdon): Replace with hypercore-crypto type.
 export type KeyPair = {
@@ -8,0 +7,0 @@ publicKey: Buffer;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

105292

increased by60.59%

Number of package files

30

increased by42.86%

Lines of code

1508

increased by47.99%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Dependency changes

• + Added@dxos/debug@0.5.9-main.8359215(transitive)

• + Added@dxos/invariant@0.5.9-main.8359215(transitive)

• + Added@dxos/node-std@0.5.9-main.8359215(transitive)

• - Removed@dxos/debug@0.5.8(transitive)

• - Removed@dxos/invariant@0.5.8(transitive)

• - Removed@dxos/node-std@0.5.8(transitive)

• Updated@dxos/debug@0.5.9-main.8359215

• Updated@dxos/invariant@0.5.9-main.8359215

• Updated@dxos/node-std@0.5.9-main.8359215