applesauce-accounts 0.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 hzrd149
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# applesauce-accounts
+
+A simple nostr account management system

package/dist/account.d.ts

@@ -0,0 +1,31 @@
+import { Nip07Interface } from "applesauce-signer";
+import { EventTemplate } from "nostr-tools";
+import { IAccount, SerializedAccount } from "./types.js";
+export declare class SignerMismatchError extends Error {
+}
+export declare class AccountLockedError extends Error {
+}
+export declare class BaseAccount<T extends string, S> implements IAccount<T, S> {
+    pubkey: string;
+    signer: Nip07Interface;
+    name?: string;
+    locked: boolean;
+    nip04?: {
+        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+    } | undefined;
+    nip44?: {
+        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+    } | undefined;
+    constructor(pubkey: string, signer: Nip07Interface);
+    unlock(): Promise<boolean>;
+    lock(): void;
+    toJSON(): SerializedAccount<T, S>;
+    /** throws if account is locked */
+    protected checkLocked(): void;
+    /** Gets the pubkey from the signer */
+    getPublicKey(): Promise<string>;
+    /** sign the event and make sure its signed with the correct pubkey */
+    signEvent(template: EventTemplate): Promise<import("nostr-tools").Event>;
+}

package/dist/account.js

@@ -0,0 +1,77 @@
+// errors
+export class SignerMismatchError extends Error {
+}
+export class AccountLockedError extends Error {
+}
+export class BaseAccount {
+    pubkey;
+    signer;
+    name;
+    locked = true;
+    // encryption interfaces
+    nip04;
+    nip44;
+    constructor(pubkey, signer) {
+        this.pubkey = pubkey;
+        this.signer = signer;
+        // setup encryption interfaces to check if account is locked
+        if (this.signer.nip04) {
+            this.nip04 = {
+                encrypt: (pubkey, plaintext) => {
+                    this.checkLocked();
+                    return this.signer.nip04.encrypt(pubkey, plaintext);
+                },
+                decrypt: (pubkey, plaintext) => {
+                    this.checkLocked();
+                    return this.signer.nip04.decrypt(pubkey, plaintext);
+                },
+            };
+        }
+        if (this.signer.nip44) {
+            this.nip44 = {
+                encrypt: (pubkey, plaintext) => {
+                    this.checkLocked();
+                    return this.signer.nip44.encrypt(pubkey, plaintext);
+                },
+                decrypt: (pubkey, plaintext) => {
+                    this.checkLocked();
+                    return this.signer.nip44.decrypt(pubkey, plaintext);
+                },
+            };
+        }
+    }
+    async unlock() {
+        this.locked = false;
+        return true;
+    }
+    lock() {
+        this.locked = true;
+    }
+    // This should be overwritten by a sub class
+    toJSON() {
+        throw new Error("Not implemented");
+    }
+    /** throws if account is locked */
+    checkLocked() {
+        if (this.locked)
+            throw new AccountLockedError("Account is locked");
+    }
+    /** Gets the pubkey from the signer */
+    async getPublicKey() {
+        this.checkLocked();
+        const signerKey = await this.signer.getPublicKey();
+        if (this.pubkey !== signerKey)
+            throw new Error("Account signer mismatch");
+        return this.pubkey;
+    }
+    /** sign the event and make sure its signed with the correct pubkey */
+    async signEvent(template) {
+        this.checkLocked();
+        if (!Reflect.has(template, "pubkey"))
+            Reflect.set(template, "pubkey", this.pubkey);
+        const signed = await this.signer.signEvent(template);
+        if (signed.pubkey !== this.pubkey)
+            throw new SignerMismatchError("Signer signed with wrong pubkey");
+        return signed;
+    }
+}

package/dist/accounts/amber-clipboard-account.d.ts

