@sphereon/ssi-sdk.event-logger 0.17.6-next.52

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [2023] [Sphereon BV]
+
+   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,193 @@
+<!--suppress HtmlDeprecatedAttribute -->
+<h1 align="center">
+  <br>
+  <a href="https://www.sphereon.com"><img src="https://sphereon.com/content/themes/sphereon/assets/img/logo.svg" alt="Sphereon" width="400"></a>
+  <br>Event Logger (Typescript) 
+  <br>
+</h1>
+
+---
+
+**Warning: This package still is in very early development. Breaking changes without notice will happen at this point!**
+
+---
+
+A Veramo event logger plugin. This plugin allows for listening to events and to persist them into a database. 
+There are also functions that can be manually called to persist events. Current, only audit events are supported that can be used to create an audit log.
+
+Ideally this plugin should be used in combination with the event logger from our core package. This event logger will also default debug the events. 
+This is mainly as a fallback for when no listener is present within the agent.
+
+## Available functions
+- loggerGetAuditEvents
+- loggerStoreAuditEvent
+
+## Usage
+
+### Adding the plugin to an agent:
+
+```typescript
+import { migrations, Entities } from '@veramo/data-store'
+import { EventLogger, IEventLogger } from '@sphereon/ssi-sdk.event-logger'
+import {
+  EventLoggerStore,
+  DataStoreMigrations,
+  DataStoreEventLoggerEntities,
+  LoggingEventType
+} from '@sphereon/ssi-sdk.data-store'
+
+const dbConnection = createConnection({
+  type: 'react-native',
+  database: 'app.sqlite',
+  location: 'default',
+  logging: false,
+  synchronize: false,
+  migrationsRun: true,
+  migrations: [...DataStoreMigrations, ...migrations],
+  entities: [...DataStoreEventLoggerEntities, ...Entities],
+})
+
+const agent = createAgent<IEventLogger>({
+  plugins: [
+    new EventLogger({
+      eventTypes: [LoggingEventType.AUDIT],
+      store: new EventLoggerStore(dbConnection),
+    }),
+  ],
+})
+```
+
+### Log event using event listener:
+
+```typescript
+import { 
+  EventLogger, 
+  EventLoggerBuilder, 
+  LoggingEventType ,
+  LogLevel,
+  System,
+  SubSystem,
+  ActionType,
+  InitiatorType,
+  SystemCorrelationIdType,
+  PartyCorrelationType
+} from '@sphereon/ssi-sdk.core';
+
+const agentContext = { agent }
+const logger: EventLogger = new EventLoggerBuilder()
+    .withContext(agentContext)
+    .withNamespace('custom_namespace')
+    .build()
+
+await logger.logEvent({
+  type: LoggingEventType.AUDIT,
+  data: {
+    level: LogLevel.DEBUG,
+    correlationId: 'b40b8474-58a2-4b23-9fde-bd6ee1902cdb',
+    system: System.GENERAL,
+    subSystemType: SubSystem.DID_PROVIDER,
+    actionType: ActionType.CREATE,
+    actionSubType: 'Key generation',
+    initiatorType: InitiatorType.EXTERNAL,
+    systemCorrelationIdType: SystemCorrelationIdType.DID,
+    systemCorrelationId: 'did:example:123456789abcdefghi',
+    systemAlias: 'test_alias',
+    partyCorrelationType: PartyCorrelationType.DID,
+    partyCorrelationId: 'did:example:123456789abcdefghi',
+    partyAlias: 'test_alias',
+    description: 'test_description',
+    data: 'test_data_string',
+    diagnosticData: { data: 'test_data_string'}
+  }
+})
+```
+
+### Log event manually:
+
+```typescript
+import {
+  AuditLoggingEvent,
+  LogLevel,
+  System,
+  SubSystem,
+  ActionType,
+  InitiatorType,
+  SystemCorrelationIdType,
+  PartyCorrelationType
+} from '@sphereon/ssi-sdk.core'
+import { GetAuditEventsArgs, NonPersistedAuditLoggingEvent } from '@sphereon/ssi-sdk.event-logger'
+
+const auditEvent: NonPersistedAuditLoggingEvent = {
+  level: LogLevel.DEBUG,
+  correlationId: 'b40b8474-58a2-4b23-9fde-bd6ee1902cdb',
+  system: System.GENERAL,
+  subSystemType: SubSystem.DID_PROVIDER,
+  actionType: ActionType.CREATE,
+  actionSubType: 'Key generation',
+  initiatorType: InitiatorType.EXTERNAL,
+  systemCorrelationIdType: SystemCorrelationIdType.DID,
+  systemCorrelationId: 'did:example:123456789abcdefghi',
+  systemAlias: 'test_alias',
+  partyCorrelationType: PartyCorrelationType.DID,
+  partyCorrelationId: 'did:example:123456789abcdefghi',
+  partyAlias: 'test_alias',
+  description: 'test_description',
+  data: 'test_data_string',
+  diagnosticData: { data: 'test_data_string'}
+}
+
+const result: AuditLoggingEvent = await agent.loggerLogAuditEvent({event: auditEvent})
+```
+
+### Retrieve audit events:
+
+```typescript
+import {
+  AuditLoggingEvent,
+  LogLevel,
+  System,
+  SubSystem,
+  ActionType,
+  InitiatorType,
+  SystemCorrelationIdType,
+  PartyCorrelationType
+} from '@sphereon/ssi-sdk.core'
+import { GetAuditEventsArgs, NonPersistedAuditLoggingEvent } from '@sphereon/ssi-sdk.event-logger'
+
+const auditEvent: NonPersistedAuditLoggingEvent = {
+  level: LogLevel.DEBUG,
+  correlationId: 'b40b8474-58a2-4b23-9fde-bd6ee1902cdb',
+  system: System.GENERAL,
+  subSystemType: SubSystem.DID_PROVIDER,
+  actionType: ActionType.CREATE,
+  actionSubType: 'Key generation',
+  initiatorType: InitiatorType.EXTERNAL,
+  systemCorrelationIdType: SystemCorrelationIdType.DID,
+  systemCorrelationId: 'did:example:123456789abcdefghi',
+  systemAlias: 'test_alias',
+  partyCorrelationType: PartyCorrelationType.DID,
+  partyCorrelationId: 'did:example:123456789abcdefghi',
+  partyAlias: 'test_alias',
+  description: 'test_description',
+  data: 'test_data_string',
+  diagnosticData: { data: 'test_data_string'}
+}
+
+await agent.loggerLogAuditEvent({event: auditEvent})
+const getAuditEventArgs: GetAuditEventsArgs = {
+  filter: [{ correlationId: auditEvent.correlationId }],
+}
+const result: Array<AuditLoggingEvent> = await agent.loggerGetAuditEvents(getAuditEventArgs)
+```
+
+## Installation
+
+```shell
+yarn add @sphereon/ssi-sdk.event-logger
+```
+
+## Build
+
+```shell
+yarn build
+```

