mrs-toolbox-cli 5.2.1 → 5.2.2

package/npm-cache/_cacache/content-v2/sha512/{3c/7d/0abf4db333345b194c195b2a3e10ff54613991bf0741a0a4cb9c1057a8741bf232291df36077b47412c8a3eeacf000a7bf216c11a8d2f71f6fb82bf1c1f3 → c3/da/d2bee4f73d078f5902174544d3c2957edfdb418d010abdcd81d6467c8e94be6d6ce82f4adaf5b9db589d029bb989227a99dd71b10d9a1fca82f01e980481}

@@ -46405,7 +46405,7 @@
     "gamma": "1.0.0-gamma.9",
     "rc": "3.5.1-rc.0"
   },
-  "_rev": "88-d309f59aa5b72b11",
+  "_rev": "89-9a674655f899cfe2",
   "_id": "@aws-sdk/credential-provider-node",
   "readme": "# @aws-sdk/credential-provider-node\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-node/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-node)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-node.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-node)\n\n## AWS Credential Provider for Node.JS\n\nThis module provides a factory function, `defaultProvider`, that will attempt to\nsource AWS credentials from a Node.JS environment. It will attempt to find\ncredentials from the following sources (listed in order of precedence):\n\n- Environment variables exposed via `process.env`\n- SSO credentials from token cache\n- Web identity token credentials\n- Shared credentials and config ini files\n- The EC2/ECS Instance Metadata Service\n\nThe default credential provider will invoke one provider at a time and only\ncontinue to the next if no credentials have been located. For example, if the\nprocess finds values defined via the `AWS_ACCESS_KEY_ID` and\n`AWS_SECRET_ACCESS_KEY` environment variables, the files at `~/.aws/credentials`\nand `~/.aws/config` will not be read, nor will any messages be sent to the\nInstance Metadata Service.\n\nIf invalid configuration is encountered (such as a profile in\n`~/.aws/credentials` specifying as its `source_profile` the name of a profile\nthat does not exist), then the chained provider will be rejected with an error\nand will not invoke the next provider in the list.\n\n_IMPORTANT_: if you intend to acquire credentials using EKS \n[IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html), \nthen you must explicitly specify a value for `roleAssumerWithWebIdentity`. There is a\ndefault function available in `@aws-sdk/client-sts` package. An example of using\nthis:\n\n```js\nconst { getDefaultRoleAssumerWithWebIdentity } = require(\"@aws-sdk/client-sts\");\nconst { defaultProvider } = require(\"@aws-sdk/credential-provider-node\");\nconst { S3Client, GetObjectCommand } = require(\"@aws-sdk/client-s3\");\n\nconst provider = defaultProvider({\n  roleAssumerWithWebIdentity: getDefaultRoleAssumerWithWebIdentity({\n    // You must explicitly pass a region if you are not using us-east-1\n    region: \"eu-west-1\"\n  }),\n});\n\nconst client = new S3Client({ credentialDefaultProvider: provider });\n```\n\n_IMPORTANT_: We provide a wrapper of this provider in `@aws-sdk/credential-providers`\npackage to save you from importing `getDefaultRoleAssumerWithWebIdentity()` or\n`getDefaultRoleAssume()` from STS package. Similarly, you can do:\n\n```js\nconst { fromNodeProviderChain } = require(\"@aws-sdk/credential-providers\");\n\nconst credentials = fromNodeProviderChain();\n\nconst client = new S3Client({ credentials });\n```\n\n## Supported configuration\n\nYou may customize how credentials are resolved by providing an options hash to\nthe `defaultProvider` factory function. The following options are\nsupported:\n\n- `profile` - The configuration profile to use. If not specified, the provider\n  will use the value in the `AWS_PROFILE` environment variable or a default of\n  `default`.\n- `filepath` - The path to the shared credentials file. If not specified, the\n  provider will use the value in the `AWS_SHARED_CREDENTIALS_FILE` environment\n  variable or a default of `~/.aws/credentials`.\n- `configFilepath` - The path to the shared config file. If not specified, the\n  provider will use the value in the `AWS_CONFIG_FILE` environment variable or a\n  default of `~/.aws/config`.\n- `mfaCodeProvider` - A function that returns a a promise fulfilled with an\n  MFA token code for the provided MFA Serial code. If a profile requires an MFA\n  code and `mfaCodeProvider` is not a valid function, the credential provider\n  promise will be rejected.\n- `roleAssumer` - A function that assumes a role and returns a promise\n  fulfilled with credentials for the assumed role. If not specified, no role\n  will be assumed, and an error will be thrown.\n- `roleArn` - ARN to assume. If not specified, the provider will use the value\n  in the `AWS_ROLE_ARN` environment variable.\n- `webIdentityTokenFile` - File location of where the `OIDC` token is stored.\n  If not specified, the provider will use the value in the `AWS_WEB_IDENTITY_TOKEN_FILE`\n  environment variable.\n- `roleAssumerWithWebIdentity` - A function that assumes a role with web identity and\n  returns a promise fulfilled with credentials for the assumed role.\n- `timeout` - The connection timeout (in milliseconds) to apply to any remote\n  requests. If not specified, a default value of `1000` (one second) is used.\n- `maxRetries` - The maximum number of times any HTTP connections should be\n  retried. If not specified, a default value of `0` will be used.\n\n## Related packages:\n\n- [AWS Credential Provider for Node.JS - Environment Variables](../credential-provider-env)\n- [AWS Credential Provider for Node.JS - SSO](../credential-provider-sso)\n- [AWS Credential Provider for Node.JS - Web Identity](../credential-provider-web-identity)\n- [AWS Credential Provider for Node.JS - Shared Configuration Files](../credential-provider-ini)\n- [AWS Credential Provider for Node.JS - Instance and Container Metadata](../credential-provider-imds)\n- [AWS Shared Configuration File Loader](../shared-ini-file-loader)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{b3/42/94defd76627434cc54b8dfe213e95af86ca7be3c85ca63899ce84063222ecb97bdbd39bdeaff53de37ece8fba0ef5d47fd2a34328b5bf09f7ad4527e29d6 → c4/04/c3a91fe5510cff1bb1646a3885abc6913fa7c3bde5be6213f78383c399d7baf43de9021624fc40f94d69404870452e3fc59897276a2b6d1d1168a55327fd}

@@ -404,7 +404,7 @@
   "dist-tags": {
     "latest": "5.0.0"
   },
-  "_rev": "1781-6fe247f4afe5269b",
+  "_rev": "1783-7c725eb993533523",
   "_id": "is-fullwidth-code-point",
   "readme": "# is-fullwidth-code-point\n\n> Check if the character represented by a given [Unicode code point](https://en.wikipedia.org/wiki/Code_point) is [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms)\n\n## Install\n\n```sh\nnpm install is-fullwidth-code-point\n```\n\n## Usage\n\n```js\nimport isFullwidthCodePoint from 'is-fullwidth-code-point';\n\nisFullwidthCodePoint('谢'.codePointAt(0));\n//=> true\n\nisFullwidthCodePoint('a'.codePointAt(0));\n//=> false\n```\n\n## API\n\n### isFullwidthCodePoint(codePoint)\n\n#### codePoint\n\nType: `number`\n\nThe [code point](https://en.wikipedia.org/wiki/Code_point) of a character.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{55/83/23017f3f450ae7fffe0ff5672f109e9d0f17498f1d303e3abe09e2c7f8d1f063162f904fc4b9dc6ad568a2e0bc317c6d6676b7692a6032a8ea47b33b01a1 → c7/ab/ee14f4368087d5f915c811313fafb825f5cfa53b10df2471dddeaddeeae285f5e1c681af23fe629868655030ee569e7b8e184b941d34d86085789fe5609a}

@@ -5782,7 +5782,7 @@
   "dist-tags": {
     "latest": "3.374.0"
   },
-  "_rev": "81-77447f7d29f453f5",
+  "_rev": "82-8bd6ef75e9a87146",
   "_id": "@aws-sdk/util-middleware",
   "readme": "# @aws-sdk/util-middleware\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-middleware/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-middleware)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-middleware.svg)](https://www.npmjs.com/package/@aws-sdk/util-middleware)\n\n> An internal package\n\nThis package provides shared utilities for middleware.\n\n## Usage\n\nYou probably shouldn't, at least directly.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{3f/42/0ff5c7c4ee5e0692269c438ea639a4d79f0e7e3ed9be0d1bd419645af968805a84dd18b201bd9b5f698ec46d5cf564d351409723eedba172ed2f03593198 → c7/cd/64e8bed4418bd19a24d77551997af79c3de4b4a77b2446f04f703b89dec36ee706d9538961a2ceb51ae3b38daf3dca480490b788cd6abcdcd86790dc3082}

@@ -21550,7 +21550,7 @@
     "gamma": "1.0.0-gamma.9",
     "rc": "3.5.1-rc.0"
   },
-  "_rev": "85-693b715c8fc3173c",
+  "_rev": "86-78a6e6275d7b5686",
   "_id": "@aws-sdk/credential-provider-process",
   "readme": "# @aws-sdk/credential-provider-process\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-process/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-process)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-process.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-process)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly. Please use [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers)\ninstead.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{d9/9b/a48a3676abb72b43f064d79ea65a9e42120c705af8639825c25d11916577636a0dc609f24d54d924567e1c8a63da2680e4322f24c5a4cc3eaf63ba4a098e → c9/2c/57b45c13ce2906ab58215d754783ed3bbebd629b8eee822394afaa8cf07364d82ad5168796dfccc7ee634300dd7161bf8e43566320d68935a4fecf4138ff}

@@ -758,7 +758,7 @@
   "dist-tags": {
     "latest": "5.2.1"
   },
