feat(kv-store): add key-value store based on a typescript port of the…

… keyv package (#1150)

authors.md

@@ -34,3 +34,4 @@ Special thanks to the following extraordinary individuals, for their contributio
 - [Devraj Singh Rawat](https://github.com/devrajsinghrawat)
 - [Eseoghene Mentie](https://github.com/Eseoghene)
 - [Ilan Olkies](https://github.com/ilanolkies)
+- [Niels Klomp](https://github.com/nklomp)

packages/cli/src/dev.ts

@@ -31,7 +31,7 @@ function createSchema(generator: TJS.SchemaGenerator, symbol: string) {
     return { components: { schemas: {} } }
   }
 
-  let fixedSymbol = symbol.replace('Array<', '').replace('>', '')
+  let fixedSymbol = symbol.replace(/Array\<(.*)\>/gm, '$1')
 
   const schema = generator.createSchema(fixedSymbol)
 

packages/kv-store/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 2019 Consensys AG
+
+   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.

packages/kv-store/README.md

@@ -0,0 +1,140 @@
+# Veramo Key Value store
+
+A simple typed Key Value store with out of the box support for in memory/maps, sqlite and typeorm implementations for
+usage in browser, NodeJS and React-Native.
+It includes a tiered local/remote implementation that support all environments.
+
+# Usage in your application or module
+
+## setup
+
+Veramo provides 3 store adapters out of the box. The first is an in memory Map based store, the second is a TypeORM
+based store, meaning we support multiple databases. Lastly there is a tiered store, which allows you to use a local and
+remote store together.
+
+You should also be able to use store adapters from the [keyv](https://github.com/jaredwray/keyv) project. Be aware that
+Veramo uses an internal fork of that project, as we have several constraints not present in the upstream project. As a
+result the adapters are not guaranteed to work in your environment.
+See [Keyv project relationship](#keyv-project-relationship) for more information.
+
+### Map based in memory store
+
+This is the simplest implementation where a Map is being used to store the Keys and Values
+
+````typescript
+import { IKeyValueStore, IKeyValueStoreOptions, KeyValueStore } from '@veramo/key-value-store'
+
+const options: IKeyValueStoreOptions<MyValueType> = {
+  namespace: 'example',
+  store: new Map<string, MyValueType>()
+}
+const kvStore: IKeyValueStore<MyValueType> = new KeyValueStore({ options })
+````
+
+### TypeORM store
+
+This implementation uses TypeORM using a simple entity to store the namespace prefixed key, an expiration value and the
+value itself. It supports multiple database backends.
+
+````typescript
+import {
+  IKeyValueStore,
+  IKeyValueStoreOptions,
+  KeyValueStore,
+  KeyValueStoreEntity,
+  KeyValueTypeORMStoreAdapter
+} from '@veramo/key-value-store'
+import { DataSource } from 'typeorm'
+
+const dbConnection: DataSource = await new DataSource({
+  type: 'sqlite',
+  database: ':memory:',
+  logging: 'all',
+  migrationsRun: true,
+  synchronize: false,
+  entities: [KeyValueStoreEntity],
+}).initialize()
+
+const options: IKeyValueStoreOptions<MyValueType> = {
+  namespace: 'example',
+  store: new KeyValueTypeORMStoreAdapter({ dbConnection })
+}
+const kvStore: IKeyValueStore<MyValueType> = new KeyValueStore({ options })
+````
+
+### Tiered store
+
+The tiered store expects a local store and a remote store. Obviously it makes most sense to have a memory based local
+store and potentially more expensive/slower remote store
+
+````typescript
+import {
+  kvStoreMigrations,
+  IKeyValueStore,
+  IKeyValueStoreOptions,
+  KeyValueStore,
+  KeyValueStoreEntity,
+  KeyValueTieredStoreAdapter,
+  KeyValueTypeORMStoreAdapter
+} from '@veramo/key-value-store'
+import { DataSource } from 'typeorm'
+
+dbConnection = await new DataSource({
+  type: 'sqlite',
+  database: ':memory:',
+  logging: 'all',
+  migrationsRun: true,
+  synchronize: false,
+  migrations: [...kvStoreMigrations],
+  entities: [KeyValueStoreEntity],
+}).initialize()
+
+const local: Map<string, MyValueType> = new Map()
+const remote = new KeyValueTypeORMStoreAdapter({ dbConnection })
+
+const options: IKeyValueStoreOptions<MyValueType> = {
+  namespace: 'example',
+  store: new KeyValueTieredStoreAdapter({ local, remote })
+}
+const kvStore: IKeyValueStore<MyValueType> = new KeyValueStore<MyValueType>({ options })
+````
+
+## Usage
+
+After you have setup the Key Value Store as described above in your agent, it will be available in your agent.
+
+````typescript
+
+kvStore.set('hello', { example: world }) // Stores the value object by key untill deleted
+kvStore.set('expiring', { example: 'expiration' }, 1000) // Stores the value object by key for 1 second
+const value = await kvStore.get('hello') // { example: world }
+const values = await kvStore.getMany(['hello', 'expiring']) // [{ example: world }, {example: expiring}]
+
+if (await kvStore.has('hello')) {
+  await kvStore.delete('hello') // return a boolean for success. You can also call it on non existing keys, which will return false
+}
+
+await kvStore.clear() // Removes all keys/values from the store
+kvStore.disconnect() // disconnects the store from it backing adapter. You cannot reuse the store afterwards unlesss you initialize a new store.
+
+````
+
+# Keyv project relationship
+
+Please note that a large portion of the Veramo Key Value Store code is a port of
+the [keyv](https://github.com/jaredwray/keyv) project, adding support for Typescript and ESM, so it can be used Veramo
+
+The ported code should support the storage plugins available for the keyv project, although testing has been limited
+Veramo itself has a requirement to support NodeJS, Browser and React-Native environments. The port and the store
+adapters included in Veramo run in these environments.
+Please be aware that these requirements probably aren't true for any keyv storage plugins.
+
+One of the big changes compared to the upstream project is that this port does not have dynamic loading of adapters
+based on URIs. We believe that any Veramo Key Value store should use explicit defined adapters.
+
+The keyv port is part of the Veramo Key Value Store module code itself, as we do not want to make an official maintained port at this point.
+
+Veramo exposes its own API/interfaces for the Key Value store, meaning we could also support any other implementation in
+the future 
+
+We welcome any new storage modules

packages/kv-store/api-extractor.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "./api",
+    "reportTempFolder": "./api"
+  },
+
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "./api/<unscopedPackageName>.api.json"
+  },
+
+  "dtsRollup": {
+    "enabled": false
+  },
+  "mainEntryPointFilePath": "<projectFolder>/build/index.d.ts"
+}