package/dist/agent/EventLogger.d.ts

@@ -0,0 +1,17 @@
+import { IAgentPlugin } from '@veramo/core';
+import { LoggingEventType } from '@sphereon/ssi-sdk.core';
+import { EventLoggerOptions, IEventLogger, RequiredContext, LoggingEvent } from '../types/IEventLogger';
+/**
+ * {@inheritDoc IEventLogger}
+ */
+export declare class EventLogger implements IAgentPlugin {
+    readonly schema: any;
+    readonly eventTypes: Array<LoggingEventType>;
+    readonly methods: IEventLogger;
+    private readonly store;
+    constructor(options: EventLoggerOptions);
+    onEvent(event: LoggingEvent, context: RequiredContext): Promise<void>;
+    private loggerGetAuditEvents;
+    private loggerLogAuditEvent;
+}
+//# sourceMappingURL=EventLogger.d.ts.map

package/dist/agent/EventLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventLogger.d.ts","sourceRoot":"","sources":["../../src/agent/EventLogger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,OAAO,EAAqB,gBAAgB,EAAY,MAAM,wBAAwB,CAAA;AAGtF,OAAO,EACL,kBAAkB,EAElB,YAAY,EACZ,eAAe,EAEf,YAAY,EACb,MAAM,uBAAuB,CAAA;AAE9B;;GAEG;AAEH,qBAAa,WAAY,YAAW,YAAY;IAC9C,QAAQ,CAAC,MAAM,MAAsB;IACrC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAK;IAEjD,QAAQ,CAAC,OAAO,EAAE,YAAY,CAG7B;IAED,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA0B;gBAEpC,OAAO,EAAE,kBAAkB;IAM1B,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;YAUpE,oBAAoB;YAMpB,mBAAmB;CAclC"}

