@credo-ts/askar-to-drizzle-storage-migration 0.6.0-alpha-20251127043254 → 0.6.0-alpha-20251127093557

package/package.json

@@ -1,14 +1,10 @@
 {
   "name": "@credo-ts/askar-to-drizzle-storage-migration",
   "exports": {
-    ".": {
-      "import": "./build/index.mjs",
-      "require": "./build/index.js",
-      "types": "./build/index.d.ts"
-    },
+    ".": "./build/index.mjs",
     "./package.json": "./package.json"
   },
-  "version": "0.6.0-alpha-20251127043254",
+  "version": "0.6.0-alpha-20251127093557",
   "files": [
     "build"
   ],
@@ -23,10 +19,10 @@
     "directory": "packages/askar-to-drizzle-storage-migration"
   },
   "dependencies": {
-    "@credo-ts/askar": "0.6.0-alpha-20251127043254",
-    "@credo-ts/tenants": "0.6.0-alpha-20251127043254",
-    "@credo-ts/drizzle-storage": "0.6.0-alpha-20251127043254",
-    "@credo-ts/core": "0.6.0-alpha-20251127043254"
+    "@credo-ts/askar": "0.6.0-alpha-20251127093557",
+    "@credo-ts/tenants": "0.6.0-alpha-20251127093557",
+    "@credo-ts/drizzle-storage": "0.6.0-alpha-20251127093557",
+    "@credo-ts/core": "0.6.0-alpha-20251127093557"
   },
   "peerDependencies": {
     "@openwallet-foundation/askar-shared": "^0.4.3"
@@ -38,7 +34,6 @@
   "scripts": {
     "build": "tsdown --config-loader unconfig"
   },
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
+  "types": "./build/index.d.mts",
   "module": "./build/index.mjs"
 }

package/build/AskarToDrizzleStorageMigrator.d.ts

@@ -1,65 +0,0 @@
-import * as _credo_ts_core0 from "@credo-ts/core";
-import { Agent, AgentDependencies, Logger } from "@credo-ts/core";
-import { AskarModule } from "@credo-ts/askar";
-import { DrizzleStorageModule } from "@credo-ts/drizzle-storage";
-import { TenantsModule } from "@credo-ts/tenants";
-
-//#region src/AskarToDrizzleStorageMigrator.d.ts
-
-/**
- * Migration class to move storage from Askar to Drizzle. Note that this does not migrate
- * the KMS part of Askar (the keys), and only the normal record storage.
- *
- * No backups are created during the process. The askar store is only used for reading, the
- * drizzle store is also used for writing. Ensure the drizzle target is empty when starting the
- * migration.
- *
- * Note that if you were previously using `AskarMultiWalletDatabaseScheme.DatabasePerWallet`, that all storage will be moved
- * to a single database. You can still keep using multiiple databases for the Askar storage, but Drizzle only supports
- * a single database per main agent instance (including sub agents for tenants).
- */
-declare class AskarToDrizzleStorageMigrator {
-  private drizzleModule;
-  private askarModule;
-  private agentDependencies;
-  private logger;
-  private skipMigrationforMissingAdapter;
-  private tenantsModule?;
-  private drizzleAgent;
-  askarAgent: Agent<_credo_ts_core0.ModulesMap>;
-  private drizzleConfig;
-  private drizzleAdapters;
-  private constructor();
-  static initialize({
-    drizzleModule,
-    askarModule,
-    agentDependencies,
-    logger,
-    skipMigrationForMissingAdapter,
-    tenantsModule
-  }: {
-    drizzleModule: DrizzleStorageModule;
-    askarModule: AskarModule;
-    agentDependencies: AgentDependencies;
-    logger: Logger;
-    tenantsModule?: TenantsModule;
-    /**
-     * When set to `true`, the migration of any records in the Askar store that don't
-     * have an adapter registered will be skipped. Note that this can be dangerous and
-     * result in loss of data in the new store. Use this only if you have records with a
-     * category in your askar store, for which there is no adapter registered, and should
-     * not be migrated.
-     *
-     * @default false
-     */
-    skipMigrationForMissingAdapter?: boolean;
-  }): Promise<AskarToDrizzleStorageMigrator>;
-  private getAdapterForRecordType;
-  migrate(): Promise<void>;
-  deleteStorageRecords(): Promise<void>;
-  private migrateForContext;
-  private deleteForContext;
-}
-//#endregion
-export { AskarToDrizzleStorageMigrator };
-//# sourceMappingURL=AskarToDrizzleStorageMigrator.d.ts.map