-  "_rev": "1656-efa46513c0ee017b",
+  "_rev": "1659-7ace226ba5eea5a9",
   "_id": "safe-buffer",
   "readme": "# safe-buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]\n\n[travis-image]: https://img.shields.io/travis/feross/safe-buffer/master.svg\n[travis-url]: https://travis-ci.org/feross/safe-buffer\n[npm-image]: https://img.shields.io/npm/v/safe-buffer.svg\n[npm-url]: https://npmjs.org/package/safe-buffer\n[downloads-image]: https://img.shields.io/npm/dm/safe-buffer.svg\n[downloads-url]: https://npmjs.org/package/safe-buffer\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n\n#### Safer Node.js Buffer API\n\n**Use the new Node.js Buffer APIs (`Buffer.from`, `Buffer.alloc`,\n`Buffer.allocUnsafe`, `Buffer.allocUnsafeSlow`) in all versions of Node.js.**\n\n**Uses the built-in implementation when available.**\n\n## install\n\n```\nnpm install safe-buffer\n```\n\n## usage\n\nThe goal of this package is to provide a safe replacement for the node.js `Buffer`.\n\nIt's a drop-in replacement for `Buffer`. You can use it by adding one `require` line to\nthe top of your node.js modules:\n\n```js\nvar Buffer = require('safe-buffer').Buffer\n\n// Existing buffer code will continue to work without issues:\n\nnew Buffer('hey', 'utf8')\nnew Buffer([1, 2, 3], 'utf8')\nnew Buffer(obj)\nnew Buffer(16) // create an uninitialized buffer (potentially unsafe)\n\n// But you can use these new explicit APIs to make clear what you want:\n\nBuffer.from('hey', 'utf8') // convert from many types to a Buffer\nBuffer.alloc(16) // create a zero-filled buffer (safe)\nBuffer.allocUnsafe(16) // create an uninitialized buffer (potentially unsafe)\n```\n\n## api\n\n### Class Method: Buffer.from(array)\n<!-- YAML\nadded: v3.0.0\n-->\n\n* `array` {Array}\n\nAllocates a new `Buffer` using an `array` of octets.\n\n```js\nconst buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n```\n\nA `TypeError` will be thrown if `array` is not an `Array`.\n\n### Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or\n  a `new ArrayBuffer()`\n* `byteOffset` {Number} Default: `0`\n* `length` {Number} Default: `arrayBuffer.length - byteOffset`\n\nWhen passed a reference to the `.buffer` property of a `TypedArray` instance,\nthe newly created `Buffer` will share the same allocated memory as the\nTypedArray.\n\n```js\nconst arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = Buffer.from(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n```\n\nThe optional `byteOffset` and `length` arguments specify a memory range within\nthe `arrayBuffer` that will be shared by the `Buffer`.\n\n```js\nconst ab = new ArrayBuffer(10);\nconst buf = Buffer.from(ab, 0, 2);\nconsole.log(buf.length);\n  // Prints: 2\n```\n\nA `TypeError` will be thrown if `arrayBuffer` is not an `ArrayBuffer`.\n\n### Class Method: Buffer.from(buffer)\n<!-- YAML\nadded: v3.0.0\n-->\n\n* `buffer` {Buffer}\n\nCopies the passed `buffer` data onto a new `Buffer` instance.\n\n```js\nconst buf1 = Buffer.from('buffer');\nconst buf2 = Buffer.from(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n```\n\nA `TypeError` will be thrown if `buffer` is not a `Buffer`.\n\n### Class Method: Buffer.from(str[, encoding])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `str` {String} String to encode.\n* `encoding` {String} Encoding to use, Default: `'utf8'`\n\nCreates a new `Buffer` containing the given JavaScript string `str`. If\nprovided, the `encoding` parameter identifies the character encoding.\nIf not provided, `encoding` defaults to `'utf8'`.\n\n```js\nconst buf1 = Buffer.from('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n```\n\nA `TypeError` will be thrown if `str` is not a string.\n\n### Class Method: Buffer.alloc(size[, fill[, encoding]])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n* `fill` {Value} Default: `undefined`\n* `encoding` {String} Default: `utf8`\n\nAllocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the\n`Buffer` will be *zero-filled*.\n\n```js\nconst buf = Buffer.alloc(5);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n```\n\nThe `size` must be less than or equal to the value of\n`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is\n`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will\nbe created if a `size` less than or equal to 0 is specified.\n\nIf `fill` is specified, the allocated `Buffer` will be initialized by calling\n`buf.fill(fill)`. See [`buf.fill()`][] for more information.\n\n```js\nconst buf = Buffer.alloc(5, 'a');\nconsole.log(buf);\n  // <Buffer 61 61 61 61 61>\n```\n\nIf both `fill` and `encoding` are specified, the allocated `Buffer` will be\ninitialized by calling `buf.fill(fill, encoding)`. For example:\n\n```js\nconst buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');\nconsole.log(buf);\n  // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>\n```\n\nCalling `Buffer.alloc(size)` can be significantly slower than the alternative\n`Buffer.allocUnsafe(size)` but ensures that the newly created `Buffer` instance\ncontents will *never contain sensitive data*.\n\nA `TypeError` will be thrown if `size` is not a number.\n\n### Class Method: Buffer.allocUnsafe(size)\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n\nAllocates a new *non-zero-filled* `Buffer` of `size` bytes.  The `size` must\nbe less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit\narchitectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is\nthrown. A zero-length Buffer will be created if a `size` less than or equal to\n0 is specified.\n\nThe underlying memory for `Buffer` instances created in this way is *not\ninitialized*. The contents of the newly created `Buffer` are unknown and\n*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such\n`Buffer` instances to zeroes.\n\n```js\nconst buf = Buffer.allocUnsafe(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n```\n\nA `TypeError` will be thrown if `size` is not a number.\n\nNote that the `Buffer` module pre-allocates an internal `Buffer` instance of\nsize `Buffer.poolSize` that is used as a pool for the fast allocation of new\n`Buffer` instances created using `Buffer.allocUnsafe(size)` (and the deprecated\n`new Buffer(size)` constructor) only when `size` is less than or equal to\n`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). The default\nvalue of `Buffer.poolSize` is `8192` but can be modified.\n\nUse of this pre-allocated internal memory pool is a key difference between\ncalling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.\nSpecifically, `Buffer.alloc(size, fill)` will *never* use the internal Buffer\npool, while `Buffer.allocUnsafe(size).fill(fill)` *will* use the internal\nBuffer pool if `size` is less than or equal to half `Buffer.poolSize`. The\ndifference is subtle but can be important when an application requires the\nadditional performance that `Buffer.allocUnsafe(size)` provides.\n\n### Class Method: Buffer.allocUnsafeSlow(size)\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n\nAllocates a new *non-zero-filled* and non-pooled `Buffer` of `size` bytes.  The\n`size` must be less than or equal to the value of\n`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is\n`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will\nbe created if a `size` less than or equal to 0 is specified.\n\nThe underlying memory for `Buffer` instances created in this way is *not\ninitialized*. The contents of the newly created `Buffer` are unknown and\n*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such\n`Buffer` instances to zeroes.\n\nWhen using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,\nallocations under 4KB are, by default, sliced from a single pre-allocated\n`Buffer`. This allows applications to avoid the garbage collection overhead of\ncreating many individually allocated Buffers. This approach improves both\nperformance and memory usage by eliminating the need to track and cleanup as\nmany `Persistent` objects.\n\nHowever, in the case where a developer may need to retain a small chunk of\nmemory from a pool for an indeterminate amount of time, it may be appropriate\nto create an un-pooled Buffer instance using `Buffer.allocUnsafeSlow()` then\ncopy out the relevant bits.\n\n```js\n// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n  const data = socket.read();\n  // allocate for retained data\n  const sb = Buffer.allocUnsafeSlow(10);\n  // copy the data into the new allocation\n  data.copy(sb, 0, 0, 10);\n  store.push(sb);\n});\n```\n\nUse of `Buffer.allocUnsafeSlow()` should be used only as a last resort *after*\na developer has observed undue memory retention in their applications.\n\nA `TypeError` will be thrown if `size` is not a number.\n\n### All the Rest\n\nThe rest of the `Buffer` API is exactly the same as in node.js.\n[See the docs](https://nodejs.org/api/buffer.html).\n\n\n## Related links\n\n- [Node.js issue: Buffer(number) is unsafe](https://github.com/nodejs/node/issues/4660)\n- [Node.js Enhancement Proposal: Buffer.from/Buffer.alloc/Buffer.zalloc/Buffer() soft-deprecate](https://github.com/nodejs/node-eps/pull/4)\n\n## Why is `Buffer` unsafe?\n\nToday, the node.js `Buffer` constructor is overloaded to handle many different argument\ntypes like `String`, `Array`, `Object`, `TypedArrayView` (`Uint8Array`, etc.),\n`ArrayBuffer`, and also `Number`.\n\nThe API is optimized for convenience: you can throw any type at it, and it will try to do\nwhat you want.\n\nBecause the Buffer constructor is so powerful, you often see code like this:\n\n```js\n// Convert UTF-8 strings to hex\nfunction toHex (str) {\n  return new Buffer(str).toString('hex')\n}\n```\n\n***But what happens if `toHex` is called with a `Number` argument?***\n\n### Remote Memory Disclosure\n\nIf an attacker can make your program call the `Buffer` constructor with a `Number`\nargument, then they can make it allocate uninitialized memory from the node.js process.\nThis could potentially disclose TLS private keys, user data, or database passwords.\n\nWhen the `Buffer` constructor is passed a `Number` argument, it returns an\n**UNINITIALIZED** block of memory of the specified `size`. When you create a `Buffer` like\nthis, you **MUST** overwrite the contents before returning it to the user.\n\nFrom the [node.js docs](https://nodejs.org/api/buffer.html#buffer_new_buffer_size):\n\n> `new Buffer(size)`\n>\n> - `size` Number\n>\n> The underlying memory for `Buffer` instances created in this way is not initialized.\n> **The contents of a newly created `Buffer` are unknown and could contain sensitive\n> data.** Use `buf.fill(0)` to initialize a Buffer to zeroes.\n\n(Emphasis our own.)\n\nWhenever the programmer intended to create an uninitialized `Buffer` you often see code\nlike this:\n\n```js\nvar buf = new Buffer(16)\n\n// Immediately overwrite the uninitialized buffer with data from another buffer\nfor (var i = 0; i < buf.length; i++) {\n  buf[i] = otherBuf[i]\n}\n```\n\n\n### Would this ever be a problem in real code?\n\nYes. It's surprisingly common to forget to check the type of your variables in a\ndynamically-typed language like JavaScript.\n\nUsually the consequences of assuming the wrong type is that your program crashes with an\nuncaught exception. But the failure mode for forgetting to check the type of arguments to\nthe `Buffer` constructor is more catastrophic.\n\nHere's an example of a vulnerable service that takes a JSON payload and converts it to\nhex:\n\n```js\n// Take a JSON payload {str: \"some string\"} and convert it to hex\nvar server = http.createServer(function (req, res) {\n  var data = ''\n  req.setEncoding('utf8')\n  req.on('data', function (chunk) {\n    data += chunk\n  })\n  req.on('end', function () {\n    var body = JSON.parse(data)\n    res.end(new Buffer(body.str).toString('hex'))\n  })\n})\n\nserver.listen(8080)\n```\n\nIn this example, an http client just has to send:\n\n```json\n{\n  \"str\": 1000\n}\n```\n\nand it will get back 1,000 bytes of uninitialized memory from the server.\n\nThis is a very serious bug. It's similar in severity to the\n[the Heartbleed bug](http://heartbleed.com/) that allowed disclosure of OpenSSL process\nmemory by remote attackers.\n\n\n### Which real-world packages were vulnerable?\n\n#### [`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht)\n\n[Mathias Buus](https://github.com/mafintosh) and I\n([Feross Aboukhadijeh](http://feross.org/)) found this issue in one of our own packages,\n[`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht). The bug would allow\nanyone on the internet to send a series of messages to a user of `bittorrent-dht` and get\nthem to reveal 20 bytes at a time of uninitialized memory from the node.js process.\n\nHere's\n[the commit](https://github.com/feross/bittorrent-dht/commit/6c7da04025d5633699800a99ec3fbadf70ad35b8)\nthat fixed it. We released a new fixed version, created a\n[Node Security Project disclosure](https://nodesecurity.io/advisories/68), and deprecated all\nvulnerable versions on npm so users will get a warning to upgrade to a newer version.\n\n#### [`ws`](https://www.npmjs.com/package/ws)\n\nThat got us wondering if there were other vulnerable packages. Sure enough, within a short\nperiod of time, we found the same issue in [`ws`](https://www.npmjs.com/package/ws), the\nmost popular WebSocket implementation in node.js.\n\nIf certain APIs were called with `Number` parameters instead of `String` or `Buffer` as\nexpected, then uninitialized server memory would be disclosed to the remote peer.\n\nThese were the vulnerable methods:\n\n```js\nsocket.send(number)\nsocket.ping(number)\nsocket.pong(number)\n```\n\nHere's a vulnerable socket server with some echo functionality:\n\n```js\nserver.on('connection', function (socket) {\n  socket.on('message', function (message) {\n    message = JSON.parse(message)\n    if (message.type === 'echo') {\n      socket.send(message.data) // send back the user's message\n    }\n  })\n})\n```\n\n`socket.send(number)` called on the server, will disclose server memory.\n\nHere's [the release](https://github.com/websockets/ws/releases/tag/1.0.1) where the issue\nwas fixed, with a more detailed explanation. Props to\n[Arnout Kazemier](https://github.com/3rd-Eden) for the quick fix. Here's the\n[Node Security Project disclosure](https://nodesecurity.io/advisories/67).\n\n\n### What's the solution?\n\nIt's important that node.js offers a fast way to get memory otherwise performance-critical\napplications would needlessly get a lot slower.\n\nBut we need a better way to *signal our intent* as programmers. **When we want\nuninitialized memory, we should request it explicitly.**\n\nSensitive functionality should not be packed into a developer-friendly API that loosely\naccepts many different types. This type of API encourages the lazy practice of passing\nvariables in without checking the type very carefully.\n\n#### A new API: `Buffer.allocUnsafe(number)`\n\nThe functionality of creating buffers with uninitialized memory should be part of another\nAPI. We propose `Buffer.allocUnsafe(number)`. This way, it's not part of an API that\nfrequently gets user input of all sorts of different types passed into it.\n\n```js\nvar buf = Buffer.allocUnsafe(16) // careful, uninitialized memory!\n\n// Immediately overwrite the uninitialized buffer with data from another buffer\nfor (var i = 0; i < buf.length; i++) {\n  buf[i] = otherBuf[i]\n}\n```\n\n\n### How do we fix node.js core?\n\nWe sent [a PR to node.js core](https://github.com/nodejs/node/pull/4514) (merged as\n`semver-major`) which defends against one case:\n\n```js\nvar str = 16\nnew Buffer(str, 'utf8')\n```\n\nIn this situation, it's implied that the programmer intended the first argument to be a\nstring, since they passed an encoding as a second argument. Today, node.js will allocate\nuninitialized memory in the case of `new Buffer(number, encoding)`, which is probably not\nwhat the programmer intended.\n\nBut this is only a partial solution, since if the programmer does `new Buffer(variable)`\n(without an `encoding` parameter) there's no way to know what they intended. If `variable`\nis sometimes a number, then uninitialized memory will sometimes be returned.\n\n### What's the real long-term fix?\n\nWe could deprecate and remove `new Buffer(number)` and use `Buffer.allocUnsafe(number)` when\nwe need uninitialized memory. But that would break 1000s of packages.\n\n~~We believe the best solution is to:~~\n\n~~1. Change `new Buffer(number)` to return safe, zeroed-out memory~~\n\n~~2. Create a new API for creating uninitialized Buffers. We propose: `Buffer.allocUnsafe(number)`~~\n\n#### Update\n\nWe now support adding three new APIs:\n\n- `Buffer.from(value)` - convert from any type to a buffer\n- `Buffer.alloc(size)` - create a zero-filled buffer\n- `Buffer.allocUnsafe(size)` - create an uninitialized buffer with given size\n\nThis solves the core problem that affected `ws` and `bittorrent-dht` which is\n`Buffer(variable)` getting tricked into taking a number argument.\n\nThis way, existing code continues working and the impact on the npm ecosystem will be\nminimal. Over time, npm maintainers can migrate performance-critical code to use\n`Buffer.allocUnsafe(number)` instead of `new Buffer(number)`.\n\n\n### Conclusion\n\nWe think there's a serious design issue with the `Buffer` API as it exists today. It\npromotes insecure software by putting high-risk functionality into a convenient API\nwith friendly \"developer ergonomics\".\n\nThis wasn't merely a theoretical exercise because we found the issue in some of the\nmost popular npm packages.\n\nFortunately, there's an easy fix that can be applied today. Use `safe-buffer` in place of\n`buffer`.\n\n```js\nvar Buffer = require('safe-buffer').Buffer\n```\n\nEventually, we hope that node.js core can switch to this new, safer behavior. We believe\nthe impact on the ecosystem would be minimal since it's not a breaking change.\nWell-maintained, popular packages would be updated to use `Buffer.alloc` quickly, while\nolder, insecure packages would magically become safe from this attack vector.\n\n\n## links\n\n- [Node.js PR: buffer: throw if both length and enc are passed](https://github.com/nodejs/node/pull/4514)\n- [Node Security Project disclosure for `ws`](https://nodesecurity.io/advisories/67)\n- [Node Security Project disclosure for`bittorrent-dht`](https://nodesecurity.io/advisories/68)\n\n\n## credit\n\nThe original issues in `bittorrent-dht`\n([disclosure](https://nodesecurity.io/advisories/68)) and\n`ws` ([disclosure](https://nodesecurity.io/advisories/67)) were discovered by\n[Mathias Buus](https://github.com/mafintosh) and\n[Feross Aboukhadijeh](http://feross.org/).\n\nThanks to [Adam Baldwin](https://github.com/evilpacket) for helping disclose these issues\nand for his work running the [Node Security Project](https://nodesecurity.io/).\n\nThanks to [John Hiesey](https://github.com/jhiesey) for proofreading this README and\nauditing the code.\n\n\n## license\n\nMIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{74/f9/cbd3b65485b0128b0b980c2bf5ffa67300ef868c3ae41ebf9fb3293f55e9646c6a66ff81d36182e2c66ebfe2e63e104808ad0d2fa5397bd6bd72d9c100c3 → cb/0e/51187c18adafc54c899f7fc91e9ad3e0be7318d011087bb2c99bd5563c71883ac4b4b61b8c6fb40f43120a944b1d35c5ac608db11abe7c5bb88206c4e714}