package/dist/agent/EventLogger.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventLogger = void 0;
+const ssi_sdk_core_1 = require("@sphereon/ssi-sdk.core");
+const uuid_1 = require("uuid");
+const index_1 = require("../index");
+/**
+ * {@inheritDoc IEventLogger}
+ */
+class EventLogger {
+    constructor(options) {
+        this.schema = index_1.schema.IEventLogger;
+        this.eventTypes = [];
+        this.methods = {
+            loggerGetAuditEvents: this.loggerGetAuditEvents.bind(this),
+            loggerLogAuditEvent: this.loggerLogAuditEvent.bind(this),
+        };
+        const { store, eventTypes } = options;
+        this.store = store;
+        this.eventTypes = eventTypes;
+    }
+    onEvent(event, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            switch (event.type) {
+                case ssi_sdk_core_1.LoggingEventType.AUDIT:
+                    yield this.loggerLogAuditEvent({ event: event.data }, context);
+                    break;
+                default:
+                    return Promise.reject(Error('Event type not supported'));
+            }
+        });
+    }
+    loggerGetAuditEvents(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { filter } = args !== null && args !== void 0 ? args : {};
+            return this.store.getAuditEvents({ filter });
+        });
+    }
+    loggerLogAuditEvent(args, context) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { event } = args;
+            return this.store.storeAuditEvent({ event: Object.assign(Object.assign({}, event), { system: event.system, subSystemType: event.subSystemType, level: (_a = event.level) !== null && _a !== void 0 ? _a : ssi_sdk_core_1.LogLevel.INFO, correlationId: (_b = event.correlationId) !== null && _b !== void 0 ? _b : (0, uuid_1.v4)(), timestamp: new Date() })
+            });
+        });
+    }
+}
+exports.EventLogger = EventLogger;
+//# sourceMappingURL=EventLogger.js.map

