cdk-ecr-deployment 2.5.6 → 2.5.21

package/node_modules/keyv/README.md

@@ -6,8 +6,8 @@
 
 > Simple key-value storage with support for multiple backends
 
-[![build](https://github.com/jaredwray/keyv/actions/workflows/build.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/build.yaml)
-[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/master/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
 [![npm](https://img.shields.io/npm/dm/keyv.svg)](https://www.npmjs.com/package/keyv)
 [![npm](https://img.shields.io/npm/v/keyv.svg)](https://www.npmjs.com/package/keyv)
 
@@ -44,6 +44,7 @@ npm install --save @keyv/mongo
 npm install --save @keyv/sqlite
 npm install --save @keyv/postgres
 npm install --save @keyv/mysql
+npm install --save @keyv/etcd
 ```
 
 Create a new Keyv instance, passing your connection string if applicable. Keyv will automatically load the correct storage adapter.
@@ -58,6 +59,7 @@ const keyv = new Keyv('mongodb://user:pass@localhost:27017/dbname');
 const keyv = new Keyv('sqlite://path/to/database.sqlite');
 const keyv = new Keyv('postgresql://user:pass@localhost:5432/dbname');
 const keyv = new Keyv('mysql://user:pass@localhost:3306/dbname');
+const keyv = new Keyv('etcd://localhost:2379');
 
 // Handle DB connection errors
 keyv.on('error', err => console.log('Connection Error', err));
@@ -100,7 +102,7 @@ const keyv = new Keyv({ serialize: JSON.stringify, deserialize: JSON.parse });
 
 ## Official Storage Adapters
 
-The official storage adapters are covered by [over 150 integration tests](https://github.com/jaredwray/keyv/actions/workflows/build.yaml) to guarantee consistent behaviour. They are lightweight, efficient wrappers over the DB clients making use of indexes and native TTLs where available.
+The official storage adapters are covered by [over 150 integration tests](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml) to guarantee consistent behaviour. They are lightweight, efficient wrappers over the DB clients making use of indexes and native TTLs where available.
 
 Database | Adapter | Native TTL
 ---|---|---
@@ -109,6 +111,8 @@ MongoDB | [@keyv/mongo](https://github.com/jaredwray/keyv/tree/master/packages/m
 SQLite | [@keyv/sqlite](https://github.com/jaredwray/keyv/tree/master/packages/sqlite) | No 
 PostgreSQL | [@keyv/postgres](https://github.com/jaredwray/keyv/tree/master/packages/postgres) | No 
 MySQL | [@keyv/mysql](https://github.com/jaredwray/keyv/tree/master/packages/mysql) | No 
+Etcd | [@keyv/etcd](https://github.com/jaredwray/keyv/tree/master/packages/etcd) | Yes
+Memcache | [@keyv/memcache](https://github.com/jaredwray/keyv/tree/master/packages/memcache) | Yes
 
 ## Third-party Storage Adapters
 
@@ -146,7 +150,6 @@ The following are third-party storage adapters compatible with Keyv:
 - [keyv-null](https://www.npmjs.com/package/keyv-null) - Null storage adapter for Keyv
 - [keyv-firestore ](https://github.com/goto-bus-stop/keyv-firestore) – Firebase Cloud Firestore adapter for Keyv
 - [keyv-mssql](https://github.com/pmorgan3/keyv-mssql) - Microsoft Sql Server adapter for Keyv
-- [keyv-memcache](https://github.com/jaredwray/keyv/tree/master/packages/memcache) - Memcache storage adapter for Keyv
 - [keyv-azuretable](https://github.com/howlowck/keyv-azuretable) - Azure Table Storage/API adapter for Keyv
 
 ## Add Cache Support to your Module
@@ -184,6 +187,42 @@ const awesomeModule = new AwesomeModule({ cache: 'redis://localhost' });
 const awesomeModule = new AwesomeModule({ cache: some3rdPartyStore });
 ```
 
+## Compression
+
+Keyv supports `gzip` and `brotli` compression. To enable compression, pass the `compress` option to the constructor.
+
+```js
+const KeyvGzip = require('@keyv/compress-gzip');
+const Keyv = require('keyv');
+
+const keyvGzip = new KeyvGzip();
+const keyv = new Keyv({ compression: KeyvGzip });
+```
+
+You can also pass a custom compression function to the `compression` option. Following the pattern of the official compression adapters.
+
+### Want to build your own? 
+
+Great! Keyv is designed to be easily extended. You can build your own compression adapter by following the pattern of the official compression adapters based on this interface:
+
+```typescript
+interface CompressionAdapter {
+	async compress(value: any, options?: any);
+	async decompress(value: any, options?: any);
+	async serialize(value: any);
+	async deserialize(value: any);
+}
+```
+
+In addition to the interface, you can test it with our compression test suite using @keyv/test-suite:
+
+```js
+const {keyvCompresstionTests} = require('@keyv/test-suite');
+const KeyvGzip = require('@keyv/compress-gzip');
+
+keyvCompresstionTests(test, new KeyvGzip());
+```
+
 ## API
 
 ### new Keyv([uri], [options])
@@ -221,6 +260,13 @@ Default: `undefined`
 
 Default TTL. Can be overridden by specififying a TTL on `.set()`.
 
+#### options.compression
+
+Type: `@keyv/compress-<compression_package_name>`<br>
+Default: `undefined`
+
+Compression package to use. See [Compression](#compression) for more details.
+
 #### options.serialize
 
 Type: `Function`<br>
@@ -286,6 +332,96 @@ Delete all entries in the current namespace.
 
 Returns a promise which is resolved when the entries have been cleared.
 
+#### .iterator()
+
+Iterate over all entries of the current namespace.
+
+Returns a iterable that can be iterated by for-of loops. For example:
+
+```js
+// please note that the "await" keyword should be used here
+for await (const [key, value] of this.keyv.iterator()) {
+  console.log(key, value);
+};
+```
+
+# How to Contribute
+
+In this section of the documentation we will cover:
+
+1) How to set up this repository locally
+2) How to get started with running commands
+3) How to contribute changes using Pull Requests
+
+## Dependencies
+
+This package requires the following dependencies to run:
+
+1) [Yarn V1](https://yarnpkg.com/getting-started/install)
+3) [Docker](https://docs.docker.com/get-docker/)
+
+## Setting up your workspace
+
+To contribute to this repository, start by setting up this project locally:
+
+1) Fork this repository into your Git account
+2) Clone the forked repository to your local directory using `git clone`
+3) Install any of the above missing dependencies
+
+## Launching the project
+
+Once the project is installed locally, you are ready to start up its services:
+
+1) Ensure that your Docker service is running.
+2) From the root directory of your project, run the `yarn` command in the command prompt to install yarn.
+3) Run the `yarn bootstrap` command to  install any necessary dependencies.
+4) Run `yarn test:services:start` to start up this project's Docker container. The container will launch all services within your workspace.
+
+## Available Commands
+
+Once the project is running, you can execute a variety of commands. The root workspace and each subpackage contain a `package.json` file with a  `scripts` field listing all the commands that can be executed from that directory. This project also supports native `yarn`, and `docker` commands.
+
+Here, we'll cover the primary commands that can be executed from the root directory. Unless otherwise noted, these commands can also be executed from a subpackage. If executed from a subpackage, they will only affect that subpackage, rather than the entire workspace.
+
+### `yarn`
+
+The `yarn` command installs yarn in the workspace.
+
+### `yarn bootstrap`
+
+The `yarn bootstrap` command installs all dependencies in the workspace.
+
+### `yarn test:services:start`
+
+The `yarn test:services:start` command starts up the project's Docker container, launching all services in the workspace. This command must be executed from the root directory.
+
+### `yarn test:services:stop`
+
+The `yarn test:services:stop` command brings down the project's Docker container, halting all services. This command must be executed from the root directory.
+
+### `yarn test`
+
+The `yarn test` command runs all tests in the workspace.
+
+### `yarn clean`
+
+The `yarn clean` command removes yarn and all dependencies installed by yarn. After executing this command, you must repeat the steps in *Setting up your workspace* to rebuild your workspace.
+
+## Contributing Changes
+
+Now that you've set up your workspace, you're ready to contribute changes to the `keyv` repository.
+
+1) Make any changes that you would like to contribute in your local workspace.
+2) After making these changes, ensure that the project's tests still pass by executing the `yarn test` command in the root directory.
+3) Commit your changes and push them to your forked repository.
+4) Navigate to the original `keyv` repository and go the *Pull Requests* tab.
+5) Click the *New pull request* button, and open a pull request for the branch in your repository that contains your changes.
+6) Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
+7) Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
+8) Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the `keyv` repository.
+
+If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the [Github documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
+
 ## License
 
-MIT © Jared Wray & Luke Childs
+MIT © Jared Wray

package/node_modules/keyv/package.json

@@ -1,52 +1,58 @@
 {
-  "name": "keyv",
-  "version": "4.0.5",
-  "description": "Simple key-value storage with support for multiple backends",
-  "main": "src/index.js",
-  "scripts": {
-    "test": "xo && nyc ava --serial",
-    "coverage": "nyc report --reporter=text-lcov > coverage.lcov",
-    "clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
-  },
-  "xo": {
-    "extends": "xo-lukechilds",
-    "rules": {
-      "unicorn/prefer-module": 0
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/jaredwray/keyv.git"
-  },
-  "keywords": [
-    "key",
-    "value",
-    "store",
-    "cache",
-    "ttl"
-  ],
-  "author": "Jared Wray <me@jaredwray.com> (http://jaredwray.com)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/jaredwray/keyv/issues"
-  },
-  "homepage": "https://github.com/jaredwray/keyv",
-  "dependencies": {
-    "json-buffer": "3.0.1"
-  },
-  "devDependencies": {
-    "@keyv/mongo": "*",
-    "@keyv/mysql": "*",
-    "@keyv/postgres": "*",
-    "@keyv/redis": "*",
-    "@keyv/sqlite": "*",
-    "@keyv/test-suite": "*",
-    "ava": "^3.15.0",
-    "eslint-config-xo-lukechilds": "^1.0.0",
-    "eslint-plugin-promise": "^5.1.1",
-    "nyc": "^15.1.0",
-    "this": "^1.0.2",
-    "timekeeper": "^2.0.0",
-    "xo": "^0.46.3"
-  }
+	"name": "keyv",
+	"version": "4.5.2",
+	"description": "Simple key-value storage with support for multiple backends",
+	"main": "src/index.js",
+	"scripts": {
+		"test": "xo && nyc ava --serial",
+		"coverage": "nyc report --reporter=text-lcov > coverage.lcov",
+		"clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
+	},
+	"xo": {
+		"rules": {
+			"unicorn/prefer-module": 0,
+			"unicorn/prefer-node-protocol": 0,
+			"@typescript-eslint/consistent-type-definitions": 0
+		}
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/jaredwray/keyv.git"
+	},
+	"keywords": [
+		"key",
+		"value",
+		"store",
+		"cache",
+		"ttl"
+	],
+	"author": "Jared Wray <me@jaredwray.com> (http://jaredwray.com)",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/jaredwray/keyv/issues"
+	},
+	"homepage": "https://github.com/jaredwray/keyv",
+	"dependencies": {
+		"json-buffer": "3.0.1"
+	},
+	"devDependencies": {
+		"@keyv/test-suite": "*",
+		"ava": "^5.0.1",
+		"eslint": "^8.26.0",
+		"eslint-plugin-promise": "^6.1.1",
+		"nyc": "^15.1.0",
+		"pify": "5.0.0",
+		"this": "^1.1.0",
+		"timekeeper": "^2.2.0",
+		"tsd": "^0.24.1",
+		"typescript": "^4.8.4",
+		"xo": "^0.52.4"
+	},
+	"tsd": {
+		"directory": "test"
+	},
+	"types": "./src/index.d.ts",
+	"files": [
+		"src"
+	]
 }