@@ -1757,7 +1757,7 @@
     "latest": "7.1.0",
     "version6": "6.0.1"
   },
-  "_rev": "1727-b743dca4e399140c",
+  "_rev": "1729-23a996106539b560",
   "_id": "strip-ansi",
   "readme": "# strip-ansi\n\n> Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string\n\n## Install\n\n```\n$ npm install strip-ansi\n```\n\n## Usage\n\n```js\nimport stripAnsi from 'strip-ansi';\n\nstripAnsi('\\u001B[4mUnicorn\\u001B[0m');\n//=> 'Unicorn'\n\nstripAnsi('\\u001B]8;;https://github.com\\u0007Click\\u001B]8;;\\u0007');\n//=> 'Click'\n```\n\n## strip-ansi for enterprise\n\nAvailable as part of the Tidelift Subscription.\n\nThe maintainers of strip-ansi and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-strip-ansi?utm_source=npm-strip-ansi&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)\n\n## Related\n\n- [strip-ansi-cli](https://github.com/chalk/strip-ansi-cli) - CLI for this module\n- [strip-ansi-stream](https://github.com/chalk/strip-ansi-stream) - Streaming version of this module\n- [has-ansi](https://github.com/chalk/has-ansi) - Check if a string has ANSI escape codes\n- [ansi-regex](https://github.com/chalk/ansi-regex) - Regular expression for matching ANSI escape codes\n- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right\n\n## Maintainers\n\n- [Sindre Sorhus](https://github.com/sindresorhus)\n- [Josh Junon](https://github.com/qix-)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{16/6b/6dea72f0f79c5dc4c69b33a7c5d59ab4bfb8949c69eb3f5cd2df86d1e7c5bfbbba190f39b8b6fc1ff04fcd075e38f7aafd7ca6652db4a76aa8791a55cb7e → cc/09/f8067a30d5dd3c69cd8c601407e744eaf92255e8f1d864144480c50a44cd1477f4f0c406ae8960e107e7dd55501d9c70d5e51fe1626212669d0ad4139ed9}

@@ -165,7 +165,7 @@
   "dist-tags": {
     "latest": "1.0.2"
   },
-  "_rev": "1061-02241d4f3a392223",
+  "_rev": "1063-0d4692bb8377c7cf",
   "_id": "util-deprecate",
   "readme": "util-deprecate\n==============\n### The Node.js `util.deprecate()` function with browser support\n\nIn Node.js, this module simply re-exports the `util.deprecate()` function.\n\nIn the web browser (i.e. via browserify), a browser-specific implementation\nof the `util.deprecate()` function is used.\n\n\n## API\n\nA `deprecate()` function is the only thing exposed by this module.\n\n``` javascript\n// setup:\nexports.foo = deprecate(foo, 'foo() is deprecated, use bar() instead');\n\n\n// users see:\nfoo();\n// foo() is deprecated, use bar() instead\nfoo();\nfoo();\n```\n\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{a0/f0/6f6e77027e7c72b981f23e2f4e5ea3af2982dc2dcbb9ed9d9d4ff3cdfe463fc6e22968b617436a2ba1751640f74451c729b68da1e23603606bee150d492e → ce/99/ea2caf4c19eaee9fb9c04e9b4083ab9ca8063c1f1b4a05f1f16544fc45758265731c7a6b84f8caf799523304c7d44f085a82da587b381137a6a98001c8fc}