package/dist/agent/EventLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventLogger.js","sourceRoot":"","sources":["../../src/agent/EventLogger.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,yDAAsF;AACtF,+BAAmC;AACnC,oCAAiC;AAUjC;;GAEG;AAEH,MAAa,WAAW;IAWtB,YAAY,OAA2B;QAV9B,WAAM,GAAG,cAAM,CAAC,YAAY,CAAA;QAC5B,eAAU,GAA4B,EAAE,CAAA;QAExC,YAAO,GAAiB;YAC/B,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1D,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;SACzD,CAAA;QAKC,MAAM,EAAC,KAAK,EAAE,UAAU,EAAC,GAAG,OAAO,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAEY,OAAO,CAAC,KAAmB,EAAE,OAAwB;;YAChE,QAAO,KAAK,CAAC,IAAI,EAAE;gBACjB,KAAK,+BAAgB,CAAC,KAAK;oBACzB,MAAM,IAAI,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;oBAC9D,MAAM;gBACR;oBACE,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAA;aAC3D;QACH,CAAC;KAAA;IAEa,oBAAoB,CAAC,IAAyB;;YAC1D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAA;YAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QAC9C,CAAC;KAAA;IAEa,mBAAmB,CAAC,IAAuB,EAAE,OAAwB;;;YACjF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;YAEtB,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,KAAK,kCAClC,KAAK,KACR,MAAM,EAAE,KAAK,CAAC,MAAM,EACpB,aAAa,EAAE,KAAK,CAAC,aAAa,EAClC,KAAK,EAAE,MAAA,KAAK,CAAC,KAAK,mCAAI,uBAAQ,CAAC,IAAI,EACnC,aAAa,EAAE,MAAA,KAAK,CAAC,aAAa,mCAAI,IAAA,SAAM,GAAE,EAC9C,SAAS,EAAE,IAAI,IAAI,EAAE,GACtB;aACF,CAAC,CAAA;;KACH;CAEF;AA/CD,kCA+CC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @public
+ */
+declare const schema: any;
+export { schema };
+export { EventLogger } from './agent/EventLogger';
+export * from './types/IEventLogger';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,QAAA,MAAM,MAAM,KAAmC,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,cAAc,sBAAsB,CAAA"}

package/dist/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventLogger = exports.schema = void 0;
+/**
+ * @public
+ */
+const schema = require('../plugin.schema.json');
+exports.schema = schema;
+var EventLogger_1 = require("./agent/EventLogger");
+Object.defineProperty(exports, "EventLogger", { enumerable: true, get: function () { return EventLogger_1.EventLogger; } });
+__exportStar(require("./types/IEventLogger"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,MAAM,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;AACtC,wBAAM;AACf,mDAAiD;AAAxC,0GAAA,WAAW,OAAA;AACpB,uDAAoC"}

package/dist/ssi-sdk.event-logger.d.ts

@@ -0,0 +1,61 @@
+import { AbstractEventLoggerStore } from '@sphereon/ssi-sdk.data-store';
+import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core';
+import { FindAuditLoggingEventArgs } from '@sphereon/ssi-sdk.data-store';
+import { IAgentContext } from '@veramo/core';
+import { IAgentPlugin } from '@veramo/core';
+import { IPluginMethodMap } from '@veramo/core';
+import { LoggingEventType } from '@sphereon/ssi-sdk.core';
+import { NonPersistedAuditLoggingEvent as NonPersistedAuditLoggingEvent_2 } from '@sphereon/ssi-sdk.core';
+import { SubSystem } from '@sphereon/ssi-sdk.core';
+import { System } from '@sphereon/ssi-sdk.core';
+
+/**
+ * {@inheritDoc IEventLogger}
+ */
+export declare class EventLogger implements IAgentPlugin {
+    readonly schema: any;
+    readonly eventTypes: Array<LoggingEventType>;
+    readonly methods: IEventLogger;
+    private readonly store;
+    constructor(options: EventLoggerOptions);
+    onEvent(event: LoggingEvent, context: RequiredContext): Promise<void>;
+    private loggerGetAuditEvents;
+    private loggerLogAuditEvent;
+}
+
+export declare type EventLoggerOptions = {
+    store: AbstractEventLoggerStore;
+    eventTypes: Array<LoggingEventType>;
+};
+
+export declare type GetAuditEventsArgs = {
+    filter?: FindAuditLoggingEventArgs;
+};
+
+export declare interface IEventLogger extends IPluginMethodMap {
+    loggerGetAuditEvents(args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>;
+    loggerLogAuditEvent(args: LogAuditEventArgs, context: RequiredContext): Promise<AuditLoggingEvent>;
+}
+
+export declare type LogAuditEventArgs = {
+    event: NonPersistedAuditLoggingEvent;
+};
+
+export declare type LoggingEvent = {
+    type: LoggingEventType;
+    data: NonPersistedAuditLoggingEvent;
+};
+
+export declare type NonPersistedAuditLoggingEvent = Omit<NonPersistedAuditLoggingEvent_2, 'system' | 'subSystemType'> & {
+    system: System;
+    subSystemType: SubSystem;
+};
+
+export declare type RequiredContext = IAgentContext<never>;
+
+/**
+ * @public
+ */
+export declare const schema: any;
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.37.1"
+    }
+  ]
+}

