@sphereon/ssi-sdk-ext.mnemonic-seed-manager 0.28.0 → 0.28.1-feature.esm.cjs.8

package/dist/{types/IMnemonicSeedManager.d.ts → index.d.cts}

@@ -1,8 +1,20 @@
-import { IAgentContext, IDataStore, IKeyManager, IPluginMethodMap, ManagedKeyInfo } from '@veramo/core';
+import { BaseEntity, DataSource, MigrationInterface, QueryRunner } from 'typeorm';
+import { IPluginMethodMap, IAgentContext, IKeyManager, IDataStore, ManagedKeyInfo, IAgentPlugin } from '@veramo/core';
+import { AbstractSecretBox } from '@veramo/key-manager';
+import { OrPromise } from '@veramo/utils';
+
+declare class MnemonicEntity extends BaseEntity {
+    id: string;
+    hash: string;
+    mnemonic: string;
+    masterKey: string;
+    chainCode: string;
+}
+
 /**
  * @public
  */
-export interface IMnemonicSeedManager extends IPluginMethodMap {
+interface IMnemonicSeedManager extends IPluginMethodMap {
     generateMnemonic(args: IMnemonicGeneratorArgs): Promise<IMnemonicInfoResult>;
     verifyMnemonic(args: IMnemonicVerificationArgs): Promise<IMnemonicInfoResult>;
     verifyPartialMnemonic(args: IPartialMnemonicVerificationArgs): Promise<IMnemonicInfoResult>;
@@ -19,7 +31,7 @@ export interface IMnemonicSeedManager extends IPluginMethodMap {
  * @param persist - Whether the mnemonic should be persisted into the database
  * @public
  */
-export interface IMnemonicGeneratorArgs {
+interface IMnemonicGeneratorArgs {
     bits: 128 | 160 | 192 | 224 | 256;
     id?: string;
     persist?: boolean;
@@ -31,7 +43,7 @@ export interface IMnemonicGeneratorArgs {
  *
  * @public
  */
-export interface IMnemonicVerificationArgs {
+interface IMnemonicVerificationArgs {
     id?: string;
     hash?: string;
     wordList: string[];
@@ -44,7 +56,7 @@ export interface IMnemonicVerificationArgs {
  * It must be in the same order as in the mnemonic.
  * @public
  */
-export interface IPartialMnemonicVerificationArgs {
+interface IPartialMnemonicVerificationArgs {
     id?: string;
     hash?: string;
     indexedWordList: [number, string][];
@@ -53,7 +65,7 @@ export interface IPartialMnemonicVerificationArgs {
  * @param mnemonic - Array representation of the mnemonic string
  * @public
  */
-export interface ISeedGeneratorArgs {
+interface ISeedGeneratorArgs {
     mnemonic: string[];
 }
 /**
@@ -69,7 +81,7 @@ export interface ISeedGeneratorArgs {
  * @param persist - Whether the information should be persisted
  * @public
  */
-export interface IMnemonicInfoStoreArgs {
+interface IMnemonicInfoStoreArgs {
     id?: string;
     hash?: string;
     mnemonic?: string[];
@@ -84,38 +96,85 @@ export interface IMnemonicInfoStoreArgs {
 /**
  * @public
  */
-export interface IMnemonicInfoKeyResult {
+interface IMnemonicInfoKeyResult {
     masterKey?: string;
     chainCode?: string;
 }
 /**
  * @public
  */
-export interface DeleteResult {
+interface DeleteResult {
     raw: unknown;
     affected?: number | null;
 }
 /**
  * @public
  */
-export interface UpdateResult extends DeleteResult {
+interface UpdateResult extends DeleteResult {
     generatedMaps: ObjectLiteral;
 }
 /**
  * @public
  */
-export interface ObjectLiteral {
+interface ObjectLiteral {
     [key: string]: any;
 }
 /**
  * @public
  */
-export interface IMnemonicInfoResult extends IMnemonicInfoStoreArgs {
+interface IMnemonicInfoResult extends IMnemonicInfoStoreArgs {
     succeeded?: boolean;
     seed?: string;
 }
 /**
  * @public
  */
-export type IRequiredContext = IAgentContext<IKeyManager & IDataStore>;
-//# sourceMappingURL=IMnemonicSeedManager.d.ts.map
+type IRequiredContext = IAgentContext<IKeyManager & IDataStore>;
+
+/**
+ * @public
+ */
+declare class MnemonicSeedManager implements IAgentPlugin {
+    private dbConnection;
+    private secretBox?;
+    readonly schema: any;
+    readonly methods: IMnemonicSeedManager;
+    constructor(dbConnection: OrPromise<DataSource>, secretBox?: AbstractSecretBox | undefined);
+    private generateMnemonic;
+    private verifyMnemonic;
+    private verifyPartialMnemonic;
+    private generateSeed;
+    private saveMnemonicInfo;
+    private getMnemonicInfo;
+    private deleteMnemonicInfo;
+    private saveMasterKey;
+    private generateMasterKey;
+    private generateKeysFromMnemonic;
+}
+
+declare class CreateMnemonics1659567079429 implements MigrationInterface {
+    name: string;
+    up(queryRunner: QueryRunner): Promise<void>;
+    down(queryRunner: QueryRunner): Promise<void>;
+}
+
+/**
+ * The migrations array that SHOULD be used when initializing a TypeORM database connection.
+ *
+ * These ensure the correct creation of tables and the proper migrations of data when tables change between versions.
+ *
+ * @internal
+ */
+declare const MnemonicSeedManagerMigrations: (typeof CreateMnemonics1659567079429)[];
+
+/**
+ * @internal
+ */
+declare const schema: any;
+
+/**
+ * @internal
+ */
+declare const MnemonicSeedManagerEntities: (typeof MnemonicEntity)[];
+
+export { type DeleteResult, type IMnemonicGeneratorArgs, type IMnemonicInfoKeyResult, type IMnemonicInfoResult, type IMnemonicInfoStoreArgs, type IMnemonicSeedManager, type IMnemonicVerificationArgs, type IPartialMnemonicVerificationArgs, type IRequiredContext, type ISeedGeneratorArgs, MnemonicSeedManager, MnemonicSeedManagerEntities, MnemonicSeedManagerMigrations, type ObjectLiteral, type UpdateResult, schema };

package/dist/index.d.ts

@@ -1,20 +1,180 @@
-import { MnemonicEntity } from './entities/MnemonicEntity';
+import { BaseEntity, DataSource, MigrationInterface, QueryRunner } from 'typeorm';
+import { IPluginMethodMap, IAgentContext, IKeyManager, IDataStore, ManagedKeyInfo, IAgentPlugin } from '@veramo/core';
+import { AbstractSecretBox } from '@veramo/key-manager';
+import { OrPromise } from '@veramo/utils';
+
+declare class MnemonicEntity extends BaseEntity {
+    id: string;
+    hash: string;
+    mnemonic: string;
+    masterKey: string;
+    chainCode: string;
+}
+
 /**
- * @internal
+ * @public
  */
-declare const schema: any;
-export { schema };
+interface IMnemonicSeedManager extends IPluginMethodMap {
+    generateMnemonic(args: IMnemonicGeneratorArgs): Promise<IMnemonicInfoResult>;
+    verifyMnemonic(args: IMnemonicVerificationArgs): Promise<IMnemonicInfoResult>;
+    verifyPartialMnemonic(args: IPartialMnemonicVerificationArgs): Promise<IMnemonicInfoResult>;
+    generateSeed(args: ISeedGeneratorArgs): Promise<IMnemonicInfoResult>;
+    saveMnemonicInfo(args: IMnemonicInfoStoreArgs): Promise<IMnemonicInfoResult>;
+    getMnemonicInfo(args: IMnemonicInfoStoreArgs): Promise<IMnemonicInfoResult>;
+    deleteMnemonicInfo(args: IMnemonicInfoStoreArgs): Promise<DeleteResult>;
+    generateMasterKey(args: IMnemonicInfoStoreArgs): Promise<IMnemonicInfoKeyResult>;
+    generateKeysFromMnemonic(args: IMnemonicInfoStoreArgs, context: IRequiredContext): Promise<ManagedKeyInfo>;
+}
+/**
+ * @param bits - Affects the number of words in the mnemonic, which is 12, 15, 18, 21 and 24 respectively.
+ * @param id - Optional user defined id for the mnemonic
+ * @param persist - Whether the mnemonic should be persisted into the database
+ * @public
+ */
+interface IMnemonicGeneratorArgs {
+    bits: 128 | 160 | 192 | 224 | 256;
+    id?: string;
+    persist?: boolean;
+}
+/**
+ * @param id - Optional user defined id for the mnemonic
+ * @param hash - Optional sha256 hash of the mnemonic
+ * @param wordList - List containing all the words of the mnemonic in order.
+ *
+ * @public
+ */
+interface IMnemonicVerificationArgs {
+    id?: string;
+    hash?: string;
+    wordList: string[];
+}
+/**
+ * @param id - Optional user defined id for the mnemonic
+ * @param hash - Optional sha256 hash of the mnemonic
+ * @param indexedWordList - List partially containing the words
+ * with their indexes corresponding the position in which they appear in the mnemonic.
+ * It must be in the same order as in the mnemonic.
+ * @public
+ */
+interface IPartialMnemonicVerificationArgs {
+    id?: string;
+    hash?: string;
+    indexedWordList: [number, string][];
+}
+/**
+ * @param mnemonic - Array representation of the mnemonic string
+ * @public
+ */
+interface ISeedGeneratorArgs {
+    mnemonic: string[];
+}
+/**
+ * @param id - Optional user defined id for the mnemonic
+ * @param hash - Optional sha256 hash of the mnemonic
+ * @param mnemonic - Array representation of the mnemonic string
+ * @param masterKey - The master key generated from the seed
+ * @param chainCode - The chain code generated with the keys
+ * @param kms - The key management service to be used
+ * @param path - The derivation path to be used
+ * @param withZeroBytes - Whether the public key should be generated with zero bytes
+ * @param type - The type of the key generated
+ * @param persist - Whether the information should be persisted
+ * @public
+ */
+interface IMnemonicInfoStoreArgs {
+    id?: string;
+    hash?: string;
+    mnemonic?: string[];
+    masterKey?: string;
+    chainCode?: string;
+    kms?: string;
+    path?: string;
+    withZeroBytes?: boolean;
+    type?: 'Ed25519' | 'Secp256k1';
+    persist?: boolean;
+}
+/**
+ * @public
+ */
+interface IMnemonicInfoKeyResult {
+    masterKey?: string;
+    chainCode?: string;
+}
+/**
+ * @public
+ */
+interface DeleteResult {
+    raw: unknown;
+    affected?: number | null;
+}
+/**
+ * @public
+ */
+interface UpdateResult extends DeleteResult {
+    generatedMaps: ObjectLiteral;
+}
+/**
+ * @public
+ */
+interface ObjectLiteral {
+    [key: string]: any;
+}
 /**
  * @public
  */
-export { MnemonicSeedManager } from './agent/MnemonicSeedManager';
-export * from './types/IMnemonicSeedManager';
+interface IMnemonicInfoResult extends IMnemonicInfoStoreArgs {
+    succeeded?: boolean;
+    seed?: string;
+}
 /**
+ * @public
+ */
+type IRequiredContext = IAgentContext<IKeyManager & IDataStore>;
+
+/**
+ * @public
+ */
+declare class MnemonicSeedManager implements IAgentPlugin {
+    private dbConnection;
+    private secretBox?;
+    readonly schema: any;
+    readonly methods: IMnemonicSeedManager;
+    constructor(dbConnection: OrPromise<DataSource>, secretBox?: AbstractSecretBox | undefined);
+    private generateMnemonic;
+    private verifyMnemonic;
+    private verifyPartialMnemonic;
+    private generateSeed;
+    private saveMnemonicInfo;
+    private getMnemonicInfo;
+    private deleteMnemonicInfo;
+    private saveMasterKey;
+    private generateMasterKey;
+    private generateKeysFromMnemonic;
+}
+
+declare class CreateMnemonics1659567079429 implements MigrationInterface {
+    name: string;
+    up(queryRunner: QueryRunner): Promise<void>;
+    down(queryRunner: QueryRunner): Promise<void>;
+}
+
+/**
+ * The migrations array that SHOULD be used when initializing a TypeORM database connection.
+ *
+ * These ensure the correct creation of tables and the proper migrations of data when tables change between versions.
+ *
  * @internal
  */
-export declare const MnemonicSeedManagerEntities: (typeof MnemonicEntity)[];
+declare const MnemonicSeedManagerMigrations: (typeof CreateMnemonics1659567079429)[];
+
+/**
+ * @internal
+ */
+declare const schema: any;
+
 /**
  * @internal
  */
-export { MnemonicSeedManagerMigrations } from './migrations';
-//# sourceMappingURL=index.d.ts.map
+declare const MnemonicSeedManagerEntities: (typeof MnemonicEntity)[];
+
+export { type DeleteResult, type IMnemonicGeneratorArgs, type IMnemonicInfoKeyResult, type IMnemonicInfoResult, type IMnemonicInfoStoreArgs, type IMnemonicSeedManager, type IMnemonicVerificationArgs, type IPartialMnemonicVerificationArgs, type IRequiredContext, type ISeedGeneratorArgs, MnemonicSeedManager, MnemonicSeedManagerEntities, MnemonicSeedManagerMigrations, type ObjectLiteral, type UpdateResult, schema };