@@ -12727,7 +12727,7 @@
     "gamma": "1.0.0-gamma.8",
     "rc": "1.0.0-rc.10"
   },
-  "_rev": "67-68ece71ec4e7916d",
+  "_rev": "68-5807e3e9bcc98431",
   "_id": "@aws-sdk/hash-stream-node",
   "readme": "# @aws-sdk/hash-stream-node\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-stream-node/latest.svg)](https://www.npmjs.com/package/@aws-sdk/hash-stream-node)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-stream-node.svg)](https://www.npmjs.com/package/@aws-sdk/hash-stream-node)\n\nA utility for calculating the hash of Node.JS readable streams.\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{00/69/0ba94e234901cbf686bc5318791a220e0d4fc42711bda72024b964ea3a84810dae5bbfe9087844fde8e580142d742106380868c2397fa2b6c2cb1a3894f6 → cf/45/886c06ef2fd2d204dbb35c77f8bfecface1e7c0827a7faeb01cfd801ed44ee830524ee950a36f3153fc4b0d25d533b45caa6cbce01e852e6860887571877}

@@ -816,7 +816,7 @@
   "dist-tags": {
     "latest": "3.374.0"
   },
-  "_rev": "75-ade414b0738c1b76",
+  "_rev": "76-24a2149d617d0b7e",
   "_id": "@aws-sdk/util-utf8",
   "readme": "# @aws-sdk/util-utf8\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-utf8/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-utf8)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-utf8.svg)](https://www.npmjs.com/package/@aws-sdk/util-utf8)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{9d/5d/6cc537109a3d87e75ff7d3e3a20b260f549b78cb77c2ddc52a5a2d427d2793f04d754fa9f4c2beba6625db3ba97767f0cc0cfa55969c6a1dfba90e5e7715 → d0/d7/ad23411f1b46bdd6918cf07fa8ff7c67180baebc1ffc1a00ed48ecb7196b5779281a1fa257220776d2e144768669f12ce9af5b88a2b8b5f68ca65b36207a}

@@ -16537,7 +16537,7 @@
     "gamma": "1.0.0-gamma.8",
     "rc": "1.0.0-rc.10"
   },
-  "_rev": "73-f55ef4caa4cb5341",
+  "_rev": "74-54f96b85baeba342",
   "_id": "@aws-sdk/middleware-ssec",
   "readme": "# @aws-sdk/middleware-ssec\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-ssec/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-ssec)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-ssec.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-ssec)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{31/bf/40c6835822c68327fa2c190e8dc46d15851ce90adeeb5d2fe3863538f701aeedb85a0037e7a7729b357993c134c3401d3235b11a15c6a831c37d736883a9 → d1/0d/5381007e29a5ab818ce3e8f29ae1031b372110469ee0f4f6b9200fcf1abc29625dedc24ef396a61a1494be7ecec45c42900871036f1a25efcd2c124a9654}

@@ -16694,7 +16694,7 @@
     "gamma": "1.0.0-gamma.8",
     "rc": "1.0.0-rc.10"
   },
-  "_rev": "73-eaba9542d07edfc2",
+  "_rev": "74-95a6f30206e897e6",
   "_id": "@aws-sdk/middleware-location-constraint",
   "readme": "# @aws-sdk/middleware-location-constraint\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-location-constraint/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-location-constraint)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-location-constraint.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-location-constraint)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{d9/ad/acaafcdc6410626d8218dcabb1df450ab8fb68cefe11eb86fe8ec6a006b57bb5019e6467667d983c10ebcef4cfa65cdff19a8e7ee8893e2857b856d809bd → d1/76/b1a86085107429c65fc0c78114d3c7d26bb2173c77dd93a7d908a47e74fe240399c75f562549f2fe82dbb06b9e361c48a66d0de9548aa0987083b2f01e1e}

@@ -5235,7 +5235,7 @@
     "gamma": "1.0.0-gamma.7",
     "rc": "1.0.0-rc.8"
   },
-  "_rev": "75-e7a5f582aae92167",
+  "_rev": "76-af0b2e4934fd9171",
   "_id": "@aws-sdk/util-hex-encoding",
   "readme": "# @aws-sdk/util-hex-encoding\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-hex-encoding/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-hex-encoding.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{cf/37/f0d8dcb3ed900f2f4d9de1b3b475bc87642f8cdf2029d4113d5fba7d3fac5791e96412a832bb43bc3eb52f2972ab5d2ed39077376aec0ce424f1927101b0 → d2/5f/905e06e60d0dd675ad5254df99cb1c70b0f24cfcdf4e5bd5ce520e6e17b90f223981ab85e1f34faf97464c16502e79fbdae38088cc81f3969488e70877fc}

@@ -9286,7 +9286,7 @@
     "next": "3.3.5",
     "legacy-v4": "4.2.8"
   },
