Merge branch 'docs/update-readme-and-changelog'

Author: vveerrgg

CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.5] - 2025-01-13
+
+### Changed
+- Fixed TypeScript errors related to unknown type assignments across multiple files.
+- Improved error handling by converting error objects to strings before logging.
+- Updated logger imports to use default imports where necessary.
+- Ensured consistent logging practices throughout the codebase.
+
+### Added
+- Created a CHECKLIST.md file for future development and maintenance reference.
+
+## [0.6.4] - 2025-01-13
+
+### Added
+- Enhanced webpack compatibility for client-side usage
+- Improved TypeScript type definitions
+- Additional documentation for module usage patterns
+
+## [0.6.3] - 2025-01-05
+
+### Changed
+- Updated dependency versions for better compatibility
+- Improved error handling in key management functions
+
 ## [0.6.2] - 2024-12-29
 
 ### Changed

README.md

@@ -180,6 +180,35 @@ const isValid = await isDelegationValid(delegation);
 const expiry = getDelegationExpiry(delegation);
 ```
 
+## Module Support
+
+This package supports both ESM and CommonJS usage:
+
+### ESM (recommended)
+```typescript
+import { generateKeyPairWithSeed } from 'nostr-nsec-seedphrase';
+```
+
+### CommonJS
+```javascript
+const { generateKeyPairWithSeed } = require('nostr-nsec-seedphrase');
+```
+
+### Webpack Usage
+The package is fully compatible with webpack for client-side applications. Add to your webpack config:
+
+```javascript
+module.exports = {
+  resolve: {
+    fallback: {
+      "crypto": require.resolve("crypto-browserify"),
+      "stream": require.resolve("stream-browserify"),
+      "buffer": require.resolve("buffer/")
+    }
+  }
+};
+```
+
 ## Documentation
 
 The library includes comprehensive TypeScript types and JSDoc documentation. You can:
@@ -189,7 +218,11 @@ The library includes comprehensive TypeScript types and JSDoc documentation. You
    ```bash
    npm run docs
    ```
-3. Access the generated documentation in the `docs` directory
+3. View the generated documentation locally:
+   ```bash
+   npm run docs:serve
+   ```
+4. Access the generated documentation in the `docs` directory
 
 ### Key Format Utilities
 
@@ -233,3 +266,10 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
 ## License
 
 MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Version 0.6.5
+- Fixed TypeScript errors related to unknown type assignments across multiple files.
+- Improved error handling by converting error objects to strings before logging.
+- Updated logger imports to use default imports where necessary.
+- Ensured consistent logging practices throughout the codebase.
+- Added a checklist for future reference.

dist/bips/bip39.js

@@ -1,5 +1,5 @@
 import { generateMnemonic, validateMnemonic, mnemonicToEntropy } from 'bip39';
-import { logger } from '../utils/logger.js';
+import { logger } from '../utils/logger';
 /**
  * Generates a new BIP39 seed phrase
  * @returns {string} The generated seed phrase
@@ -12,7 +12,7 @@ export function generateSeedPhrase() {
         return generateMnemonic();
     }
     catch (error) {
-        logger.error('Failed to generate seed phrase:', error);
+        logger.error('Failed to generate seed phrase:', error instanceof Error ? error.message : String(error));
         throw new Error('Failed to generate seed phrase');
     }
 }
@@ -29,7 +29,7 @@ export function validateSeedPhrase(seedPhrase) {
         return validateMnemonic(seedPhrase);
     }
     catch (error) {
-        logger.error('Failed to validate seed phrase:', error);
+        logger.error('Failed to validate seed phrase:', error instanceof Error ? error.message : String(error));
         return false;
     }
 }
@@ -57,7 +57,7 @@ export function getEntropyFromSeedPhrase(seedPhrase) {
         return entropyBytes;
     }
     catch (error) {
-        logger.error('Failed to get entropy from seed phrase:', error);
+        logger.error('Failed to get entropy from seed phrase:', error instanceof Error ? error.message : String(error));
         throw new Error('Failed to get entropy from seed phrase');
     }
 }

dist/browser.d.ts

@@ -0,0 +1 @@
+export * from './index';

dist/browser.js

@@ -0,0 +1,13 @@
+// Re-export everything from index
+export * from './index';
+// Add browser-specific implementations or overrides here
+import { Buffer } from 'buffer';
+if (typeof window !== 'undefined') {
+    window.Buffer = Buffer;
+}
+// Add any browser-specific initialization code here
+const isBrowser = typeof window !== 'undefined';
+if (isBrowser) {
+    // Initialize any browser-specific features
+    console.log('NostrNsecSeedphrase loaded in browser environment');
+}

dist/browser/nostr-nsec-seedphrase.min.js

@@ -0,0 +1,12 @@
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
+/*! noble-hashes - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+
+/*! noble-secp256k1 - MIT License (c) 2019 Paul Miller (paulmillr.com) */

dist/browser/nostr-nsec-seedphrase.min.js.LICENSE.txt

@@ -0,0 +1,26 @@
+import { bytesToHex as originalBytesToHex, hexToBytes as originalHexToBytes } from "@noble/hashes/utils";
+export declare function getPublicKey(privateKey: Uint8Array | string): Uint8Array;
+export declare const schnorr: {
+    sign(message: Uint8Array | string, privateKey: Uint8Array | string): Promise<Uint8Array>;
+    verify(signature: Uint8Array | string, message: Uint8Array | string, publicKey: Uint8Array | string): Promise<boolean>;
+};
+export declare const utils: {
+    bytesToHex: typeof originalBytesToHex;
+    hexToBytes: typeof originalHexToBytes;
+    isValidPrivateKey(key: Uint8Array | string): boolean;
+    randomPrivateKey(): Uint8Array;
+};
+declare const _default: {
+    getPublicKey: typeof getPublicKey;
+    schnorr: {
+        sign(message: Uint8Array | string, privateKey: Uint8Array | string): Promise<Uint8Array>;
+        verify(signature: Uint8Array | string, message: Uint8Array | string, publicKey: Uint8Array | string): Promise<boolean>;
+    };
+    utils: {
+        bytesToHex: typeof originalBytesToHex;
+        hexToBytes: typeof originalHexToBytes;
+        isValidPrivateKey(key: Uint8Array | string): boolean;
+        randomPrivateKey(): Uint8Array;
+    };
+};
+export default _default;

dist/browser/report.html

@@ -0,0 +1,14 @@
+declare function toWords(data: Uint8Array): number[];
+declare function fromWords(words: number[]): number[];
+declare function encode(prefix: string, words: number[], limit: number): string;
+declare function decode(str: string, limit?: number): {
+    prefix: string;
+    words: number[];
+};
+export declare const bech32: {
+    toWords: typeof toWords;
+    fromWords: typeof fromWords;
+    encode: typeof encode;
+    decode: typeof decode;
+};
+export {};

dist/cjs/__mocks__/@noble/secp256k1.d.ts

@@ -0,0 +1,3 @@
+export declare function generateMnemonic(): string;
+export declare function validateMnemonic(mnemonic: string): boolean;
+export declare function mnemonicToEntropy(mnemonic: string): string;

dist/cjs/__mocks__/bech32.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generates a new BIP39 seed phrase
+ * @returns {string} The generated seed phrase
+ * @example
+ * const seedPhrase = generateSeedPhrase();
+ * console.log(seedPhrase); // "witch collapse practice feed shame open despair creek road again ice least"
+ */
+export declare function generateSeedPhrase(): string;
+/**
+ * Validates a BIP39 seed phrase
+ * @param {string} seedPhrase - The seed phrase to validate
+ * @returns {boolean} True if the seed phrase is valid
+ * @example
+ * const isValid = validateSeedPhrase("witch collapse practice feed shame open despair creek road again ice least");
+ * console.log(isValid); // true
+ */
+export declare function validateSeedPhrase(seedPhrase: string): boolean;
+/**
+ * Converts a BIP39 seed phrase to its entropy value
+ * @param {string} seedPhrase - The BIP39 seed phrase to convert
+ * @returns {Uint8Array} The entropy value
+ * @throws {Error} If the seed phrase is invalid
+ * @example
+ * const entropy = getEntropyFromSeedPhrase("witch collapse practice feed shame open despair creek road again ice least");
+ * console.log(entropy); // Uint8Array
+ */
+export declare function getEntropyFromSeedPhrase(seedPhrase: string): Uint8Array;

dist/cjs/__mocks__/bip39.d.ts

@@ -4,7 +4,7 @@ exports.generateSeedPhrase = generateSeedPhrase;
 exports.validateSeedPhrase = validateSeedPhrase;
 exports.getEntropyFromSeedPhrase = getEntropyFromSeedPhrase;
 const bip39_1 = require("bip39");
-const logger_js_1 = require("../utils/logger.js");
+const logger_1 = require("../utils/logger");
 /**
  * Generates a new BIP39 seed phrase
  * @returns {string} The generated seed phrase
@@ -17,7 +17,7 @@ function generateSeedPhrase() {
         return (0, bip39_1.generateMnemonic)();
     }
     catch (error) {
-        logger_js_1.logger.error('Failed to generate seed phrase:', error);
+        logger_1.logger.error('Failed to generate seed phrase:', error instanceof Error ? error.message : String(error));
         throw new Error('Failed to generate seed phrase');
     }
 }
@@ -34,7 +34,7 @@ function validateSeedPhrase(seedPhrase) {
         return (0, bip39_1.validateMnemonic)(seedPhrase);
     }
     catch (error) {
-        logger_js_1.logger.error('Failed to validate seed phrase:', error);
+        logger_1.logger.error('Failed to validate seed phrase:', error instanceof Error ? error.message : String(error));
         return false;
     }
 }
@@ -62,7 +62,7 @@ function getEntropyFromSeedPhrase(seedPhrase) {
         return entropyBytes;
     }
     catch (error) {
-        logger_js_1.logger.error('Failed to get entropy from seed phrase:', error);
+        logger_1.logger.error('Failed to get entropy from seed phrase:', error instanceof Error ? error.message : String(error));
         throw new Error('Failed to get entropy from seed phrase');
     }
 }

dist/cjs/bips/bip39.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module bips
+ * @description Bitcoin Improvement Proposals (BIPs) implementations
+ */
+export * from './bip39.js';

dist/cjs/bips/bip39.js

@@ -0,0 +1 @@
+export * from './index';

dist/cjs/bips/index.d.ts

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Re-export everything from index
+__exportStar(require("./index"), exports);
+// Add browser-specific implementations or overrides here
+const buffer_1 = require("buffer");
+if (typeof window !== 'undefined') {
+    window.Buffer = buffer_1.Buffer;
+}
+// Add any browser-specific initialization code here
+const isBrowser = typeof window !== 'undefined';
+if (isBrowser) {
+    // Initialize any browser-specific features
+    console.log('NostrNsecSeedphrase loaded in browser environment');
+}

dist/cjs/browser.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @module constants
+ * @description Constants used throughout the library
+ */
+/**
+ * Standard Nostr message types as defined in NIP-01
+ * @see https://github.com/nostr-protocol/nips/blob/master/01.md
+ */
+export declare const NOSTR_MESSAGE_TYPE: {
+    readonly EVENT: "EVENT";
+    readonly REQ: "REQ";
+    readonly CLOSE: "CLOSE";
+    readonly NOTICE: "NOTICE";
+    readonly EOSE: "EOSE";
+    readonly OK: "OK";
+    readonly AUTH: "AUTH";
+    readonly ERROR: "ERROR";
+};
+/**
+ * Standard Nostr event kinds as defined in various NIPs
+ * @see https://github.com/nostr-protocol/nips
+ */
+export declare const NOSTR_EVENT_KIND: {
+    readonly SET_METADATA: 0;
+    readonly TEXT_NOTE: 1;
+    readonly RECOMMEND_SERVER: 2;
+    readonly CONTACT_LIST: 3;
+    readonly ENCRYPTED_DIRECT_MESSAGE: 4;
+    readonly DELETE: 5;
+    readonly REPOST: 6;
+    readonly REACTION: 7;
+    readonly BADGE_AWARD: 8;
+    readonly CHANNEL_CREATE: 40;
+    readonly CHANNEL_METADATA: 41;
+    readonly CHANNEL_MESSAGE: 42;
+    readonly CHANNEL_HIDE_MESSAGE: 43;
+    readonly CHANNEL_MUTE_USER: 44;
+    readonly CHANNEL_RESERVED_FIRST: 40;
+    readonly CHANNEL_RESERVED_LAST: 49;
+    readonly REPLACEABLE_FIRST: 10000;
+    readonly REPLACEABLE_LAST: 19999;
+    readonly EPHEMERAL_FIRST: 20000;
+    readonly EPHEMERAL_LAST: 29999;
+    readonly PARAMETERIZED_REPLACEABLE_FIRST: 30000;
+    readonly PARAMETERIZED_REPLACEABLE_LAST: 39999;
+};
+/**
+ * Standard Nostr tag types
+ */
+export declare const NOSTR_TAG: {
+    readonly EVENT: "e";
+    readonly PUBKEY: "p";
+    readonly REFERENCE: "a";
+    readonly DELEGATION: "delegation";
+    readonly DEDUPLICATION: "d";
+    readonly EXPIRATION: "expiration";
+    readonly KIND: "k";
+    readonly RELAY: "relay";
+};
+/**
+ * Protocol-related constants
+ */
+export declare const Protocol: {
+    readonly DEFAULT_RELAY_URL: "wss://relay.nostr.info";
+    readonly RECONNECT_DELAY: 1000;
+    readonly MAX_RECONNECT_DELAY: 30000;
+    readonly PING_INTERVAL: 30000;
+    readonly SUBSCRIPTION_TIMEOUT: 10000;
+};
+/**
+ * Default values
+ */
+export declare const Defaults: {
+    readonly KIND: 1;
+    readonly CREATED_AT: () => number;
+    readonly TAGS: string[][];
+    readonly CONTENT: "";
+};