@credo-ts/core 0.5.0-alpha.101

package/build/agent/AgentMessage.d.ts

@@ -0,0 +1,85 @@
+import type { PlaintextMessage } from '../types';
+import type { ParsedMessageType } from '../utils/messageType';
+import type { Constructor } from '../utils/mixins';
+import { BaseMessage } from './BaseMessage';
+export type ConstructableAgentMessage = Constructor<AgentMessage> & {
+    type: ParsedMessageType;
+};
+declare const Decorated: {
+    new (...args: any[]): {
+        thread?: import("../decorators/thread/ThreadDecorator").ThreadDecorator | undefined;
+        readonly threadId: string;
+        setThread(options: Partial<import("../decorators/thread/ThreadDecorator").ThreadDecorator>): void;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & {
+    new (...args: any[]): {
+        l10n?: import("../decorators/l10n/L10nDecorator").L10nDecorator | undefined;
+        addLocale(locale: string): void;
+        getLocale(): string | undefined;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & {
+    new (...args: any[]): {
+        transport?: import("../decorators/transport/TransportDecorator").TransportDecorator | undefined;
+        setReturnRouting(type: import("..").ReturnRouteTypes, thread?: string | undefined): void;
+        hasReturnRouting(threadId?: string | undefined): boolean;
+        hasAnyReturnRoute(): boolean;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & {
+    new (...args: any[]): {
+        timing?: import("../decorators/timing/TimingDecorator").TimingDecorator | undefined;
+        setTiming(options: Partial<import("../decorators/timing/TimingDecorator").TimingDecorator>): void;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & {
+    new (...args: any[]): {
+        pleaseAck?: import("../decorators/ack/AckDecorator").AckDecorator | undefined;
+        setPleaseAck(on?: [import("../decorators/ack/AckDecorator").AckValues.Receipt]): void;
+        getPleaseAck(): import("../decorators/ack/AckDecorator").AckDecorator | undefined;
+        requiresAck(): boolean;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & {
+    new (...args: any[]): {
+        appendedAttachments?: import("..").Attachment[] | undefined;
+        getAppendedAttachmentById(id: string): import("..").Attachment | undefined;
+        addAppendedAttachment(attachment: import("..").Attachment): void;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & {
+    new (...args: any[]): {
+        service?: import("..").ServiceDecorator | undefined;
+        setService(serviceData: import("..").ServiceDecoratorOptions): void;
+        id: string;
+        readonly type: string;
+        generateId(): string;
+    };
+} & typeof BaseMessage;
+export declare class AgentMessage extends Decorated {
+    /**
+     * Whether the protocol RFC was initially written using the legacy did:prefix instead of the
+     * new https://didcomm.org message type prefix.
+     *
+     * @see https://github.com/hyperledger/aries-rfcs/blob/main/features/0348-transition-msg-type-to-https/README.md
+     */
+    readonly allowDidSovPrefix: boolean;
+    toJSON({ useDidSovPrefixWhereAllowed }?: {
+        useDidSovPrefixWhereAllowed?: boolean;
+    }): PlaintextMessage;
+    is<C extends typeof AgentMessage>(Class: C): this is InstanceType<C>;
+}
+export {};

package/build/agent/AgentMessage.js

@@ -0,0 +1,55 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentMessage = void 0;
+const class_transformer_1 = require("class-transformer");
+const AckDecoratorExtension_1 = require("../decorators/ack/AckDecoratorExtension");
+const AttachmentExtension_1 = require("../decorators/attachment/AttachmentExtension");
+const L10nDecoratorExtension_1 = require("../decorators/l10n/L10nDecoratorExtension");
+const ServiceDecoratorExtension_1 = require("../decorators/service/ServiceDecoratorExtension");
+const ThreadDecoratorExtension_1 = require("../decorators/thread/ThreadDecoratorExtension");
+const TimingDecoratorExtension_1 = require("../decorators/timing/TimingDecoratorExtension");
+const TransportDecoratorExtension_1 = require("../decorators/transport/TransportDecoratorExtension");
+const JsonTransformer_1 = require("../utils/JsonTransformer");
+const messageType_1 = require("../utils/messageType");
+const BaseMessage_1 = require("./BaseMessage");
+const Decorated = (0, ThreadDecoratorExtension_1.ThreadDecorated)((0, L10nDecoratorExtension_1.L10nDecorated)((0, TransportDecoratorExtension_1.TransportDecorated)((0, TimingDecoratorExtension_1.TimingDecorated)((0, AckDecoratorExtension_1.AckDecorated)((0, AttachmentExtension_1.AttachmentDecorated)((0, ServiceDecoratorExtension_1.ServiceDecorated)(BaseMessage_1.BaseMessage)))))));
+class AgentMessage extends Decorated {
+    constructor() {
+        super(...arguments);
+        /**
+         * Whether the protocol RFC was initially written using the legacy did:prefix instead of the
+         * new https://didcomm.org message type prefix.
+         *
+         * @see https://github.com/hyperledger/aries-rfcs/blob/main/features/0348-transition-msg-type-to-https/README.md
+         */
+        this.allowDidSovPrefix = false;
+    }
+    toJSON({ useDidSovPrefixWhereAllowed } = {}) {
+        const json = JsonTransformer_1.JsonTransformer.toJSON(this);
+        // If we have `useDidSovPrefixWhereAllowed` enabled, we want to replace the new https://didcomm.org prefix with the legacy did:sov prefix.
+        // However, we only do this if the protocol RFC was initially written with the did:sov message type prefix
+        // See https://github.com/hyperledger/aries-rfcs/blob/main/features/0348-transition-msg-type-to-https/README.md
+        if (this.allowDidSovPrefix && useDidSovPrefixWhereAllowed) {
+            (0, messageType_1.replaceNewDidCommPrefixWithLegacyDidSovOnMessage)(json);
+        }
+        return json;
+    }
+    is(Class) {
+        return this.type === Class.type.messageTypeUri;
+    }
+}
+__decorate([
+    (0, class_transformer_1.Exclude)(),
+    __metadata("design:type", Boolean)
+], AgentMessage.prototype, "allowDidSovPrefix", void 0);
+exports.AgentMessage = AgentMessage;
+//# sourceMappingURL=AgentMessage.js.map

package/build/agent/AgentMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AgentMessage.js","sourceRoot":"","sources":["../../src/agent/AgentMessage.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,yDAA2C;AAE3C,mFAAsE;AACtE,sFAAkF;AAClF,sFAAyE;AACzE,+FAAkF;AAClF,4FAA+E;AAC/E,4FAA+E;AAC/E,qGAAwF;AACxF,8DAA0D;AAC1D,sDAAuF;AAEvF,+CAA2C;AAI3C,MAAM,SAAS,GAAG,IAAA,0CAAe,EAC/B,IAAA,sCAAa,EAAC,IAAA,gDAAkB,EAAC,IAAA,0CAAe,EAAC,IAAA,oCAAY,EAAC,IAAA,yCAAmB,EAAC,IAAA,4CAAgB,EAAC,yBAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACrH,CAAA;AAED,MAAa,YAAa,SAAQ,SAAS;IAA3C;;QACE;;;;;WAKG;QAEa,sBAAiB,GAAY,KAAK,CAAA;IAkBpD,CAAC;IAhBQ,MAAM,CAAC,EAAE,2BAA2B,KAAgD,EAAE;QAC3F,MAAM,IAAI,GAAG,iCAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAEzC,0IAA0I;QAC1I,0GAA0G;QAC1G,+GAA+G;QAC/G,IAAI,IAAI,CAAC,iBAAiB,IAAI,2BAA2B,EAAE;YACzD,IAAA,8DAAgD,EAAC,IAAI,CAAC,CAAA;SACvD;QAED,OAAO,IAAwB,CAAA;IACjC,CAAC;IAEM,EAAE,CAAgC,KAAQ;QAC/C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,cAAc,CAAA;IAChD,CAAC;CACF;AAnBC;IAAC,IAAA,2BAAO,GAAE;;uDACwC;AARpD,oCA0BC"}

package/build/agent/AgentModules.d.ts

@@ -0,0 +1,154 @@
+import type { Module, DependencyManager, ApiModule } from '../plugins';
+import type { IsAny } from '../types';
+import type { Constructor } from '../utils/mixins';
+import { BasicMessagesModule } from '../modules/basic-messages';
+import { CacheModule } from '../modules/cache';
+import { ConnectionsModule } from '../modules/connections';
+import { CredentialsModule } from '../modules/credentials';
+import { DidsModule } from '../modules/dids';
+import { DifPresentationExchangeModule } from '../modules/dif-presentation-exchange';
+import { DiscoverFeaturesModule } from '../modules/discover-features';
+import { GenericRecordsModule } from '../modules/generic-records';
+import { MessagePickupModule } from '../modules/message-pickup';
+import { OutOfBandModule } from '../modules/oob';
+import { ProofsModule } from '../modules/proofs';
+import { MediationRecipientModule, MediatorModule } from '../modules/routing';
+import { W3cCredentialsModule } from '../modules/vc';
+import { WalletModule } from '../wallet';
+/**
+ * Simple utility type that represent a map of modules. This is used to map from moduleKey (api key) to the api in the framework.
+ */
+export type ModulesMap = {
+    [key: string]: Module;
+};
+export type EmptyModuleMap = {};
+/**
+ * Default modules can be optionally defined to provide custom configuration. This type makes it so that it is not
+ * possible to use a different key for the default modules
+ */
+export type AgentModulesInput = Partial<DefaultAgentModulesInput> & ModulesMap;
+/**
+ * Defines the input type for the default agent modules. This is overwritten as we
+ * want the input type to allow for generics to be passed in for the credentials module.
+ */
+export type DefaultAgentModulesInput = Omit<DefaultAgentModules, 'credentials' | 'proofs'> & {
+    credentials: CredentialsModule<any>;
+    proofs: ProofsModule<any>;
+};
+/**
+ * Type that represents the default agent modules. This is the {@link ModulesMap} variant for the default modules in the framework.
+ * It uses the return type of the {@link getDefaultAgentModules} method to automatically infer which modules are always available on
+ * the agent and in the agent. namespace.
+ */
+export type DefaultAgentModules = {
+    [moduleKey in keyof ReturnType<typeof getDefaultAgentModules>]: ReturnType<ReturnType<typeof getDefaultAgentModules>[moduleKey]>;
+};
+export type WithoutDefaultModules<Modules extends ModulesMap> = {
+    [moduleKey in Exclude<keyof Modules, keyof DefaultAgentModules>]: Modules[moduleKey];
+};
+/**
+ * Type that represents the api object of the agent (`agent.xxx`). It will extract all keys of the modules and map this to the
+ * registered {@link Module.api} class instance. If the module does not have an api class registered, the property will be removed
+ * and won't be available on the api object.
+ *
+ * @example
+ * If the following AgentModules type was passed:
+ * ```ts
+ * {
+ *   connections: ConnectionsModule
+ *   indy: IndyModule
+ * }
+ * ```
+ *
+ * And we use the `AgentApi` type like this:
+ * ```ts
+ * type MyAgentApi = AgentApi<{
+ *   connections: ConnectionsModule
+ *   indy: IndyModule
+ * }>
+ * ```
+ *
+ * the resulting agent api will look like:
+ *
+ * ```ts
+ * {
+ *   connections: ConnectionsApi
+ * }
+ * ```
+ *
+ * The `indy` module has been ignored because it doesn't define an api class.
+ */
+export type AgentApi<Modules extends ModulesMap> = {
+    [moduleKey in keyof Modules as Modules[moduleKey]['api'] extends Constructor<unknown> ? moduleKey : never]: Modules[moduleKey]['api'] extends Constructor<unknown> ? InstanceType<Modules[moduleKey]['api']> : never;
+};
+/**
+ * Returns the `api` type from the CustomModuleType if the module is an ApiModule. If the module is not defined
+ * which is the case if you don't configure a default agent module (e.g. credentials module), it will use the default
+ * module type and use that for the typing. This will contain the default typing, and thus provide the correct agent api
+ * interface
+ */
+export type CustomOrDefaultApi<CustomModuleType, DefaultModuleType extends ApiModule> = IsAny<CustomModuleType> extends true ? InstanceType<DefaultModuleType['api']> : CustomModuleType extends ApiModule ? InstanceType<CustomModuleType['api']> : CustomModuleType extends Module ? never : InstanceType<DefaultModuleType['api']>;
+/**
+ * Method to get the default agent modules to be registered on any agent instance. It doens't configure the modules in any way,
+ * and if that's needed the user needs to provide the module in the agent constructor
+ */
+declare function getDefaultAgentModules(): {
+    readonly connections: () => ConnectionsModule;
+    readonly credentials: () => CredentialsModule<[]>;
+    readonly proofs: () => ProofsModule<import("../modules/proofs").DefaultProofProtocols>;
+    readonly mediator: () => MediatorModule;
+    readonly mediationRecipient: () => MediationRecipientModule;
+    readonly messagePickup: () => MessagePickupModule<import("../modules/message-pickup").DefaultMessagePickupProtocols>;
+    readonly basicMessages: () => BasicMessagesModule;
+    readonly genericRecords: () => GenericRecordsModule;
+    readonly discovery: () => DiscoverFeaturesModule;
+    readonly dids: () => DidsModule;
+    readonly wallet: () => WalletModule;
+    readonly oob: () => OutOfBandModule;
+    readonly w3cCredentials: () => W3cCredentialsModule;
+    readonly cache: () => CacheModule;
+    readonly pex: () => DifPresentationExchangeModule;
+};
+/**
+ * Extend the provided modules object with the default agent modules. If the modules property already contains a module with the same
+ * name as a default module, the module won't be added to the extended module object. This allows users of the framework to override
+ * the modules with custom configuration. The agent constructor type ensures you can't provide a different module for a key that registered
+ * on the default agent.
+ */
+export declare function extendModulesWithDefaultModules<AgentModules extends AgentModulesInput>(modules?: AgentModules): AgentModules & DefaultAgentModules;
+/**
+ * Get the agent api object based on the modules registered in the dependency manager. For each registered module on the
+ * dependency manager, the method will extract the api class from the module, resolve it and assign it to the module key
+ * as provided in the agent constructor (or the {@link getDefaultAgentModules} method).
+ *
+ * Modules that don't have an api class defined ({@link Module.api} is undefined) will be ignored and won't be added to the
+ * api object.
+ *
+ * If the api of a module is passed in the `excluded` array, the api will not be added to the resulting api object.
+ *
+ * @example
+ * If the dependency manager has the following modules configured:
+ * ```ts
+ * {
+ *   connections: ConnectionsModule
+ *   indy: IndyModule
+ * }
+ * ```
+ *
+ * And we call the `getAgentApi` method like this:
+ * ```ts
+ * const api = getAgentApi(dependencyManager)
+ * ```
+ *
+ * the resulting agent api will look like:
+ *
+ * ```ts
+ * {
+ *   connections: ConnectionsApi
+ * }
+ * ```
+ *
+ * The `indy` module has been ignored because it doesn't define an api class.
+ */
+export declare function getAgentApi<AgentModules extends ModulesMap>(dependencyManager: DependencyManager, excludedApis?: unknown[]): AgentApi<AgentModules>;
+export {};

package/build/agent/AgentModules.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAgentApi = exports.extendModulesWithDefaultModules = void 0;
+const basic_messages_1 = require("../modules/basic-messages");
+const cache_1 = require("../modules/cache");
+const connections_1 = require("../modules/connections");
+const credentials_1 = require("../modules/credentials");
+const dids_1 = require("../modules/dids");
+const dif_presentation_exchange_1 = require("../modules/dif-presentation-exchange");
+const discover_features_1 = require("../modules/discover-features");
+const generic_records_1 = require("../modules/generic-records");
+const message_pickup_1 = require("../modules/message-pickup");
+const oob_1 = require("../modules/oob");
+const proofs_1 = require("../modules/proofs");
+const routing_1 = require("../modules/routing");
+const vc_1 = require("../modules/vc");
+const wallet_1 = require("../wallet");
+/**
+ * Method to get the default agent modules to be registered on any agent instance. It doens't configure the modules in any way,
+ * and if that's needed the user needs to provide the module in the agent constructor
+ */
+function getDefaultAgentModules() {
+    return {
+        connections: () => new connections_1.ConnectionsModule(),
+        credentials: () => new credentials_1.CredentialsModule(),
+        proofs: () => new proofs_1.ProofsModule(),
+        mediator: () => new routing_1.MediatorModule(),
+        mediationRecipient: () => new routing_1.MediationRecipientModule(),
+        messagePickup: () => new message_pickup_1.MessagePickupModule(),
+        basicMessages: () => new basic_messages_1.BasicMessagesModule(),
+        genericRecords: () => new generic_records_1.GenericRecordsModule(),
+        discovery: () => new discover_features_1.DiscoverFeaturesModule(),
+        dids: () => new dids_1.DidsModule(),
+        wallet: () => new wallet_1.WalletModule(),
+        oob: () => new oob_1.OutOfBandModule(),
+        w3cCredentials: () => new vc_1.W3cCredentialsModule(),
+        cache: () => new cache_1.CacheModule(),
+        pex: () => new dif_presentation_exchange_1.DifPresentationExchangeModule(),
+    };
+}
+/**
+ * Extend the provided modules object with the default agent modules. If the modules property already contains a module with the same
+ * name as a default module, the module won't be added to the extended module object. This allows users of the framework to override
+ * the modules with custom configuration. The agent constructor type ensures you can't provide a different module for a key that registered
+ * on the default agent.
+ */
+function extendModulesWithDefaultModules(modules) {
+    const extendedModules = Object.assign({}, modules);
+    const defaultAgentModules = getDefaultAgentModules();
+    // Register all default modules, if not registered yet
+    for (const [moduleKey, getConfiguredModule] of Object.entries(defaultAgentModules)) {
+        // Do not register if the module is already registered.
+        if (modules && modules[moduleKey])
+            continue;
+        extendedModules[moduleKey] = getConfiguredModule();
+    }
+    return extendedModules;
+}
+exports.extendModulesWithDefaultModules = extendModulesWithDefaultModules;
+/**
+ * Get the agent api object based on the modules registered in the dependency manager. For each registered module on the
+ * dependency manager, the method will extract the api class from the module, resolve it and assign it to the module key
+ * as provided in the agent constructor (or the {@link getDefaultAgentModules} method).
+ *
+ * Modules that don't have an api class defined ({@link Module.api} is undefined) will be ignored and won't be added to the
+ * api object.
+ *
+ * If the api of a module is passed in the `excluded` array, the api will not be added to the resulting api object.
+ *
+ * @example
+ * If the dependency manager has the following modules configured:
+ * ```ts
+ * {
+ *   connections: ConnectionsModule
+ *   indy: IndyModule
+ * }
+ * ```
+ *
+ * And we call the `getAgentApi` method like this:
+ * ```ts
+ * const api = getAgentApi(dependencyManager)
+ * ```
+ *
+ * the resulting agent api will look like:
+ *
+ * ```ts
+ * {
+ *   connections: ConnectionsApi
+ * }
+ * ```
+ *
+ * The `indy` module has been ignored because it doesn't define an api class.
+ */
+function getAgentApi(dependencyManager, excludedApis = []) {
+    // Create the api object based on the `api` properties on the modules. If no `api` exists
+    // on the module it will be ignored.
+    const api = Object.entries(dependencyManager.registeredModules).reduce((api, [moduleKey, module]) => {
+        // Module has no api
+        if (!module.api)
+            return api;
+        const apiInstance = dependencyManager.resolve(module.api);
+        // Api is excluded
+        if (excludedApis.includes(apiInstance))
+            return api;
+        return Object.assign(Object.assign({}, api), { [moduleKey]: apiInstance });
+    }, {});
+    return api;
+}
+exports.getAgentApi = getAgentApi;
+//# sourceMappingURL=AgentModules.js.map

package/build/agent/AgentModules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AgentModules.js","sourceRoot":"","sources":["../../src/agent/AgentModules.ts"],"names":[],"mappings":";;;AAIA,8DAA+D;AAC/D,4CAA8C;AAC9C,wDAA0D;AAC1D,wDAA0D;AAC1D,0CAA4C;AAC5C,oFAAoF;AACpF,oEAAqE;AACrE,gEAAiE;AACjE,8DAA+D;AAC/D,wCAAgD;AAChD,8CAAgD;AAChD,gDAA6E;AAC7E,sCAAoD;AACpD,sCAAwC;AAiGxC;;;GAGG;AACH,SAAS,sBAAsB;IAC7B,OAAO;QACL,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,+BAAiB,EAAE;QAC1C,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,+BAAiB,EAAE;QAC1C,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,qBAAY,EAAE;QAChC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,wBAAc,EAAE;QACpC,kBAAkB,EAAE,GAAG,EAAE,CAAC,IAAI,kCAAwB,EAAE;QACxD,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,oCAAmB,EAAE;QAC9C,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,oCAAmB,EAAE;QAC9C,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,sCAAoB,EAAE;QAChD,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,0CAAsB,EAAE;QAC7C,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,iBAAU,EAAE;QAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,qBAAY,EAAE;QAChC,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,qBAAe,EAAE;QAChC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,yBAAoB,EAAE;QAChD,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,mBAAW,EAAE;QAC9B,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,yDAA6B,EAAE;KACtC,CAAA;AACZ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAC7C,OAAsB;IAEtB,MAAM,eAAe,qBAAgC,OAAO,CAAE,CAAA;IAC9D,MAAM,mBAAmB,GAAG,sBAAsB,EAAE,CAAA;IAEpD,sDAAsD;IACtD,KAAK,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;QAClF,uDAAuD;QACvD,IAAI,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC;YAAE,SAAQ;QAE3C,eAAe,CAAC,SAAS,CAAC,GAAG,mBAAmB,EAAE,CAAA;KACnD;IAED,OAAO,eAAqD,CAAA;AAC9D,CAAC;AAfD,0EAeC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,WAAW,CACzB,iBAAoC,EACpC,eAA0B,EAAE;IAE5B,yFAAyF;IACzF,oCAAoC;IACpC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,EAAE;QAClG,oBAAoB;QACpB,IAAI,CAAC,MAAM,CAAC,GAAG;YAAE,OAAO,GAAG,CAAA;QAE3B,MAAM,WAAW,GAAG,iBAAiB,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAEzD,kBAAkB;QAClB,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC;YAAE,OAAO,GAAG,CAAA;QAClD,uCAAY,GAAG,KAAE,CAAC,SAAS,CAAC,EAAE,WAAW,IAAE;IAC7C,CAAC,EAAE,EAAE,CAA2B,CAAA;IAEhC,OAAO,GAAG,CAAA;AACZ,CAAC;AAlBD,kCAkBC"}

package/build/agent/BaseAgent.d.ts

@@ -0,0 +1,63 @@
+import type { AgentConfig } from './AgentConfig';
+import type { AgentApi, CustomOrDefaultApi, EmptyModuleMap, ModulesMap, WithoutDefaultModules } from './AgentModules';
+import type { TransportSession } from './TransportService';
+import type { Logger } from '../logger';
+import type { CredentialsModule } from '../modules/credentials';
+import type { MessagePickupModule } from '../modules/message-pickup';
+import type { ProofsModule } from '../modules/proofs';
+import type { DependencyManager } from '../plugins';
+import { BasicMessagesApi } from '../modules/basic-messages';
+import { ConnectionsApi } from '../modules/connections';
+import { DidsApi } from '../modules/dids';
+import { DiscoverFeaturesApi } from '../modules/discover-features';
+import { GenericRecordsApi } from '../modules/generic-records';
+import { OutOfBandApi } from '../modules/oob';
+import { MediatorApi, MediationRecipientApi } from '../modules/routing';
+import { W3cCredentialsApi } from '../modules/vc/W3cCredentialsApi';
+import { WalletApi } from '../wallet';
+import { EventEmitter } from './EventEmitter';
+import { FeatureRegistry } from './FeatureRegistry';
+import { MessageReceiver } from './MessageReceiver';
+import { MessageSender } from './MessageSender';
+import { TransportService } from './TransportService';
+import { AgentContext } from './context';
+export declare abstract class BaseAgent<AgentModules extends ModulesMap = EmptyModuleMap> {
+    protected agentConfig: AgentConfig;
+    protected logger: Logger;
+    readonly dependencyManager: DependencyManager;
+    protected eventEmitter: EventEmitter;
+    protected featureRegistry: FeatureRegistry;
+    protected messageReceiver: MessageReceiver;
+    protected transportService: TransportService;
+    protected messageSender: MessageSender;
+    protected _isInitialized: boolean;
+    protected agentContext: AgentContext;
+    readonly connections: ConnectionsApi;
+    readonly credentials: CustomOrDefaultApi<AgentModules['credentials'], CredentialsModule>;
+    readonly proofs: CustomOrDefaultApi<AgentModules['proofs'], ProofsModule>;
+    readonly mediator: MediatorApi;
+    readonly mediationRecipient: MediationRecipientApi;
+    readonly messagePickup: CustomOrDefaultApi<AgentModules['messagePickup'], MessagePickupModule>;
+    readonly basicMessages: BasicMessagesApi;
+    readonly genericRecords: GenericRecordsApi;
+    readonly discovery: DiscoverFeaturesApi;
+    readonly dids: DidsApi;
+    readonly wallet: WalletApi;
+    readonly oob: OutOfBandApi;
+    readonly w3cCredentials: W3cCredentialsApi;
+    readonly modules: AgentApi<WithoutDefaultModules<AgentModules>>;
+    constructor(agentConfig: AgentConfig, dependencyManager: DependencyManager);
+    get isInitialized(): boolean;
+    initialize(): Promise<void>;
+    /**
+     * Receive a message.
+     *
+     * @deprecated Use {@link OutOfBandApi.receiveInvitationFromUrl} instead for receiving legacy connection-less messages.
+     * For receiving messages that originated from a transport, use the {@link MessageReceiver}
+     * for this. The `receiveMessage` method on the `Agent` class will associate the current context to the message, which
+     * may not be what should happen (e.g. in case of multi tenancy).
+     */
+    receiveMessage(inboundMessage: unknown, session?: TransportSession): Promise<void>;
+    get config(): AgentConfig;
+    get context(): AgentContext;
+}

package/build/agent/BaseAgent.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseAgent = void 0;
+const error_1 = require("../error");
+const basic_messages_1 = require("../modules/basic-messages");
+const connections_1 = require("../modules/connections");
+const credentials_1 = require("../modules/credentials");
+const dids_1 = require("../modules/dids");
+const discover_features_1 = require("../modules/discover-features");
+const generic_records_1 = require("../modules/generic-records");
+const MessagePickupApi_1 = require("../modules/message-pickup/MessagePickupApi");
+const oob_1 = require("../modules/oob");
+const proofs_1 = require("../modules/proofs");
+const routing_1 = require("../modules/routing");
+const W3cCredentialsApi_1 = require("../modules/vc/W3cCredentialsApi");
+const storage_1 = require("../storage");
+const UpdateAssistant_1 = require("../storage/migration/UpdateAssistant");
+const updates_1 = require("../storage/migration/updates");
+const wallet_1 = require("../wallet");
+const error_2 = require("../wallet/error");
+const AgentModules_1 = require("./AgentModules");
+const EventEmitter_1 = require("./EventEmitter");
+const FeatureRegistry_1 = require("./FeatureRegistry");
+const MessageReceiver_1 = require("./MessageReceiver");
+const MessageSender_1 = require("./MessageSender");
+const TransportService_1 = require("./TransportService");
+const context_1 = require("./context");
+class BaseAgent {
+    constructor(agentConfig, dependencyManager) {
+        this._isInitialized = false;
+        this.dependencyManager = dependencyManager;
+        this.agentConfig = agentConfig;
+        this.logger = this.agentConfig.logger;
+        this.logger.info('Creating agent with config', {
+            agentConfig: agentConfig.toJSON(),
+        });
+        if (!this.agentConfig.walletConfig) {
+            this.logger.warn('Wallet config has not been set on the agent config. ' +
+                'Make sure to initialize the wallet yourself before initializing the agent, ' +
+                'or provide the required wallet configuration in the agent constructor');
+        }
+        // Resolve instances after everything is registered
+        this.eventEmitter = this.dependencyManager.resolve(EventEmitter_1.EventEmitter);
+        this.featureRegistry = this.dependencyManager.resolve(FeatureRegistry_1.FeatureRegistry);
+        this.messageSender = this.dependencyManager.resolve(MessageSender_1.MessageSender);
+        this.messageReceiver = this.dependencyManager.resolve(MessageReceiver_1.MessageReceiver);
+        this.transportService = this.dependencyManager.resolve(TransportService_1.TransportService);
+        this.agentContext = this.dependencyManager.resolve(context_1.AgentContext);
+        this.connections = this.dependencyManager.resolve(connections_1.ConnectionsApi);
+        this.credentials = this.dependencyManager.resolve(credentials_1.CredentialsApi);
+        this.proofs = this.dependencyManager.resolve(proofs_1.ProofsApi);
+        this.mediator = this.dependencyManager.resolve(routing_1.MediatorApi);
+        this.mediationRecipient = this.dependencyManager.resolve(routing_1.MediationRecipientApi);
+        this.messagePickup = this.dependencyManager.resolve(MessagePickupApi_1.MessagePickupApi);
+        this.basicMessages = this.dependencyManager.resolve(basic_messages_1.BasicMessagesApi);
+        this.genericRecords = this.dependencyManager.resolve(generic_records_1.GenericRecordsApi);
+        this.discovery = this.dependencyManager.resolve(discover_features_1.DiscoverFeaturesApi);
+        this.dids = this.dependencyManager.resolve(dids_1.DidsApi);
+        this.wallet = this.dependencyManager.resolve(wallet_1.WalletApi);
+        this.oob = this.dependencyManager.resolve(oob_1.OutOfBandApi);
+        this.w3cCredentials = this.dependencyManager.resolve(W3cCredentialsApi_1.W3cCredentialsApi);
+        const defaultApis = [
+            this.connections,
+            this.credentials,
+            this.proofs,
+            this.mediator,
+            this.mediationRecipient,
+            this.messagePickup,
+            this.basicMessages,
+            this.genericRecords,
+            this.discovery,
+            this.dids,
+            this.wallet,
+            this.oob,
+            this.w3cCredentials,
+        ];
+        // Set the api of the registered modules on the agent, excluding the default apis
+        this.modules = (0, AgentModules_1.getAgentApi)(this.dependencyManager, defaultApis);
+    }
+    get isInitialized() {
+        return this._isInitialized && this.wallet.isInitialized;
+    }
+    async initialize() {
+        const { walletConfig } = this.agentConfig;
+        if (this._isInitialized) {
+            throw new error_1.AriesFrameworkError('Agent already initialized. Currently it is not supported to re-initialize an already initialized agent.');
+        }
+        if (!this.wallet.isInitialized && walletConfig) {
+            await this.wallet.initialize(walletConfig);
+        }
+        else if (!this.wallet.isInitialized) {
+            throw new error_2.WalletError('Wallet config has not been set on the agent config. ' +
+                'Make sure to initialize the wallet yourself before initializing the agent, ' +
+                'or provide the required wallet configuration in the agent constructor');
+        }
+        // Make sure the storage is up to date
+        const storageUpdateService = this.dependencyManager.resolve(storage_1.StorageUpdateService);
+        const isStorageUpToDate = await storageUpdateService.isUpToDate(this.agentContext);
+        this.logger.info(`Agent storage is ${isStorageUpToDate ? '' : 'not '}up to date.`);
+        if (!isStorageUpToDate && this.agentConfig.autoUpdateStorageOnStartup) {
+            const updateAssistant = new UpdateAssistant_1.UpdateAssistant(this, updates_1.DEFAULT_UPDATE_CONFIG);
+            await updateAssistant.initialize();
+            await updateAssistant.update();
+        }
+        else if (!isStorageUpToDate) {
+            const currentVersion = await storageUpdateService.getCurrentStorageVersion(this.agentContext);
+            // Close wallet to prevent un-initialized agent with initialized wallet
+            await this.wallet.close();
+            throw new error_1.AriesFrameworkError(
+            // TODO: add link to where documentation on how to update can be found.
+            `Current agent storage is not up to date. ` +
+                `To prevent the framework state from getting corrupted the agent initialization is aborted. ` +
+                `Make sure to update the agent storage (currently at ${currentVersion}) to the latest version (${UpdateAssistant_1.UpdateAssistant.frameworkStorageVersion}). ` +
+                `You can also downgrade your version of Credo.`);
+        }
+    }
+    /**
+     * Receive a message.
+     *
+     * @deprecated Use {@link OutOfBandApi.receiveInvitationFromUrl} instead for receiving legacy connection-less messages.
+     * For receiving messages that originated from a transport, use the {@link MessageReceiver}
+     * for this. The `receiveMessage` method on the `Agent` class will associate the current context to the message, which
+     * may not be what should happen (e.g. in case of multi tenancy).
+     */
+    async receiveMessage(inboundMessage, session) {
+        return await this.messageReceiver.receiveMessage(inboundMessage, {
+            session,
+            contextCorrelationId: this.agentContext.contextCorrelationId,
+        });
+    }
+    get config() {
+        return this.agentConfig;
+    }
+    get context() {
+        return this.agentContext;
+    }
+}
+exports.BaseAgent = BaseAgent;
+//# sourceMappingURL=BaseAgent.js.map

package/build/agent/BaseAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAgent.js","sourceRoot":"","sources":["../../src/agent/BaseAgent.ts"],"names":[],"mappings":";;;AASA,oCAA8C;AAC9C,8DAA4D;AAC5D,wDAAuD;AACvD,wDAAuD;AACvD,0CAAyC;AACzC,oEAAkE;AAClE,gEAA8D;AAC9D,iFAA6E;AAC7E,wCAA6C;AAC7C,8CAA6C;AAC7C,gDAAuE;AACvE,uEAAmE;AACnE,wCAAiD;AACjD,0EAAsE;AACtE,0DAAoE;AACpE,sCAAqC;AACrC,2CAA6C;AAE7C,iDAA4C;AAC5C,iDAA6C;AAC7C,uDAAmD;AACnD,uDAAmD;AACnD,mDAA+C;AAC/C,yDAAqD;AACrD,uCAAwC;AAExC,MAAsB,SAAS;IA4B7B,YAAmB,WAAwB,EAAE,iBAAoC;QAnBvE,mBAAc,GAAG,KAAK,CAAA;QAoB9B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;QAE1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAA;QAErC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,EAAE;YAC7C,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE;SAClC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,sDAAsD;gBACpD,6EAA6E;gBAC7E,uEAAuE,CAC1E,CAAA;SACF;QAED,mDAAmD;QACnD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,2BAAY,CAAC,CAAA;QAChE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAA;QACtE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,6BAAa,CAAC,CAAA;QAClE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAA;QACtE,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,mCAAgB,CAAC,CAAA;QACxE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAA;QAEhE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,4BAAc,CAAC,CAAA;QACjE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,4BAAc,CAG/D,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,kBAAS,CAA6D,CAAA;QACnH,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,qBAAW,CAAC,CAAA;QAC3D,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,+BAAqB,CAAC,CAAA;QAC/E,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,mCAAgB,CAGnE,CAAA;QACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,iCAAgB,CAAC,CAAA;QACrE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,mCAAiB,CAAC,CAAA;QACvE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,uCAAmB,CAAC,CAAA;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,cAAO,CAAC,CAAA;QACnD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,kBAAS,CAAC,CAAA;QACvD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,kBAAY,CAAC,CAAA;QACvD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,qCAAiB,CAAC,CAAA;QAEvE,MAAM,WAAW,GAAG;YAClB,IAAI,CAAC,WAAW;YAChB,IAAI,CAAC,WAAW;YAChB,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,QAAQ;YACb,IAAI,CAAC,kBAAkB;YACvB,IAAI,CAAC,aAAa;YAClB,IAAI,CAAC,aAAa;YAClB,IAAI,CAAC,cAAc;YACnB,IAAI,CAAC,SAAS;YACd,IAAI,CAAC,IAAI;YACT,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,cAAc;SACpB,CAAA;QAED,iFAAiF;QACjF,IAAI,CAAC,OAAO,GAAG,IAAA,0BAAW,EAAC,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAA;IACjE,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAA;IACzD,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,WAAW,CAAA;QAEzC,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,IAAI,2BAAmB,CAC3B,yGAAyG,CAC1G,CAAA;SACF;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,YAAY,EAAE;YAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;SAC3C;aAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YACrC,MAAM,IAAI,mBAAW,CACnB,sDAAsD;gBACpD,6EAA6E;gBAC7E,uEAAuE,CAC1E,CAAA;SACF;QAED,sCAAsC;QACtC,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,8BAAoB,CAAC,CAAA;QACjF,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAClF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,CAAA;QAElF,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE;YACrE,MAAM,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,EAAE,+BAAqB,CAAC,CAAA;YAExE,MAAM,eAAe,CAAC,UAAU,EAAE,CAAA;YAClC,MAAM,eAAe,CAAC,MAAM,EAAE,CAAA;SAC/B;aAAM,IAAI,CAAC,iBAAiB,EAAE;YAC7B,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC7F,uEAAuE;YACvE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;YACzB,MAAM,IAAI,2BAAmB;YAC3B,uEAAuE;YACvE,2CAA2C;gBACzC,6FAA6F;gBAC7F,uDAAuD,cAAc,4BAA4B,iCAAe,CAAC,uBAAuB,KAAK;gBAC7I,+CAA+C,CAClD,CAAA;SACF;IACH,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,cAAc,CAAC,cAAuB,EAAE,OAA0B;QAC7E,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,cAAc,EAAE;YAC/D,OAAO;YACP,oBAAoB,EAAE,IAAI,CAAC,YAAY,CAAC,oBAAoB;SAC7D,CAAC,CAAA;IACJ,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;CACF;AAnKD,8BAmKC"}

package/build/agent/BaseMessage.d.ts

@@ -0,0 +1,11 @@
+import type { ParsedMessageType } from '../utils/messageType';
+import type { Constructor } from '../utils/mixins';
+export declare const MessageIdRegExp: RegExp;
+export declare const MessageTypeRegExp: RegExp;
+export type BaseMessageConstructor = Constructor<BaseMessage>;
+export declare class BaseMessage {
+    id: string;
+    readonly type: string;
+    static readonly type: ParsedMessageType;
+    generateId(): string;
+}