@@ -0,0 +1,10 @@
+import { AmberClipboardSigner } from "applesauce-signer/signers/amber-clipboard-signer";
+import { BaseAccount } from "../account.js";
+import { IAccount, SerializedAccount } from "../types.js";
+/** An account for the amber clipboard api */
+export declare class AmberClipboardAccount extends BaseAccount<"amber-clipboard", void> {
+    signer: AmberClipboardSigner;
+    constructor(pubkey: string, signer: AmberClipboardSigner);
+    toJSON(): SerializedAccount<"amber-clipboard", void>;
+    static fromJSON(json: SerializedAccount<"amber-clipboard", void>): IAccount<"amber-clipboard", void>;
+}

package/dist/accounts/amber-clipboard-account.js

@@ -0,0 +1,16 @@
+import { AmberClipboardSigner } from "applesauce-signer/signers/amber-clipboard-signer";
+import { BaseAccount } from "../account.js";
+/** An account for the amber clipboard api */
+export class AmberClipboardAccount extends BaseAccount {
+    signer;
+    constructor(pubkey, signer) {
+        super(pubkey, signer);
+        this.signer = signer;
+    }
+    toJSON() {
+        return { type: "amber-clipboard", pubkey: this.pubkey, name: this.name, signer: void 0 };
+    }
+    static fromJSON(json) {
+        return new AmberClipboardAccount(json.pubkey, new AmberClipboardSigner());
+    }
+}

package/dist/accounts/extension-account.d.ts

@@ -0,0 +1,7 @@
+import { BaseAccount } from "../account.js";
+import { SerializedAccount } from "../types.js";
+export default class ExtensionAccount extends BaseAccount<"extension", void> {
+    constructor(pubkey: string);
+    toJSON(): SerializedAccount<"extension", void>;
+    static fromJSON(json: SerializedAccount<"extension", void>): ExtensionAccount;
+}

package/dist/accounts/extension-account.js

@@ -0,0 +1,13 @@
+import { ExtensionSigner } from "applesauce-signer/signers/extension-signer";
+import { BaseAccount } from "../account.js";
+export default class ExtensionAccount extends BaseAccount {
+    constructor(pubkey) {
+        super(pubkey, new ExtensionSigner());
+    }
+    toJSON() {
+        return { type: "extension", pubkey: this.pubkey, signer: undefined };
+    }
+    static fromJSON(json) {
+        return new ExtensionAccount(json.pubkey);
+    }
+}

package/dist/accounts/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./amber-clipboard-account.js";
+export * from "./extension-account.js";
+export * from "./password-account.js";
+export * from "./readonly-account.js";
+export * from "./serial-port-account.js";
+export * from "./simple-account.js";

package/dist/accounts/index.js

@@ -0,0 +1,6 @@
+export * from "./amber-clipboard-account.js";
+export * from "./extension-account.js";
+export * from "./password-account.js";
+export * from "./readonly-account.js";
+export * from "./serial-port-account.js";
+export * from "./simple-account.js";

package/dist/accounts/password-account.d.ts

@@ -0,0 +1,15 @@
+import { PasswordSigner } from "applesauce-signer/signers/password-signer";
+import { BaseAccount } from "../account.js";
+import { SerializedAccount } from "../types.js";
+type SignerData = {
+    ncryptsec: string;
+};
+export default class PasswordAccount extends BaseAccount<"ncryptsec", SignerData> {
+    signer: PasswordSigner;
+    constructor(pubkey: string, signer: PasswordSigner);
+    unlock(): Promise<boolean>;
+    toJSON(): SerializedAccount<"ncryptsec", SignerData>;
+    static fromJSON(json: SerializedAccount<"ncryptsec", SignerData>): PasswordAccount;
+    static fromNcryptsec(pubkey: string, ncryptsec: string): PasswordAccount;
+}
+export {};

package/dist/accounts/password-account.js