package/node_modules/keyv/src/index.d.ts

@@ -0,0 +1,116 @@
+import {EventEmitter} from 'events';
+
+type WithRequiredProperties<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+declare class Keyv<Value = any, Options extends Record<string, any> = Record<string, unknown>> extends EventEmitter {
+	/**
+     * `this.opts` is an object containing at least the properties listed
+     * below. However, `Keyv.Options` allows arbitrary properties as well.
+     * These properties can be specified as the second type parameter to `Keyv`.
+     */
+	opts: WithRequiredProperties<
+	Keyv.Options<Value>,
+	'deserialize' | 'namespace' | 'serialize' | 'store' | 'uri'
+	> &
+	Options;
+
+	/**
+     * @param opts The options object is also passed through to the storage adapter. Check your storage adapter docs for any extra options.
+     */
+	constructor(options?: Keyv.Options<Value> & Options);
+	/**
+     * @param uri The connection string URI.
+     *
+     * Merged into the options object as options.uri.
+     * @param opts The options object is also passed through to the storage adapter. Check your storage adapter docs for any extra options.
+     */
+	constructor(uri?: string, options?: Keyv.Options<Value> & Options);
+
+	/** Returns the value. */
+	get<Raw extends boolean = false>(key: string, options?: {raw?: Raw}):
+	Promise<(Raw extends false
+		? Value
+		: Keyv.DeserializedData<Value>) | undefined>;
+
+	/** Returns an array of values. Uses `store.getMany` if it exists, otherwise uses parallel calls to `store.get`. */
+	get<Raw extends boolean = false>(
+		key: string[],
+		options?: {raw?: Raw}
+	): Promise<
+	Array<(Raw extends false ? Value : Keyv.DeserializedData<Value>) | undefined>
+	>;
+
+	/**
+     * Set a value.
+     *
+     * By default keys are persistent. You can set an expiry TTL in milliseconds.
+     */
+	set(key: string, value: Value, ttl?: number): Promise<true>;
+	/**
+     * Deletes an entry.
+     *
+     * Returns `true` if the key existed, `false` if not.
+     */
+	delete(key: string | string[]): Promise<boolean>;
+	/** Delete all entries in the current namespace. */
+	clear(): Promise<void>;
+	/** Check if key exists in current namespace. */
+	has(key: string): Promise<boolean>;
+	/** Iterator */
+	iterator(namespace?: string): AsyncGenerator<any, void, any>;
+	/**
+	 * Closes the connection.
+	 *
+	 * Returns `undefined` when the connection closes.
+	 */
+	disconnect(): Promise<void>;
+}
+
+declare namespace Keyv {
+	interface Options<Value> {
+		[key: string]: any;
+
+		/** Namespace for the current instance. */
+		namespace?: string | undefined;
+		/** A custom serialization function. */
+		serialize?: ((data: DeserializedData<Value>) => string) | undefined;
+		/** A custom deserialization function. */
+		deserialize?: ((data: string) => DeserializedData<Value> | undefined) | undefined;
+		/** The connection string URI. */
+		uri?: string | undefined;
+		/** The storage adapter instance to be used by Keyv. */
+		store?: Store<string | undefined> | undefined;
+		/** Default TTL. Can be overridden by specififying a TTL on `.set()`. */
+		ttl?: number | undefined;
+		/** Specify an adapter to use. e.g `'redis'` or `'mongodb'`. */
+		adapter?: 'redis' | 'mongodb' | 'mongo' | 'sqlite' | 'postgresql' | 'postgres' | 'mysql' | undefined;
+		/** Enable compression option **/
+		compression?: CompressionAdapter | undefined;
+	}
+
+	interface CompressionAdapter {
+		compress(value: any, options?: any): Promise<any>;
+		decompress(value: any, options?: any): Promise<any>;
+		serialize(value: any): Promise<any>;
+		deserialize(value: any): Promise<any>;
+	}
+
+	interface DeserializedData<Value> {
+		value: Value; expires: number | undefined;
+	}
+
+	type StoredData<Value> = DeserializedData<Value> | string | undefined;
+
+	interface Store<Value> {
+		get(key: string): Value | Promise<Value | undefined> | undefined;
+		set(key: string, value: Value, ttl?: number): any;
+		delete(key: string): boolean | Promise<boolean>;
+		clear(): void | Promise<void>;
+		has?(key: string): boolean | Promise<boolean>;
+		getMany?(
+			keys: string[]
+		): Array<StoredData<Value>> | Promise<Array<StoredData<Value>>> | undefined;
+	}
+}
+
+export = Keyv;