package/dist/types/IEventLogger.d.ts

@@ -0,0 +1,27 @@
+import { IAgentContext, IPluginMethodMap } from '@veramo/core';
+import { AuditLoggingEvent, NonPersistedAuditLoggingEvent as NPAuditLoggingEvent, LoggingEventType, SubSystem, System } from '@sphereon/ssi-sdk.core';
+import { AbstractEventLoggerStore, FindAuditLoggingEventArgs } from '@sphereon/ssi-sdk.data-store';
+export interface IEventLogger extends IPluginMethodMap {
+    loggerGetAuditEvents(args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>;
+    loggerLogAuditEvent(args: LogAuditEventArgs, context: RequiredContext): Promise<AuditLoggingEvent>;
+}
+export type EventLoggerOptions = {
+    store: AbstractEventLoggerStore;
+    eventTypes: Array<LoggingEventType>;
+};
+export type GetAuditEventsArgs = {
+    filter?: FindAuditLoggingEventArgs;
+};
+export type LogAuditEventArgs = {
+    event: NonPersistedAuditLoggingEvent;
+};
+export type NonPersistedAuditLoggingEvent = Omit<NPAuditLoggingEvent, 'system' | 'subSystemType'> & {
+    system: System;
+    subSystemType: SubSystem;
+};
+export type LoggingEvent = {
+    type: LoggingEventType;
+    data: NonPersistedAuditLoggingEvent;
+};
+export type RequiredContext = IAgentContext<never>;
+//# sourceMappingURL=IEventLogger.d.ts.map

package/dist/types/IEventLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEventLogger.d.ts","sourceRoot":"","sources":["../../src/types/IEventLogger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,EACL,iBAAiB,EACjB,6BAA6B,IAAI,mBAAmB,EACpD,gBAAgB,EAChB,SAAS,EACT,MAAM,EACP,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAA;AAElG,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,oBAAoB,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAA;IAClF,mBAAmB,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;CACnG;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,wBAAwB,CAAA;IAC/B,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,yBAAyB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,6BAA6B,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,eAAe,CAAC,GAAG;IAClG,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,SAAS,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,6BAA6B,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA"}

package/dist/types/IEventLogger.js

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

package/dist/types/IEventLogger.js.map

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

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@sphereon/ssi-sdk.event-logger",
+  "version": "0.17.6-next.52+967da967",
+  "source": "src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "veramo": {
+    "pluginInterfaces": {
+      "IEventLogger": "./src/types/IEventLogger.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:clean": "tsc --build --clean && tsc --build",
+    "generate-plugin-schema": "ts-node ../../packages/dev/bin/sphereon.js dev generate-plugin-schema"
+  },
+  "dependencies": {
+    "@sphereon/ssi-sdk.data-store": "0.17.6-next.52+967da967",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@sphereon/ssi-sdk.agent-config": "0.17.6-next.52+967da967",
+    "@sphereon/ssi-sdk.core": "0.17.6-next.52+967da967",
+    "@sphereon/ssi-sdk.data-store": "workspace:*",
+    "@types/jest": "^27.5.2",
+    "@types/uuid": "^8.3.4",
+    "@veramo/remote-client": "4.2.0",
+    "@veramo/remote-server": "4.2.0",
+    "jest": "^27.5.1",
+    "typeorm": "0.3.17",
+    "typescript": "^4.9.5"
+  },
+  "files": [
+    "dist/**/*",
+    "src/**/*",
+    "README.md",
+    "plugin.schema.json",
+    "LICENSE"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "git@github.com:Sphereon-Opensource/SSI-SDK.git",
+  "author": "Sphereon <dev@sphereon.com>",
+  "license": "Apache-2.0",
+  "keywords": [
+    "Sphereon",
+    "SSI",
+    "Veramo",
+    "Events",
+    "Logger",
+    "Audit"
+  ],
+  "gitHead": "967da9671a941f39637dcf163156c1a9f56c739b"
+}

package/plugin.schema.json

@@ -0,0 +1,350 @@
+{
+  "IEventLogger": {
+    "components": {
+      "schemas": {
+        "GetAuditEventsArgs": {
+          "type": "object",
+          "properties": {
+            "filter": {
+              "$ref": "#/components/schemas/FindAuditLoggingEventArgs"
+            }
+          }
+        },
+        "FindAuditLoggingEventArgs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/components/schemas/PartialAuditLoggingEvent"
+          }
+        },
+        "PartialAuditLoggingEvent": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "timestamp": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "level": {
+              "$ref": "#/components/schemas/LogLevel"
+            },
+            "correlationId": {
+              "type": "string"
+            },
+            "system": {
+              "$ref": "#/components/schemas/System"
+            },
+            "subSystemType": {
+              "$ref": "#/components/schemas/SubSystem"
+            },
+            "actionType": {
+              "$ref": "#/components/schemas/ActionType"
+            },
+            "actionSubType": {
+              "$ref": "#/components/schemas/ActionSubType"
+            },
+            "initiatorType": {
+              "$ref": "#/components/schemas/InitiatorType"
+            },
+            "systemCorrelationIdType": {
+              "$ref": "#/components/schemas/SystemCorrelationIdType"
+            },
+            "systemCorrelationId": {
+              "type": "string"
+            },
+            "systemAlias": {
+              "type": "string"
+            },
+            "partyCorrelationType": {
+              "$ref": "#/components/schemas/PartyCorrelationType"
+            },
+            "partyCorrelationId": {
+              "type": "string"
+            },
+            "partyAlias": {
+              "type": "string"
+            },
+            "description": {
+              "type": "string"
+            },
+            "data": {},
+            "diagnosticData": {}
+          }
+        },
+        "LogLevel": {
+          "type": "number",
+          "enum": [
+            0,
+            1,
+            2,
+            3
+          ]
+        },
+        "System": {
+          "type": "string",
+          "enum": [
+            "general",
+            "kms",
+            "identity",
+            "oid4vci",
+            "credentials",
+            "web3",
+            "profile",
+            "contact"
+          ]
+        },
+        "SubSystem": {
+          "type": "string",
+          "enum": [
+            "key",
+            "did_provider",
+            "did_resolver",
+            "oid4vp_op",
+            "oid4vci_client",
+            "siopv2_op",
+            "contact_manager",
+            "vc_issuer",
+            "vc_verifier",
+            "vc_persistence",
+            "transport",
+            "profile"
+          ]
+        },
+        "ActionType": {
+          "type": "string",
+          "enum": [
+            "create",
+            "read",
+            "update",
+            "delete",
+            "execute"
+          ]
+        },
+        "ActionSubType": {
+          "anyOf": [
+            {
+              "$ref": "#/components/schemas/DefaultActionSubType"
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "DefaultActionSubType": {
+          "type": "string",
+          "enum": [
+            "Key generation",
+            "Key import",
+            "Key persistence",
+            "Key removal",
+            "DID creation",
+            "DID resolution",
+            "DID service update",
+            "VC issue",
+            "VC verify"
+          ]
+        },
+        "InitiatorType": {
+          "type": "string",
+          "enum": [
+            "user",
+            "system",
+            "external"
+          ]
+        },
+        "SystemCorrelationIdType": {
+          "type": "string",
+          "enum": [
+            "did",
+            "email",
+            "hostname",
+            "phone",
+            "user"
+          ]
+        },
+        "PartyCorrelationType": {
+          "type": "string",
+          "enum": [
+            "did",
+            "email",
+            "hostname",
+            "phone"
+          ]
+        },
+        "AuditLoggingEvent": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "timestamp": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "level": {
+              "$ref": "#/components/schemas/LogLevel"
+            },
+            "correlationId": {
+              "type": "string"
+            },
+            "system": {
+              "$ref": "#/components/schemas/System"
+            },
+            "subSystemType": {
+              "$ref": "#/components/schemas/SubSystem"
+            },
+            "actionType": {
+              "$ref": "#/components/schemas/ActionType"
+            },
+            "actionSubType": {
+              "$ref": "#/components/schemas/ActionSubType"
+            },
+            "initiatorType": {
+              "$ref": "#/components/schemas/InitiatorType"
+            },
+            "systemCorrelationIdType": {
+              "$ref": "#/components/schemas/SystemCorrelationIdType"
+            },
+            "systemCorrelationId": {
+              "type": "string"
+            },
+            "systemAlias": {
+              "type": "string"
+            },
+            "partyCorrelationType": {
+              "$ref": "#/components/schemas/PartyCorrelationType"
+            },
+            "partyCorrelationId": {
+              "type": "string"
+            },
+            "partyAlias": {
+              "type": "string"
+            },
+            "description": {
+              "type": "string"
+            },
+            "data": {},
+            "diagnosticData": {}
+          },
+          "required": [
+            "id",
+            "timestamp",
+            "level",
+            "correlationId",
+            "system",
+            "subSystemType",
+            "actionType",
+            "actionSubType",
+            "initiatorType",
+            "description"
+          ]
+        },
+        "LogAuditEventArgs": {
+          "type": "object",
+          "properties": {
+            "event": {
+              "$ref": "#/components/schemas/NonPersistedAuditLoggingEvent"
+            }
+          },
+          "required": [
+            "event"
+          ]
+        },
+        "NonPersistedAuditLoggingEvent": {
+          "type": "object",
+          "properties": {
+            "system": {
+              "$ref": "#/components/schemas/System"
+            },
+            "subSystemType": {
+              "$ref": "#/components/schemas/SubSystem"
+            },
+            "actionType": {
+              "type": "object",
+              "properties": {}
+            },
+            "actionSubType": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "properties": {}
+                },
+                {
+                  "type": "string"
+                }
+              ]
+            },
+            "initiatorType": {
+              "type": "object",
+              "properties": {}
+            },
+            "systemCorrelationIdType": {
+              "type": "object",
+              "properties": {}
+            },
+            "systemCorrelationId": {
+              "type": "string"
+            },
+            "systemAlias": {
+              "type": "string"
+            },
+            "partyCorrelationType": {
+              "type": "object",
+              "properties": {}
+            },
+            "partyCorrelationId": {
+              "type": "string"
+            },
+            "partyAlias": {
+              "type": "string"
+            },
+            "description": {
+              "type": "string"
+            },
+            "data": {},
+            "diagnosticData": {},
+            "level": {
+              "type": "object",
+              "properties": {}
+            },
+            "correlationId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "actionSubType",
+            "actionType",
+            "description",
+            "initiatorType",
+            "subSystemType",
+            "system"
+          ]
+        }
+      },
+      "methods": {
+        "loggerGetAuditEvents": {
+          "description": "",
+          "arguments": {
+            "$ref": "#/components/schemas/GetAuditEventsArgs"
+          },
+          "returnType": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/AuditLoggingEvent"
+            }
+          }
+        },
+        "loggerLogAuditEvent": {
+          "description": "",
+          "arguments": {
+            "$ref": "#/components/schemas/LogAuditEventArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/AuditLoggingEvent"
+          }
+        }
+      }
+    }
+  }
+}