package/build/AskarToDrizzleStorageMigrator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AskarToDrizzleStorageMigrator.d.ts","names":[],"sources":["../src/AskarToDrizzleStorageMigrator.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AA4BA;;;;;;;;;AAmDmB,cAnDN,6BAAA,CAmDM;EACF,QAAA,aAAA;EACM,QAAA,WAAA;EACX,QAAA,iBAAA;EACQ,QAAA,MAAA;EAYjB,QAAA,8BAAA;EAAA,QAAA,aAAA;EA6BmB,QAAA,YAAA;EAuDa,UAAA,EAvIhB,KAuIgB,CAvJO,eAAA,CAgBvB,UAAA,CAuIgB;EAAA,QAAA,aAAA;;;;;;;;;;;mBApGhB;iBACF;uBACM;YACX;oBACQ;;;;;;;;;;;MAYjB,QAAA;;aA6BmB;0BAuDa"}

package/build/AskarToDrizzleStorageMigrator.js

@@ -1,202 +0,0 @@
-const require_AskarToDrizzleStorageMigrationError = require('./errors/AskarToDrizzleStorageMigrationError.js');
-let __credo_ts_askar = require("@credo-ts/askar");
-let __credo_ts_core = require("@credo-ts/core");
-let __credo_ts_drizzle_storage = require("@credo-ts/drizzle-storage");
-require("@credo-ts/tenants");
-let __openwallet_foundation_askar_shared = require("@openwallet-foundation/askar-shared");
-
-//#region src/AskarToDrizzleStorageMigrator.ts
-/**
-* Migration class to move storage from Askar to Drizzle. Note that this does not migrate
-* the KMS part of Askar (the keys), and only the normal record storage.
-*
-* No backups are created during the process. The askar store is only used for reading, the
-* drizzle store is also used for writing. Ensure the drizzle target is empty when starting the
-* migration.
-*
-* Note that if you were previously using `AskarMultiWalletDatabaseScheme.DatabasePerWallet`, that all storage will be moved
-* to a single database. You can still keep using multiiple databases for the Askar storage, but Drizzle only supports
-* a single database per main agent instance (including sub agents for tenants).
-*/
-var AskarToDrizzleStorageMigrator = class AskarToDrizzleStorageMigrator {
-	constructor(drizzleModule, askarModule, agentDependencies, logger, skipMigrationforMissingAdapter, tenantsModule) {
-		this.drizzleModule = drizzleModule;
-		this.askarModule = askarModule;
-		this.agentDependencies = agentDependencies;
-		this.logger = logger;
-		this.skipMigrationforMissingAdapter = skipMigrationforMissingAdapter;
-		this.tenantsModule = tenantsModule;
-		this.drizzleAgent = new __credo_ts_core.Agent({
-			dependencies: this.agentDependencies,
-			config: { logger: this.logger },
-			modules: this.tenantsModule ? {
-				drizzle: this.drizzleModule,
-				tenants: this.tenantsModule
-			} : { drizzle: this.drizzleModule }
-		});
-		this.askarAgent = new __credo_ts_core.Agent({
-			modules: this.tenantsModule ? {
-				askar: this.askarModule,
-				tenants: this.tenantsModule
-			} : { askar: this.askarModule },
-			config: { logger: this.logger },
-			dependencies: this.agentDependencies
-		});
-		this.drizzleConfig = this.drizzleAgent.context.resolve(__credo_ts_drizzle_storage.DrizzleStorageModuleConfig);
-		this.drizzleAdapters = this.drizzleConfig.adapters;
-	}
-	static async initialize({ drizzleModule, askarModule, agentDependencies, logger = new __credo_ts_core.ConsoleLogger(__credo_ts_core.LogLevel.trace), skipMigrationForMissingAdapter = false, tenantsModule }) {
-		if (!askarModule.config.enableStorage) throw new require_AskarToDrizzleStorageMigrationError.AskarToDrizzleStorageMigrationError("Askar module has enableStorage set to false. Make sure the storage is enabled on the askar module");
-		return new AskarToDrizzleStorageMigrator(drizzleModule, askarModule, agentDependencies, logger, skipMigrationForMissingAdapter, tenantsModule);
-	}
-	getAdapterForRecordType(recordType) {
-		const adapter = this.drizzleAdapters.find((adapter$1) => adapter$1.recordClass.type === recordType);
-		if (!adapter) return null;
-		return adapter;
-	}
-	async migrate() {
-		try {
-			await this.drizzleAgent.initialize();
-			this.logger.info("Successfully initialized drizzle agent");
-			await this.askarAgent.initialize();
-			this.logger.info("Successfully initialized askar agent");
-			this.logger.info("Starting migration of default agent context");
-			await this.migrateForContext({
-				askarContext: this.askarAgent.context,
-				drizzleContext: this.drizzleAgent.context
-			});
-			this.logger.info("Succesfully migrated default agent context");
-			if (this.tenantsModule) {
-				const askarAgentWithTenants = this.askarAgent;
-				const drizzleAgentWithTenants = this.drizzleAgent;
-				this.logger.info("Detected tenants module, migrating tenants context");
-				const allTenants = await askarAgentWithTenants.modules.tenants.getAllTenants();
-				this.logger.debug(`Retrieved '${allTenants.length}' tenant records to migrate.`);
-				for (const tenant of allTenants) {
-					this.logger.info(`Starting migration of tenant '${tenant.id}'`);
-					await askarAgentWithTenants.modules.tenants.withTenantAgent({ tenantId: tenant.id }, async (askarTenantAgent) => {
-						await drizzleAgentWithTenants.modules.tenants.withTenantAgent({ tenantId: tenant.id }, (drizzleTenantAgent) => this.migrateForContext({
-							askarContext: askarTenantAgent.context,
-							drizzleContext: drizzleTenantAgent.context
-						}));
-					});
-					this.logger.info(`Succesfully migrated tenant '${tenant.id}'`);
-				}
-			}
-		} finally {
-			if (this.drizzleAgent.isInitialized) await this.drizzleAgent.shutdown();
-			if (this.askarAgent.isInitialized) await this.askarAgent.shutdown();
-		}
-	}
-	async deleteStorageRecords() {
-		try {
-			await this.askarAgent.initialize();
-			this.logger.info("Successfully initialized askar agent");
-			if (this.tenantsModule) {
-				const askarAgentWithTenants = this.askarAgent;
-				this.logger.info("Detected tenants module, deleting tenant records");
-				const allTenants = await askarAgentWithTenants.modules.tenants.getAllTenants();
-				this.logger.debug(`Retrieved '${allTenants.length}' tenants to delete non-KMS storage for.`);
-				for (const tenant of allTenants) {
-					this.logger.info(`Starting deletion of non-KMS records for tenant '${tenant.id}'`);
-					await askarAgentWithTenants.modules.tenants.withTenantAgent({ tenantId: tenant.id }, async (askarTenantAgent) => this.deleteForContext({ askarContext: askarTenantAgent.context }));
-					this.logger.info(`Succesfully removed non-KMS records for tenant '${tenant.id}'`);
-				}
-			}
-			this.logger.info("Starting deletion of non-KMS records for default agent context");
-			await this.deleteForContext({ askarContext: this.askarAgent.context });
-			this.logger.info("Succesfully removed non-KMS records for default agent context");
-		} finally {
-			if (this.askarAgent.isInitialized) await this.askarAgent.shutdown();
-		}
-	}
-	async migrateForContext({ drizzleContext, askarContext }) {
-		try {
-			const storeManager = askarContext.resolve(__credo_ts_askar.AskarStoreManager);
-			const askar = askarContext.resolve(__credo_ts_askar.AskarModuleConfig).askar;
-			const { store, profile } = await storeManager.getInitializedStoreWithProfile(askarContext);
-			await this.drizzleModule.onProvisionContext(drizzleContext);
-			let scanHandle;
-			let entryListHandle = null;
-			let migratedRecordCount = 0;
-			let skippedRecordCount = 0;
-			const skippedRecordTypes = [];
-			try {
-				this.logger.debug(`Initializing retrieval of records from askar storage for context '${askarContext.contextCorrelationId}'`);
-				scanHandle = await askar.scanStart({
-					storeHandle: store.handle,
-					profile
-				});
-				while (true) {
-					this.logger.debug(`Fetching batch of records from askar storage for context '${askarContext.contextCorrelationId}'`);
-					entryListHandle = await askar.scanNext({ scanHandle });
-					if (!entryListHandle) {
-						this.logger.debug(`No records returned in batch from askar storage. No records left to migrate for context '${askarContext.contextCorrelationId}'`);
-						break;
-					}
-					const list = new __openwallet_foundation_askar_shared.EntryList({ handle: entryListHandle });
-					this.logger.debug(`Retrieved batch of '${list.length}' records from askar storage for context '${askarContext.contextCorrelationId}'`);
-					for (let index = 0; index < list.length; index++) {
-						const entry = list.getEntryByIndex(index);
-						const entryObject = entry.toJson();
-						this.logger.trace(`Retrieved record with index '${index}', id '${entryObject.name}' and type '${entryObject.category}' from batch for context '${askarContext.contextCorrelationId}'`);
-						const adapter = this.getAdapterForRecordType(entryObject.category);
-						if (!adapter) {
-							if (this.skipMigrationforMissingAdapter) {
-								this.logger.info(`Skippping migration of record '${entry.name}' with type '${entry.category}' due to missing drizzle adapter for context '${askarContext.contextCorrelationId}'.`);
-								skippedRecordCount++;
-								skippedRecordTypes.push(entryObject.category);
-								continue;
-							}
-							throw new require_AskarToDrizzleStorageMigrationError.AskarToDrizzleStorageMigrationError(`Could not find a registered drizzle adapter for record type '${entry.category}'. Make sure to register the record type in the DrizzleStorageModule.`);
-						}
-						const record = (0, __credo_ts_askar.recordToInstance)(entryObject, adapter.recordClass);
-						if (record instanceof __credo_ts_core.StorageVersionRecord && record.id === __credo_ts_core.StorageVersionRecord.storageVersionRecordId) {
-							this.logger.debug(`Updating record '${record.id}' with type '${record.type}' into drizzle storage for context '${askarContext.contextCorrelationId}'`);
-							await adapter.update(drizzleContext, record);
-						} else {
-							this.logger.debug(`Inserting record '${record.id}' with type '${record.type}' into drizzle storage for context '${askarContext.contextCorrelationId}'`);
-							await adapter.insert(drizzleContext, record);
-						}
-						migratedRecordCount++;
-					}
-					this.logger.debug(`Processed all records from batch for context '${askarContext.contextCorrelationId}'`);
-					entryListHandle.free();
-					entryListHandle = null;
-				}
-				this.logger.debug(`Succesfully migrated '${migratedRecordCount}' records from Askar to Drizzle for context '${askarContext.contextCorrelationId}'`, {
-					migratedRecordCount,
-					skippedRecordCount,
-					skippedRecordTypes
-				});
-			} finally {
-				entryListHandle?.free();
-				entryListHandle = null;
-				scanHandle?.free();
-				scanHandle = void 0;
-			}
-		} catch (error) {
-			this.logger.error(`Migration failed for context '${askarContext.contextCorrelationId}'. ${error.message}`);
-			throw new require_AskarToDrizzleStorageMigrationError.AskarToDrizzleStorageMigrationError(`Migration failed for context '${askarContext.contextCorrelationId}'. ${error.message}`, { cause: error });
-		}
-	}
-	async deleteForContext({ askarContext }) {
-		try {
-			const { store, profile } = await askarContext.resolve(__credo_ts_askar.AskarStoreManager).getInitializedStoreWithProfile(askarContext);
-			this.logger.debug(`Removing all non-KMS records from askar storage for context '${askarContext.contextCorrelationId}'`);
-			const session = await store.session(profile).open();
-			try {
-				await session.removeAll({});
-				this.logger.debug(`Succesfully removed all non-KMS records from Askar for context '${askarContext.contextCorrelationId}'`);
-			} finally {
-				await session.close();
-			}
-		} catch (error) {
-			this.logger.error(`Removing non-KMS records failed for context '${askarContext.contextCorrelationId}'. ${error.message}`);
-			throw new require_AskarToDrizzleStorageMigrationError.AskarToDrizzleStorageMigrationError(`Removing non-KMS record failed for context '${askarContext.contextCorrelationId}'. ${error.message}`, { cause: error });
-		}
-	}
-};
-
-//#endregion
-exports.AskarToDrizzleStorageMigrator = AskarToDrizzleStorageMigrator;

package/build/errors/AskarToDrizzleStorageMigrationError.js

@@ -1,10 +0,0 @@
-let __credo_ts_core = require("@credo-ts/core");
-
-//#region src/errors/AskarToDrizzleStorageMigrationError.ts
-/**
-* @internal
-*/
-var AskarToDrizzleStorageMigrationError = class extends __credo_ts_core.CredoError {};
-
-//#endregion
-exports.AskarToDrizzleStorageMigrationError = AskarToDrizzleStorageMigrationError;

package/build/index.d.ts

@@ -1,2 +0,0 @@
-import { AskarToDrizzleStorageMigrator } from "./AskarToDrizzleStorageMigrator.js";
-export { AskarToDrizzleStorageMigrator };

package/build/index.js

@@ -1,3 +0,0 @@
-const require_AskarToDrizzleStorageMigrator = require('./AskarToDrizzleStorageMigrator.js');
-
-exports.AskarToDrizzleStorageMigrator = require_AskarToDrizzleStorageMigrator.AskarToDrizzleStorageMigrator;