@@ -0,0 +1,36 @@
+import { PasswordSigner } from "applesauce-signer/signers/password-signer";
+import { BaseAccount } from "../account.js";
+export default class PasswordAccount extends BaseAccount {
+    signer;
+    constructor(pubkey, signer) {
+        super(pubkey, signer);
+        this.signer = signer;
+    }
+    async unlock() {
+        try {
+            const password = prompt("Unlock password");
+            if (password === null)
+                return false;
+            await this.signer.unlock(password);
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    toJSON() {
+        if (!this.signer.ncryptsec)
+            throw new Error("Cant save account without ncryptsec");
+        return { type: "ncryptsec", pubkey: this.pubkey, signer: { ncryptsec: this.signer.ncryptsec } };
+    }
+    static fromJSON(json) {
+        const signer = new PasswordSigner();
+        signer.ncryptsec = json.signer.ncryptsec;
+        return new PasswordAccount(json.pubkey, signer);
+    }
+    static fromNcryptsec(pubkey, ncryptsec) {
+        const signer = new PasswordSigner();
+        signer.ncryptsec = ncryptsec;
+        return new PasswordAccount(pubkey, signer);
+    }
+}

package/dist/accounts/readonly-account.d.ts

@@ -0,0 +1,9 @@
+import { ReadonlySigner } from "applesauce-signer/signers/readonly-signer";
+import { BaseAccount } from "../account.js";
+import { SerializedAccount } from "../types.js";
+/** An account that cannot sign or encrypt anything */
+export default class ReadonlyAccount extends BaseAccount<"readonly", void> {
+    constructor(pubkey: string, signer?: ReadonlySigner);
+    toJSON(): SerializedAccount<"readonly", void>;
+    static fromJSON(json: SerializedAccount<"readonly", void>): ReadonlyAccount;
+}

package/dist/accounts/readonly-account.js

@@ -0,0 +1,18 @@
+import { ReadonlySigner } from "applesauce-signer/signers/readonly-signer";
+import { BaseAccount } from "../account.js";
+/** An account that cannot sign or encrypt anything */
+export default class ReadonlyAccount extends BaseAccount {
+    constructor(pubkey, signer) {
+        super(pubkey, signer || new ReadonlySigner(pubkey));
+    }
+    toJSON() {
+        return {
+            type: "readonly",
+            pubkey: this.pubkey,
+            signer: undefined,
+        };
+    }
+    static fromJSON(json) {
+        return new ReadonlyAccount(json.pubkey);
+    }
+}

package/dist/accounts/serial-port-account.d.ts

@@ -0,0 +1,10 @@
+import { SerialPortSigner } from "applesauce-signer/signers/serial-port-signer";
+import { BaseAccount } from "../account.js";
+import { SerializedAccount } from "../types.js";
+/** An account for SerialPortSigner */
+export default class SerialPortAccount extends BaseAccount<"serial-port", void> {
+    constructor(pubkey: string, signer?: SerialPortSigner);
+    unlock(): Promise<boolean>;
+    toJSON(): SerializedAccount<"serial-port", void>;
+    static fromJSON(json: SerializedAccount<"serial-port", void>): SerialPortAccount;
+}

package/dist/accounts/serial-port-account.js

@@ -0,0 +1,25 @@
+import { SerialPortSigner } from "applesauce-signer/signers/serial-port-signer";
+import { BaseAccount } from "../account.js";
+/** An account for SerialPortSigner */
+export default class SerialPortAccount extends BaseAccount {
+    constructor(pubkey, signer) {
+        super(pubkey, signer || new SerialPortSigner());
+    }
+    async unlock() {
+        try {
+            const pubkey = await this.signer.getPublicKey();
+            if (pubkey !== this.pubkey)
+                throw new Error("Signer returned incorrect pubkey");
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    toJSON() {
+        return { type: "serial-port", pubkey: this.pubkey, signer: undefined };
+    }
+    static fromJSON(json) {
+        return new SerialPortAccount(json.pubkey);
+    }
+}

package/dist/accounts/simple-account.d.ts

@@ -0,0 +1,14 @@
+import { SimpleSigner } from "applesauce-signer/signers/simple-signer";
+import { BaseAccount } from "../account.js";
+import { SerializedAccount } from "../types.js";
+type SignerData = {
+    key: string;
+};
+export default class SimpleAccount extends BaseAccount<"nsec", SignerData> {
+    signer: SimpleSigner;
+    constructor(pubkey: string, signer: SimpleSigner);
+    static fromKey(key: Uint8Array | string): SimpleAccount;
+    toJSON(): SerializedAccount<"nsec", SignerData>;
+    static fromJSON(json: SerializedAccount<"nsec", SignerData>): SimpleAccount;
+}
+export {};

package/dist/accounts/simple-account.js

@@ -0,0 +1,24 @@
+import { getPublicKey } from "nostr-tools";
+import { SimpleSigner } from "applesauce-signer/signers/simple-signer";
+import { bytesToHex, hexToBytes } from "@noble/hashes/utils";
+import { BaseAccount } from "../account.js";
+export default class SimpleAccount extends BaseAccount {
+    signer;
+    constructor(pubkey, signer) {
+        super(pubkey, signer);
+        this.signer = signer;
+    }
+    static fromKey(key) {
+        if (typeof key === "string")
+            key = hexToBytes(key);
+        const pubkey = getPublicKey(key);
+        return new SimpleAccount(pubkey, new SimpleSigner(key));
+    }
+    toJSON() {
+        return { type: "nsec", pubkey: this.pubkey, signer: { key: bytesToHex(this.signer.key) } };
+    }
+    static fromJSON(json) {
+        const key = hexToBytes(json.signer.key);
+        return new SimpleAccount(json.pubkey, new SimpleSigner(key));
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * as Accounts from "./accounts/index.js";
+export * from "./types.js";
+export * from "./account.js";
+export * from "./manager.js";

package/dist/index.js

@@ -0,0 +1,4 @@
+export * as Accounts from "./accounts/index.js";
+export * from "./types.js";
+export * from "./account.js";
+export * from "./manager.js";

package/dist/manager.d.ts

@@ -0,0 +1,2 @@
+export declare class AccountManager {
+}

package/dist/manager.js

@@ -0,0 +1,2 @@
+export class AccountManager {
+}

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+import { Nip07Interface } from "applesauce-signer";
+export type SerializedAccount<T extends string, S> = {
+    type: T;
+    name?: string;
+    pubkey: string;
+    signer: S;
+};
+export interface IAccount<T extends string, S> extends Nip07Interface {
+    name?: string;
+    pubkey: string;
+    locked: boolean;
+    unlock(): Promise<boolean>;
+    lock(): void;
+    toJSON(): SerializedAccount<T, S>;
+}
+export interface IAccountConstructor<T extends string, S> {
+    new (pubkey: string, signer: Nip07Interface): IAccount<T, S>;
+    fromJSON(json: SerializedAccount<T, S>): IAccount<T, S>;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "applesauce-accounts",
+  "version": "0.10.0",
+  "description": "A simple nostr account management system",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "nostr"
+  ],
+  "author": "hzrd149",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./accounts": {
+      "import": "./dist/accounts/index.js",
+      "types": "./dist/accounts/index.d.ts"
+    },
+    "./accounts/*": {
+      "import": "./dist/accounts/*.js",
+      "types": "./dist/accounts/*.d.ts"
+    }
+  },
+  "dependencies": {
+    "@noble/hashes": "^1.5.0",
+    "applesauce-signer": "^0.10.0",
+    "nanoid": "^5.0.9",
+    "nostr-tools": "^2.10.3",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.8"
+  },
+  "funding": {
+    "type": "lightning",
+    "url": "lightning:nostrudel@geyser.fund"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch:build": "tsc --watch > /dev/null",
+    "test": "vitest run --passWithNoTests",
+    "watch:test": "vitest"
+  }
+}