@credo-ts/tenants 0.4.1-alpha.157

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-present Hyperledger Contributors.
+   Copyright 2021 Queen’s Printer for Ontario. Mostafa Youssef (https://github.com/MosCD3), Amit Padmani (https://github.com/nbAmit), Prasad Katkar (https://github.com/NB-PrasadKatkar), Mike Richardson (https://github.com/NB-MikeRichardson)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,31 @@
+<p align="center">
+  <br />
+  <img
+    alt="Credo Logo"
+    src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-logo.png"
+    height="250px"
+  />
+</p>
+<h1 align="center"><b>Credo Tenants Module</b></h1>
+<p align="center">
+  <a
+    href="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/main/LICENSE"
+    ><img
+      alt="License"k
+      src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
+  /></a>
+  <a href="https://www.typescriptlang.org/"
+    ><img
+      alt="typescript"
+      src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg"
+  /></a>
+    <a href="https://www.npmjs.com/package/@credo-ts/tenants"
+    ><img
+      alt="@credo-ts/tenants version"
+      src="https://img.shields.io/npm/v/@credo-ts/tenants"
+  /></a>
+
+</p>
+<br />
+
+Credo Tenant Module provides an optional addon to Credo to use an agent with multiple tenants.

package/build/TenantAgent.d.ts

@@ -0,0 +1,8 @@
+import type { AgentContext, DefaultAgentModules, ModulesMap } from '@credo-ts/core';
+import { BaseAgent } from '@credo-ts/core';
+export declare class TenantAgent<AgentModules extends ModulesMap = DefaultAgentModules> extends BaseAgent<AgentModules> {
+    private sessionHasEnded;
+    constructor(agentContext: AgentContext);
+    initialize(): Promise<void>;
+    endSession(): Promise<void>;
+}

package/build/TenantAgent.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantAgent = void 0;
+const core_1 = require("@credo-ts/core");
+class TenantAgent extends core_1.BaseAgent {
+    constructor(agentContext) {
+        super(agentContext.config, agentContext.dependencyManager);
+        this.sessionHasEnded = false;
+    }
+    async initialize() {
+        if (this.sessionHasEnded) {
+            throw new core_1.CredoError("Can't initialize agent after tenant sessions has been ended.");
+        }
+        await super.initialize();
+        this._isInitialized = true;
+    }
+    async endSession() {
+        this.logger.trace(`Ending session for agent context with contextCorrelationId '${this.agentContext.contextCorrelationId}'`);
+        await this.agentContext.endSession();
+        this._isInitialized = false;
+        this.sessionHasEnded = true;
+    }
+}
+exports.TenantAgent = TenantAgent;
+//# sourceMappingURL=TenantAgent.js.map

package/build/TenantAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantAgent.js","sourceRoot":"","sources":["../src/TenantAgent.ts"],"names":[],"mappings":";;;AAEA,yCAAsD;AAEtD,MAAa,WAAmE,SAAQ,gBAAuB;IAG7G,YAAmB,YAA0B;QAC3C,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAA;QAHpD,oBAAe,GAAG,KAAK,CAAA;IAI/B,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,MAAM,IAAI,iBAAU,CAAC,8DAA8D,CAAC,CAAA;SACrF;QAED,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;QACxB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;IAC5B,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,+DAA+D,IAAI,CAAC,YAAY,CAAC,oBAAoB,GAAG,CACzG,CAAA;QACD,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAA;QACpC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAA;QAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAA;IAC7B,CAAC;CACF;AAxBD,kCAwBC"}

package/build/TenantsApi.d.ts

@@ -0,0 +1,25 @@
+import type { CreateTenantOptions, GetTenantAgentOptions, UpdateTenantStorageOptions, WithTenantAgentCallback } from './TenantsApiOptions';
+import type { TenantRecord } from './repository';
+import type { DefaultAgentModules, ModulesMap, Query } from '@credo-ts/core';
+import { AgentContext, Logger } from '@credo-ts/core';
+import { TenantAgent } from './TenantAgent';
+import { TenantAgentContextProvider } from './context/TenantAgentContextProvider';
+import { TenantRecordService } from './services';
+export declare class TenantsApi<AgentModules extends ModulesMap = DefaultAgentModules> {
+    readonly rootAgentContext: AgentContext;
+    private tenantRecordService;
+    private agentContextProvider;
+    private logger;
+    constructor(tenantRecordService: TenantRecordService, rootAgentContext: AgentContext, agentContextProvider: TenantAgentContextProvider, logger: Logger);
+    getTenantAgent({ tenantId }: GetTenantAgentOptions): Promise<TenantAgent<AgentModules>>;
+    withTenantAgent(options: GetTenantAgentOptions, withTenantAgentCallback: WithTenantAgentCallback<AgentModules>): Promise<void>;
+    createTenant(options: CreateTenantOptions): Promise<TenantRecord>;
+    getTenantById(tenantId: string): Promise<TenantRecord>;
+    findTenantsByLabel(label: string): Promise<TenantRecord[]>;
+    deleteTenantById(tenantId: string): Promise<void>;
+    updateTenant(tenant: TenantRecord): Promise<void>;
+    findTenantsByQuery(query: Query<TenantRecord>): Promise<TenantRecord[]>;
+    getAllTenants(): Promise<TenantRecord[]>;
+    updateTenantStorage({ tenantId, updateOptions }: UpdateTenantStorageOptions): Promise<void>;
+    getTenantsWithOutdatedStorage(): Promise<TenantRecord[]>;
+}

package/build/TenantsApi.js

@@ -0,0 +1,116 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantsApi = void 0;
+const core_1 = require("@credo-ts/core");
+const TenantAgent_1 = require("./TenantAgent");
+const TenantAgentContextProvider_1 = require("./context/TenantAgentContextProvider");
+const services_1 = require("./services");
+let TenantsApi = class TenantsApi {
+    constructor(tenantRecordService, rootAgentContext, agentContextProvider, logger) {
+        this.tenantRecordService = tenantRecordService;
+        this.rootAgentContext = rootAgentContext;
+        this.agentContextProvider = agentContextProvider;
+        this.logger = logger;
+    }
+    async getTenantAgent({ tenantId }) {
+        this.logger.debug(`Getting tenant agent for tenant '${tenantId}'`);
+        const tenantContext = await this.agentContextProvider.getAgentContextForContextCorrelationId(tenantId);
+        this.logger.trace(`Got tenant context for tenant '${tenantId}'`);
+        const tenantAgent = new TenantAgent_1.TenantAgent(tenantContext);
+        await tenantAgent.initialize();
+        this.logger.trace(`Initializing tenant agent for tenant '${tenantId}'`);
+        return tenantAgent;
+    }
+    async withTenantAgent(options, withTenantAgentCallback) {
+        this.logger.debug(`Getting tenant agent for tenant '${options.tenantId}' in with tenant agent callback`);
+        const tenantAgent = await this.getTenantAgent(options);
+        try {
+            this.logger.debug(`Calling tenant agent callback for tenant '${options.tenantId}'`);
+            await withTenantAgentCallback(tenantAgent);
+        }
+        catch (error) {
+            this.logger.error(`Error in tenant agent callback for tenant '${options.tenantId}'`, { error });
+            throw error;
+        }
+        finally {
+            this.logger.debug(`Ending tenant agent session for tenant '${options.tenantId}'`);
+            await tenantAgent.endSession();
+        }
+    }
+    async createTenant(options) {
+        this.logger.debug(`Creating tenant with label ${options.config.label}`);
+        const tenantRecord = await this.tenantRecordService.createTenant(this.rootAgentContext, options.config);
+        // This initializes the tenant agent, creates the wallet etc...
+        const tenantAgent = await this.getTenantAgent({ tenantId: tenantRecord.id });
+        await tenantAgent.endSession();
+        this.logger.info(`Successfully created tenant '${tenantRecord.id}'`);
+        return tenantRecord;
+    }
+    async getTenantById(tenantId) {
+        this.logger.debug(`Getting tenant by id '${tenantId}'`);
+        return this.tenantRecordService.getTenantById(this.rootAgentContext, tenantId);
+    }
+    async findTenantsByLabel(label) {
+        this.logger.debug(`Finding tenants by label '${label}'`);
+        return this.tenantRecordService.findTenantsByLabel(this.rootAgentContext, label);
+    }
+    async deleteTenantById(tenantId) {
+        this.logger.debug(`Deleting tenant by id '${tenantId}'`);
+        // TODO: force remove context from the context provider (or session manager)
+        const tenantAgent = await this.getTenantAgent({ tenantId });
+        this.logger.trace(`Deleting wallet for tenant '${tenantId}'`);
+        await tenantAgent.wallet.delete();
+        this.logger.trace(`Shutting down agent for tenant '${tenantId}'`);
+        await tenantAgent.endSession();
+        return this.tenantRecordService.deleteTenantById(this.rootAgentContext, tenantId);
+    }
+    async updateTenant(tenant) {
+        await this.tenantRecordService.updateTenant(this.rootAgentContext, tenant);
+    }
+    async findTenantsByQuery(query) {
+        return this.tenantRecordService.findTenantsByQuery(this.rootAgentContext, query);
+    }
+    async getAllTenants() {
+        this.logger.debug('Getting all tenants');
+        return this.tenantRecordService.getAllTenants(this.rootAgentContext);
+    }
+    async updateTenantStorage({ tenantId, updateOptions }) {
+        this.logger.debug(`Updating tenant storage for tenant '${tenantId}'`);
+        const tenantRecord = await this.tenantRecordService.getTenantById(this.rootAgentContext, tenantId);
+        if ((0, core_1.isStorageUpToDate)(tenantRecord.storageVersion)) {
+            this.logger.debug(`Tenant storage for tenant '${tenantId}' is already up to date. Skipping update`);
+            return;
+        }
+        await this.agentContextProvider.updateTenantStorage(tenantRecord, updateOptions);
+    }
+    async getTenantsWithOutdatedStorage() {
+        const outdatedTenants = await this.tenantRecordService.findTenantsByQuery(this.rootAgentContext, {
+            $not: {
+                storageVersion: core_1.UpdateAssistant.frameworkStorageVersion,
+            },
+        });
+        return outdatedTenants;
+    }
+};
+TenantsApi = __decorate([
+    (0, core_1.injectable)(),
+    __param(2, (0, core_1.inject)(core_1.InjectionSymbols.AgentContextProvider)),
+    __param(3, (0, core_1.inject)(core_1.InjectionSymbols.Logger)),
+    __metadata("design:paramtypes", [services_1.TenantRecordService,
+        core_1.AgentContext,
+        TenantAgentContextProvider_1.TenantAgentContextProvider, Object])
+], TenantsApi);
+exports.TenantsApi = TenantsApi;
+//# sourceMappingURL=TenantsApi.js.map

package/build/TenantsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantsApi.js","sourceRoot":"","sources":["../src/TenantsApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AASA,yCAQuB;AAEvB,+CAA2C;AAC3C,qFAAiF;AACjF,yCAAgD;AAGzC,IAAM,UAAU,GAAhB,MAAM,UAAU;IAMrB,YACE,mBAAwC,EACxC,gBAA8B,EACiB,oBAAgD,EAC9D,MAAc;QAE/C,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAA;QAC9C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QAChD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAyB;QAC7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,QAAQ,GAAG,CAAC,CAAA;QAClE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,sCAAsC,CAAC,QAAQ,CAAC,CAAA;QAEtG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,QAAQ,GAAG,CAAC,CAAA;QAChE,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAe,aAAa,CAAC,CAAA;QAChE,MAAM,WAAW,CAAC,UAAU,EAAE,CAAA;QAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,QAAQ,GAAG,CAAC,CAAA;QAEvE,OAAO,WAAW,CAAA;IACpB,CAAC;IAEM,KAAK,CAAC,eAAe,CAC1B,OAA8B,EAC9B,uBAA8D;QAE9D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,OAAO,CAAC,QAAQ,iCAAiC,CAAC,CAAA;QACxG,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QAEtD,IAAI;YACF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6CAA6C,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;YACnF,MAAM,uBAAuB,CAAC,WAAW,CAAC,CAAA;SAC3C;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,OAAO,CAAC,QAAQ,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;YAC/F,MAAM,KAAK,CAAA;SACZ;gBAAS;YACR,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;YACjF,MAAM,WAAW,CAAC,UAAU,EAAE,CAAA;SAC/B;IACH,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,OAA4B;QACpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;QACvE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAEvG,+DAA+D;QAC/D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,CAAC,CAAA;QAC5E,MAAM,WAAW,CAAC,UAAU,EAAE,CAAA;QAE9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,YAAY,CAAC,EAAE,GAAG,CAAC,CAAA;QAEpE,OAAO,YAAY,CAAA;IACrB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,QAAgB;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,QAAQ,GAAG,CAAC,CAAA;QACvD,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAA;IAChF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,KAAa;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,KAAK,GAAG,CAAC,CAAA;QACxD,OAAO,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;IAClF,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QAC5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,QAAQ,GAAG,CAAC,CAAA;QACxD,4EAA4E;QAC5E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAA;QAE3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,QAAQ,GAAG,CAAC,CAAA;QAC7D,MAAM,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;QACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,QAAQ,GAAG,CAAC,CAAA;QACjE,MAAM,WAAW,CAAC,UAAU,EAAE,CAAA;QAE9B,OAAO,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAA;IACnF,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,MAAoB;QAC5C,MAAM,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAA;IAC5E,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,KAA0B;QACxD,OAAO,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;IAClF,CAAC;IAEM,KAAK,CAAC,aAAa;QACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;QACxC,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACtE,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,EAAE,QAAQ,EAAE,aAAa,EAA8B;QACtF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,QAAQ,GAAG,CAAC,CAAA;QACrE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAA;QAElG,IAAI,IAAA,wBAAiB,EAAC,YAAY,CAAC,cAAc,CAAC,EAAE;YAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,QAAQ,0CAA0C,CAAC,CAAA;YACnG,OAAM;SACP;QAED,MAAM,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAA;IAClF,CAAC;IAEM,KAAK,CAAC,6BAA6B;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,EAAE;YAC/F,IAAI,EAAE;gBACJ,cAAc,EAAE,sBAAe,CAAC,uBAAuB;aACxD;SACF,CAAC,CAAA;QAEF,OAAO,eAAe,CAAA;IACxB,CAAC;CACF,CAAA;AAvHY,UAAU;IADtB,IAAA,iBAAU,GAAE;IAUR,WAAA,IAAA,aAAM,EAAC,uBAAgB,CAAC,oBAAoB,CAAC,CAAA;IAC7C,WAAA,IAAA,aAAM,EAAC,uBAAgB,CAAC,MAAM,CAAC,CAAA;qCAHX,8BAAmB;QACtB,mBAAY;QACuC,uDAA0B;GATtF,UAAU,CAuHtB;AAvHY,gCAAU"}

package/build/TenantsApiOptions.d.ts

@@ -0,0 +1,14 @@
+import type { TenantAgent } from './TenantAgent';
+import type { TenantConfig } from './models/TenantConfig';
+import type { ModulesMap, UpdateAssistantUpdateOptions } from '@credo-ts/core';
+export interface GetTenantAgentOptions {
+    tenantId: string;
+}
+export type WithTenantAgentCallback<AgentModules extends ModulesMap> = (tenantAgent: TenantAgent<AgentModules>) => Promise<void>;
+export interface CreateTenantOptions {
+    config: Omit<TenantConfig, 'walletConfig'>;
+}
+export interface UpdateTenantStorageOptions {
+    tenantId: string;
+    updateOptions?: UpdateAssistantUpdateOptions;
+}

package/build/TenantsApiOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TenantsApiOptions.js.map

package/build/TenantsApiOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantsApiOptions.js","sourceRoot":"","sources":["../src/TenantsApiOptions.ts"],"names":[],"mappings":""}

package/build/TenantsModule.d.ts

@@ -0,0 +1,19 @@
+import type { TenantsModuleConfigOptions } from './TenantsModuleConfig';
+import type { Constructor, ModulesMap, DependencyManager, Module, EmptyModuleMap } from '@credo-ts/core';
+import { TenantsApi } from './TenantsApi';
+import { TenantsModuleConfig } from './TenantsModuleConfig';
+import { updateTenantsModuleV0_4ToV0_5 } from './updates/0.4-0.5';
+export declare class TenantsModule<AgentModules extends ModulesMap = EmptyModuleMap> implements Module {
+    readonly config: TenantsModuleConfig;
+    readonly api: Constructor<TenantsApi<AgentModules>>;
+    constructor(config?: TenantsModuleConfigOptions);
+    /**
+     * Registers the dependencies of the tenants module on the dependency manager.
+     */
+    register(dependencyManager: DependencyManager): void;
+    updates: {
+        fromVersion: "0.4";
+        toVersion: "0.5";
+        doUpdate: typeof updateTenantsModuleV0_4ToV0_5;
+    }[];
+}

package/build/TenantsModule.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantsModule = void 0;
+const core_1 = require("@credo-ts/core");
+const TenantsApi_1 = require("./TenantsApi");
+const TenantsModuleConfig_1 = require("./TenantsModuleConfig");
+const TenantAgentContextProvider_1 = require("./context/TenantAgentContextProvider");
+const TenantSessionCoordinator_1 = require("./context/TenantSessionCoordinator");
+const repository_1 = require("./repository");
+const services_1 = require("./services");
+const _0_4_0_5_1 = require("./updates/0.4-0.5");
+class TenantsModule {
+    constructor(config) {
+        this.api = TenantsApi_1.TenantsApi;
+        this.updates = [
+            {
+                fromVersion: '0.4',
+                toVersion: '0.5',
+                doUpdate: _0_4_0_5_1.updateTenantsModuleV0_4ToV0_5,
+            },
+        ];
+        this.config = new TenantsModuleConfig_1.TenantsModuleConfig(config);
+    }
+    /**
+     * Registers the dependencies of the tenants module on the dependency manager.
+     */
+    register(dependencyManager) {
+        // Warn about experimental module
+        dependencyManager
+            .resolve(core_1.AgentConfig)
+            .logger.warn("The '@credo-ts/tenants' module is experimental and could have unexpected breaking changes. When using this module, make sure to use strict versions for all @credo-ts packages.");
+        // Api
+        // NOTE: this is a singleton because tenants can't have their own tenants. This makes sure the tenants api is always used in the root agent context.
+        dependencyManager.registerSingleton(TenantsApi_1.TenantsApi);
+        // Config
+        dependencyManager.registerInstance(TenantsModuleConfig_1.TenantsModuleConfig, this.config);
+        // Services
+        dependencyManager.registerSingleton(services_1.TenantRecordService);
+        // Repositories
+        dependencyManager.registerSingleton(repository_1.TenantRepository);
+        dependencyManager.registerSingleton(repository_1.TenantRoutingRepository);
+        dependencyManager.registerSingleton(core_1.InjectionSymbols.AgentContextProvider, TenantAgentContextProvider_1.TenantAgentContextProvider);
+        dependencyManager.registerSingleton(TenantSessionCoordinator_1.TenantSessionCoordinator);
+    }
+}
+exports.TenantsModule = TenantsModule;
+//# sourceMappingURL=TenantsModule.js.map

package/build/TenantsModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantsModule.js","sourceRoot":"","sources":["../src/TenantsModule.ts"],"names":[],"mappings":";;;AAGA,yCAA8D;AAE9D,6CAAyC;AACzC,+DAA2D;AAC3D,qFAAiF;AACjF,iFAA6E;AAC7E,6CAAwE;AACxE,yCAAgD;AAChD,gDAAiE;AAEjE,MAAa,aAAa;IAKxB,YAAmB,MAAmC;QAFtC,QAAG,GAA0C,uBAAU,CAAA;QAmChE,YAAO,GAAG;YACf;gBACE,WAAW,EAAE,KAAK;gBAClB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,wCAA6B;aACxC;SACiB,CAAA;QAtClB,IAAI,CAAC,MAAM,GAAG,IAAI,yCAAmB,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,iBAAoC;QAClD,iCAAiC;QACjC,iBAAiB;aACd,OAAO,CAAC,kBAAW,CAAC;aACpB,MAAM,CAAC,IAAI,CACV,iLAAiL,CAClL,CAAA;QAEH,MAAM;QACN,oJAAoJ;QACpJ,iBAAiB,CAAC,iBAAiB,CAAC,uBAAU,CAAC,CAAA;QAE/C,SAAS;QACT,iBAAiB,CAAC,gBAAgB,CAAC,yCAAmB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAEpE,WAAW;QACX,iBAAiB,CAAC,iBAAiB,CAAC,8BAAmB,CAAC,CAAA;QAExD,eAAe;QACf,iBAAiB,CAAC,iBAAiB,CAAC,6BAAgB,CAAC,CAAA;QACrD,iBAAiB,CAAC,iBAAiB,CAAC,oCAAuB,CAAC,CAAA;QAE5D,iBAAiB,CAAC,iBAAiB,CAAC,uBAAgB,CAAC,oBAAoB,EAAE,uDAA0B,CAAC,CAAA;QACtG,iBAAiB,CAAC,iBAAiB,CAAC,mDAAwB,CAAC,CAAA;IAC/D,CAAC;CASF;AA7CD,sCA6CC"}

package/build/TenantsModuleConfig.d.ts

@@ -0,0 +1,31 @@
+/**
+ * TenantsModuleConfigOptions defines the interface for the options of the TenantsModuleConfig class.
+ * This can contain optional parameters that have default values in the config class itself.
+ */
+export interface TenantsModuleConfigOptions {
+    /**
+     * Maximum number of concurrent tenant sessions that can be active at the same time. Defaults to
+     * 100 concurrent sessions. The default is low on purpose, to make sure deployments determine their own
+     * session limit based on the hardware and usage of the tenants module. Use `Infinity` to allow unlimited
+     * concurrent sessions.
+     *
+     * @default 100
+     */
+    sessionLimit?: number;
+    /**
+     * Timeout in milliseconds for acquiring a tenant session. If the {@link TenantsModuleConfigOptions.maxNumberOfSessions} is reached and
+     * a tenant sessions couldn't be acquired within the specified timeout, an error will be thrown and the session creation will be aborted.
+     * Use `Infinity` to disable the timeout.
+     *
+     * @default 1000
+     */
+    sessionAcquireTimeout?: number;
+}
+export declare class TenantsModuleConfig {
+    private options;
+    constructor(options?: TenantsModuleConfigOptions);
+    /** See {@link TenantsModuleConfigOptions.sessionLimit} */
+    get sessionLimit(): number;
+    /** See {@link TenantsModuleConfigOptions.sessionAcquireTimeout} */
+    get sessionAcquireTimeout(): number;
+}

package/build/TenantsModuleConfig.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantsModuleConfig = void 0;
+class TenantsModuleConfig {
+    constructor(options) {
+        this.options = options !== null && options !== void 0 ? options : {};
+    }
+    /** See {@link TenantsModuleConfigOptions.sessionLimit} */
+    get sessionLimit() {
+        var _a;
+        return (_a = this.options.sessionLimit) !== null && _a !== void 0 ? _a : 100;
+    }
+    /** See {@link TenantsModuleConfigOptions.sessionAcquireTimeout} */
+    get sessionAcquireTimeout() {
+        var _a;
+        return (_a = this.options.sessionAcquireTimeout) !== null && _a !== void 0 ? _a : 1000;
+    }
+}
+exports.TenantsModuleConfig = TenantsModuleConfig;
+//# sourceMappingURL=TenantsModuleConfig.js.map

package/build/TenantsModuleConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantsModuleConfig.js","sourceRoot":"","sources":["../src/TenantsModuleConfig.ts"],"names":[],"mappings":";;;AAyBA,MAAa,mBAAmB;IAG9B,YAAmB,OAAoC;QACrD,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAA;IAC9B,CAAC;IAED,0DAA0D;IAC1D,IAAW,YAAY;;QACrB,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,YAAY,mCAAI,GAAG,CAAA;IACzC,CAAC;IAED,mEAAmE;IACnE,IAAW,qBAAqB;;QAC9B,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,qBAAqB,mCAAI,IAAI,CAAA;IACnD,CAAC;CACF;AAhBD,kDAgBC"}

package/build/context/TenantAgentContextProvider.d.ts

@@ -0,0 +1,40 @@
+import type { TenantRecord } from '../repository';
+import type { AgentContextProvider, UpdateAssistantUpdateOptions } from '@credo-ts/core';
+import { AgentContext, EventEmitter, Logger } from '@credo-ts/core';
+import { TenantRecordService } from '../services';
+import { TenantSessionCoordinator } from './TenantSessionCoordinator';
+export declare class TenantAgentContextProvider implements AgentContextProvider {
+    private tenantRecordService;
+    private rootAgentContext;
+    private eventEmitter;
+    private logger;
+    private tenantSessionCoordinator;
+    constructor(tenantRecordService: TenantRecordService, rootAgentContext: AgentContext, eventEmitter: EventEmitter, tenantSessionCoordinator: TenantSessionCoordinator, logger: Logger);
+    getAgentContextForContextCorrelationId(contextCorrelationId: string): Promise<AgentContext>;
+    getContextForInboundMessage(inboundMessage: unknown, options?: {
+        contextCorrelationId?: string;
+    }): Promise<AgentContext>;
+    endSessionForAgentContext(agentContext: AgentContext): Promise<void>;
+    private getRecipientKeysFromEncryptedMessage;
+    private registerRecipientKeyForTenant;
+    private listenForRoutingKeyCreatedEvents;
+    /**
+     * Method to allow updating the tenant storage, this method can be called from the TenantsApi
+     * to update the storage for a tenant manually
+     */
+    updateTenantStorage(tenantRecord: TenantRecord, updateOptions?: UpdateAssistantUpdateOptions): Promise<void>;
+    /**
+     * Handle the case where the tenant storage is outdated. If auto-update is disabled we will throw an error
+     * and not update the storage. If auto-update is enabled we will update the storage.
+     *
+     * When this method is called we can be sure that we are in the mutex runExclusive lock and thus other sessions
+     * will not be able to open a session for this tenant until we're done.
+     *
+     * NOTE: We don't support multi-instance locking for now. That means you can only have a single instance open and
+     * it will prevent multiple processes from updating the tenant storage at the same time. However if multi-instances
+     * are used, we can't prevent multiple instances from updating the tenant storage at the same time.
+     * In the future we can make the tenantSessionCoordinator an interface and allowing a instance-tenant-lock as well
+     * as an tenant-lock (across all instances)
+     */
+    private _updateTenantStorage;
+}