-  "_rev": "1047-cc898ab48e92a137",
+  "_rev": "1049-049ff93096cecd75",
   "_id": "minipass",
   "readme": "# minipass\n\nA _very_ minimal implementation of a [PassThrough\nstream](https://nodejs.org/api/stream.html#stream_class_stream_passthrough)\n\n[It's very\nfast](https://docs.google.com/spreadsheets/d/1K_HR5oh3r80b8WVMWCPPjfuWXUgfkmhlX7FGI6JJ8tY/edit?usp=sharing)\nfor objects, strings, and buffers.\n\nSupports `pipe()`ing (including multi-`pipe()` and backpressure\ntransmission), buffering data until either a `data` event handler\nor `pipe()` is added (so you don't lose the first chunk), and\nmost other cases where PassThrough is a good idea.\n\nThere is a `read()` method, but it's much more efficient to\nconsume data from this stream via `'data'` events or by calling\n`pipe()` into some other stream. Calling `read()` requires the\nbuffer to be flattened in some cases, which requires copying\nmemory.\n\nIf you set `objectMode: true` in the options, then whatever is\nwritten will be emitted. Otherwise, it'll do a minimal amount of\nBuffer copying to ensure proper Streams semantics when `read(n)`\nis called.\n\n`objectMode` can only be set at instantiation. Attempting to\nwrite something other than a String or Buffer without having set\n`objectMode` in the options will throw an error.\n\nThis is not a `through` or `through2` stream. It doesn't\ntransform the data, it just passes it right through. If you want\nto transform the data, extend the class, and override the\n`write()` method. Once you're done transforming the data however\nyou want, call `super.write()` with the transform output.\n\nFor some examples of streams that extend Minipass in various\nways, check out:\n\n- [minizlib](http://npm.im/minizlib)\n- [fs-minipass](http://npm.im/fs-minipass)\n- [tar](http://npm.im/tar)\n- [minipass-collect](http://npm.im/minipass-collect)\n- [minipass-flush](http://npm.im/minipass-flush)\n- [minipass-pipeline](http://npm.im/minipass-pipeline)\n- [tap](http://npm.im/tap)\n- [tap-parser](http://npm.im/tap-parser)\n- [treport](http://npm.im/treport)\n- [minipass-fetch](http://npm.im/minipass-fetch)\n- [pacote](http://npm.im/pacote)\n- [make-fetch-happen](http://npm.im/make-fetch-happen)\n- [cacache](http://npm.im/cacache)\n- [ssri](http://npm.im/ssri)\n- [npm-registry-fetch](http://npm.im/npm-registry-fetch)\n- [minipass-json-stream](http://npm.im/minipass-json-stream)\n- [minipass-sized](http://npm.im/minipass-sized)\n\n## Usage in TypeScript\n\nThe `Minipass` class takes three type template definitions:\n\n- `RType` the type being read, which defaults to `Buffer`. If\n  `RType` is `string`, then the constructor _must_ get an options\n  object specifying either an `encoding` or `objectMode: true`.\n  If it's anything other than `string` or `Buffer`, then it\n  _must_ get an options object specifying `objectMode: true`.\n- `WType` the type being written. If `RType` is `Buffer` or\n  `string`, then this defaults to `ContiguousData` (Buffer,\n  string, ArrayBuffer, or ArrayBufferView). Otherwise, it\n  defaults to `RType`.\n- `Events` type mapping event names to the arguments emitted\n  with that event, which extends `Minipass.Events`.\n\nTo declare types for custom events in subclasses, extend the\nthird parameter with your own event signatures. For example:\n\n```js\nimport { Minipass } from 'minipass'\n\n// a NDJSON stream that emits 'jsonError' when it can't stringify\nexport interface Events extends Minipass.Events {\n  jsonError: [e: Error]\n}\n\nexport class NDJSONStream extends Minipass<string, any, Events> {\n  constructor() {\n    super({ objectMode: true })\n  }\n\n  // data is type `any` because that's WType\n  write(data, encoding, cb) {\n    try {\n      const json = JSON.stringify(data)\n      return super.write(json + '\\n', encoding, cb)\n    } catch (er) {\n      if (!er instanceof Error) {\n        er = Object.assign(new Error('json stringify failed'), {\n          cause: er,\n        })\n      }\n      // trying to emit with something OTHER than an error will\n      // fail, because we declared the event arguments type.\n      this.emit('jsonError', er)\n    }\n  }\n}\n\nconst s = new NDJSONStream()\ns.on('jsonError', e => {\n  // here, TS knows that e is an Error\n})\n```\n\nEmitting/handling events that aren't declared in this way is\nfine, but the arguments will be typed as `unknown`.\n\n## Differences from Node.js Streams\n\nThere are several things that make Minipass streams different\nfrom (and in some ways superior to) Node.js core streams.\n\nPlease read these caveats if you are familiar with node-core\nstreams and intend to use Minipass streams in your programs.\n\nYou can avoid most of these differences entirely (for a very\nsmall performance penalty) by setting `{async: true}` in the\nconstructor options.\n\n### Timing\n\nMinipass streams are designed to support synchronous use-cases.\nThus, data is emitted as soon as it is available, always. It is\nbuffered until read, but no longer. Another way to look at it is\nthat Minipass streams are exactly as synchronous as the logic\nthat writes into them.\n\nThis can be surprising if your code relies on\n`PassThrough.write()` always providing data on the next tick\nrather than the current one, or being able to call `resume()` and\nnot have the entire buffer disappear immediately.\n\nHowever, without this synchronicity guarantee, there would be no\nway for Minipass to achieve the speeds it does, or support the\nsynchronous use cases that it does. Simply put, waiting takes\ntime.\n\nThis non-deferring approach makes Minipass streams much easier to\nreason about, especially in the context of Promises and other\nflow-control mechanisms.\n\nExample:\n\n```js\n// hybrid module, either works\nimport { Minipass } from 'minipass'\n// or:\nconst { Minipass } = require('minipass')\n\nconst stream = new Minipass()\nstream.on('data', () => console.log('data event'))\nconsole.log('before write')\nstream.write('hello')\nconsole.log('after write')\n// output:\n// before write\n// data event\n// after write\n```\n\n### Exception: Async Opt-In\n\nIf you wish to have a Minipass stream with behavior that more\nclosely mimics Node.js core streams, you can set the stream in\nasync mode either by setting `async: true` in the constructor\noptions, or by setting `stream.async = true` later on.\n\n```js\n// hybrid module, either works\nimport { Minipass } from 'minipass'\n// or:\nconst { Minipass } = require('minipass')\n\nconst asyncStream = new Minipass({ async: true })\nasyncStream.on('data', () => console.log('data event'))\nconsole.log('before write')\nasyncStream.write('hello')\nconsole.log('after write')\n// output:\n// before write\n// after write\n// data event <-- this is deferred until the next tick\n```\n\nSwitching _out_ of async mode is unsafe, as it could cause data\ncorruption, and so is not enabled. Example:\n\n```js\nimport { Minipass } from 'minipass'\nconst stream = new Minipass({ encoding: 'utf8' })\nstream.on('data', chunk => console.log(chunk))\nstream.async = true\nconsole.log('before writes')\nstream.write('hello')\nsetStreamSyncAgainSomehow(stream) // <-- this doesn't actually exist!\nstream.write('world')\nconsole.log('after writes')\n// hypothetical output would be:\n// before writes\n// world\n// after writes\n// hello\n// NOT GOOD!\n```\n\nTo avoid this problem, once set into async mode, any attempt to\nmake the stream sync again will be ignored.\n\n```js\nconst { Minipass } = require('minipass')\nconst stream = new Minipass({ encoding: 'utf8' })\nstream.on('data', chunk => console.log(chunk))\nstream.async = true\nconsole.log('before writes')\nstream.write('hello')\nstream.async = false // <-- no-op, stream already async\nstream.write('world')\nconsole.log('after writes')\n// actual output:\n// before writes\n// after writes\n// hello\n// world\n```\n\n### No High/Low Water Marks\n\nNode.js core streams will optimistically fill up a buffer,\nreturning `true` on all writes until the limit is hit, even if\nthe data has nowhere to go. Then, they will not attempt to draw\nmore data in until the buffer size dips below a minimum value.\n\nMinipass streams are much simpler. The `write()` method will\nreturn `true` if the data has somewhere to go (which is to say,\ngiven the timing guarantees, that the data is already there by\nthe time `write()` returns).\n\nIf the data has nowhere to go, then `write()` returns false, and\nthe data sits in a buffer, to be drained out immediately as soon\nas anyone consumes it.\n\nSince nothing is ever buffered unnecessarily, there is much less\ncopying data, and less bookkeeping about buffer capacity levels.\n\n### Hazards of Buffering (or: Why Minipass Is So Fast)\n\nSince data written to a Minipass stream is immediately written\nall the way through the pipeline, and `write()` always returns\ntrue/false based on whether the data was fully flushed,\nbackpressure is communicated immediately to the upstream caller.\nThis minimizes buffering.\n\nConsider this case:\n\n```js\nconst { PassThrough } = require('stream')\nconst p1 = new PassThrough({ highWaterMark: 1024 })\nconst p2 = new PassThrough({ highWaterMark: 1024 })\nconst p3 = new PassThrough({ highWaterMark: 1024 })\nconst p4 = new PassThrough({ highWaterMark: 1024 })\n\np1.pipe(p2).pipe(p3).pipe(p4)\np4.on('data', () => console.log('made it through'))\n\n// this returns false and buffers, then writes to p2 on next tick (1)\n// p2 returns false and buffers, pausing p1, then writes to p3 on next tick (2)\n// p3 returns false and buffers, pausing p2, then writes to p4 on next tick (3)\n// p4 returns false and buffers, pausing p3, then emits 'data' and 'drain'\n// on next tick (4)\n// p3 sees p4's 'drain' event, and calls resume(), emitting 'resume' and\n// 'drain' on next tick (5)\n// p2 sees p3's 'drain', calls resume(), emits 'resume' and 'drain' on next tick (6)\n// p1 sees p2's 'drain', calls resume(), emits 'resume' and 'drain' on next\n// tick (7)\n\np1.write(Buffer.alloc(2048)) // returns false\n```\n\nAlong the way, the data was buffered and deferred at each stage,\nand multiple event deferrals happened, for an unblocked pipeline\nwhere it was perfectly safe to write all the way through!\n\nFurthermore, setting a `highWaterMark` of `1024` might lead\nsomeone reading the code to think an advisory maximum of 1KiB is\nbeing set for the pipeline. However, the actual advisory\nbuffering level is the _sum_ of `highWaterMark` values, since\neach one has its own bucket.\n\nConsider the Minipass case:\n\n```js\nconst m1 = new Minipass()\nconst m2 = new Minipass()\nconst m3 = new Minipass()\nconst m4 = new Minipass()\n\nm1.pipe(m2).pipe(m3).pipe(m4)\nm4.on('data', () => console.log('made it through'))\n\n// m1 is flowing, so it writes the data to m2 immediately\n// m2 is flowing, so it writes the data to m3 immediately\n// m3 is flowing, so it writes the data to m4 immediately\n// m4 is flowing, so it fires the 'data' event immediately, returns true\n// m4's write returned true, so m3 is still flowing, returns true\n// m3's write returned true, so m2 is still flowing, returns true\n// m2's write returned true, so m1 is still flowing, returns true\n// No event deferrals or buffering along the way!\n\nm1.write(Buffer.alloc(2048)) // returns true\n```\n\nIt is extremely unlikely that you _don't_ want to buffer any data\nwritten, or _ever_ buffer data that can be flushed all the way\nthrough. Neither node-core streams nor Minipass ever fail to\nbuffer written data, but node-core streams do a lot of\nunnecessary buffering and pausing.\n\nAs always, the faster implementation is the one that does less\nstuff and waits less time to do it.\n\n### Immediately emit `end` for empty streams (when not paused)\n\nIf a stream is not paused, and `end()` is called before writing\nany data into it, then it will emit `end` immediately.\n\nIf you have logic that occurs on the `end` event which you don't\nwant to potentially happen immediately (for example, closing file\ndescriptors, moving on to the next entry in an archive parse\nstream, etc.) then be sure to call `stream.pause()` on creation,\nand then `stream.resume()` once you are ready to respond to the\n`end` event.\n\nHowever, this is _usually_ not a problem because:\n\n### Emit `end` When Asked\n\nOne hazard of immediately emitting `'end'` is that you may not\nyet have had a chance to add a listener. In order to avoid this\nhazard, Minipass streams safely re-emit the `'end'` event if a\nnew listener is added after `'end'` has been emitted.\n\nIe, if you do `stream.on('end', someFunction)`, and the stream\nhas already emitted `end`, then it will call the handler right\naway. (You can think of this somewhat like attaching a new\n`.then(fn)` to a previously-resolved Promise.)\n\nTo prevent calling handlers multiple times who would not expect\nmultiple ends to occur, all listeners are removed from the\n`'end'` event whenever it is emitted.\n\n### Emit `error` When Asked\n\nThe most recent error object passed to the `'error'` event is\nstored on the stream. If a new `'error'` event handler is added,\nand an error was previously emitted, then the event handler will\nbe called immediately (or on `process.nextTick` in the case of\nasync streams).\n\nThis makes it much more difficult to end up trying to interact\nwith a broken stream, if the error handler is added after an\nerror was previously emitted.\n\n### Impact of \"immediate flow\" on Tee-streams\n\nA \"tee stream\" is a stream piping to multiple destinations:\n\n```js\nconst tee = new Minipass()\nt.pipe(dest1)\nt.pipe(dest2)\nt.write('foo') // goes to both destinations\n```\n\nSince Minipass streams _immediately_ process any pending data\nthrough the pipeline when a new pipe destination is added, this\ncan have surprising effects, especially when a stream comes in\nfrom some other function and may or may not have data in its\nbuffer.\n\n```js\n// WARNING! WILL LOSE DATA!\nconst src = new Minipass()\nsrc.write('foo')\nsrc.pipe(dest1) // 'foo' chunk flows to dest1 immediately, and is gone\nsrc.pipe(dest2) // gets nothing!\n```\n\nOne solution is to create a dedicated tee-stream junction that\npipes to both locations, and then pipe to _that_ instead.\n\n```js\n// Safe example: tee to both places\nconst src = new Minipass()\nsrc.write('foo')\nconst tee = new Minipass()\ntee.pipe(dest1)\ntee.pipe(dest2)\nsrc.pipe(tee) // tee gets 'foo', pipes to both locations\n```\n\nThe same caveat applies to `on('data')` event listeners. The\nfirst one added will _immediately_ receive all of the data,\nleaving nothing for the second:\n\n```js\n// WARNING! WILL LOSE DATA!\nconst src = new Minipass()\nsrc.write('foo')\nsrc.on('data', handler1) // receives 'foo' right away\nsrc.on('data', handler2) // nothing to see here!\n```\n\nUsing a dedicated tee-stream can be used in this case as well:\n\n```js\n// Safe example: tee to both data handlers\nconst src = new Minipass()\nsrc.write('foo')\nconst tee = new Minipass()\ntee.on('data', handler1)\ntee.on('data', handler2)\nsrc.pipe(tee)\n```\n\nAll of the hazards in this section are avoided by setting `{\nasync: true }` in the Minipass constructor, or by setting\n`stream.async = true` afterwards. Note that this does add some\noverhead, so should only be done in cases where you are willing\nto lose a bit of performance in order to avoid having to refactor\nprogram logic.\n\n## USAGE\n\nIt's a stream! Use it like a stream and it'll most likely do what\nyou want.\n\n```js\nimport { Minipass } from 'minipass'\nconst mp = new Minipass(options) // options is optional\nmp.write('foo')\nmp.pipe(someOtherStream)\nmp.end('bar')\n```\n\n### OPTIONS\n\n- `encoding` How would you like the data coming _out_ of the\n  stream to be encoded? Accepts any values that can be passed to\n  `Buffer.toString()`.\n- `objectMode` Emit data exactly as it comes in. This will be\n  flipped on by default if you write() something other than a\n  string or Buffer at any point. Setting `objectMode: true` will\n  prevent setting any encoding value.\n- `async` Defaults to `false`. Set to `true` to defer data\n  emission until next tick. This reduces performance slightly,\n  but makes Minipass streams use timing behavior closer to Node\n  core streams. See [Timing](#timing) for more details.\n- `signal` An `AbortSignal` that will cause the stream to unhook\n  itself from everything and become as inert as possible. Note\n  that providing a `signal` parameter will make `'error'` events\n  no longer throw if they are unhandled, but they will still be\n  emitted to handlers if any are attached.\n\n### API\n\nImplements the user-facing portions of Node.js's `Readable` and\n`Writable` streams.\n\n### Methods\n\n- `write(chunk, [encoding], [callback])` - Put data in. (Note\n  that, in the base Minipass class, the same data will come out.)\n  Returns `false` if the stream will buffer the next write, or\n  true if it's still in \"flowing\" mode.\n- `end([chunk, [encoding]], [callback])` - Signal that you have\n  no more data to write. This will queue an `end` event to be\n  fired when all the data has been consumed.\n- `pause()` - No more data for a while, please. This also\n  prevents `end` from being emitted for empty streams until the\n  stream is resumed.\n- `resume()` - Resume the stream. If there's data in the buffer,\n  it is all discarded. Any buffered events are immediately\n  emitted.\n- `pipe(dest)` - Send all output to the stream provided. When\n  data is emitted, it is immediately written to any and all pipe\n  destinations. (Or written on next tick in `async` mode.)\n- `unpipe(dest)` - Stop piping to the destination stream. This is\n  immediate, meaning that any asynchronously queued data will\n  _not_ make it to the destination when running in `async` mode.\n  - `options.end` - Boolean, end the destination stream when the\n    source stream ends. Default `true`.\n  - `options.proxyErrors` - Boolean, proxy `error` events from\n    the source stream to the destination stream. Note that errors\n    are _not_ proxied after the pipeline terminates, either due\n    to the source emitting `'end'` or manually unpiping with\n    `src.unpipe(dest)`. Default `false`.\n- `on(ev, fn)`, `emit(ev, fn)` - Minipass streams are\n  EventEmitters. Some events are given special treatment,\n  however. (See below under \"events\".)\n- `promise()` - Returns a Promise that resolves when the stream\n  emits `end`, or rejects if the stream emits `error`.\n- `collect()` - Return a Promise that resolves on `end` with an\n  array containing each chunk of data that was emitted, or\n  rejects if the stream emits `error`. Note that this consumes\n  the stream data.\n- `concat()` - Same as `collect()`, but concatenates the data\n  into a single Buffer object. Will reject the returned promise\n  if the stream is in objectMode, or if it goes into objectMode\n  by the end of the data.\n- `read(n)` - Consume `n` bytes of data out of the buffer. If `n`\n  is not provided, then consume all of it. If `n` bytes are not\n  available, then it returns null. **Note** consuming streams in\n  this way is less efficient, and can lead to unnecessary Buffer\n  copying.\n- `destroy([er])` - Destroy the stream. If an error is provided,\n  then an `'error'` event is emitted. If the stream has a\n  `close()` method, and has not emitted a `'close'` event yet,\n  then `stream.close()` will be called. Any Promises returned by\n  `.promise()`, `.collect()` or `.concat()` will be rejected.\n  After being destroyed, writing to the stream will emit an\n  error. No more data will be emitted if the stream is destroyed,\n  even if it was previously buffered.\n\n### Properties\n\n- `bufferLength` Read-only. Total number of bytes buffered, or in\n  the case of objectMode, the total number of objects.\n- `encoding` Read-only. The encoding that has been set.\n- `flowing` Read-only. Boolean indicating whether a chunk written\n  to the stream will be immediately emitted.\n- `emittedEnd` Read-only. Boolean indicating whether the end-ish\n  events (ie, `end`, `prefinish`, `finish`) have been emitted.\n  Note that listening on any end-ish event will immediateyl\n  re-emit it if it has already been emitted.\n- `writable` Whether the stream is writable. Default `true`. Set\n  to `false` when `end()`\n- `readable` Whether the stream is readable. Default `true`.\n- `pipes` An array of Pipe objects referencing streams that this\n  stream is piping into.\n- `destroyed` A getter that indicates whether the stream was\n  destroyed.\n- `paused` True if the stream has been explicitly paused,\n  otherwise false.\n- `objectMode` Indicates whether the stream is in `objectMode`.\n- `aborted` Readonly property set when the `AbortSignal`\n  dispatches an `abort` event.\n\n### Events\n\n- `data` Emitted when there's data to read. Argument is the data\n  to read. This is never emitted while not flowing. If a listener\n  is attached, that will resume the stream.\n- `end` Emitted when there's no more data to read. This will be\n  emitted immediately for empty streams when `end()` is called.\n  If a listener is attached, and `end` was already emitted, then\n  it will be emitted again. All listeners are removed when `end`\n  is emitted.\n- `prefinish` An end-ish event that follows the same logic as\n  `end` and is emitted in the same conditions where `end` is\n  emitted. Emitted after `'end'`.\n- `finish` An end-ish event that follows the same logic as `end`\n  and is emitted in the same conditions where `end` is emitted.\n  Emitted after `'prefinish'`.\n- `close` An indication that an underlying resource has been\n  released. Minipass does not emit this event, but will defer it\n  until after `end` has been emitted, since it throws off some\n  stream libraries otherwise.\n- `drain` Emitted when the internal buffer empties, and it is\n  again suitable to `write()` into the stream.\n- `readable` Emitted when data is buffered and ready to be read\n  by a consumer.\n- `resume` Emitted when stream changes state from buffering to\n  flowing mode. (Ie, when `resume` is called, `pipe` is called,\n  or a `data` event listener is added.)\n\n### Static Methods\n\n- `Minipass.isStream(stream)` Returns `true` if the argument is a\n  stream, and false otherwise. To be considered a stream, the\n  object must be either an instance of Minipass, or an\n  EventEmitter that has either a `pipe()` method, or both\n  `write()` and `end()` methods. (Pretty much any stream in\n  node-land will return `true` for this.)\n\n## EXAMPLES\n\nHere are some examples of things you can do with Minipass\nstreams.\n\n### simple \"are you done yet\" promise\n\n```js\nmp.promise().then(\n  () => {\n    // stream is finished\n  },\n  er => {\n    // stream emitted an error\n  }\n)\n```\n\n### collecting\n\n```js\nmp.collect().then(all => {\n  // all is an array of all the data emitted\n  // encoding is supported in this case, so\n  // so the result will be a collection of strings if\n  // an encoding is specified, or buffers/objects if not.\n  //\n  // In an async function, you may do\n  // const data = await stream.collect()\n})\n```\n\n### collecting into a single blob\n\nThis is a bit slower because it concatenates the data into one\nchunk for you, but if you're going to do it yourself anyway, it's\nconvenient this way:\n\n```js\nmp.concat().then(onebigchunk => {\n  // onebigchunk is a string if the stream\n  // had an encoding set, or a buffer otherwise.\n})\n```\n\n### iteration\n\nYou can iterate over streams synchronously or asynchronously in\nplatforms that support it.\n\nSynchronous iteration will end when the currently available data\nis consumed, even if the `end` event has not been reached. In\nstring and buffer mode, the data is concatenated, so unless\nmultiple writes are occurring in the same tick as the `read()`,\nsync iteration loops will generally only have a single iteration.\n\nTo consume chunks in this way exactly as they have been written,\nwith no flattening, create the stream with the `{ objectMode:\ntrue }` option.\n\n```js\nconst mp = new Minipass({ objectMode: true })\nmp.write('a')\nmp.write('b')\nfor (let letter of mp) {\n  console.log(letter) // a, b\n}\nmp.write('c')\nmp.write('d')\nfor (let letter of mp) {\n  console.log(letter) // c, d\n}\nmp.write('e')\nmp.end()\nfor (let letter of mp) {\n  console.log(letter) // e\n}\nfor (let letter of mp) {\n  console.log(letter) // nothing\n}\n```\n\nAsynchronous iteration will continue until the end event is reached,\nconsuming all of the data.\n\n```js\nconst mp = new Minipass({ encoding: 'utf8' })\n\n// some source of some data\nlet i = 5\nconst inter = setInterval(() => {\n  if (i-- > 0) mp.write(Buffer.from('foo\\n', 'utf8'))\n  else {\n    mp.end()\n    clearInterval(inter)\n  }\n}, 100)\n\n// consume the data with asynchronous iteration\nasync function consume() {\n  for await (let chunk of mp) {\n    console.log(chunk)\n  }\n  return 'ok'\n}\n\nconsume().then(res => console.log(res))\n// logs `foo\\n` 5 times, and then `ok`\n```\n\n### subclass that `console.log()`s everything written into it\n\n```js\nclass Logger extends Minipass {\n  write(chunk, encoding, callback) {\n    console.log('WRITE', chunk, encoding)\n    return super.write(chunk, encoding, callback)\n  }\n  end(chunk, encoding, callback) {\n    console.log('END', chunk, encoding)\n    return super.end(chunk, encoding, callback)\n  }\n}\n\nsomeSource.pipe(new Logger()).pipe(someDest)\n```\n\n### same thing, but using an inline anonymous class\n\n```js\n// js classes are fun\nsomeSource\n  .pipe(\n    new (class extends Minipass {\n      emit(ev, ...data) {\n        // let's also log events, because debugging some weird thing\n        console.log('EMIT', ev)\n        return super.emit(ev, ...data)\n      }\n      write(chunk, encoding, callback) {\n        console.log('WRITE', chunk, encoding)\n        return super.write(chunk, encoding, callback)\n      }\n      end(chunk, encoding, callback) {\n        console.log('END', chunk, encoding)\n        return super.end(chunk, encoding, callback)\n      }\n    })()\n  )\n  .pipe(someDest)\n```\n\n### subclass that defers 'end' for some reason\n\n```js\nclass SlowEnd extends Minipass {\n  emit(ev, ...args) {\n    if (ev === 'end') {\n      console.log('going to end, hold on a sec')\n      setTimeout(() => {\n        console.log('ok, ready to end now')\n        super.emit('end', ...args)\n      }, 100)\n      return true\n    } else {\n      return super.emit(ev, ...args)\n    }\n  }\n}\n```\n\n### transform that creates newline-delimited JSON\n\n```js\nclass NDJSONEncode extends Minipass {\n  write(obj, cb) {\n    try {\n      // JSON.stringify can throw, emit an error on that\n      return super.write(JSON.stringify(obj) + '\\n', 'utf8', cb)\n    } catch (er) {\n      this.emit('error', er)\n    }\n  }\n  end(obj, cb) {\n    if (typeof obj === 'function') {\n      cb = obj\n      obj = undefined\n    }\n    if (obj !== undefined) {\n      this.write(obj)\n    }\n    return super.end(cb)\n  }\n}\n```\n\n### transform that parses newline-delimited JSON\n\n```js\nclass NDJSONDecode extends Minipass {\n  constructor(options) {\n    // always be in object mode, as far as Minipass is concerned\n    super({ objectMode: true })\n    this._jsonBuffer = ''\n  }\n  write(chunk, encoding, cb) {\n    if (\n      typeof chunk === 'string' &&\n      typeof encoding === 'string' &&\n      encoding !== 'utf8'\n    ) {\n      chunk = Buffer.from(chunk, encoding).toString()\n    } else if (Buffer.isBuffer(chunk)) {\n      chunk = chunk.toString()\n    }\n    if (typeof encoding === 'function') {\n      cb = encoding\n    }\n    const jsonData = (this._jsonBuffer + chunk).split('\\n')\n    this._jsonBuffer = jsonData.pop()\n    for (let i = 0; i < jsonData.length; i++) {\n      try {\n        // JSON.parse can throw, emit an error on that\n        super.write(JSON.parse(jsonData[i]))\n      } catch (er) {\n        this.emit('error', er)\n        continue\n      }\n    }\n    if (cb) cb()\n  }\n}\n```",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{34/49/8f2da253158d3e73142f14565e0783aac839de2c748f7b2ba901fefca8fc783a4f5719611e6f57e8766a70e440da4b1edba213321eef9eb7ad69ab41cf2e → d2/9d/8c5cf415a1b0ef38d781217c32973408c53e05bb3677b3d80e41a91d05051d71d0382e64f4071a1ace8f3d0d7cb888032ed60fe8980561a0eda5f4d61901}