package/src/agent/EventLogger.ts

@@ -0,0 +1,66 @@
+import { IAgentPlugin } from '@veramo/core'
+import { AbstractEventLoggerStore } from '@sphereon/ssi-sdk.data-store'
+import { AuditLoggingEvent, LoggingEventType, LogLevel } from '@sphereon/ssi-sdk.core'
+import { v4 as uuidv4 } from 'uuid'
+import { schema } from '../index'
+import {
+  EventLoggerOptions,
+  GetAuditEventsArgs,
+  IEventLogger,
+  RequiredContext,
+  LogAuditEventArgs,
+  LoggingEvent
+} from '../types/IEventLogger'
+
+/**
+ * {@inheritDoc IEventLogger}
+ */
+
+export class EventLogger implements IAgentPlugin {
+  readonly schema = schema.IEventLogger
+  readonly eventTypes: Array<LoggingEventType> = []
+
+  readonly methods: IEventLogger = {
+    loggerGetAuditEvents: this.loggerGetAuditEvents.bind(this),
+    loggerLogAuditEvent: this.loggerLogAuditEvent.bind(this),
+  }
+
+  private readonly store: AbstractEventLoggerStore
+
+  constructor(options: EventLoggerOptions) {
+    const {store, eventTypes} = options
+    this.store = store
+    this.eventTypes = eventTypes
+  }
+
+  public async onEvent(event: LoggingEvent, context: RequiredContext): Promise<void> {
+    switch(event.type) {
+      case LoggingEventType.AUDIT:
+        await this.loggerLogAuditEvent({ event: event.data }, context)
+        break;
+      default:
+        return Promise.reject(Error('Event type not supported'))
+    }
+  }
+
+  private async loggerGetAuditEvents(args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>> {
+    const { filter } = args ?? {}
+
+    return this.store.getAuditEvents({ filter })
+  }
+
+  private async loggerLogAuditEvent(args: LogAuditEventArgs, context: RequiredContext): Promise<AuditLoggingEvent> {
+    const { event } = args
+
+    return this.store.storeAuditEvent({ event: {
+        ...event,
+        system: event.system,
+        subSystemType: event.subSystemType,
+        level: event.level ?? LogLevel.INFO,
+        correlationId: event.correlationId ?? uuidv4(),
+        timestamp: new Date()
+      }
+    })
+  }
+
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @public
+ */
+const schema = require('../plugin.schema.json')
+export { schema }
+export { EventLogger } from './agent/EventLogger'
+export * from './types/IEventLogger'

package/src/types/IEventLogger.ts

@@ -0,0 +1,39 @@
+import { IAgentContext, IPluginMethodMap } from '@veramo/core'
+import {
+  AuditLoggingEvent,
+  NonPersistedAuditLoggingEvent as NPAuditLoggingEvent,
+  LoggingEventType,
+  SubSystem,
+  System
+} from '@sphereon/ssi-sdk.core'
+import { AbstractEventLoggerStore, FindAuditLoggingEventArgs } from '@sphereon/ssi-sdk.data-store'
+
+export interface IEventLogger extends IPluginMethodMap {
+  loggerGetAuditEvents(args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>
+  loggerLogAuditEvent(args: LogAuditEventArgs, context: RequiredContext): Promise<AuditLoggingEvent>
+}
+
+export type EventLoggerOptions = {
+  store: AbstractEventLoggerStore
+  eventTypes: Array<LoggingEventType>
+}
+
+export type GetAuditEventsArgs = {
+  filter?: FindAuditLoggingEventArgs
+}
+
+export type LogAuditEventArgs = {
+  event: NonPersistedAuditLoggingEvent
+}
+
+export type NonPersistedAuditLoggingEvent = Omit<NPAuditLoggingEvent, 'system' | 'subSystemType'> & {
+  system: System
+  subSystemType: SubSystem
+}
+
+export type LoggingEvent = {
+  type: LoggingEventType,
+  data: NonPersistedAuditLoggingEvent
+}
+
+export type RequiredContext = IAgentContext<never>