@@ -4214,7 +4214,7 @@
   "dist-tags": {
     "latest": "4.1.0"
   },
-  "_rev": "60-201e52a3876dce52",
+  "_rev": "61-385d7e9f5669c5a3",
   "_id": "@smithy/types",
   "readme": "# @smithy/types\n\n[![NPM version](https://img.shields.io/npm/v/@smithy/types/latest.svg)](https://www.npmjs.com/package/@smithy/types)\n[![NPM downloads](https://img.shields.io/npm/dm/@smithy/types.svg)](https://www.npmjs.com/package/@smithy/types)\n\n## Usage\n\nThis package is mostly used internally by generated clients.\nSome public components have independent applications.\n\n---\n\n### Scenario: Removing `| undefined` from input and output structures\n\nGenerated shapes' members are unioned with `undefined` for\ninput shapes, and are `?` (optional) for output shapes.\n\n- for inputs, this defers the validation to the service.\n- for outputs, this strongly suggests that you should runtime-check the output data.\n\nIf you would like to skip these steps, use the `AssertiveClient` or\n`UncheckedClient` type helpers.\n\nUsing AWS S3 as an example:\n\n```ts\nimport { S3 } from \"@aws-sdk/client-s3\";\nimport type { AssertiveClient, UncheckedClient } from \"@smithy/types\";\n\nconst s3a = new S3({}) as AssertiveClient<S3>;\nconst s3b = new S3({}) as UncheckedClient<S3>;\n\n// AssertiveClient enforces required inputs are not undefined\n// and required outputs are not undefined.\nconst get = await s3a.getObject({\n  Bucket: \"\",\n  // @ts-expect-error (undefined not assignable to string)\n  Key: undefined,\n});\n\n// UncheckedClient makes output fields non-nullable.\n// You should still perform type checks as you deem\n// necessary, but the SDK will no longer prompt you\n// with nullability errors.\nconst body = await (\n  await s3b.getObject({\n    Bucket: \"\",\n    Key: \"\",\n  })\n).Body.transformToString();\n```\n\nWhen using the transform on non-aggregated client with the `Command` syntax,\nthe input cannot be validated because it goes through another class.\n\n```ts\nimport { S3Client, ListBucketsCommand, GetObjectCommand, GetObjectCommandInput } from \"@aws-sdk/client-s3\";\nimport type { AssertiveClient, UncheckedClient, NoUndefined } from \"@smithy/types\";\n\nconst s3 = new S3Client({}) as UncheckedClient<S3Client>;\n\nconst list = await s3.send(\n  new ListBucketsCommand({\n    // command inputs are not validated by the type transform.\n    // because this is a separate class.\n  })\n);\n\n/**\n * Although less ergonomic, you can use the NoUndefined<T>\n * transform on the input type.\n */\nconst getObjectInput: NoUndefined<GetObjectCommandInput> = {\n  Bucket: \"undefined\",\n  // @ts-expect-error (undefined not assignable to string)\n  Key: undefined,\n  // optional params can still be undefined.\n  SSECustomerAlgorithm: undefined,\n};\n\nconst get = s3.send(new GetObjectCommand(getObjectInput));\n\n// outputs are still transformed.\nawait get.Body.TransformToString();\n```\n\n### Scenario: Narrowing a smithy-typescript generated client's output payload blob types\n\nThis is mostly relevant to operations with streaming bodies such as within\nthe S3Client in the AWS SDK for JavaScript v3.\n\nBecause blob payload types are platform dependent, you may wish to indicate in your application that a client is running in a specific\nenvironment. This narrows the blob payload types.\n\n```typescript\nimport { GetObjectCommand, S3Client } from \"@aws-sdk/client-s3\";\nimport type { NodeJsClient, SdkStream, StreamingBlobPayloadOutputTypes } from \"@smithy/types\";\nimport type { IncomingMessage } from \"node:http\";\n\n// default client init.\nconst s3Default = new S3Client({});\n\n// client init with type narrowing.\nconst s3NarrowType = new S3Client({}) as NodeJsClient<S3Client>;\n\n// The default type of blob payloads is a wide union type including multiple possible\n// request handlers.\nconst body1: StreamingBlobPayloadOutputTypes = (await s3Default.send(new GetObjectCommand({ Key: \"\", Bucket: \"\" })))\n  .Body!;\n\n// This is of the narrower type SdkStream<IncomingMessage> representing\n// blob payload responses using specifically the node:http request handler.\nconst body2: SdkStream<IncomingMessage> = (await s3NarrowType.send(new GetObjectCommand({ Key: \"\", Bucket: \"\" })))\n  .Body!;\n```",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{1d/ed/bd9d076e41b08d03c2d1e1983790640512e51d140851cdeb08bfb7c5584094e235c98bfcfd94580debbf826c43dadb84b4d0788dcc046e6db899b373865f → d3/30/a6c9e504a091d696841138d07629e4d1d030a244a05fe55e7ab3f21805b252680982e8feae8e75de30e615c39b011f69191f68c6c4d6fea1cfa09c0abde9}

@@ -236,7 +236,7 @@
   "dist-tags": {
     "latest": "1.0.2"
   },
-  "_rev": "1675-a079fa1ed3653036",
+  "_rev": "1678-e08047432f66ea20",
   "_id": "wrappy",
   "readme": "# wrappy\n\nCallback wrapping utility\n\n## USAGE\n\n```javascript\nvar wrappy = require(\"wrappy\")\n\n// var wrapper = wrappy(wrapperFunction)\n\n// make sure a cb is called only once\n// See also: http://npm.im/once for this specific use case\nvar once = wrappy(function (cb) {\n  var called = false\n  return function () {\n    if (called) return\n    called = true\n    return cb.apply(this, arguments)\n  }\n})\n\nfunction printBoo () {\n  console.log('boo')\n}\n// has some rando property\nprintBoo.iAmBooPrinter = true\n\nvar onlyPrintOnce = once(printBoo)\n\nonlyPrintOnce() // prints 'boo'\nonlyPrintOnce() // does nothing\n\n// random property is retained!\nassert.equal(onlyPrintOnce.iAmBooPrinter, true)\n```",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{c8/b1/b40e4d482744cabc2ee163c57a577930162b31e4bd0636a7eede2434596f62012232d909822d2cca6bd1a9ef17765adfd5699fff9c477b9aa8af35db00a4 → d3/36/056d20198d5126ba02b41f3d025769456d6882848979b09ffc6895927ab17e56f14f50b60a31f18a90e7e462ebb8d046e76a623f057a1a49795e999301aa}

@@ -43966,7 +43966,7 @@
     "gamma": "1.0.0-gamma.9",
     "rc": "3.5.1-rc.0"
   },
-  "_rev": "87-4d663129d93064d9",
+  "_rev": "88-0a3a96136e845ad2",
   "_id": "@aws-sdk/credential-provider-ini",
   "readme": "# @aws-sdk/credential-provider-ini\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-ini/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-ini)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-ini.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-ini)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly. Please use [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers)\ninstead.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{e1/f5/e7cfeb67775aeb0e843e234f988ed9f0242c6f887e9954b37ccb9feac21d57f0ff8c445068c0e9cdc93af6ceb772f082aaff46fe6cc4e46984ede5d3e7cc → d6/56/a909b131d5458027511a3f36fbf7213fa121ac6ac8d8024e1c489da3fab0f1c31dbcefbbea511e3c8f45ef732d13696b1a5e8aee7a6556df320ec4b0fc50}

@@ -5910,7 +5910,7 @@
     "gamma": "1.0.0-gamma.7",
     "rc": "1.0.0-rc.8"
   },
-  "_rev": "100-29a95acaf95b601b",
+  "_rev": "102-5c666ccc97cce0d9",
   "_id": "@aws-sdk/util-locate-window",
   "readme": "# @aws-sdk/util-locate-window\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-locate-window/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-locate-window)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-locate-window.svg)](https://www.npmjs.com/package/@aws-sdk/util-locate-window)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{82/86/fdfcd77ea72ca60812b85db71fc3c38279562e6980a0885e84d30eef8a77f631c95ca26cc1c6f2aa40bfcb04f27bd18f736b8e00d2ecdb8932adf3f80e4b → d6/9f/aa0158910258f248299822fbc410350e048b88c7c2e44d2d4980c0a65110752446bd5f53cb25c472993e47de29b7db3fce10f4dfe9510279d15f9d2bfce6}

@@ -286,7 +286,7 @@
   "dist-tags": {
     "latest": "0.0.2"
   },
-  "_rev": "1655-579c0f323a3ce321",
+  "_rev": "1657-5bee1d4e442322bf",
   "_id": "concat-map",
   "readme": "# concat-map <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![github actions][actions-image]][actions-url]\n[![coverage][codecov-image]][codecov-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\nConcatenative mapdashery.\n\n## example\n\n``` js\nvar concatMap = require('concat-map');\nvar xs = [ 1, 2, 3, 4, 5, 6 ];\nvar ys = concatMap(xs, function (x) {\n    return x % 2 ? [ x - 0.1, x, x + 0.1 ] : [];\n});\nconsole.dir(ys);\n```\n\n\n```js\n[ 0.9, 1, 1.1, 2.9, 3, 3.1, 4.9, 5, 5.1 ]\n```\n\n## methods\n\n```js\nvar concatMap = require('concat-map')\n```\n\nconcatMap(xs, fn)\n-----------------\n\nReturn an array of concatenated elements by calling `fn(x, i)` for each element\n`x` and each index `i` in the array `xs`.\n\nWhen `fn(x, i)` returns an array, its result will be concatenated with the\nresult array. If `fn(x, i)` returns anything else, that value will be pushed\nonto the end of the result array.\n\n## install\n\nWith [npm](http://npmjs.org) do:\n\n```sh\nnpm install concat-map\n```\n\n## license\n\nMIT\n\n## notes\n\nThis module was written while sitting high above the ground in a tree.\n\n[package-url]: https://npmjs.org/package/concat-map\n[npm-version-svg]: https://versionbadg.es/ljharb/concat-map.svg\n[deps-svg]: https://david-dm.org/ljharb/concat-map.svg\n[deps-url]: https://david-dm.org/ljharb/concat-map\n[dev-deps-svg]: https://david-dm.org/ljharb/concat-map/dev-status.svg\n[dev-deps-url]: https://david-dm.org/ljharb/concat-map#info=devDependencies\n[npm-badge-png]: https://nodei.co/npm/concat-map.png?downloads=true&stars=true\n[license-image]: https://img.shields.io/npm/l/concat-map.svg\n[license-url]: LICENSE\n[downloads-image]: https://img.shields.io/npm/dm/concat-map.svg\n[downloads-url]: https://npm-stat.com/charts.html?package=concat-map\n[codecov-image]: https://codecov.io/gh/ljharb/concat-map/branch/main/graphs/badge.svg\n[codecov-url]: https://app.codecov.io/gh/ljharb/concat-map/\n[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/concat-map\n[actions-url]: https://github.com/ljharb/concat-map/actions",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{f0/cd/6cc2653b6ea8efa9b6d4673e97199f09a482f09e1391a89184b34b4e5995cfe663436fdb9b8ce5e1da7cf7a838fea9df169d130041c72637a2336a01bff2 → d8/31/c2d4d221f0c7abb4c80bb478031ad1184a972247396e0b23cc616c947fb4027727608326869c17c7a103c018d41572844c45f6a7cafa1334aa795df998f3}

@@ -999,7 +999,7 @@
   "dist-tags": {
     "latest": "1.3.0"
   },
-  "_rev": "1429-cabca21604b58b90",
+  "_rev": "1431-57749c828a3cdef2",
   "_id": "string_decoder",
   "readme": "# string_decoder\n\n***Node-core v8.9.4 string_decoder for userland***\n\n\n[![NPM](https://nodei.co/npm/string_decoder.png?downloads=true&downloadRank=true)](https://nodei.co/npm/string_decoder/)\n[![NPM](https://nodei.co/npm-dl/string_decoder.png?&months=6&height=3)](https://nodei.co/npm/string_decoder/)\n\n\n```bash\nnpm install --save string_decoder\n```\n\n***Node-core string_decoder for userland***\n\nThis package is a mirror of the string_decoder implementation in Node-core.\n\nFull documentation may be found on the [Node.js website](https://nodejs.org/dist/v8.9.4/docs/api/).\n\nAs of version 1.0.0 **string_decoder** uses semantic versioning.\n\n## Previous versions\n\nPrevious version numbers match the versions found in Node core, e.g. 0.10.24 matches Node 0.10.24, likewise 0.11.10 matches Node 0.11.10.\n\n## Update\n\nThe *build/* directory contains a build script that will scrape the source from the [nodejs/node](https://github.com/nodejs/node) repo given a specific Node version.\n\n## Streams Working Group\n\n`string_decoder` is maintained by the Streams Working Group, which\noversees the development and maintenance of the Streams API within\nNode.js. The responsibilities of the Streams Working Group include:\n\n* Addressing stream issues on the Node.js issue tracker.\n* Authoring and editing stream documentation within the Node.js project.\n* Reviewing changes to stream subclasses within the Node.js project.\n* Redirecting changes to streams from the Node.js project to this\n  project.\n* Assisting in the implementation of stream providers within Node.js.\n* Recommending versions of `readable-stream` to be included in Node.js.\n* Messaging about the future of streams to give the community advance\n  notice of changes.\n\nSee [readable-stream](https://github.com/nodejs/readable-stream) for\nmore details.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{0a/55/8c147c968f5de74351600dc5e68e7f47922464a8dff1c2eae9d02bc8b57fb53b838b7775544bd3068891864c810675bd90bd45c19373ff69b70accb102f1 → d8/bd/53f6a7dfd1a471a3f132a15526e9bec865315066e4abee73780677b79f6384e6aa6dcc953d80f668698617d049f7e551bd3a6e7529d17e6936a24e1096a8}

@@ -17772,7 +17772,7 @@
     "gamma": "1.0.0-gamma.9",
     "rc": "1.0.0-rc.10"
   },
-  "_rev": "86-824da9de4466728d",
+  "_rev": "87-9f2f984667726696",
   "_id": "@aws-sdk/middleware-host-header",
   "readme": "# @aws-sdk/middleware-host-header\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-host-header/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-host-header)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-host-header.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-host-header)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{01/59/33beca0259eab5f7d21972c931f2048fd9214c10f6e75b799505d3a391e1c4cec9931ef6553782a5ae596a01897ad2163dae60211601c49433f21a8b1272 → d8/e3/6d1fcebaa837cbf7f2ff13a25bbee94d1541ccc67f224d6f755a5af6ff4be44c82210eb80be7eaec882253d1f5b802e5129121d9e7ea1cddbb3955c5c0e3}

@@ -38860,7 +38860,7 @@
   "dist-tags": {
     "latest": "3.750.0"
   },
-  "_rev": "89-191bfc4c9eb3ba8c",
+  "_rev": "90-3d417e1887118a30",
   "_id": "@aws-sdk/credential-provider-sso",
   "readme": "# @aws-sdk/credential-provider-sso\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-sso/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-sso)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-sso.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-sso)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly. Please use [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers)\ninstead.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{8d/9f/a6fd428090da947d075ec4a5a467f9788046a035500f14e03014deee06b642df1d09822ed4ebdb4a5de23208f226350f375b5339c78d989c9a79ac96a689 → d9/99/c9fc0e8fb17a7a62679c0e4d84c233f063f7e26d7db1dda2c79da3fee0a022e00d1e0e0e49754656b4f6d37c0f2e344ccac12e83473bb88eb02463652c19}

@@ -18987,7 +18987,7 @@
   "dist-tags": {
     "latest": "3.750.0"
   },
-  "_rev": "85-d25dd29c3a8e9615",
+  "_rev": "86-3462cf368c39d568",
   "_id": "@aws-sdk/credential-provider-web-identity",
   "readme": "# @aws-sdk/credential-provider-web-identity\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-web-identity/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-web-identity)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-web-identity.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-web-identity)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly. Please use [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers)\ninstead.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{d0/7e/266b1337bcec33852a0d69400dd7d2cc6354a88d92fcc6a1a1ce68915cc244789cafb62722a4e49186c7908bcc057431347fdf0ca372463c94d6de21d3d7 → d9/df/777a1182bd0f988873515fb830c5d508ab584571b212307258b04dd4ce0fc0162a127ccacfc26d8481f46a8718f01e2f7a9167245050e303e8a25ab89e2d}

@@ -9543,7 +9543,7 @@
     "latest": "3.374.0",
     "rc": "1.0.0-rc.10"
   },
-  "_rev": "67-66d5f91b40d48860",
+  "_rev": "68-99b6bdfb64714df5",
   "_id": "@aws-sdk/util-waiter",
   "readme": "# @aws-sdk/util-waiter\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-waiter/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-waiter)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-waiter.svg)](https://www.npmjs.com/package/@aws-sdk/util-waiter)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{85/a2/981692e0232ee91c1bdf5052a5459d961f04501935499d78834a134c33b24ec92577cce3d7a2330534f4b4ac3ead1c0b7195a3aef80eff76d5623fbea549 → da/ef/0fd3bf23c3a795e5e431154d74d36eab785606e803bfad1c119a3c60c91fa7b1660b741fc83af948306557a5e803042795661afcac63c2570ebf9c63899b}

@@ -1767,7 +1767,7 @@
     "latest": "1.0.0",
     "next": "1.0.0-RC9"
   },
-  "_rev": "138-16a4c3f0a88633e3",
+  "_rev": "139-dc6d79ab016214f4",
   "_id": "buffer-crc32",
   "readme": "# buffer-crc32\n\n[![NPM Version](https://img.shields.io/npm/v/buffer-crc32.svg)](https://npmjs.org/package/buffer-crc32)\n[![Build Status](https://github.com/brianloveswords/buffer-crc32/actions/workflows/ci.yml/badge.svg)](https://github.com/brianloveswords/buffer-crc32/actions/workflows/ci.yml)\n\ncrc32 that works with binary data and fancy character sets, outputs\nbuffer, signed or unsigned data and has tests.\n\nDerived from the sample CRC implementation in the PNG specification: http://www.w3.org/TR/PNG/#D-CRCAppendix\n\nThis package requires Node 8+ to work.\n\n# install\n\n```\nnpm install buffer-crc32\n```\n\n# example\n\n```js\nconst crc32 = require('buffer-crc32');\n// works with buffers\nconst buf = Buffer([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);\ncrc32(buf); // -> <Buffer 94 5a ab 4a>\n\n// has convenience methods for getting signed or unsigned ints\ncrc32.signed(buf); // -> -1805997238\ncrc32.unsigned(buf); // -> 2488970058\n\n// will cast to buffer if given a string, so you can\n// directly use foreign characters safely\ncrc32('自動販売機'); // -> <Buffer cb 03 1a c5>\n\n// and works in append mode too\nconst partialCrc = crc32('hey');\nconst partialCrc = crc32(' ', partialCrc);\nconst partialCrc = crc32('sup', partialCrc);\nconst partialCrc = crc32(' ', partialCrc);\nconst finalCrc = crc32('bros', partialCrc); // -> <Buffer 47 fa 55 70>\n```\n\n# tests\n\nThis was tested against the output of zlib's crc32 method. You can run\nthe tests with`npm test` (requires tap)\n\n# see also\n\nhttps://github.com/alexgorbatchev/node-crc, `crc.buffer.crc32` also\nsupports buffer inputs and return unsigned ints (thanks @tjholowaychuk).\n\n# license\n\nMIT/X11",
   "_attachments": {}