From 54e80cf25edd7a1a1633c05d9f6bef2224b8eb79 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Thu, 3 Jun 2021 20:39:48 -0400 Subject: [PATCH 01/91] Initial code before tests --- .eslintignore | 2 + .eslintrc.js | 49 +- package-lock.json | 2290 ++++++++++++++---- package.json | 18 +- src/EnvoyAPI.ts | 347 +++ src/EnvoyJWT.ts | 39 + src/EnvoyMeta.ts | 70 + src/EnvoyPluginJob.ts | 55 + src/EnvoyPluginJobAttachment.ts | 25 + src/EnvoyPluginJobUpdate.ts | 8 + src/EnvoyPluginSDK.ts | 129 + src/EnvoyPluginStorage.ts | 58 + src/EnvoyPluginStoragePipeline.ts | 84 + src/EnvoyRequest.ts | 13 + src/EnvoyResponse.ts | 7 + src/EnvoySignatureVerifier.ts | 61 + src/EnvoyStorageCommand.ts | 43 + src/EnvoyStorageItem.ts | 4 + src/HttpStatus.ts | 7 + src/asyncHandler.ts | 19 + src/constants.ts | 4 + src/errorMiddleware.ts | 19 + src/middleware.ts | 66 + src/payloads/EntryPayload.ts | 59 + src/payloads/InvitePayload.ts | 58 + src/resources/AgreementPageResource.ts | 10 + src/resources/AgreementResource.ts | 17 + src/resources/CompanyResource.ts | 12 + src/resources/CompanyRoleResource.ts | 0 src/resources/EmployeeResource.ts | 32 + src/resources/FlowResource.ts | 20 + src/resources/InviteResource.ts | 71 + src/resources/LocationResource.ts | 52 + src/resources/SignInFieldPageResource.ts | 14 + src/resources/SignInFieldResource.ts | 22 + src/resources/UserResource.ts | 8 + src/util/json-api/JSONAPIData.ts | 4 + src/util/json-api/JSONAPIFilterParams.ts | 5 + src/util/json-api/JSONAPIModel.ts | 10 + src/util/json-api/JSONAPIPaginationParams.ts | 12 + src/util/json-api/JSONAPIParams.ts | 3 + src/util/json-api/JSONAPIResponse.ts | 7 + tsconfig.json | 77 + 43 files changed, 3409 insertions(+), 501 deletions(-) create mode 100644 .eslintignore create mode 100644 src/EnvoyAPI.ts create mode 100644 src/EnvoyJWT.ts create mode 100644 src/EnvoyMeta.ts create mode 100644 src/EnvoyPluginJob.ts create mode 100644 src/EnvoyPluginJobAttachment.ts create mode 100644 src/EnvoyPluginJobUpdate.ts create mode 100644 src/EnvoyPluginSDK.ts create mode 100644 src/EnvoyPluginStorage.ts create mode 100644 src/EnvoyPluginStoragePipeline.ts create mode 100644 src/EnvoyRequest.ts create mode 100644 src/EnvoyResponse.ts create mode 100644 src/EnvoySignatureVerifier.ts create mode 100644 src/EnvoyStorageCommand.ts create mode 100644 src/EnvoyStorageItem.ts create mode 100644 src/HttpStatus.ts create mode 100644 src/asyncHandler.ts create mode 100644 src/constants.ts create mode 100644 src/errorMiddleware.ts create mode 100644 src/middleware.ts create mode 100644 src/payloads/EntryPayload.ts create mode 100644 src/payloads/InvitePayload.ts create mode 100644 src/resources/AgreementPageResource.ts create mode 100644 src/resources/AgreementResource.ts create mode 100644 src/resources/CompanyResource.ts create mode 100644 src/resources/CompanyRoleResource.ts create mode 100644 src/resources/EmployeeResource.ts create mode 100644 src/resources/FlowResource.ts create mode 100644 src/resources/InviteResource.ts create mode 100644 src/resources/LocationResource.ts create mode 100644 src/resources/SignInFieldPageResource.ts create mode 100644 src/resources/SignInFieldResource.ts create mode 100644 src/resources/UserResource.ts create mode 100644 src/util/json-api/JSONAPIData.ts create mode 100644 src/util/json-api/JSONAPIFilterParams.ts create mode 100644 src/util/json-api/JSONAPIModel.ts create mode 100644 src/util/json-api/JSONAPIPaginationParams.ts create mode 100644 src/util/json-api/JSONAPIParams.ts create mode 100644 src/util/json-api/JSONAPIResponse.ts create mode 100644 tsconfig.json diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..a56a7ef --- /dev/null +++ b/.eslintignore @@ -0,0 +1,2 @@ +node_modules + diff --git a/.eslintrc.js b/.eslintrc.js index fad69dd..25f4aad 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,46 +1,39 @@ module.exports = { - env: { - commonjs: true, - es6: true, - node: true, - }, - extends: 'airbnb-base', - globals: { - Atomics: 'readonly', - SharedArrayBuffer: 'readonly', - }, + extends: [ + 'airbnb-typescript/base', + 'plugin:@typescript-eslint/recommended', + 'plugin:@typescript-eslint/recommended-requiring-type-checking', + ], + parser: "@typescript-eslint/parser", parserOptions: { - ecmaVersion: 2018, + project: './tsconfig.json', }, rules: { - 'no-trailing-spaces': 'off', - 'padded-blocks': 'off', - 'no-console': 'off', - 'arrow-parens': 'off', - 'no-return-assign': 'off', - 'no-empty': 'off', + 'no-param-reassign': 'off', + 'no-void': 'off', + 'max-len': ["error", { "code": 120 }], 'consistent-return': 'off', - 'no-shadow': 'off', - 'no-plusplus': 'off', - 'no-case-declarations': 'off', - 'class-methods-use-this': 'off' + '@typescript-eslint/no-unsafe-assignment': 'off', + '@typescript-eslint/no-unsafe-return': 'off', + '@typescript-eslint/no-unsafe-call': 'off', + '@typescript-eslint/no-unsafe-member-access': 'off', + '@typescript-eslint/no-misused-promises': 'off', + '@typescript-eslint/no-unused-expressions': 'off', + '@typescript-eslint/restrict-template-expressions': 'off', }, overrides: [ { files: [ - 'tests/**/*.test.js' + 'test/**/*.ts' ], env: { mocha: true }, rules: { 'prefer-arrow-callback': 'off', - 'func-names': 'off', - 'no-loop-func': 'off', - 'no-await-in-loop': 'off', - 'no-restricted-syntax': 'off', - 'max-len': 'off' + 'func-names': 'off' } } - ] + ], + ignorePatterns: ["*.js"] }; diff --git a/package-lock.json b/package-lock.json index 9786be7..1812891 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,26 +1,32 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "1.0.0", + "version": "1.2.1", "lockfileVersion": 1, "requires": true, "dependencies": { "@babel/code-frame": { - "version": "7.5.5", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.5.5.tgz", - "integrity": "sha512-27d4lZoomVyo51VegxI20xZPuSHusqbQag/ztrBC7wegWoQ1nLREPVSKSW8byhTlzTKyNE4ifaTA6lCp7JjpFw==", + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", "dev": true, "requires": { - "@babel/highlight": "^7.0.0" + "@babel/highlight": "^7.10.4" } }, + "@babel/helper-validator-identifier": { + "version": "7.14.0", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.14.0.tgz", + "integrity": "sha512-V3ts7zMSu5lfiwWDVWzRDGIN+lnCEUdaXgtVHJgLb1rGaA6jMrtB9EmE7L18foXJIE8Un/A/h6NJfGQp/e1J4A==", + "dev": true + }, "@babel/highlight": { - "version": "7.5.0", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.5.0.tgz", - "integrity": "sha512-7dV4eu9gBxoM0dAnj/BCFDW9LFU0zvTrkq0ugM7pnHEgguOEeOz1so2ZghEdzviYzQEED0r4EAgpsBChKy1TRQ==", + "version": "7.14.0", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.0.tgz", + "integrity": "sha512-YSCOwxvTYEIMSGaBQb5kDDsCopDdiUGsqpatp3fOlI4+2HQSkTmEVWnVuySdAC5EWCqSWWTv0ib63RjR7dTBdg==", "dev": true, "requires": { + "@babel/helper-validator-identifier": "^7.14.0", "chalk": "^2.0.0", - "esutils": "^2.0.2", "js-tokens": "^4.0.0" } }, @@ -30,6 +36,105 @@ "integrity": "sha512-E5BN68cqR7dhKan1SfqgPGhQ178bkVKpXTPEXnFJBrEt8/DKRZlybmy+IgYLTeN7tp1R5Ccmbm2rBk17sHYU3g==", "dev": true }, + "@eslint/eslintrc": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.1.tgz", + "integrity": "sha512-5v7TDE9plVhvxQeWLXDTvFvJBdH6pEsdnl2g/dAptmuFEPedQ4Erq5rsDsX+mvAM610IhNaO2W5V1dOOnDKxkQ==", + "dev": true, + "requires": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^12.1.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "dependencies": { + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true + }, + "globals": { + "version": "12.4.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-12.4.0.tgz", + "integrity": "sha512-BWICuzzDvDoH54NHKCseDanAhE3CeDorgDL5MT6LMXXj2WCnd9UC2szdk4AWLfjdgNBCXLUanXYcpBBKOSWGwg==", + "dev": true, + "requires": { + "type-fest": "^0.8.1" + } + }, + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + } + } + }, + "@nodelib/fs.scandir": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.4.tgz", + "integrity": "sha512-33g3pMJk3bg5nXbL/+CY6I2eJDzZAni49PfJnL5fghPTggPvBd/pFNSgJsdAgWptuFu7qq/ERvOYFlhvsLTCKA==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "2.0.4", + "run-parallel": "^1.1.9" + } + }, + "@nodelib/fs.stat": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.4.tgz", + "integrity": "sha512-IYlHJA0clt2+Vg7bccq+TzRdJvv19c2INqBSsoOLp1je7xjtr7J26+WXR72MCdvU9q1qTzIWDfhMf+DRvQJK4Q==", + "dev": true + }, + "@nodelib/fs.walk": { + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.6.tgz", + "integrity": "sha512-8Broas6vTtW4GIXTAHDoE32hnN2M5ykgCpWGbuXHQ15vEMqr23pB76e/GZcYsZCHALv50ktd24qhEyKr6wBtow==", + "dev": true, + "requires": { + "@nodelib/fs.scandir": "2.1.4", + "fastq": "^1.6.0" + } + }, "@sinonjs/commons": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.6.0.tgz", @@ -66,16 +171,271 @@ "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", "dev": true }, + "@types/body-parser": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", + "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", + "dev": true, + "requires": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "@types/connect": { + "version": "3.4.34", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", + "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", + "dev": true, + "requires": { + "@types/node": "*" + } + }, + "@types/express": { + "version": "4.17.12", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", + "integrity": "sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==", + "dev": true, + "requires": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.18", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "@types/express-serve-static-core": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.21.tgz", + "integrity": "sha512-gwCiEZqW6f7EoR8TTEfalyEhb1zA5jQJnRngr97+3pzMaO1RKoI1w2bw07TK72renMUVWcWS5mLI6rk1NqN0nA==", + "dev": true, + "requires": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*" + } + }, + "@types/json-schema": { + "version": "7.0.7", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", + "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", + "dev": true + }, + "@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", + "dev": true + }, + "@types/jsonwebtoken": { + "version": "8.5.1", + "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", + "integrity": "sha512-rNAPdomlIUX0i0cg2+I+Q1wOUr531zHBQ+cV/28PJ39bSPKjahatZZ2LMuhiguETkCgLVzfruw/ZvNMNkKoSzw==", + "dev": true, + "requires": { + "@types/node": "*" + } + }, + "@types/mime": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", + "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", + "dev": true + }, + "@types/node": { + "version": "15.12.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.0.tgz", + "integrity": "sha512-+aHJvoCsVhO2ZCuT4o5JtcPrCPyDE3+1nvbDprYes+pPkEsbjH7AGUCNtjMOXS0fqH14t+B7yLzaqSz92FPWyw==", + "dev": true + }, + "@types/qs": { + "version": "6.9.6", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", + "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==", + "dev": true + }, + "@types/range-parser": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", + "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", + "dev": true + }, + "@types/serve-static": { + "version": "1.13.9", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", + "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", + "dev": true, + "requires": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "@typescript-eslint/eslint-plugin": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.26.0.tgz", + "integrity": "sha512-yA7IWp+5Qqf+TLbd8b35ySFOFzUfL7i+4If50EqvjT6w35X8Lv0eBHb6rATeWmucks37w+zV+tWnOXI9JlG6Eg==", + "dev": true, + "requires": { + "@typescript-eslint/experimental-utils": "4.26.0", + "@typescript-eslint/scope-manager": "4.26.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "lodash": "^4.17.21", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "dependencies": { + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + } + } + }, + "@typescript-eslint/experimental-utils": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.26.0.tgz", + "integrity": "sha512-TH2FO2rdDm7AWfAVRB5RSlbUhWxGVuxPNzGT7W65zVfl8H/WeXTk1e69IrcEVsBslrQSTDKQSaJD89hwKrhdkw==", + "dev": true, + "requires": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.26.0", + "@typescript-eslint/types": "4.26.0", + "@typescript-eslint/typescript-estree": "4.26.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + } + }, + "@typescript-eslint/parser": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.26.0.tgz", + "integrity": "sha512-b4jekVJG9FfmjUfmM4VoOItQhPlnt6MPOBUL0AQbiTmm+SSpSdhHYlwayOm4IW9KLI/4/cRKtQCmDl1oE2OlPg==", + "dev": true, + "requires": { + "@typescript-eslint/scope-manager": "4.26.0", + "@typescript-eslint/types": "4.26.0", + "@typescript-eslint/typescript-estree": "4.26.0", + "debug": "^4.3.1" + }, + "dependencies": { + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + } + } + }, + "@typescript-eslint/scope-manager": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.26.0.tgz", + "integrity": "sha512-G6xB6mMo4xVxwMt5lEsNTz3x4qGDt0NSGmTBNBPJxNsrTXJSm21c6raeYroS2OwQsOyIXqKZv266L/Gln1BWqg==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.26.0", + "@typescript-eslint/visitor-keys": "4.26.0" + } + }, + "@typescript-eslint/types": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.26.0.tgz", + "integrity": "sha512-rADNgXl1kS/EKnDr3G+m7fB9yeJNnR9kF7xMiXL6mSIWpr3Wg5MhxyfEXy/IlYthsqwBqHOr22boFbf/u6O88A==", + "dev": true + }, + "@typescript-eslint/typescript-estree": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.26.0.tgz", + "integrity": "sha512-GHUgahPcm9GfBuy3TzdsizCcPjKOAauG9xkz9TR8kOdssz2Iz9jRCSQm6+aVFa23d5NcSpo1GdHGSQKe0tlcbg==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.26.0", + "@typescript-eslint/visitor-keys": "4.26.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "dependencies": { + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + } + } + }, + "@typescript-eslint/visitor-keys": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.26.0.tgz", + "integrity": "sha512-cw4j8lH38V1ycGBbF+aFiLUls9Z0Bw8QschP3mkth50BbWzgFS33ISIgBzUMuQ2IdahoEv/rXstr8Zhlz4B1Zg==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.26.0", + "eslint-visitor-keys": "^2.0.0" + } + }, "acorn": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.3.0.tgz", - "integrity": "sha512-/czfa8BwS88b9gWQVhc8eknunSA2DoJpJyTQkhheIf5E48u1N0R4q/YxxsAeqRrmK9TQ/uYfgLDfZo91UlANIA==", + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", "dev": true }, "acorn-jsx": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.0.2.tgz", - "integrity": "sha512-tiNTrP1MP0QrChmD2DdupCr6HWSFeKVw5d/dHTu4Y7rkAkRhU/Dt7dphAfIUyxtHpl/eBVip5uTNSpQJHylpAw==", + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.1.tgz", + "integrity": "sha512-K0Ptm/47OKfQRpNQ2J/oIN/3QYiK6FwW+eJbILhsdxh2WTLdl+30o8aGdTbm5JbffpFFAg/g+zi1E+jvJha5ng==", "dev": true }, "ajv": { @@ -104,15 +464,6 @@ "array-back": "^3.0.1" } }, - "ansi-escapes": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.2.1.tgz", - "integrity": "sha512-Cg3ymMAdN10wOk/VYfLV7KCQyv7EDirJ64500sU7n9UlmioEtDuU5Gd+hj73hXSU/ex7tHJSssmyftDdkMLO8Q==", - "dev": true, - "requires": { - "type-fest": "^0.5.2" - } - }, "ansi-regex": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", @@ -150,13 +501,175 @@ "dev": true }, "array-includes": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.0.3.tgz", - "integrity": "sha1-GEtI9i2S10UrsxsyMWXH+L0CJm0=", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.3.tgz", + "integrity": "sha512-gcem1KlBU7c9rB+Rq8/3PPKsK2kjqeEBa3bD5kkQo4nYlOHQCJqIJFqBXDEfwaRuYTT4E+FxA9xez7Gf/e3Q7A==", "dev": true, "requires": { - "define-properties": "^1.1.2", - "es-abstract": "^1.7.0" + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.2", + "get-intrinsic": "^1.1.1", + "is-string": "^1.0.5" + }, + "dependencies": { + "es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + } + }, + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true + }, + "is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + } + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + } + } + }, + "array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true + }, + "array.prototype.flat": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.4.tgz", + "integrity": "sha512-4470Xi3GAPAjZqFcljX2xzckv1qeKPizoNkiS0+O4IoPR2ZNpcjE0pkhdihlDouK+x6QOast26B4Q/O9DJnwSg==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.1" + }, + "dependencies": { + "es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + } + }, + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true + }, + "is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + } + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + } } }, "asn1": { @@ -179,9 +692,9 @@ "dev": true }, "astral-regex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-1.0.0.tgz", - "integrity": "sha512-+Ryf6g3BKoRc7jfp7ad8tM4TtMiaWvbF/1/sQcZPkkS7ag3D5nMBCe2UfOTONtAkaG0tO0ij3C5Lwmf1EiyjHg==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", "dev": true }, "asynckit": { @@ -199,6 +712,14 @@ "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.8.0.tgz", "integrity": "sha512-ReZxvNHIOv88FlT7rxcXIIC0fPt4KZqZbOlivyWtXLt8ESx84zd3kMC6iK5jVeS2qt+g7ftS7ye4fi06X5rtRQ==" }, + "axios": { + "version": "0.21.1", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz", + "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==", + "requires": { + "follow-redirects": "^1.10.0" + } + }, "balanced-match": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", @@ -234,6 +755,13 @@ "qs": "6.7.0", "raw-body": "2.4.0", "type-is": "~1.6.17" + }, + "dependencies": { + "qs": { + "version": "6.7.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", + "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==" + } } }, "brace-expansion": { @@ -246,6 +774,15 @@ "concat-map": "0.0.1" } }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, "browser-stdout": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", @@ -284,6 +821,15 @@ } } }, + "call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "requires": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + } + }, "callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -335,33 +881,12 @@ "supports-color": "^5.3.0" } }, - "chardet": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", - "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==", - "dev": true - }, "check-error": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", "dev": true }, - "cli-cursor": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", - "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", - "dev": true, - "requires": { - "restore-cursor": "^3.1.0" - } - }, - "cli-width": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-2.2.0.tgz", - "integrity": "sha1-/xnt6Kml5XkyQUewwR8PvLq+1jk=", - "dev": true - }, "cliui": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", @@ -533,18 +1058,6 @@ } } }, - "confusing-browser-globals": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.8.tgz", - "integrity": "sha512-lI7asCibVJ6Qd3FGU7mu4sfG4try4LX3+GVS+Gv8UlrEf2AeW57piecapnog2UHZSbcX/P/1UDWVaTsblowlZg==", - "dev": true - }, - "contains-path": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/contains-path/-/contains-path-0.1.0.tgz", - "integrity": "sha1-/ozxhP9mcLa67wGp1IYaXL7EEgo=", - "dev": true - }, "content-type": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", @@ -576,6 +1089,11 @@ "assert-plus": "^1.0.0" } }, + "dataloader": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-2.0.0.tgz", + "integrity": "sha512-YzhyDAwA4TaQIhM5go+vCLmU0UikghC/t9DTQYZR2M/UvZ1MdOhPezSDZcjj9uqQJOMqjLcpWtyW2iNINdlatQ==" + }, "debug": { "version": "2.6.9", "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", @@ -636,6 +1154,15 @@ "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", "dev": true }, + "dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "requires": { + "path-type": "^4.0.0" + } + }, "dmd": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/dmd/-/dmd-4.0.0.tgz", @@ -715,6 +1242,23 @@ "once": "^1.4.0" } }, + "enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "requires": { + "ansi-colors": "^4.1.1" + }, + "dependencies": { + "ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true + } + } + }, "entities": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", @@ -762,162 +1306,579 @@ "dev": true }, "eslint": { - "version": "5.16.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-5.16.0.tgz", - "integrity": "sha512-S3Rz11i7c8AA5JPv7xAH+dOyq/Cu/VXHiHXBPOU1k/JAM5dXqQPt3qcrhpHSorXmrpu2g0gkIBVXAqCpzfoZIg==", + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.27.0.tgz", + "integrity": "sha512-JZuR6La2ZF0UD384lcbnd0Cgg6QJjiCwhMD6eU4h/VGPcVGwawNNzKU41tgokGXnfjOOyI6QIffthhJTPzzuRA==", + "dev": true, + "requires": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.1", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.0.0", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "dependencies": { + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "dev": true + }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", + "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true + }, + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + }, + "strip-ansi": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.0" + } + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } + } + } + }, + "eslint-config-airbnb": { + "version": "18.2.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb/-/eslint-config-airbnb-18.2.1.tgz", + "integrity": "sha512-glZNDEZ36VdlZWoxn/bUR1r/sdFKPd1mHPbqUtkctgNG4yT2DLLtJ3D+yCV+jzZCc2V1nBVkmdknOJBZ5Hc0fg==", "dev": true, "requires": { - "@babel/code-frame": "^7.0.0", - "ajv": "^6.9.1", - "chalk": "^2.1.0", - "cross-spawn": "^6.0.5", - "debug": "^4.0.1", - "doctrine": "^3.0.0", - "eslint-scope": "^4.0.3", - "eslint-utils": "^1.3.1", - "eslint-visitor-keys": "^1.0.0", - "espree": "^5.0.1", - "esquery": "^1.0.1", - "esutils": "^2.0.2", - "file-entry-cache": "^5.0.1", - "functional-red-black-tree": "^1.0.1", - "glob": "^7.1.2", - "globals": "^11.7.0", - "ignore": "^4.0.6", - "import-fresh": "^3.0.0", - "imurmurhash": "^0.1.4", - "inquirer": "^6.2.2", - "js-yaml": "^3.13.0", - "json-stable-stringify-without-jsonify": "^1.0.1", - "levn": "^0.3.0", - "lodash": "^4.17.11", - "minimatch": "^3.0.4", - "mkdirp": "^0.5.1", - "natural-compare": "^1.4.0", - "optionator": "^0.8.2", - "path-is-inside": "^1.0.2", - "progress": "^2.0.0", - "regexpp": "^2.0.1", - "semver": "^5.5.1", - "strip-ansi": "^4.0.0", - "strip-json-comments": "^2.0.1", - "table": "^5.2.3", - "text-table": "^0.2.0" + "eslint-config-airbnb-base": "^14.2.1", + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" }, "dependencies": { - "debug": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", - "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", + "confusing-browser-globals": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", + "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", + "dev": true + }, + "es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", "dev": true, "requires": { - "ms": "^2.1.1" + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" } }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "eslint-config-airbnb-base": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", + "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", + "dev": true, + "requires": { + "confusing-browser-globals": "^1.0.10", + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" + } + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", "dev": true + }, + "is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true + }, + "is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + } + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + }, + "object.entries": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", + "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.2" + } } } }, - "eslint-config-airbnb-base": { - "version": "13.2.0", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-13.2.0.tgz", - "integrity": "sha512-1mg/7eoB4AUeB0X1c/ho4vb2gYkNH8Trr/EgCT/aGmKhhG+F6vF5s8+iRBlWAzFIAphxIdp3YfEKgEl0f9Xg+w==", + "eslint-config-airbnb-typescript": { + "version": "12.3.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-typescript/-/eslint-config-airbnb-typescript-12.3.1.tgz", + "integrity": "sha512-ql/Pe6/hppYuRp4m3iPaHJqkBB7dgeEmGPQ6X0UNmrQOfTF+dXw29/ZjU2kQ6RDoLxaxOA+Xqv07Vbef6oVTWw==", "dev": true, "requires": { - "confusing-browser-globals": "^1.0.5", - "object.assign": "^4.1.0", - "object.entries": "^1.1.0" + "@typescript-eslint/parser": "^4.4.1", + "eslint-config-airbnb": "^18.2.0", + "eslint-config-airbnb-base": "^14.2.0" + }, + "dependencies": { + "confusing-browser-globals": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", + "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", + "dev": true + }, + "es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + } + }, + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "eslint-config-airbnb-base": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", + "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", + "dev": true, + "requires": { + "confusing-browser-globals": "^1.0.10", + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" + } + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true + }, + "is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + } + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + }, + "object.entries": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", + "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.2" + } + } } }, "eslint-import-resolver-node": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.2.tgz", - "integrity": "sha512-sfmTqJfPSizWu4aymbPr4Iidp5yKm8yDkHp+Ir3YiTHiiDfxh69mOUsmiqW6RZ9zRXFaF64GtYmN7e+8GHBv6Q==", + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.4.tgz", + "integrity": "sha512-ogtf+5AB/O+nM6DIeBUNr2fuT7ot9Qg/1harBfBtaP13ekEWFQEEMP94BCB7zaNW3gyY+8SHYF00rnqYwXKWOA==", "dev": true, "requires": { "debug": "^2.6.9", - "resolve": "^1.5.0" + "resolve": "^1.13.1" + }, + "dependencies": { + "resolve": { + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", + "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", + "dev": true, + "requires": { + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" + } + } } }, "eslint-module-utils": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.4.1.tgz", - "integrity": "sha512-H6DOj+ejw7Tesdgbfs4jeS4YMFrT8uI8xwd1gtQqXssaR0EQ26L+2O/w6wkYFy2MymON0fTwHmXBvvfLNZVZEw==", + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.6.1.tgz", + "integrity": "sha512-ZXI9B8cxAJIH4nfkhTwcRTEAnrVfobYqwjWy/QMCZ8rHkZHFjf9yO4BzpiF9kCSfNlMG54eKigISHpX0+AaT4A==", "dev": true, "requires": { - "debug": "^2.6.8", + "debug": "^3.2.7", "pkg-dir": "^2.0.0" + }, + "dependencies": { + "debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + }, + "ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true + } } }, "eslint-plugin-import": { - "version": "2.18.2", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.18.2.tgz", - "integrity": "sha512-5ohpsHAiUBRNaBWAF08izwUGlbrJoJJ+W9/TBwsGoR1MnlgfwMIKrFeSjWbt6moabiXW9xNvtFz+97KHRfI4HQ==", + "version": "2.23.4", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.23.4.tgz", + "integrity": "sha512-6/wP8zZRsnQFiR3iaPFgh5ImVRM1WN5NUWfTIRqwOdeiGJlBcSk82o1FEVq8yXmy4lkIzTo7YhHCIxlU/2HyEQ==", "dev": true, "requires": { - "array-includes": "^3.0.3", - "contains-path": "^0.1.0", + "array-includes": "^3.1.3", + "array.prototype.flat": "^1.2.4", "debug": "^2.6.9", - "doctrine": "1.5.0", - "eslint-import-resolver-node": "^0.3.2", - "eslint-module-utils": "^2.4.0", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.4", + "eslint-module-utils": "^2.6.1", + "find-up": "^2.0.0", "has": "^1.0.3", + "is-core-module": "^2.4.0", "minimatch": "^3.0.4", - "object.values": "^1.1.0", - "read-pkg-up": "^2.0.0", - "resolve": "^1.11.0" + "object.values": "^1.1.3", + "pkg-up": "^2.0.0", + "read-pkg-up": "^3.0.0", + "resolve": "^1.20.0", + "tsconfig-paths": "^3.9.0" }, "dependencies": { "doctrine": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-1.5.0.tgz", - "integrity": "sha1-N53Ocw9hZvds76TmcHoVmwLFpvo=", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "resolve": { + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", + "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", "dev": true, "requires": { - "esutils": "^2.0.2", - "isarray": "^1.0.0" + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" } } } }, "eslint-scope": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-4.0.3.tgz", - "integrity": "sha512-p7VutNr1O/QrxysMo3E45FjYDTeXBy0iTltPFNSqKAIfjDSXC+4dj+qfyuD8bfAXrW/y6lW3O76VaYNPKfpKrg==", + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", "dev": true, "requires": { - "esrecurse": "^4.1.0", + "esrecurse": "^4.3.0", "estraverse": "^4.1.1" } }, "eslint-utils": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-1.4.2.tgz", - "integrity": "sha512-eAZS2sEUMlIeCjBeubdj45dmBHQwPHWyBcT1VSYB7o9x9WRRqKxyUoiXlRjyAwzN7YEzHJlYg0NmzDRWx6GP4Q==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", "dev": true, "requires": { - "eslint-visitor-keys": "^1.0.0" + "eslint-visitor-keys": "^2.0.0" } }, "eslint-visitor-keys": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.1.0.tgz", - "integrity": "sha512-8y9YjtM1JBJU/A9Kc+SbaOV4y29sSWckBwMHa+FGtVj5gN/sbnKDf6xJUl+8g7FAij9LVaP8C24DUiH/f/2Z9A==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", "dev": true }, "espree": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/espree/-/espree-5.0.1.tgz", - "integrity": "sha512-qWAZcWh4XE/RwzLJejfcofscgMc9CamR6Tn1+XRXNzrvUSSbiAjGOI/fggztjIi7y9VLPqnICMIPiGyr8JaZ0A==", + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", "dev": true, "requires": { - "acorn": "^6.0.7", - "acorn-jsx": "^5.0.0", - "eslint-visitor-keys": "^1.0.0" + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } } }, "esprima": { @@ -927,21 +1888,37 @@ "dev": true }, "esquery": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.0.1.tgz", - "integrity": "sha512-SmiyZ5zIWH9VM+SRUReLS5Q8a7GxtRdxEBVZpm98rJM7Sb+A9DVCndXfkeFUd3byderg+EbDkfnevfCwynWaNA==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", "dev": true, "requires": { - "estraverse": "^4.0.0" + "estraverse": "^5.1.0" + }, + "dependencies": { + "estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true + } } }, "esrecurse": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.2.1.tgz", - "integrity": "sha512-64RBB++fIOAXPw3P9cy89qfMlvZEXZkqqJkjqqXIvzP5ezRZjW+lPWjw35UX/3EhUPFYbg5ER4JYgDw4007/DQ==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", "dev": true, "requires": { - "estraverse": "^4.1.0" + "estraverse": "^5.2.0" + }, + "dependencies": { + "estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true + } } }, "estraverse": { @@ -976,17 +1953,6 @@ "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" }, - "external-editor": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", - "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==", - "dev": true, - "requires": { - "chardet": "^0.7.0", - "iconv-lite": "^0.4.24", - "tmp": "^0.0.33" - } - }, "extsprintf": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", @@ -997,6 +1963,20 @@ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=" }, + "fast-glob": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.5.tgz", + "integrity": "sha512-2DtFcgT68wiTTiwZ2hNdJfcHNke9XOfnwmBRWXhmeKM8rF0TGwmC/Qto3S7RoZKp5cilZbxzO5iTNTQsJ+EeDg==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.0", + "merge2": "^1.3.0", + "micromatch": "^4.0.2", + "picomatch": "^2.2.1" + } + }, "fast-json-stable-stringify": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", @@ -1008,22 +1988,22 @@ "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", "dev": true }, - "figures": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/figures/-/figures-3.0.0.tgz", - "integrity": "sha512-HKri+WoWoUgr83pehn/SIgLOMZ9nAWC6dcGj26RY2R4F50u4+RTUz0RCrUlOV3nKRAICW1UGzyb+kcX2qK1S/g==", + "fastq": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.11.0.tgz", + "integrity": "sha512-7Eczs8gIPDrVzT+EksYBcupqMyxSHXXrHOLRRxU2/DicV8789MRBRR8+Hc2uWzUupOs4YS4JzBmBxjjCVBxD/g==", "dev": true, "requires": { - "escape-string-regexp": "^1.0.5" + "reusify": "^1.0.4" } }, "file-entry-cache": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-5.0.1.tgz", - "integrity": "sha512-bCg29ictuBaKUwwArK4ouCaqDgLZcysCFLmM/Yn/FDoqndh/9vNuQfXRDvTuXKLxfD/JtZQGKFT8MGcJBK644g==", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", "dev": true, "requires": { - "flat-cache": "^2.0.1" + "flat-cache": "^3.0.4" } }, "file-set": { @@ -1057,6 +2037,15 @@ "merge-descriptors": "~1.0.0" } }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, "find-replace": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-3.0.0.tgz", @@ -1085,22 +2074,26 @@ } }, "flat-cache": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-2.0.1.tgz", - "integrity": "sha512-LoQe6yDuUMDzQAEH8sgmh4Md6oZnc/7PjtwjNFSzveXqSHt6ka9fPBuso7IGf9Rz4uqnSnWiFH2B/zj24a5ReA==", + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", "dev": true, "requires": { - "flatted": "^2.0.0", - "rimraf": "2.6.3", - "write": "1.0.3" + "flatted": "^3.1.0", + "rimraf": "^3.0.2" } }, "flatted": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-2.0.1.tgz", - "integrity": "sha512-a1hQMktqW9Nmqr5aktAux3JMNqaucxGcjtjWnZLHX7yyPCmlSV3M54nGYbqT8K+0GhF3NBgmJCc3ma+WOgX8Jg==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.1.1.tgz", + "integrity": "sha512-zAoAQiudy+r5SvnSw3KJy5os/oRJYHzrzja/tBDqrZtNhUw8bt6y8OBzMWcjWr+8liV8Eb6yOhw8WZ7VFZ5ZzA==", "dev": true }, + "follow-redirects": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.1.tgz", + "integrity": "sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg==" + }, "forever-agent": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", @@ -1131,8 +2124,7 @@ "function-bind": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", - "dev": true + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" }, "functional-red-black-tree": { "version": "1.0.1", @@ -1152,6 +2144,23 @@ "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", "dev": true }, + "get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "requires": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + }, + "dependencies": { + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==" + } + } + }, "get-stream": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", @@ -1183,11 +2192,45 @@ "path-is-absolute": "^1.0.0" } }, + "glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "requires": { + "is-glob": "^4.0.1" + } + }, "globals": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", - "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", - "dev": true + "version": "13.9.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.9.0.tgz", + "integrity": "sha512-74/FduwI/JaIrr1H8e71UbDE+5x7pIPs1C2rrwC52SszOo043CsWOZEMW7o2Y58xwm9b+0RBKDxY5n2sUpEFxA==", + "dev": true, + "requires": { + "type-fest": "^0.20.2" + }, + "dependencies": { + "type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true + } + } + }, + "globby": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", + "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==", + "dev": true, + "requires": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.1.1", + "ignore": "^5.1.4", + "merge2": "^1.3.0", + "slash": "^3.0.0" + } }, "graceful-fs": { "version": "4.2.2", @@ -1240,11 +2283,16 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", - "dev": true, "requires": { "function-bind": "^1.1.1" } }, + "has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true + }, "has-flag": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", @@ -1264,9 +2312,9 @@ "dev": true }, "hosted-git-info": { - "version": "2.8.4", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.4.tgz", - "integrity": "sha512-pzXIvANXEFrc5oFFXRMkbLPQ2rXRoDERwDLyrcUxGhaZhgP54BBSl9Oheh7Vv0T090cszWBxPjkQQ5Sq1PbBRQ==", + "version": "2.8.9", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", + "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", "dev": true }, "http-errors": { @@ -1300,15 +2348,15 @@ } }, "ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "version": "5.1.8", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", + "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", "dev": true }, "import-fresh": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.1.0.tgz", - "integrity": "sha512-PpuksHKGt8rXfWEr9m9EHIpgyyaltBy8+eF6GJM0QCAxMgxCfucMF3mjecK2QsJr0amJW7gTqh5/wht0z2UhEQ==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", "dev": true, "requires": { "parent-module": "^1.0.0", @@ -1336,38 +2384,6 @@ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" }, - "inquirer": { - "version": "6.5.1", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-6.5.1.tgz", - "integrity": "sha512-uxNHBeQhRXIoHWTSNYUFhQVrHYFThIt6IVo2fFmSe8aBwdR3/w6b58hJpiL/fMukFkvGzjg+hSxFtwvVmKZmXw==", - "dev": true, - "requires": { - "ansi-escapes": "^4.2.1", - "chalk": "^2.4.2", - "cli-cursor": "^3.1.0", - "cli-width": "^2.0.0", - "external-editor": "^3.0.3", - "figures": "^3.0.0", - "lodash": "^4.17.15", - "mute-stream": "0.0.8", - "run-async": "^2.2.0", - "rxjs": "^6.4.0", - "string-width": "^4.1.0", - "strip-ansi": "^5.1.0", - "through": "^2.3.6" - }, - "dependencies": { - "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "requires": { - "ansi-regex": "^4.1.0" - } - } - } - }, "invert-kv": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", @@ -1380,6 +2396,21 @@ "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", "dev": true }, + "is-bigint": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", + "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", + "dev": true + }, + "is-boolean-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", + "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", + "dev": true, + "requires": { + "call-bind": "^1.0.2" + } + }, "is-buffer": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.3.tgz", @@ -1392,30 +2423,66 @@ "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==", "dev": true }, + "is-core-module": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.4.0.tgz", + "integrity": "sha512-6A2fkfq1rfeQZjxrZJGerpLCTHRNEBiSgnu0+obeJpEPZRUooHgsizvzv0ZjJwOz3iWIHdJtVWJ/tmPr3D21/A==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, "is-date-object": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.1.tgz", "integrity": "sha1-mqIOtq7rv/d/vTPnTKAbM1gdOhY=", "dev": true }, + "is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true + }, "is-fullwidth-code-point": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", "dev": true }, + "is-glob": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", + "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", + "dev": true, + "requires": { + "is-extglob": "^2.1.1" + } + }, + "is-negative-zero": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.1.tgz", + "integrity": "sha512-2z6JzQvZRa9A2Y7xC6dQQm4FSTSTNWjKIYYTt4246eMTJmIo0Q+ZyOsU66X8lxK1AbB92dFeglPLrhwpeRKO6w==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "is-number-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", + "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", + "dev": true + }, "is-object": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.1.tgz", "integrity": "sha1-iVJojF7C/9awPsyF52ngKQMINHA=", "dev": true }, - "is-promise": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-2.1.0.tgz", - "integrity": "sha1-eaKp7OfwlugPNtKy87wWwf9L8/o=", - "dev": true - }, "is-regex": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", @@ -1431,6 +2498,12 @@ "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", "dev": true }, + "is-string": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", + "integrity": "sha512-2gdzbKUuqtQ3lYNrUTQYoClPhm7oQu4UdpSZMp1/DGgkHBT8E2Z1l0yMdb6D4zNAxwDiMv8MdulKROJGNl0Q0w==", + "dev": true + }, "is-symbol": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.2.tgz", @@ -1445,12 +2518,6 @@ "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=" }, - "isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", - "dev": true - }, "isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -1591,6 +2658,12 @@ "walk-back": "^3.0.1" } }, + "json-parse-better-errors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", + "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", + "dev": true + }, "json-schema": { "version": "0.2.3", "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", @@ -1612,6 +2685,23 @@ "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=" }, + "json5": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", + "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "dev": true, + "requires": { + "minimist": "^1.2.0" + }, + "dependencies": { + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + } + } + }, "jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", @@ -1691,13 +2781,13 @@ } }, "levn": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz", - "integrity": "sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4=", + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", "dev": true, "requires": { - "prelude-ls": "~1.1.2", - "type-check": "~0.3.2" + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" } }, "linkify-it": { @@ -1710,14 +2800,14 @@ } }, "load-json-file": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz", - "integrity": "sha1-eUfkIUmvgNaWy/eXvKq8/h/inKg=", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", + "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", "dev": true, "requires": { "graceful-fs": "^4.1.2", - "parse-json": "^2.2.0", - "pify": "^2.0.0", + "parse-json": "^4.0.0", + "pify": "^3.0.0", "strip-bom": "^3.0.0" } }, @@ -1742,6 +2832,12 @@ "integrity": "sha1-soqmKIorn8ZRA1x3EfZathkDMaY=", "dev": true }, + "lodash.clonedeep": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", + "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", + "dev": true + }, "lodash.includes": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", @@ -1772,6 +2868,12 @@ "resolved": "https://registry.npmjs.org/lodash.isstring/-/lodash.isstring-4.0.1.tgz", "integrity": "sha1-1SfftUVuynzJu5XV2ur4i6VKVFE=" }, + "lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, "lodash.omit": { "version": "4.5.0", "resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz", @@ -1795,6 +2897,12 @@ "integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=", "dev": true }, + "lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true + }, "log-symbols": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", @@ -1810,6 +2918,15 @@ "integrity": "sha512-gKO5uExCXvSm6zbF562EvM+rd1kQDnB9AZBbiQVzf1ZmdDpxUSvpnAaVOP83N/31mRK8Ml8/VE8DMvsAZQ+7wg==", "dev": true }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, "map-age-cleaner": { "version": "0.1.3", "resolved": "https://registry.npmjs.org/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz", @@ -1872,6 +2989,22 @@ "integrity": "sha1-sAqqVW3YtEVoFQ7J0blT8/kMu2E=", "dev": true }, + "merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true + }, + "micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + } + }, "mime-db": { "version": "1.40.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.40.0.tgz", @@ -2046,12 +3179,6 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" }, - "mute-stream": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", - "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", - "dev": true - }, "natural-compare": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", @@ -2131,6 +3258,11 @@ "integrity": "sha1-ciu9tgA576R8rTxtws5RqFwCxa4=", "dev": true }, + "object-inspect": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.10.3.tgz", + "integrity": "sha512-e5mCJlSH7poANfC8z8S9s9S2IN5/4Zb3aZ33f5s8YqoazCFzNLloLU8r5VCG+G7WoqLvAAZoVMcy3tp/3X0Plw==" + }, "object-keys": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", @@ -2155,18 +3287,6 @@ "object-keys": "^1.0.11" } }, - "object.entries": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.0.tgz", - "integrity": "sha512-l+H6EQ8qzGRxbkHOd5I/aHRhHDKoQXQ8g0BYt4uSweQU1/J6dZUOyWh9a2Vky35YCKjzmgxOzta2hH6kf9HuXA==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.12.0", - "function-bind": "^1.1.1", - "has": "^1.0.3" - } - }, "object.getownpropertydescriptors": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz", @@ -2178,15 +3298,85 @@ } }, "object.values": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.0.tgz", - "integrity": "sha512-8mf0nKLAoFX6VlNVdhGj31SVYpaNFtUnuoOXWyFEstsWRgU837AK+JYM0iAxwkSzGRbwn8cbFmgbyxj1j4VbXg==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.4.tgz", + "integrity": "sha512-TnGo7j4XSnKQoK3MfvkzqKCi0nVe/D9I9IjwTNYdb/fxYHpjrluHVOgw0AF6jrRFGMPHdfuidR09tIDiIvnaSg==", "dev": true, "requires": { + "call-bind": "^1.0.2", "define-properties": "^1.1.3", - "es-abstract": "^1.12.0", - "function-bind": "^1.1.1", - "has": "^1.0.3" + "es-abstract": "^1.18.2" + }, + "dependencies": { + "es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + } + }, + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true + }, + "is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + } + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + } } }, "on-finished": { @@ -2206,27 +3396,18 @@ "wrappy": "1" } }, - "onetime": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.0.tgz", - "integrity": "sha512-5NcSkPHhwTVFIQN+TUqXoS5+dlElHXdpAWu9I0HP20YOtIi+aZ0Ct82jdlILDxjLEAWwvm+qj1m6aEtsDVmm6Q==", - "dev": true, - "requires": { - "mimic-fn": "^2.1.0" - } - }, "optionator": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.2.tgz", - "integrity": "sha1-NkxeQJ0/TWMB1sC0wFu6UBgK62Q=", + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", "dev": true, "requires": { - "deep-is": "~0.1.3", - "fast-levenshtein": "~2.0.4", - "levn": "~0.3.0", - "prelude-ls": "~1.1.2", - "type-check": "~0.3.2", - "wordwrap": "~1.0.0" + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" } }, "os-locale": { @@ -2240,12 +3421,6 @@ "mem": "^4.0.0" } }, - "os-tmpdir": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", - "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=", - "dev": true - }, "p-defer": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/p-defer/-/p-defer-1.0.0.tgz", @@ -2298,12 +3473,13 @@ } }, "parse-json": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-2.2.0.tgz", - "integrity": "sha1-9ID0BDTvgHQfhGkJn43qGPVaTck=", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", "dev": true, "requires": { - "error-ex": "^1.2.0" + "error-ex": "^1.3.1", + "json-parse-better-errors": "^1.0.1" } }, "path-exists": { @@ -2318,12 +3494,6 @@ "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", "dev": true }, - "path-is-inside": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", - "integrity": "sha1-NlQX3t5EQw0cEa9hAn+s8HS9/FM=", - "dev": true - }, "path-key": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", @@ -2354,13 +3524,10 @@ } }, "path-type": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-2.0.0.tgz", - "integrity": "sha1-8BLMuEFbcJb8LaoQVMPXI4lZTHM=", - "dev": true, - "requires": { - "pify": "^2.0.0" - } + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true }, "pathval": { "version": "1.1.0", @@ -2373,10 +3540,16 @@ "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=" }, - "pify": { + "picomatch": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz", - "integrity": "sha1-7RQaasBDqEnqWISY59yosVMw6Qw=", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", + "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", + "dev": true + }, + "pify": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", + "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", "dev": true }, "pkg-dir": { @@ -2388,10 +3561,19 @@ "find-up": "^2.1.0" } }, + "pkg-up": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/pkg-up/-/pkg-up-2.0.0.tgz", + "integrity": "sha1-yBmscoBZpGHKscOImivjxJoATX8=", + "dev": true, + "requires": { + "find-up": "^2.1.0" + } + }, "prelude-ls": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", - "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true }, "progress": { @@ -2432,9 +3614,18 @@ "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" }, "qs": { - "version": "6.7.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", - "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==" + "version": "6.10.1", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.10.1.tgz", + "integrity": "sha512-M528Hph6wsSVOBiYUnGf+K/7w0hNshs/duGsNXPUCLH5XAqjEtiPGwNONLV0tBH8NoGb0mvD5JubnUTrujKDTg==", + "requires": { + "side-channel": "^1.0.4" + } + }, + "queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true }, "raw-body": { "version": "2.4.0", @@ -2448,24 +3639,35 @@ } }, "read-pkg": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-2.0.0.tgz", - "integrity": "sha1-jvHAYjxqbbDcZxPEv6xGMysjaPg=", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", + "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", "dev": true, "requires": { - "load-json-file": "^2.0.0", + "load-json-file": "^4.0.0", "normalize-package-data": "^2.3.2", - "path-type": "^2.0.0" + "path-type": "^3.0.0" + }, + "dependencies": { + "path-type": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", + "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", + "dev": true, + "requires": { + "pify": "^3.0.0" + } + } } }, "read-pkg-up": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-2.0.0.tgz", - "integrity": "sha1-a3KoBImE4MQeeVEP1en6mbO1Sb4=", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", + "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", "dev": true, "requires": { "find-up": "^2.0.0", - "read-pkg": "^2.0.0" + "read-pkg": "^3.0.0" } }, "reduce-extract": { @@ -2541,9 +3743,9 @@ } }, "regexpp": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-2.0.1.tgz", - "integrity": "sha512-lv0M6+TkDVniA3aD1Eg0DVpfU/booSu7Eev3TDO/mZKHBfVjgCGTV4t4buppESEYDtkArYFOxTJWv6S5C+iaNw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.1.0.tgz", + "integrity": "sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q==", "dev": true }, "request": { @@ -2604,6 +3806,12 @@ "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", "dev": true }, + "require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true + }, "require-main-filename": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", @@ -2634,41 +3842,28 @@ "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", "dev": true }, - "restore-cursor": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", - "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", - "dev": true, - "requires": { - "onetime": "^5.1.0", - "signal-exit": "^3.0.2" - } + "reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true }, "rimraf": { - "version": "2.6.3", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz", - "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", "dev": true, "requires": { "glob": "^7.1.3" } }, - "run-async": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.3.0.tgz", - "integrity": "sha1-A3GrSuC91yDUFm19/aZP96RFpsA=", - "dev": true, - "requires": { - "is-promise": "^2.1.0" - } - }, - "rxjs": { - "version": "6.5.2", - "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.5.2.tgz", - "integrity": "sha512-HUb7j3kvb7p7eCUHE3FqjoDsC1xfZQ4AHFWfTKSpZ+sAhhz5X1WX0ZuUqWbzB2QhSLp3DoLUG+hMdEDKqWo2Zg==", + "run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", "dev": true, "requires": { - "tslib": "^1.9.0" + "queue-microtask": "^1.2.2" } }, "safe-buffer": { @@ -2712,6 +3907,16 @@ "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", "dev": true }, + "side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "requires": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + } + }, "signal-exit": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", @@ -2733,21 +3938,45 @@ "supports-color": "^5.5.0" } }, + "slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true + }, "slice-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-2.1.0.tgz", - "integrity": "sha512-Qu+VC3EwYLldKa1fCxuuvULvSJOKEgk9pi8dZeCVK7TqBfUNTH4sFkk4joj8afVSfAYgJoSOetjx9QWOJ5mYoQ==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", "dev": true, "requires": { - "ansi-styles": "^3.2.0", - "astral-regex": "^1.0.0", - "is-fullwidth-code-point": "^2.0.0" + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" }, "dependencies": { - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true } } @@ -2781,9 +4010,9 @@ "dev": true }, "spdx-correct": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", - "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", + "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", "dev": true, "requires": { "spdx-expression-parse": "^3.0.0", @@ -2791,15 +4020,15 @@ } }, "spdx-exceptions": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.2.0.tgz", - "integrity": "sha512-2XQACfElKi9SlVb1CYadKDXvoajPgBVPn/gOQLrTvHdElaVhr7ZEbqJaRnJLVNeaI4cMEAgVCeBMKF6MWRDCRA==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", + "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", "dev": true }, "spdx-expression-parse": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.0.tgz", - "integrity": "sha512-Yg6D3XpRD4kkOmTpdgbUiEJFKghJH03fiC1OPll5h/0sO6neh2jqRDVHOQ4o/LMea0tgCkbMgea5ip/e+MkWyg==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", + "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", "dev": true, "requires": { "spdx-exceptions": "^2.1.0", @@ -2807,9 +4036,9 @@ } }, "spdx-license-ids": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.5.tgz", - "integrity": "sha512-J+FWzZoynJEXGphVIS+XEh3kFSjZX/1i9gFBaWQcB+/tmpe2qUsSBABpcxqxnAxFdiUFEgAX1bjYGQvIZmoz9Q==", + "version": "3.0.9", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.9.tgz", + "integrity": "sha512-Ki212dKK4ogX+xDo4CtOZBVIwhsKBEfsEEcwmJfLQzirgc2jIWdzg40Unxz/HzEUqM1WFzVlQSMF9kZZ2HboLQ==", "dev": true }, "sprintf-js": { @@ -2871,27 +4100,53 @@ "dev": true }, "string-width": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.1.0.tgz", - "integrity": "sha512-NrX+1dVVh+6Y9dnQ19pR0pP4FiEIlUvdTGn8pw6CKTNq5sgib2nIhmUNT5TAmhWmvKr3WcxBcP3E8nWezuipuQ==", + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.2.tgz", + "integrity": "sha512-XBJbT3N4JhVumXE0eoLU9DCjcaF92KLNqTmFCnG1pf8duUxFGwtP6AD6nkjw9a3IdiRtL3E2w3JDiE/xi3vOeA==", "dev": true, "requires": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^5.2.0" + "strip-ansi": "^6.0.0" }, "dependencies": { + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "dev": true + }, "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", "dev": true, "requires": { - "ansi-regex": "^4.1.0" + "ansi-regex": "^5.0.0" } } } }, + "string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, "strip-ansi": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", @@ -2937,47 +4192,56 @@ } }, "table": { - "version": "5.4.6", - "resolved": "https://registry.npmjs.org/table/-/table-5.4.6.tgz", - "integrity": "sha512-wmEc8m4fjnob4gt5riFRtTu/6+4rSe12TpAELNSqHMfF3IqnA+CH37USM6/YR3qRZv7e56kAEAtd6nKZaxe0Ug==", + "version": "6.7.1", + "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", + "integrity": "sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg==", "dev": true, "requires": { - "ajv": "^6.10.2", - "lodash": "^4.17.14", - "slice-ansi": "^2.1.0", - "string-width": "^3.0.0" + "ajv": "^8.0.1", + "lodash.clonedeep": "^4.5.0", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0" }, "dependencies": { - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "ajv": { + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.5.0.tgz", + "integrity": "sha512-Y2l399Tt1AguU3BPRP9Fn4eN+Or+StUGWCUpbnFyXSo8NZ9S4uj+AG2pjs5apK+ZMOwYOz1+a+VKvKH7CudXgQ==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + } + }, + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true }, - "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - } + "json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true }, "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", "dev": true, "requires": { - "ansi-regex": "^4.1.0" + "ansi-regex": "^5.0.0" } } } @@ -3045,19 +4309,13 @@ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, - "through": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=", - "dev": true - }, - "tmp": { - "version": "0.0.33", - "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", - "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", "dev": true, "requires": { - "os-tmpdir": "~1.0.2" + "is-number": "^7.0.0" } }, "toidentifier": { @@ -3081,12 +4339,41 @@ } } }, + "tsconfig-paths": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", + "integrity": "sha512-dRcuzokWhajtZWkQsDVKbWyY+jgcLC5sqJhg2PSgf4ZkH2aHPvaOY8YWGhmjb68b5qqTfasSsDO9k7RUiEmZAw==", + "dev": true, + "requires": { + "@types/json5": "^0.0.29", + "json5": "^1.0.1", + "minimist": "^1.2.0", + "strip-bom": "^3.0.0" + }, + "dependencies": { + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + } + } + }, "tslib": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.10.0.tgz", - "integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==", + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", "dev": true }, + "tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "requires": { + "tslib": "^1.8.1" + } + }, "tunnel-agent": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", @@ -3101,12 +4388,12 @@ "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=" }, "type-check": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", - "integrity": "sha1-WITKtRLPHTVeP7eE8wgEsrUg23I=", + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, "requires": { - "prelude-ls": "~1.1.2" + "prelude-ls": "^1.2.1" } }, "type-detect": { @@ -3116,9 +4403,9 @@ "dev": true }, "type-fest": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.5.2.tgz", - "integrity": "sha512-DWkS49EQKVX//Tbupb9TFa19c7+MK1XmzkrZUR8TAktmE/DizXoaoJV6TZ/tSIPXipqNiRI6CyAe7x69Jb6RSw==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", + "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", "dev": true }, "type-is": { @@ -3130,6 +4417,12 @@ "mime-types": "~2.1.24" } }, + "typescript": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.3.2.tgz", + "integrity": "sha512-zZ4hShnmnoVnAHpVHWpTcxdv7dWP60S2FsydQLV8V5PbS3FifjWFFRiHSWpDJahly88PRyV5teTSLoq4eG7mKw==", + "dev": true + }, "typical": { "version": "2.6.1", "resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz", @@ -3153,6 +4446,26 @@ "source-map": "~0.6.1" } }, + "unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + }, + "dependencies": { + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + } + } + }, "underscore": { "version": "1.9.1", "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.9.1.tgz", @@ -3177,6 +4490,12 @@ "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.3.tgz", "integrity": "sha512-pW0No1RGHgzlpHJO1nsVrHKpOEIxkGg1xB+v0ZmdNH5OAeAwzAVrCnI2/6Mtx+Uys6iaylxa+D3g4j63IKKjSQ==" }, + "v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true + }, "validate-npm-package-license": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", @@ -3212,6 +4531,36 @@ "isexe": "^2.0.0" } }, + "which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "requires": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "dependencies": { + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + } + } + }, "which-module": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", @@ -3245,6 +4594,12 @@ } } }, + "word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true + }, "wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", @@ -3314,15 +4669,6 @@ "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", "dev": true }, - "write": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/write/-/write-1.0.3.tgz", - "integrity": "sha512-/lg70HAjtkUgWPVZhZcm+T4hkL8Zbtp1nFNOn3lRrxnlv50SRBv7cR7RqR+GMsd3hUXy9hWBo4CHTbFTcOYwig==", - "dev": true, - "requires": { - "mkdirp": "^0.5.1" - } - }, "xmlcreate": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.1.tgz", @@ -3335,6 +4681,12 @@ "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==", "dev": true }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, "yargs": { "version": "13.2.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.2.2.tgz", diff --git a/package.json b/package.json index bfa2dd6..f5779ea 100644 --- a/package.json +++ b/package.json @@ -17,20 +17,30 @@ }, "homepage": "https://github.com/envoy/envoy-integrations-sdk-nodejs#readme", "dependencies": { + "axios": "^0.21.1", "body-parser": "^1.19.0", + "dataloader": "^2.0.0", "dotenv": "^8.1.0", "jsonwebtoken": "^8.5.1", + "qs": "^6.10.1", "request": "^2.88.0", "request-promise-native": "^1.0.7" }, "devDependencies": { + "@types/express": "^4.17.12", + "@types/jsonwebtoken": "^8.5.1", + "@types/node": "^15.12.0", + "@types/qs": "^6.9.6", + "@typescript-eslint/eslint-plugin": "^4.26.0", + "@typescript-eslint/parser": "^4.26.0", "chai": "^4.2.0", - "eslint": "^5.16.0", - "eslint-config-airbnb-base": "^13.1.0", - "eslint-plugin-import": "^2.17.3", + "eslint": "^7.27.0", + "eslint-config-airbnb-typescript": "^12.3.1", + "eslint-plugin-import": "^2.23.4", "jsdoc-to-markdown": "^5.0.0", "mocha": "^6.1.4", "proxyquire": "^2.1.0", - "sinon": "^7.3.2" + "sinon": "^7.3.2", + "typescript": "^4.3.2" } } diff --git a/src/EnvoyAPI.ts b/src/EnvoyAPI.ts new file mode 100644 index 0000000..3e9950f --- /dev/null +++ b/src/EnvoyAPI.ts @@ -0,0 +1,347 @@ +import axios from 'axios'; +import qs from 'qs'; +import DataLoader from 'dataloader'; + +/** + * JSON-API generic types + */ +import JSONAPIPaginationParams from './util/json-api/JSONAPIPaginationParams'; +import JSONAPIData from './util/json-api/JSONAPIData'; + +/** + * Envoy Web's JSON-API Resources + */ +import { AgreementPageModel } from './resources/AgreementPageResource'; +import { AgreementModel } from './resources/AgreementResource'; +import { CompanyModel } from './resources/CompanyResource'; +import { EmployeeFilterFields, EmployeeModel, EmployeeSortFields } from './resources/EmployeeResource'; +import { FlowFilterFields, FlowModel, FlowSortFields } from './resources/FlowResource'; +import { + InviteCreationModel, InviteFilterFields, InviteModel, InviteSortFields, +} from './resources/InviteResource'; +import { LocationFilterFields, LocationModel, LocationSortFields } from './resources/LocationResource'; +import { SignInFieldModel } from './resources/SignInFieldResource'; +import { SignInFieldPageModel } from './resources/SignInFieldPageResource'; +import { UserModel } from './resources/UserResource'; + +import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; +import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; +import { EnvoyMetaAuth } from './EnvoyMeta'; +import EnvoyStorageCommand from './EnvoyStorageCommand'; +import EnvoyStorageItem from './EnvoyStorageItem'; + +interface EnvoyWebDataLoaderKey extends JSONAPIData { + include?: string; +} + +/** + * Sometimes envoy-web will give us back some relationship data + * with the "type" set to the relationships name instead of the actual model's name. + * This mapping allows us to alias those cases. + */ +const TYPE_ALIASES = new Map([ + ['employee-screening-flows', 'flows'], +]); + +/** + * Make typed API calls to Envoy Web. + * Uses a data loader to leverage JSONAPI's "include" functionality. + * This allows us to save everything that was included in the initial response + * to be used later without re-fetching from the API. + */ +export default class EnvoyAPI { + /** + * HTTP Client + */ + readonly axios = axios.create({ + baseURL: envoyBaseURL, + headers: { + 'Content-Type': 'application/vnd.api+json', + Accept: 'application/vnd.api+json', + }, + paramsSerializer: (params) => qs.stringify(params, { + arrayFormat: 'brackets', + encode: false, + }), + }); + + /** + * A dataloader: https://github.com/graphql/dataloader + * Will fetch individual resources from the API, + * unless they exist in cache (which they usually will). + */ + // eslint-disable-next-line @typescript-eslint/no-explicit-any + readonly dataLoader = new DataLoader( + (keys) => Promise.all( + keys.map(async ({ type, id, include }) => { + const { data } = await this.axios.get(`api/v3/${type}/${id}`, { params: { include } }); + return data.data; + }), + ), + { + cacheKeyFn: (key) => `${key.type}_${key.id}`, + }, + ); + + constructor(accessToken: string) { + this.axios.defaults.headers.authorization = `Bearer ${accessToken}`; + /** + * Saves every model that was "include"ed in the response, + * which saves us the trouble of fetching related data. + */ + this.axios.interceptors.response.use((response) => { + const { + data: { + data: modelOrModels, + included, + }, + } = response; + + (included || []) + .concat(modelOrModels) + .forEach((model: JSONAPIData) => { + this.dataLoader.prime({ type: model.type, id: model.id }, model); + const alias = TYPE_ALIASES.get(model.type); + if (alias) { + this.dataLoader.prime({ type: alias, id: model.id }, model); + } + }); + return response; + }, (error) => Promise.reject(error)); + } + + async getAgreementPage(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'agreement-pages', id, include }); + } + + async getAgreement(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'agreements', id, include }); + } + + async getCompany(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'companies', id, include }); + } + + async getEmployee(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'employees', id, include }); + } + + async getFlow(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'flows', id, include }); + } + + async getLocation(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'locations', id, include }); + } + + async getSignInFieldPage(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'sign-in-field-pages', id, include }); + } + + async getSignInField(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'sign-in-fields', id, include }); + } + + async getEmployeeByEmail(email: string, include?: string): Promise { + const paginationParams: JSONAPIPaginationParams = { + filter: { + email, + }, + page: { + limit: 1, + }, + }; + const { data: { data: [employee] } } = await this.axios.get('/api/v3/employees', { + params: { + include, + ...paginationParams, + }, + }); + + return employee; + } + + async getEmployees( + params?: JSONAPIPaginationParams, + ): Promise> { + const { data } = await this.axios.get('/api/v3/employees', { params }); + return data.data; + } + + async getFlows(params?: JSONAPIPaginationParams): Promise> { + const { data } = await this.axios.get('/api/v3/flows', { params }); + return data.data; + } + + async getLocations( + params?: JSONAPIPaginationParams, + ): Promise> { + const { data } = await this.axios.get('/api/v3/locations', { params }); + return data.data; + } + + async getSignInFields(signInFieldPageId: string): Promise> { + const { data } = await this.axios.get(`/api/v3/sign-in-field-pages/${signInFieldPageId}/sign-in-fields`); + return data.data; + } + + async getInvites( + params?: JSONAPIPaginationParams, + ): Promise> { + const { data } = await this.axios.get('/api/v3/invites', { params }); + return data.data; + } + + async me(): Promise { + const { data } = await this.axios.get('/api/v2/users/me'); + return data.data; + } + + async createInvite(invite: InviteCreationModel): Promise { + const { data } = await this.axios({ + method: 'POST', + url: '/api/v3/invites', + data: { data: invite }, + }); + return data.data; + } + + async updateInvite(inviteId: string, invite: InviteCreationModel): Promise { + const { data } = await this.axios({ + method: 'PUT', + url: `/api/v3/invites/${inviteId}`, + data: { data: { ...invite, id: inviteId } }, + }); + + return data.data; + } + + async partialUpdateInvite(inviteId: string, invite: InviteCreationModel): Promise { + const { data } = await this.axios({ + method: 'PATCH', + url: `/api/v3/invites/${inviteId}`, + data: { data: { ...invite, id: inviteId } }, + }); + + return data.data; + } + + async removeInvite(inviteId: string): Promise { + await this.axios({ + method: 'DELETE', + url: `/api/v3/invites/${inviteId}`, + }); + } + + async updateJob(jobId: string, update: EnvoyPluginJobUpdate): Promise { + await this.axios({ + method: 'PATCH', + url: `/api/v2/plugin-services/jobs/${jobId}`, + data: update, + }); + } + + async getPluginInstallConfig(installId: string): Promise> { + const { data } = await this.axios.get(`/api/v2/plugin-services/installs/${installId}/config`); + return data.data; + } + + async setPluginInstallConfig(installId: string, config: Record): Promise { + await this.axios({ + method: 'PUT', + url: `/api/v2/plugin-services/installs/${installId}/config`, + data: config, + }); + } + + async storagePipeline( + commands: Array, + installId?: string, + ): Promise> { + const request: Record = { commands }; + if (installId) { + request.install_id = installId; + } + const { data } = await this.axios({ + method: 'POST', + url: '/api/v2/plugin-services/storage', + data: request, + }); + return data.data; + } + + async createNotification(installId: string, params = {}): Promise { + await this.axios({ + method: 'POST', + url: `/api/v2/plugin-services/installs/${installId}/notifications`, + data: params, + }); + } + + /** + * Gets an access token using client_credentials as the grant type. + */ + static async login(id = envoyClientId, secret = envoyClientSecret): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'client_credentials', + client_id: id, + client_secret: secret, + scope: 'plugin,token.refresh', + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } + + static async loginAsUser( + username: string, + password: string, + id = envoyClientId, + secret = envoyClientSecret, + ): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'password', + username, + password, + scope: 'plugin,token.refresh', + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } + + static async loginAsPluginInstaller( + installId: string, + id = envoyClientId, + secret = envoyClientSecret, + ): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'plugin_install', + install_id: installId, + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } +} diff --git a/src/EnvoyJWT.ts b/src/EnvoyJWT.ts new file mode 100644 index 0000000..6720c1b --- /dev/null +++ b/src/EnvoyJWT.ts @@ -0,0 +1,39 @@ +import jwt, { SignOptions, Algorithm, VerifyOptions } from 'jsonwebtoken'; +import { jwtSecret } from './constants'; + +export default class EnvoyJWT { + private secret: string; + + private algorithm: Algorithm; + + constructor(secret = jwtSecret, algorithm: Algorithm = 'HS256') { + if (!secret) { + throw new Error('JWT secret missing.'); + } + this.secret = secret; + this.algorithm = algorithm; + } + + encode(subject: string | number | null | undefined, expiresIn: string | number | null | undefined, payload = {}) { + const { secret, algorithm } = this; + const options: SignOptions = { algorithm }; + if (subject) { + options.subject = `${subject}`; + } + if (expiresIn) { + options.expiresIn = expiresIn; + } + + return jwt.sign(payload, secret, options); + } + + decode(token: string, options: VerifyOptions = {}) { + const { secret, algorithm } = this; + return jwt.verify(token, secret, { + ignoreExpiration: false, + ignoreNotBefore: false, + ...options, + algorithms: [algorithm], // force the algorithm + }); + } +} diff --git a/src/EnvoyMeta.ts b/src/EnvoyMeta.ts new file mode 100644 index 0000000..8d52afb --- /dev/null +++ b/src/EnvoyMeta.ts @@ -0,0 +1,70 @@ +export interface EnvoyMetaJob { + id: string, + name: string, + identifier: string, +} + +export interface EnvoyMetaLocation { + id: string, + type: 'locations', + attributes: { + name: string, + 'company-name-override': string | null, + timezone: string, + locale: string | null, + address: string, + 'address-line-one': string | null, + 'address-line-two': string | null, + city: string | null, + state: string | null, + country: string | null, + zip: string | null, + longitude: number | null, + latitude: number | null, + 'created-at': string, + } +} + +export interface EnvoyMetaCompany { + id: string, + type: 'companies', + attributes: { + name: string, + active: boolean, + 'created-at': string, + } +} + +export type EnvoyMetaAuth = { + token_type: 'Bearer', + access_token: string, + expires_in: number, + refresh_token: string | null, + refresh_token_expires_in: number | null, +}; + +export interface EnvoyEventMeta { + event: string, + plugin_id: string, + install_id: string, + config: Record, + job: EnvoyMetaJob, + location: EnvoyMetaLocation, + company: EnvoyMetaCompany, + auth: EnvoyMetaAuth | null, + forwarded_bearer_token?: string, +} + +export interface EnvoyRouteMeta { + route: string, + plugin_id: string, + install_id: string, + config: Record, + params: Record, + location: EnvoyMetaLocation, + company: EnvoyMetaCompany, + auth: EnvoyMetaAuth | null, +} + +type EnvoyMeta = EnvoyEventMeta | EnvoyRouteMeta; +export default EnvoyMeta; diff --git a/src/EnvoyPluginJob.ts b/src/EnvoyPluginJob.ts new file mode 100644 index 0000000..ed02553 --- /dev/null +++ b/src/EnvoyPluginJob.ts @@ -0,0 +1,55 @@ +import EnvoyAPI from './EnvoyAPI'; +import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; +import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; + +export default class EnvoyPluginJob { + readonly api: EnvoyAPI; + + readonly id: string; + + constructor(pluginAPI: EnvoyAPI, jobId: string) { + this.api = pluginAPI; + this.id = jobId; + } + + execute( + status: string | null, + message: string | null, + reason: string | null, + attachments: Array = [], + ): Promise { + const updates: EnvoyPluginJobUpdate = { + attachments: attachments.map((attachment) => ({ type: 'text', ...attachment })), + }; + if (status) { + Object.assign(updates, { status }); + } + if (message) { + Object.assign(updates, { status_message: message }); + } + if (reason) { + Object.assign(updates, { failure_reason: reason }); + } + return this.api.updateJob(this.id, updates); + } + + attach(...attachments: Array): Promise { + return this.execute(null, null, null, attachments); + } + + complete(message: string, ...attachments: Array): Promise { + return this.execute('done', message, null, attachments); + } + + ignore(message: string, reason: string): Promise { + return this.execute('ignored', message, reason); + } + + fail(message: string, reason: string): Promise { + return this.execute('failed', message, reason); + } + + update(message: string, ...attachments: Array): Promise { + return this.execute(null, message, null, attachments); + } +} diff --git a/src/EnvoyPluginJobAttachment.ts b/src/EnvoyPluginJobAttachment.ts new file mode 100644 index 0000000..905e04b --- /dev/null +++ b/src/EnvoyPluginJobAttachment.ts @@ -0,0 +1,25 @@ +export interface EnvoyPluginTextJobAttachment { + type?: 'text' | 'password' | 'link' | 'credential_image', + label: string, + value: string, +} + +export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachment { + type: 'link', + url: string, +} + +export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAttachment { + type: 'credential_image', + title: string, + image: { + type: 's3', + link: string, + }, +} + +type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment +| EnvoyPluginLinkJobAttachment +| EnvoyPluginCredentialJobAttachment; + +export default EnvoyPluginJobAttachment; diff --git a/src/EnvoyPluginJobUpdate.ts b/src/EnvoyPluginJobUpdate.ts new file mode 100644 index 0000000..d028721 --- /dev/null +++ b/src/EnvoyPluginJobUpdate.ts @@ -0,0 +1,8 @@ +import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; + +export default interface EnvoyPluginJobUpdate { + status?: string, + status_message?: string, + failure_reason?: string, + attachments: Array, +} diff --git a/src/EnvoyPluginSDK.ts b/src/EnvoyPluginSDK.ts new file mode 100644 index 0000000..d7c4324 --- /dev/null +++ b/src/EnvoyPluginSDK.ts @@ -0,0 +1,129 @@ +import EnvoyMeta from './EnvoyMeta'; +import EnvoyAPI from './EnvoyAPI'; +import EnvoyPluginStorage from './EnvoyPluginStorage'; +import EnvoyPluginJob from './EnvoyPluginJob'; +import EnvoyJWT from './EnvoyJWT'; + +export interface EnvoyRequestBody { + meta: Meta, + payload: Payload, +} + +export default class EnvoyPluginSDK { + readonly body: EnvoyRequestBody; + + isVerified = false; + + pluginAccessToken: string | null = null; + + constructor(body: EnvoyRequestBody, isVerified = false, pluginAccessToken: string | null = null) { + this.body = body; + this.isVerified = isVerified; + this.pluginAccessToken = pluginAccessToken; + } + + get meta(): Meta { + if (!this.isVerified) { + throw new Error('Could not verify meta.'); + } + return this.body.meta; + } + + get payload(): Payload { + if (!this.isVerified) { + throw new Error('Could not verify payload.'); + } + return this.body.payload; + } + + /** + * Envoy API scoped to the user. + * Used only in routes. + * + * @returns {EnvoyAPI} + */ + get userAPI() { + const { meta } = this; + const { auth } = meta; + let accessToken: string | undefined = auth?.access_token; + if (!accessToken && 'forwarded_bearer_token' in this.meta) { + accessToken = this.meta.forwarded_bearer_token; + } + if (!accessToken) { + throw new Error("This user's API token was not found. Are you in a route?"); + } + return new EnvoyAPI(accessToken); + } + + /** + * Envoy API scoped to the plugin. + * Used to perform storage or job operations. + */ + get pluginAPI(): EnvoyAPI { + const { pluginAccessToken } = this; + if (!pluginAccessToken) { + throw new Error('No API token found. Are your Envoy client ID and secret set?'); + } + return new EnvoyAPI(pluginAccessToken); + } + + get getStorage(): (installId?: string) => EnvoyPluginStorage { + return (installId?) => new EnvoyPluginStorage(this.pluginAPI, installId); + } + + /** + * Storage scoped to the install. + */ + get installStorage(): EnvoyPluginStorage { + const { install_id: installId } = this.meta; + if (!installId) { + throw new Error('No install ID found in meta.'); + } + return this.getStorage(installId); + } + + /** + * Storage scoped globally (across installs). + */ + get globalStorage(): EnvoyPluginStorage { + return this.getStorage(); + } + + /** + * Returns a job based on an ID. + */ + get getJob(): (jobId: string) => EnvoyPluginJob { + return (jobId: string) => new EnvoyPluginJob(this.pluginAPI, jobId); + } + + /** + * Returns the current job's ID. + */ + get jobId(): string | null { + const { meta } = this; + if ('job' in meta) { + return meta.job.id; + } + return null; + } + + /** + * Perform operations on the current job. + */ + get job(): EnvoyPluginJob { + const { jobId } = this; + if (!jobId) { + throw new Error('No job found in meta. Are you in a worker?'); + } + return this.getJob(jobId); + } + + /** + * A utility to encode and decode JWTs. + * Useful for verifiable communications between plugin endpoints. + */ + // eslint-disable-next-line class-methods-use-this + get jwt(): EnvoyJWT { + return new EnvoyJWT(); + } +} diff --git a/src/EnvoyPluginStorage.ts b/src/EnvoyPluginStorage.ts new file mode 100644 index 0000000..f99b056 --- /dev/null +++ b/src/EnvoyPluginStorage.ts @@ -0,0 +1,58 @@ +import EnvoyPluginStoragePipeline from './EnvoyPluginStoragePipeline'; +import EnvoyAPI from './EnvoyAPI'; +import { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions } from './EnvoyStorageCommand'; +import EnvoyStorageItem from './EnvoyStorageItem'; + +export default class EnvoyPluginStorage { + readonly api: EnvoyAPI; + + readonly installId: string | undefined; + + constructor(pluginAPI: EnvoyAPI, installId?: string) { + this.api = pluginAPI; + this.installId = installId; + } + + /** + * Creates a new pipeline instance. + */ + pipeline(): EnvoyPluginStoragePipeline { + return new EnvoyPluginStoragePipeline(this.api, this.installId); + } + + /** + * Wrapper for single pipeline get. + */ + get(key: string): Promise { + return this.pipeline().get(key).executeSingle(); + } + + /** + * Wrapper for single pipeline set. + */ + set(key: string, value: any): Promise { + return this.pipeline().set(key, value).executeSingle(); + } + + /** + * Wrapper for single pipeline setUnique. + */ + setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): Promise { + return this.pipeline().setUnique(key, options).executeSingle(); + } + + /** + * Wrapper for single pipeline setUnique. + */ + setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): Promise { + return this.pipeline().setUniqueNum(key, options).executeSingle(); + } + + /** + * Wrapper for single pipeline unset. + * Returns null if the item did not previously exist. + */ + unset(key: string): Promise { + return this.pipeline().unset(key).executeSingle(); + } +} diff --git a/src/EnvoyPluginStoragePipeline.ts b/src/EnvoyPluginStoragePipeline.ts new file mode 100644 index 0000000..a825957 --- /dev/null +++ b/src/EnvoyPluginStoragePipeline.ts @@ -0,0 +1,84 @@ +import EnvoyAPI from './EnvoyAPI'; +import EnvoyStorageCommand, { + EnvoyStorageSetUniqueNumOptions, + EnvoyStorageSetUniqueOptions, +} from './EnvoyStorageCommand'; +import EnvoyStorageItem from './EnvoyStorageItem'; + +export default class EnvoyPluginStoragePipeline { + readonly api: EnvoyAPI; + + readonly installId: string | undefined; + + private commands: Array; + + /** + * + * @param {EnvoyAPI} pluginAPI + * @param {number|null} [installId] + */ + constructor(pluginAPI: EnvoyAPI, installId?: string) { + this.api = pluginAPI; + this.installId = installId; + this.commands = []; + } + + /** + * Executes all the commands in the pipeline. + */ + execute(): Promise> { + return this.api.storagePipeline(this.commands, this.installId); + } + + /** + * Executes the pipeline and returns the first result. + */ + async executeSingle(): Promise { + const [result] = await this.execute(); + return result; + } + + addCommand(command: EnvoyStorageCommand): EnvoyPluginStoragePipeline { + this.commands.push(command); + return this; + } + + /** + * Gets a storage item. + */ + get(key: string): EnvoyPluginStoragePipeline { + return this.addCommand({ action: 'get', key }); + } + + /** + * Sets a value for a storage item, + * and returns that item. + */ + // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types + set(key: string, value: any): EnvoyPluginStoragePipeline { + return this.addCommand({ action: 'set', key, value }); + } + + /** + * Sets a unique value for a storage item, + * and returns that item. + */ + setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): EnvoyPluginStoragePipeline { + return this.addCommand({ action: 'set_unique', key, ...options }); + } + + /** + * Sets a unique number value for a storage item, + * and returns that item. + */ + setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): EnvoyPluginStoragePipeline { + return this.addCommand({ action: 'set_unique_num', key, ...options }); + } + + /** + * Unsets a storage item. + */ + unset(key: string): EnvoyPluginStoragePipeline { + return this.addCommand({ action: 'unset', key }); + } +} diff --git a/src/EnvoyRequest.ts b/src/EnvoyRequest.ts new file mode 100644 index 0000000..dfc9415 --- /dev/null +++ b/src/EnvoyRequest.ts @@ -0,0 +1,13 @@ +import { Request } from 'express'; +import EnvoyPluginSDK from './EnvoyPluginSDK'; +import EnvoyMeta from './EnvoyMeta'; + +export const VERIFIED = Symbol('verified'); + +export interface VerifiedRequest extends Request { + [VERIFIED]: boolean +} + +export default interface EnvoyRequest extends VerifiedRequest { + envoy: EnvoyPluginSDK +} diff --git a/src/EnvoyResponse.ts b/src/EnvoyResponse.ts new file mode 100644 index 0000000..e7bd05f --- /dev/null +++ b/src/EnvoyResponse.ts @@ -0,0 +1,7 @@ +import { Response } from 'express'; + +export default interface EnvoyResponse extends Response { + sendOngoing: (data: any) => void; + sendIgnored: (message: string, data?: Record) => void; + sendFailed: (message: string, data?: Record) => void; +} diff --git a/src/EnvoySignatureVerifier.ts b/src/EnvoySignatureVerifier.ts new file mode 100644 index 0000000..c9f4235 --- /dev/null +++ b/src/EnvoySignatureVerifier.ts @@ -0,0 +1,61 @@ +import crypto, { BinaryToTextEncoding } from 'crypto'; +import { Request } from 'express'; +import { envoyClientSecret } from './constants'; + +/** + * @typedef {Object} SignatureVerifierOptions + * @property {string} algorithm="sha256" + * @property {string} encoding="base64" + * @property {string} secret=process.env.ENVOY_CLIENT_SECRET + * @property {string} header="x-envoy-signature" + */ + +export interface EnvoySignatureVerifierOptions { + algorithm: 'sha256' | string, + encoding: BinaryToTextEncoding, + secret: string, + header: 'x-envoy-signature' | string, +} + +const defaultOptions: EnvoySignatureVerifierOptions = { + algorithm: 'sha256', + encoding: 'base64', + secret: envoyClientSecret, + header: 'x-envoy-signature', +}; + +export default class EnvoySignatureVerifier { + private readonly options: EnvoySignatureVerifierOptions; + + constructor(options: EnvoySignatureVerifierOptions = defaultOptions) { + this.options = { ...defaultOptions, ...options }; + + if (!this.options.secret) { + throw new Error('No client secret found in the ENVOY_CLIENT_SECRET environment variable.'); + } + } + + /** + * Verifies that the signature provided matches the request body. + */ + verify(req: Request, rawBody: Buffer): boolean { + const { + algorithm, + encoding, + secret, + header, + } = this.options; + + if (!req.headers[header]) { + return false; + } + const receivedDigest = req.headers[header] as string; + const computedHmac = crypto.createHmac(algorithm, secret); + computedHmac.update(rawBody); + + return crypto.timingSafeEqual( + Buffer.from(receivedDigest), + Buffer.from(computedHmac.digest(encoding)), + ); + } +} diff --git a/src/EnvoyStorageCommand.ts b/src/EnvoyStorageCommand.ts new file mode 100644 index 0000000..16cf877 --- /dev/null +++ b/src/EnvoyStorageCommand.ts @@ -0,0 +1,43 @@ +export interface EnvoyStorageSetUniqueOptions { + chars?: string, + size?: number, +} + +export interface EnvoyStorageSetUniqueNumOptions { + min?: number, + max?: number, +} + +export interface EnvoyBaseStorageCommand { + action: 'get' | 'set' | 'set_unique' | 'set_unique_num' | 'unset', + key: string, +} + +export interface EnvoyGetStorageCommand extends EnvoyBaseStorageCommand { + action: 'get', +} + +export interface EnvoySetStorageCommand extends EnvoyBaseStorageCommand { + action: 'set', + value: any, +} + +export interface EnvoySetUniqueStorageCommand extends EnvoyBaseStorageCommand, EnvoyStorageSetUniqueOptions { + action: 'set_unique', +} + +export interface EnvoySetUniqueNumStorageCommand extends EnvoyBaseStorageCommand, EnvoyStorageSetUniqueNumOptions { + action: 'set_unique_num', +} + +export interface EnvoyUnsetStorageCommand extends EnvoyBaseStorageCommand { + action: 'unset', +} + +type EnvoyStorageCommand = EnvoyGetStorageCommand +| EnvoySetStorageCommand +| EnvoySetUniqueStorageCommand +| EnvoySetUniqueNumStorageCommand +| EnvoyUnsetStorageCommand; + +export default EnvoyStorageCommand; diff --git a/src/EnvoyStorageItem.ts b/src/EnvoyStorageItem.ts new file mode 100644 index 0000000..5835ca4 --- /dev/null +++ b/src/EnvoyStorageItem.ts @@ -0,0 +1,4 @@ +export default interface EnvoyStorageItem { + key: string, + value: any, +} diff --git a/src/HttpStatus.ts b/src/HttpStatus.ts new file mode 100644 index 0000000..4464b96 --- /dev/null +++ b/src/HttpStatus.ts @@ -0,0 +1,7 @@ +enum HttpStatus { + ONGOING = 202, + IGNORED = 400, + FAILED = 412, + UNEXPECTED_FAILURE = 500, +} +export default HttpStatus; diff --git a/src/asyncHandler.ts b/src/asyncHandler.ts new file mode 100644 index 0000000..db9fc9d --- /dev/null +++ b/src/asyncHandler.ts @@ -0,0 +1,19 @@ +/** + * Catches Promise-based errors. + */ +import { RequestHandler, NextFunction } from 'express'; +import EnvoyRequest from './EnvoyRequest'; +import EnvoyResponse from './EnvoyResponse'; + +type EnvoyHandler = (req: EnvoyRequest, res: EnvoyResponse) => void | Promise; + +export default function asyncHandler(handler: RequestHandler | EnvoyHandler) { + return async (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): Promise => { + try { + // eslint-disable-next-line @typescript-eslint/await-thenable + await handler(req, res, next); + } catch (err) { + next(err); + } + }; +} diff --git a/src/constants.ts b/src/constants.ts new file mode 100644 index 0000000..4bbdc7e --- /dev/null +++ b/src/constants.ts @@ -0,0 +1,4 @@ +export const envoyBaseURL = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; +export const envoyClientId = process.env.ENVOY_CLIENT_ID as string; +export const envoyClientSecret = process.env.ENVOY_CLIENT_SECRET as string; +export const jwtSecret = process.env.JWT_SECRET as string; diff --git a/src/errorMiddleware.ts b/src/errorMiddleware.ts new file mode 100644 index 0000000..fa8338d --- /dev/null +++ b/src/errorMiddleware.ts @@ -0,0 +1,19 @@ +import { Request, Response, NextFunction } from 'express'; +import HttpStatus from './HttpStatus'; + +/** + * + * @param {Function} onError + * @returns {Function} + */ +export default function errorMiddleware(onError: (err: Error) => void = () => {}) { + return (err: Error, req: Request, res: Response, next: NextFunction): void => { + onError(err); + if (res.headersSent) { + return next(err); + } + res.statusCode = HttpStatus.UNEXPECTED_FAILURE; + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify({ message: err.message })); + }; +} diff --git a/src/middleware.ts b/src/middleware.ts new file mode 100644 index 0000000..babd074 --- /dev/null +++ b/src/middleware.ts @@ -0,0 +1,66 @@ +import bodyParser from 'body-parser'; +import { Response, NextFunction } from 'express'; +import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './EnvoySignatureVerifier'; +import EnvoyAPI from './EnvoyAPI'; +import EnvoyPluginSDK from './EnvoyPluginSDK'; + +import HttpStatus from './HttpStatus'; +import EnvoyRequest, { VERIFIED, VerifiedRequest } from './EnvoyRequest'; +import EnvoyResponse from './EnvoyResponse'; + +export default function middleware(options: EnvoySignatureVerifierOptions) { + const signatureVerifier = new EnvoySignatureVerifier(options); + const verify = (req: VerifiedRequest, res: Response, rawBody: Buffer) => { + req[VERIFIED] = signatureVerifier.verify(req, rawBody); + }; + const json = bodyParser.json({ verify }); + let accessToken: string | null = null; + let threshold = 0; + + return (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => { + json(req, res, async (err) => { + if (err) { + return next(err); + } + try { + const now = Date.now(); + if (now > threshold) { + const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyAPI.login(); + accessToken = rawAccessToken; + threshold = now + (expiresIn * 1000) - (1000 * 60 * 10); + } + + req.envoy = new EnvoyPluginSDK(req.body, req[VERIFIED], accessToken); + /** + * @param {object} [data] + */ + res.sendOngoing = (data = {}) => { + res.statusCode = HttpStatus.ONGOING; + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(data)); + }; + /** + * @param {string} [message] + * @param {object} [data] + */ + res.sendIgnored = (message = '', data = {}) => { + res.statusCode = HttpStatus.IGNORED; + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify({ ...(data || {}), message })); + }; + /** + * @param {string} [message] + * @param {object} [data] + */ + res.sendFailed = (message = '', data = {}) => { + res.statusCode = HttpStatus.FAILED; + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify({ ...(data || {}), message })); + }; + next(); + } catch (error) { + next(error); + } + }); + }; +} diff --git a/src/payloads/EntryPayload.ts b/src/payloads/EntryPayload.ts new file mode 100644 index 0000000..31f2b44 --- /dev/null +++ b/src/payloads/EntryPayload.ts @@ -0,0 +1,59 @@ +import JSONAPIData from '../util/json-api/JSONAPIData'; + +export default interface EntryPayload { + id: string, + type: 'entries', + attributes: { + 'full-name': string, + 'phone-number'?: string, + email: string | null, + 'employee-screening-flow': boolean, + host: string | null, + 'host-email': string | null, + 'private-notes': string | null, + 'signed-in-at': string, + 'signed-out-at'?: string, + thumbnails: { + large: string | null, + original: string | null, + small: string | null, + }, + 'flow-name': string, + nda?: string, + 'legal-docs'?: Array<{ + id: string, + url: string, + 'signed-at': string, + agreement: { + id: string, + }, + }>, + 'user-data': Array<{ + field: string, + value: string | null, + }> + }, + relationships: { + location: { + data: JSONAPIData<'locations'>, + }, + 'visitor-entrance'?: { + data: JSONAPIData<'visitor-entrances'>, + }, + device?: { + data: JSONAPIData<'devices'>, + }, + employee?: { + data: JSONAPIData<'employees'>, + }, + invite?: { + data: JSONAPIData<'invites'>, + }, + flow?: { + data: JSONAPIData<'flows'>, + }, + 'agreeable-ndas'?: { + data: Array>, + } + } +} diff --git a/src/payloads/InvitePayload.ts b/src/payloads/InvitePayload.ts new file mode 100644 index 0000000..a40c223 --- /dev/null +++ b/src/payloads/InvitePayload.ts @@ -0,0 +1,58 @@ +import JSONAPIData from '../util/json-api/JSONAPIData'; + +export default interface InvitePayload { + id: string, + type: 'invites', + attributes: { + 'employee-screening-flow': boolean, + 'full-name': string, + email: string | null, + 'inviter-name': string | null, + 'inviter-email': string | null, + 'expected-arrival-time': string, + 'private-notes': string | null, + arrived: boolean, + 'been-here-before': boolean, + 'flow-name': string, + 'flow-id': string, + 'user-data': Array<{ + field: string, + value: string | null, + }>, + nda?: string, + 'secret-token': string, + 'edit-token': string, + 'photo-url': string | null, + 'qr-code': string | null, + 'qr-code-sent-at': string | null, + 'preregistration-complete': boolean, + 'reminder-sent-at': string | null, + 'legal-docs'?: Array<{ + id: string, + url: string, + 'signed-at': string, + agreement: { + id: string, + }, + }>, + 'signed-in-at'?: string, + 'signed-out-at'?: string, + }, + relationships: { + entry?: { + data: JSONAPIData<'entries'>, + }, + location: { + data: JSONAPIData<'locations'>, + }, + flow?: { + data: JSONAPIData<'flows'>, + }, + employee?: { + data: JSONAPIData<'employees'>, + }, + 'agreeable-ndas'?: { + data: Array>, + } + } +} diff --git a/src/resources/AgreementPageResource.ts b/src/resources/AgreementPageResource.ts new file mode 100644 index 0000000..eb15ca3 --- /dev/null +++ b/src/resources/AgreementPageResource.ts @@ -0,0 +1,10 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type SignInFieldPageAttributes = { + enabled?: boolean; + position?: number; +}; + +export type AgreementPageRelationships = 'flow' | 'agreements'; + +export type AgreementPageModel = JSONAPIModel; diff --git a/src/resources/AgreementResource.ts b/src/resources/AgreementResource.ts new file mode 100644 index 0000000..c1dedff --- /dev/null +++ b/src/resources/AgreementResource.ts @@ -0,0 +1,17 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export interface AgreementAttributes { + name: string; + optional: boolean; + 'require-resign': boolean; + body?: string; + 'video-url'?: string; + enabled?: boolean; + position?: number; + 'created-at'?: string; + 'updated-at'?: string; +} + +export type AgreementRelationships = 'agreement-page'; + +export type AgreementModel = JSONAPIModel; diff --git a/src/resources/CompanyResource.ts b/src/resources/CompanyResource.ts new file mode 100644 index 0000000..305e2c5 --- /dev/null +++ b/src/resources/CompanyResource.ts @@ -0,0 +1,12 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export interface CompanyAttributes { + name: string; + active: boolean; + 'created-at': string; + 'updated-at': string; +} + +export type CompanyRelationships = 'locations'; + +export type CompanyModel = JSONAPIModel; diff --git a/src/resources/CompanyRoleResource.ts b/src/resources/CompanyRoleResource.ts new file mode 100644 index 0000000..e69de29 diff --git a/src/resources/EmployeeResource.ts b/src/resources/EmployeeResource.ts new file mode 100644 index 0000000..a665104 --- /dev/null +++ b/src/resources/EmployeeResource.ts @@ -0,0 +1,32 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type EmployeeSortFields = 'name' | 'created_at' | '-name' | '-created_at'; + +export interface EmployeeFilterFields { + deleted?: boolean; + company?: string; + locations?: string; + email?: string; + except?: string; + 'exclude-locations'?: string; + 'exclude-hidden'?: boolean; + 'manually-added'?: boolean; + name?: string; + query?: string; +} + +export interface EmployeeAttributes { + name: string; + email: string; + 'phone-number'?: string; + 'profile-picture-url'?: string; + deleted?: boolean; + 'company-id'?: string; + 'created-at'?: string; + 'updated-at'?: string; + 'deleted-at'?: string; +} + +export type EmployeeRelationships = 'locations' | 'company'; + +export type EmployeeModel = JSONAPIModel; diff --git a/src/resources/FlowResource.ts b/src/resources/FlowResource.ts new file mode 100644 index 0000000..fd81cb7 --- /dev/null +++ b/src/resources/FlowResource.ts @@ -0,0 +1,20 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type FlowSortFields = 'name' | 'created_at' | '-name' | '-created_at'; + +export interface FlowFilterFields { + 'employee-centric'?: boolean; + location?: string; +} + +export interface FlowAttributes { + name: string; + 'employee-centric'?: boolean; + enabled?: boolean; + 'created-at'?: string; + 'updated-at'?: string; +} + +export type FlowRelationships = 'location' | 'sign-in-field-page' | 'agreement-page'; + +export type FlowModel = JSONAPIModel; diff --git a/src/resources/InviteResource.ts b/src/resources/InviteResource.ts new file mode 100644 index 0000000..4262b54 --- /dev/null +++ b/src/resources/InviteResource.ts @@ -0,0 +1,71 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type InviteSortFields = 'name' | 'created_at' | '-name' | '-created_at'; + +export interface InviteFilterFields { + email?: string; + employee?: string; + flow?: string; + location?: string; + 'date-from'?: string; + 'date-to'?: string; + 'datetime-from'?: string; + 'datetime-to'?: string; + 'for-date'?: string; + 'employee-centric'?: boolean; + scope?: 'hosted' | 'mine' | 'include_execs'; +} + +export interface InviteAttributes { + 'additional-guests'?: number; + 'approval-status'?: { + status: 'approved' | 'review' | 'pending' | 'denied'; + auto_approved: boolean; + report: Array<{ + reason: string; + result: 'pass' | 'fail' | 'pending', + source: string, + messages: { + failure?: { + text: string, + header: string, + } + } + }> + }; + email?: string; + 'expected-arrival-time'?: string; + 'expected-departure-time'?: string; + 'full-name'?: string; + 'guest-updated-at'?: string; + 'is-presigned'?: boolean; + 'private-notes'?: string; + 'user-data'?: Record; + 'notify-visitor'?: boolean; + 'created-from'?: string; + arrived?: boolean; + attested?: boolean; + 'entry-signed-out-at'?: string; + 'reminder-sent-at'?: string; + phone?: string; + 'created-at'?: string; + 'updated-at'?: string; +} + +export interface InviteCreationAttributes { + email?: string; + 'expected-arrival-time'?: string; + 'expected-departure-time'?: string; + 'full-name'?: string; + 'private-notes'?: string; + 'user-data'?: Record; + 'notify-visitor'?: boolean; + attested?: boolean; + phone?: string; +} + +export type InviteRelationships = 'attendee' | 'creator' | 'employee' | 'entry' | 'flow' | 'location'; + +export type InviteModel = JSONAPIModel; + +export type InviteCreationModel = JSONAPIModel; diff --git a/src/resources/LocationResource.ts b/src/resources/LocationResource.ts new file mode 100644 index 0000000..6838d0a --- /dev/null +++ b/src/resources/LocationResource.ts @@ -0,0 +1,52 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type LocationSortFields = 'name' | 'created_at' | '-name' | '-created_at'; + +export interface LocationFilterFields { + disabled?: boolean; + company?: string; +} + +export interface LocationAttributes { + name: string; + address: string; + 'address-line-1'?: string; + 'address-line-2'?: string; + city?: string; + state?: string; + zip?: string; + latitude?: number; + longitude?: number; + locale?: string; + timezone?: string; + 'company-name-override'?: string; + 'logo-small-url'?: string; + 'logo-thumb-url'?: string; + 'logo-url'?: string; + disabled?: boolean; + 'visitors-onboarding-complete'?: boolean; + 'registration-eligibility-end-offset'?: number; + 'registration-eligibility-start-offset'?: number; + 'visitor-registration-eligibility-start-offset'?: number; + 'welcome-email-preference'?: string; + 'average-monthly-visitors'?: number; + 'capacity-limit'?: number; + 'auto-sign-out-at-midnight'?: boolean; + 'employee-screening-enabled'?: boolean; + 'pre-registration-enabled'?: boolean; + 'pre-registration-required-enabled'?: boolean; + 'host-approval-enabled'?: boolean; + 'multiple-languages-enabled'?: boolean; + 'near-visit-screening-enabled'?: boolean; + 'printer-notifications-enabled'?: boolean; + 'security-desk-link-enabled'?: boolean; + 'touchless-signin-enabled'?: boolean; + 'visitor-survey-enabled'?: boolean; + 'visual-compliance-enabled'?: boolean; + 'created-at'?: string; + 'updated-at'?: string; +} + +export type LocationRelationships = 'company' | 'employees' | 'flows' | 'employee-screening-flow'; + +export type LocationModel = JSONAPIModel; diff --git a/src/resources/SignInFieldPageResource.ts b/src/resources/SignInFieldPageResource.ts new file mode 100644 index 0000000..e3af783 --- /dev/null +++ b/src/resources/SignInFieldPageResource.ts @@ -0,0 +1,14 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type SignInFieldPageAttributes = { + enabled?: boolean; + position?: number; +}; + +export type SignInFieldPageRelationships = 'flow' +| 'actionable-sign-in-field-actions' +| 'actionable-sign-in-fields' +| 'sign-in-field-actions' +| 'sign-in-fields'; + +export type SignInFieldPageModel = JSONAPIModel; diff --git a/src/resources/SignInFieldResource.ts b/src/resources/SignInFieldResource.ts new file mode 100644 index 0000000..ce16aff --- /dev/null +++ b/src/resources/SignInFieldResource.ts @@ -0,0 +1,22 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export interface SignInFieldAttributes { + name: string; + kind: string; + required: boolean; + identifier?: string; + localized?: string; + 'ipad-localized-names': Array<{ + 'language-code': string; + 'region-code'?: string; + 'display-name': string; + }>; + position?: number; + 'store-response'?: boolean; + 'created-at'?: string; + 'updated-at'?: string; +} + +export type SignInFieldRelationships = 'sign-in-field-page'; + +export type SignInFieldModel = JSONAPIModel; diff --git a/src/resources/UserResource.ts b/src/resources/UserResource.ts new file mode 100644 index 0000000..0f3c2e8 --- /dev/null +++ b/src/resources/UserResource.ts @@ -0,0 +1,8 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export type UserAttributes = { + name: string; + email: string; +}; + +export type UserModel = JSONAPIModel; diff --git a/src/util/json-api/JSONAPIData.ts b/src/util/json-api/JSONAPIData.ts new file mode 100644 index 0000000..3d8395a --- /dev/null +++ b/src/util/json-api/JSONAPIData.ts @@ -0,0 +1,4 @@ +export default interface JSONAPIData { + id: ID; + type: Type; +} diff --git a/src/util/json-api/JSONAPIFilterParams.ts b/src/util/json-api/JSONAPIFilterParams.ts new file mode 100644 index 0000000..754b1c7 --- /dev/null +++ b/src/util/json-api/JSONAPIFilterParams.ts @@ -0,0 +1,5 @@ +import JSONAPIParams from './JSONAPIParams'; + +export default interface JSONAPIFilterParams extends JSONAPIParams { + filter?: FilterFields; +} diff --git a/src/util/json-api/JSONAPIModel.ts b/src/util/json-api/JSONAPIModel.ts new file mode 100644 index 0000000..1c2d707 --- /dev/null +++ b/src/util/json-api/JSONAPIModel.ts @@ -0,0 +1,10 @@ +import JSONAPIData from './JSONAPIData'; + +export default interface JSONAPIModel extends JSONAPIData { + attributes: Attributes; + relationships: { + [key in Relationships]: { + data: JSONAPIData & Array + }; + } +} diff --git a/src/util/json-api/JSONAPIPaginationParams.ts b/src/util/json-api/JSONAPIPaginationParams.ts new file mode 100644 index 0000000..1432eaf --- /dev/null +++ b/src/util/json-api/JSONAPIPaginationParams.ts @@ -0,0 +1,12 @@ +import JSONAPIFilterParams from './JSONAPIFilterParams'; + +export default interface JSONAPIPaginationParams + extends JSONAPIFilterParams { + + page?: { + offset?: number; + limit?: number; + } + + sort?: SortFields; +} diff --git a/src/util/json-api/JSONAPIParams.ts b/src/util/json-api/JSONAPIParams.ts new file mode 100644 index 0000000..16f42b6 --- /dev/null +++ b/src/util/json-api/JSONAPIParams.ts @@ -0,0 +1,3 @@ +export default interface JSONAPIParams { + include?: string; +} diff --git a/src/util/json-api/JSONAPIResponse.ts b/src/util/json-api/JSONAPIResponse.ts new file mode 100644 index 0000000..fbde6a7 --- /dev/null +++ b/src/util/json-api/JSONAPIResponse.ts @@ -0,0 +1,7 @@ +export default interface JSONAPIResponse { + data: Model, + // eslint-disable-next-line @typescript-eslint/no-explicit-any + included?: Array, + // eslint-disable-next-line @typescript-eslint/no-explicit-any + meta?: Array +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..b293d60 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,77 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ + // "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + + /* Advanced Options */ + "skipLibCheck": true, /* Skip type checking of declaration files. */ + "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ + }, + "include": [ + "src/**/*.ts" + ], + "exclude": [ + "node_modules" + ] +} From 792fa6c1e4dbe0aa62f21d15cc54bdfa78ad7409 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Thu, 3 Jun 2021 20:48:16 -0400 Subject: [PATCH 02/91] remove JSDoc annotations --- src/EnvoyPluginSDK.ts | 2 -- src/EnvoyPluginStoragePipeline.ts | 5 ----- src/EnvoySignatureVerifier.ts | 8 -------- src/errorMiddleware.ts | 4 +--- src/middleware.ts | 11 ++++++----- 5 files changed, 7 insertions(+), 23 deletions(-) diff --git a/src/EnvoyPluginSDK.ts b/src/EnvoyPluginSDK.ts index d7c4324..08c9a40 100644 --- a/src/EnvoyPluginSDK.ts +++ b/src/EnvoyPluginSDK.ts @@ -39,8 +39,6 @@ export default class EnvoyPluginSDK; - /** - * - * @param {EnvoyAPI} pluginAPI - * @param {number|null} [installId] - */ constructor(pluginAPI: EnvoyAPI, installId?: string) { this.api = pluginAPI; this.installId = installId; diff --git a/src/EnvoySignatureVerifier.ts b/src/EnvoySignatureVerifier.ts index c9f4235..fd87560 100644 --- a/src/EnvoySignatureVerifier.ts +++ b/src/EnvoySignatureVerifier.ts @@ -2,14 +2,6 @@ import crypto, { BinaryToTextEncoding } from 'crypto'; import { Request } from 'express'; import { envoyClientSecret } from './constants'; -/** - * @typedef {Object} SignatureVerifierOptions - * @property {string} algorithm="sha256" - * @property {string} encoding="base64" - * @property {string} secret=process.env.ENVOY_CLIENT_SECRET - * @property {string} header="x-envoy-signature" - */ - export interface EnvoySignatureVerifierOptions { algorithm: 'sha256' | string, encoding: BinaryToTextEncoding, diff --git a/src/errorMiddleware.ts b/src/errorMiddleware.ts index fa8338d..ce0e66a 100644 --- a/src/errorMiddleware.ts +++ b/src/errorMiddleware.ts @@ -2,9 +2,7 @@ import { Request, Response, NextFunction } from 'express'; import HttpStatus from './HttpStatus'; /** - * - * @param {Function} onError - * @returns {Function} + * Catches errors and sets the proper status code. */ export default function errorMiddleware(onError: (err: Error) => void = () => {}) { return (err: Error, req: Request, res: Response, next: NextFunction): void => { diff --git a/src/middleware.ts b/src/middleware.ts index babd074..d37e679 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -31,26 +31,27 @@ export default function middleware(options: EnvoySignatureVerifierOptions) { } req.envoy = new EnvoyPluginSDK(req.body, req[VERIFIED], accessToken); + /** - * @param {object} [data] + * Respond with "ongoing" for long jobs. */ res.sendOngoing = (data = {}) => { res.statusCode = HttpStatus.ONGOING; res.setHeader('Content-Type', 'application/json'); res.end(JSON.stringify(data)); }; + /** - * @param {string} [message] - * @param {object} [data] + * Respond with "ignored" if no action will be performed. */ res.sendIgnored = (message = '', data = {}) => { res.statusCode = HttpStatus.IGNORED; res.setHeader('Content-Type', 'application/json'); res.end(JSON.stringify({ ...(data || {}), message })); }; + /** - * @param {string} [message] - * @param {object} [data] + * Respond with "failed" in case of errors. */ res.sendFailed = (message = '', data = {}) => { res.statusCode = HttpStatus.FAILED; From c1cfd1a28315199c1f6462ac72e41a7b11b5c978 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Thu, 3 Jun 2021 20:51:16 -0400 Subject: [PATCH 03/91] explicit return type --- src/middleware.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/middleware.ts b/src/middleware.ts index d37e679..02f865b 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -8,7 +8,9 @@ import HttpStatus from './HttpStatus'; import EnvoyRequest, { VERIFIED, VerifiedRequest } from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; -export default function middleware(options: EnvoySignatureVerifierOptions) { +export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => void; + +export default function middleware(options: EnvoySignatureVerifierOptions): EnvoyMiddleware { const signatureVerifier = new EnvoySignatureVerifier(options); const verify = (req: VerifiedRequest, res: Response, rawBody: Buffer) => { req[VERIFIED] = signatureVerifier.verify(req, rawBody); From c08fadc26ede944152cf309a7fc8908ea2181a34 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Thu, 3 Jun 2021 20:55:00 -0400 Subject: [PATCH 04/91] helper request types --- src/EnvoyRequest.ts | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/EnvoyRequest.ts b/src/EnvoyRequest.ts index dfc9415..2bdba20 100644 --- a/src/EnvoyRequest.ts +++ b/src/EnvoyRequest.ts @@ -1,6 +1,8 @@ import { Request } from 'express'; import EnvoyPluginSDK from './EnvoyPluginSDK'; -import EnvoyMeta from './EnvoyMeta'; +import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta'; +import EntryPayload from './payloads/EntryPayload'; +import InvitePayload from './payloads/InvitePayload'; export const VERIFIED = Symbol('verified'); @@ -11,3 +13,7 @@ export interface VerifiedRequest extends Request { export default interface EnvoyRequest extends VerifiedRequest { envoy: EnvoyPluginSDK } + +export type EnvoyRouteRequest = EnvoyRequest; +export type EnvoyEntryEventRequest = EnvoyRequest; +export type EnvoyInviteEventRequest = EnvoyRequest; From aecf47bc34553e2ed5cff60c343dd0f3853f1bdf Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 13:45:07 -0400 Subject: [PATCH 05/91] cleanup --- .gitignore | 1 + README.md | 15 +- asynchandler.md | 46 -- docs/README.md | 125 +++++ docs/classes/envoyjwt.md | 76 +++ docs/classes/envoypluginapi.md | 193 ++++++++ docs/classes/envoypluginjob.md | 193 ++++++++ docs/classes/envoypluginsdk.md | 236 +++++++++ docs/classes/envoypluginstorage.md | 193 ++++++++ docs/classes/envoypluginstoragepipeline.md | 232 +++++++++ docs/classes/envoysignatureverifier.md | 54 ++ docs/classes/envoyuserapi.md | 516 +++++++++++++++++++ docs/enums/httpstatus.md | 54 ++ envoyapi.md | 150 ------ envoyjwt.md | 46 -- envoypluginjob.md | 106 ---- envoypluginsdk.md | 87 ---- envoypluginstorage.md | 95 ---- envoypluginstoragepipeline.md | 125 ----- envoysignatureverifier.md | 43 -- errormiddleware.md | 41 -- index.js | 47 -- lib/EnvoyAPI.js | 477 ------------------ lib/EnvoyJWT.js | 72 --- lib/EnvoyPluginJob.js | 124 ----- lib/EnvoyPluginSDK.js | 192 -------- lib/EnvoyPluginStorage.js | 109 ---- lib/EnvoyPluginStoragePipeline.js | 142 ------ lib/EnvoyResponseError.js | 18 - lib/EnvoySignatureVerifier.js | 67 --- lib/HttpStatus.js | 20 - lib/asyncHandler.js | 17 - lib/errorMiddleware.js | 27 - lib/middleware.js | 110 ----- middleware.md | 53 -- package-lock.json | 546 +++++++++------------ package.json | 34 +- src/EnvoyAPI.ts | 267 +--------- src/EnvoyJWT.ts | 17 +- src/EnvoyMeta.ts | 23 +- src/EnvoyPluginAPI.ts | 79 +++ src/EnvoyPluginJob.ts | 15 +- src/EnvoyPluginJobAttachment.ts | 15 + src/EnvoyPluginSDK.ts | 64 ++- src/EnvoyPluginStorage.ts | 12 +- src/EnvoyPluginStoragePipeline.ts | 14 +- src/EnvoyRequest.ts | 18 +- src/EnvoyResponse.ts | 10 +- src/EnvoySignatureVerifier.ts | 3 + src/EnvoyStorageCommand.ts | 2 +- src/EnvoyStorageItem.ts | 2 +- src/EnvoyUserAPI.ts | 197 ++++++++ src/HttpStatus.ts | 3 + src/asyncHandler.ts | 8 +- src/constants.ts | 3 + src/index.ts | 27 + src/middleware.ts | 30 +- src/util/json-api/JSONAPIResponse.ts | 6 +- tsconfig.json | 11 +- typedoc.json | 7 + 60 files changed, 2625 insertions(+), 2890 deletions(-) delete mode 100644 asynchandler.md create mode 100644 docs/README.md create mode 100644 docs/classes/envoyjwt.md create mode 100644 docs/classes/envoypluginapi.md create mode 100644 docs/classes/envoypluginjob.md create mode 100644 docs/classes/envoypluginsdk.md create mode 100644 docs/classes/envoypluginstorage.md create mode 100644 docs/classes/envoypluginstoragepipeline.md create mode 100644 docs/classes/envoysignatureverifier.md create mode 100644 docs/classes/envoyuserapi.md create mode 100644 docs/enums/httpstatus.md delete mode 100644 envoyapi.md delete mode 100644 envoyjwt.md delete mode 100644 envoypluginjob.md delete mode 100644 envoypluginsdk.md delete mode 100644 envoypluginstorage.md delete mode 100644 envoypluginstoragepipeline.md delete mode 100644 envoysignatureverifier.md delete mode 100644 errormiddleware.md delete mode 100644 index.js delete mode 100644 lib/EnvoyAPI.js delete mode 100644 lib/EnvoyJWT.js delete mode 100644 lib/EnvoyPluginJob.js delete mode 100644 lib/EnvoyPluginSDK.js delete mode 100644 lib/EnvoyPluginStorage.js delete mode 100644 lib/EnvoyPluginStoragePipeline.js delete mode 100644 lib/EnvoyResponseError.js delete mode 100644 lib/EnvoySignatureVerifier.js delete mode 100644 lib/HttpStatus.js delete mode 100644 lib/asyncHandler.js delete mode 100644 lib/errorMiddleware.js delete mode 100644 lib/middleware.js delete mode 100644 middleware.md create mode 100644 src/EnvoyPluginAPI.ts create mode 100644 src/EnvoyUserAPI.ts create mode 100644 src/index.ts create mode 100644 typedoc.json diff --git a/.gitignore b/.gitignore index 1c5dd34..b53be68 100644 --- a/.gitignore +++ b/.gitignore @@ -60,3 +60,4 @@ typings/ # next.js build output .next .idea +dist diff --git a/README.md b/README.md index 523f72c..050cbdf 100644 --- a/README.md +++ b/README.md @@ -132,20 +132,7 @@ app.use(errorMiddleware()); ## SDK Reference -For completeness, here is a list of each module exported by the SDK package. - -| Name | Type | -| :--- | :--- | -| EnvoyAPI | [EnvoyAPI](envoyapi.md) | -| EnvoyJWT | [EnvoyJWT](envoyjwt.md) | -| EnvoyPluginJob | [EnvoyPluginJob](envoypluginjob.md) | -| EnvoyPluginSDK | [EnvoyPluginSDK](envoypluginsdk.md) | -| EnvoyPluginStorage | [EnvoyPluginStorage](envoypluginstorage.md) | -| EnvoyPluginStoragePipeline | [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) | -| EnvoySignatureVerifier | [EnvoySignatureVerifier](envoysignatureverifier.md) | -| middleware | [middleware](middleware.md) | -| errorMiddleware | [errorMiddleware](errormiddleware.md) | -| asyncHandler | [asyncHandler](asynchandler.md) | +Please see detailed documentation [here](docs/README.md). ### Contributing diff --git a/asynchandler.md b/asynchandler.md deleted file mode 100644 index 427a4bc..0000000 --- a/asynchandler.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: >- - Use this wrapper around your `async` endpoint handlers to catch Promise-based - errors. ---- - -# asyncHandler - -## Example - -```javascript -const express = require('express'); -const { middleware, asyncHandler } = require('envoy-integrations-sdk-nodejs'); - -const app = express(); -app.use(middleware()); -app.post('/foo', asyncHandler(async (req, res) => { - await somePromiseThatThrowsAnError(); -})); -``` - -## Functions - -### asyncHandler\(handler\) ⇒ `connectHandler` - -Returns a wrapped handler that catches Promise-based errors. - -**Kind**: global function - -| Param | Type | -| :--- | :--- | -| handler | `connectHandler` | - -### Related Functions and Classes - -### connectHandler : `function` - -Express/connect middleware. - -**Kind**: global typedef - -| Param | Type | -| :--- | :--- | -| req | [http://expressjs.com/en/4x/api.html\#req](http://expressjs.com/en/4x/api.html#req) | -| res | [http://expressjs.com/en/4x/api.html\#res](http://expressjs.com/en/4x/api.html#res) | - diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..a9e87dc --- /dev/null +++ b/docs/README.md @@ -0,0 +1,125 @@ +@envoy/envoy-integrations-sdk + +# @envoy/envoy-integrations-sdk + +## Table of contents + +### Enumerations + +- [HttpStatus](enums/httpstatus.md) + +### Classes + +- [EnvoyJWT](classes/envoyjwt.md) +- [EnvoyPluginAPI](classes/envoypluginapi.md) +- [EnvoyPluginJob](classes/envoypluginjob.md) +- [EnvoyPluginSDK](classes/envoypluginsdk.md) +- [EnvoyPluginStorage](classes/envoypluginstorage.md) +- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) +- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) +- [EnvoyUserAPI](classes/envoyuserapi.md) + +### Functions + +- [asyncHandler](README.md#asynchandler) +- [errorMiddleware](README.md#errormiddleware) +- [middleware](README.md#middleware) + +## Functions + +### asyncHandler + +▸ **asyncHandler**(`handler`): (`req`: `default`, `res`: `default`, `next`: `NextFunction`) => `Promise` + +Catches Promise-based errors. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | `RequestHandler` \| `EnvoyHandler` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `Promise` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `default` | +| `res` | `default` | +| `next` | `NextFunction` | + +##### Returns + +`Promise` + +#### Defined in + +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/asyncHandler.ts#L10) + +___ + +### errorMiddleware + +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: `Request`\>, `res`: `Response`\>, `next`: `NextFunction`) => `void` + +Catches errors and sets the proper status code. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `onError` | (`err`: `Error`) => `void` | + +#### Returns + +`fn` + +▸ (`err`, `req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `req` | `Request`\> | +| `res` | `Response`\> | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +[errorMiddleware.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/errorMiddleware.ts#L7) + +___ + +### middleware + +▸ **middleware**(`options?`): `EnvoyMiddleware` + +Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. +Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. + +Also verifies that the request is coming from Envoy, +as well as managing the plugin access token lifecycle. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `EnvoySignatureVerifierOptions` | + +#### Returns + +`EnvoyMiddleware` + +#### Defined in + +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md new file mode 100644 index 0000000..6ffe62c --- /dev/null +++ b/docs/classes/envoyjwt.md @@ -0,0 +1,76 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyJWT + +# Class: EnvoyJWT + +Helper to encode and decode JWTs. + +## Table of contents + +### Constructors + +- [constructor](envoyjwt.md#constructor) + +### Methods + +- [decode](envoyjwt.md#decode) +- [encode](envoyjwt.md#encode) + +## Constructors + +### constructor + +• **new EnvoyJWT**(`secret?`, `algorithm?`) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `secret` | `string` | `undefined` | +| `algorithm` | `Algorithm` | 'HS256' | + +#### Defined in + +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyJWT.ts#L12) + +## Methods + +### decode + +▸ **decode**(`token`, `options?`): `Record` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `options` | `VerifyOptions` | + +#### Returns + +`Record` + +#### Defined in + +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyJWT.ts#L39) + +___ + +### encode + +▸ **encode**(`subject`, `expiresIn`, `payload?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subject` | ``null`` \| `string` \| `number` | +| `expiresIn` | ``null`` \| `string` \| `number` | +| `payload` | `Record` | + +#### Returns + +`string` + +#### Defined in + +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md new file mode 100644 index 0000000..f1643d5 --- /dev/null +++ b/docs/classes/envoypluginapi.md @@ -0,0 +1,193 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginAPI + +# Class: EnvoyPluginAPI + +API endpoints for *plugin-scoped* tokens. + +## Hierarchy + +- `EnvoyAPI` + + ↳ **EnvoyPluginAPI** + +## Table of contents + +### Constructors + +- [constructor](envoypluginapi.md#constructor) + +### Properties + +- [axios](envoypluginapi.md#axios) + +### Methods + +- [createNotification](envoypluginapi.md#createnotification) +- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) +- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) +- [storagePipeline](envoypluginapi.md#storagepipeline) +- [updateJob](envoypluginapi.md#updatejob) +- [login](envoypluginapi.md#login) + +## Constructors + +### constructor + +• **new EnvoyPluginAPI**(`accessToken`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `accessToken` | `string` | + +#### Inherited from + +EnvoyAPI.constructor + +#### Defined in + +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L58) + +## Properties + +### axios + +• `Readonly` **axios**: `AxiosInstance` + +HTTP Client with Envoy's defaults. + +#### Inherited from + +EnvoyAPI.axios + +#### Defined in + +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L31) + +## Methods + +### createNotification + +▸ **createNotification**(`installId`, `params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | +| `params` | `Object` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L50) + +___ + +### getPluginInstallConfig + +▸ **getPluginInstallConfig**(`installId`): `Promise`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | + +#### Returns + +`Promise`\> + +#### Defined in + +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L21) + +___ + +### setPluginInstallConfig + +▸ **setPluginInstallConfig**(`installId`, `config`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | +| `config` | `Record` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L26) + +___ + +### storagePipeline + +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| default)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `commands` | `EnvoyStorageCommand`[] | +| `installId?` | `string` | + +#### Returns + +`Promise`<(``null`` \| default)[]\> + +#### Defined in + +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L34) + +___ + +### updateJob + +▸ **updateJob**(`jobId`, `update`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `jobId` | `string` | +| `update` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L13) + +___ + +### login + +▸ `Static` **login**(`id?`, `secret?`): `Promise` + +Gets a plugin access token using `client_credentials` as the grant type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `secret` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md new file mode 100644 index 0000000..e226699 --- /dev/null +++ b/docs/classes/envoypluginjob.md @@ -0,0 +1,193 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginJob + +# Class: EnvoyPluginJob + +A "job" is an event, like `entry_sign_in`. +When your plugin handles the event, you can use this job concept +to update the status (e.g. complete, failed, ignored) +as well as attach extra data to the event's subject +(e.g. showing a generated card number in the dashboard for a visitor on `entry_sign_in`). + +## Table of contents + +### Constructors + +- [constructor](envoypluginjob.md#constructor) + +### Properties + +- [api](envoypluginjob.md#api) +- [id](envoypluginjob.md#id) + +### Methods + +- [attach](envoypluginjob.md#attach) +- [complete](envoypluginjob.md#complete) +- [execute](envoypluginjob.md#execute) +- [fail](envoypluginjob.md#fail) +- [ignore](envoypluginjob.md#ignore) +- [update](envoypluginjob.md#update) + +## Constructors + +### constructor + +• **new EnvoyPluginJob**(`pluginAPI`, `jobId`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `jobId` | `string` | + +#### Defined in + +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L15) + +## Properties + +### api + +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L13) + +___ + +### id + +• `Readonly` **id**: `string` + +#### Defined in + +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L15) + +## Methods + +### attach + +▸ **attach**(...`attachments`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L43) + +___ + +### complete + +▸ **complete**(`message`, ...`attachments`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L47) + +___ + +### execute + +▸ **execute**(`status`, `message`, `reason`, `attachments?`): `Promise` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `status` | ``null`` \| `string` | `undefined` | +| `message` | ``null`` \| `string` | `undefined` | +| `reason` | ``null`` \| `string` | `undefined` | +| `attachments` | `EnvoyPluginJobAttachment`[] | [] | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L22) + +___ + +### fail + +▸ **fail**(`message`, `reason`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `reason` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L55) + +___ + +### ignore + +▸ **ignore**(`message`, `reason`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `reason` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L51) + +___ + +### update + +▸ **update**(`message`, ...`attachments`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md new file mode 100644 index 0000000..813b75d --- /dev/null +++ b/docs/classes/envoypluginsdk.md @@ -0,0 +1,236 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginSDK + +# Class: EnvoyPluginSDK + +Sets up all relevant Envoy functions. +Attaches itself to every request object using our `middleware`, +to allow for easy access to Envoy functions. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Payload` | `Payload` = `unknown` | + +## Table of contents + +### Constructors + +- [constructor](envoypluginsdk.md#constructor) + +### Accessors + +- [getJob](envoypluginsdk.md#getjob) +- [globalStorage](envoypluginsdk.md#globalstorage) +- [installStorage](envoypluginsdk.md#installstorage) +- [job](envoypluginsdk.md#job) +- [jobId](envoypluginsdk.md#jobid) +- [jwt](envoypluginsdk.md#jwt) +- [meta](envoypluginsdk.md#meta) +- [payload](envoypluginsdk.md#payload) +- [pluginAPI](envoypluginsdk.md#pluginapi) +- [userAPI](envoypluginsdk.md#userapi) + +## Constructors + +### constructor + +• **new EnvoyPluginSDK**(`body`, `isVerified?`, `pluginAccessToken?`) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Payload` | `Payload` = `unknown` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `body` | `EnvoyRequestBody` | `undefined` | +| `isVerified` | `boolean` | false | +| `pluginAccessToken` | ``null`` \| `string` | null | + +#### Defined in + +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L38) + +## Accessors + +### getJob + +• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](envoypluginjob.md) + +Returns a job based on an ID. + +#### Returns + +`fn` + +▸ (`jobId`): [EnvoyPluginJob](envoypluginjob.md) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `jobId` | `string` | + +##### Returns + +[EnvoyPluginJob](envoypluginjob.md) + +#### Defined in + +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L129) + +___ + +### globalStorage + +• `get` **globalStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) + +Storage scoped globally (across installs). + +#### Returns + +[EnvoyPluginStorage](envoypluginstorage.md) + +#### Defined in + +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L122) + +___ + +### installStorage + +• `get` **installStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) + +Storage scoped to the install. + +#### Returns + +[EnvoyPluginStorage](envoypluginstorage.md) + +#### Defined in + +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L111) + +___ + +### job + +• `get` **job**(): [EnvoyPluginJob](envoypluginjob.md) + +Perform operations on the current job. + +#### Returns + +[EnvoyPluginJob](envoypluginjob.md) + +#### Defined in + +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L147) + +___ + +### jobId + +• `get` **jobId**(): ``null`` \| `string` + +Returns the current job's ID. + +#### Returns + +``null`` \| `string` + +#### Defined in + +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L136) + +___ + +### jwt + +• `get` **jwt**(): [EnvoyJWT](envoyjwt.md) + +A utility to encode and decode JWTs. +Useful for verifiable communications between plugin endpoints. + +#### Returns + +[EnvoyJWT](envoyjwt.md) + +#### Defined in + +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L160) + +___ + +### meta + +• `get` **meta**(): `Meta` + +The metadata for the request. +Either an EnvoyEventMeta or EnvoyRouteMeta. + +#### Returns + +`Meta` + +#### Defined in + +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L50) + +___ + +### payload + +• `get` **payload**(): `Payload` + +The payload for the request. +For events, it's some Envoy resource, like an Entry or Invite. +For setup step validation URLs, it's the form submitted values for a validation URL. + +#### Returns + +`Payload` + +#### Defined in + +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L62) + +___ + +### pluginAPI + +• `get` **pluginAPI**(): [EnvoyPluginAPI](envoypluginapi.md) + +Envoy API scoped to the plugin. +Used to perform storage or job operations. + +#### Returns + +[EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L90) + +___ + +### userAPI + +• `get` **userAPI**(): [EnvoyUserAPI](envoyuserapi.md) + +Envoy API scoped to the user. +Used only in routes. + +#### Returns + +[EnvoyUserAPI](envoyuserapi.md) + +#### Defined in + +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md new file mode 100644 index 0000000..1b22426 --- /dev/null +++ b/docs/classes/envoypluginstorage.md @@ -0,0 +1,193 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStorage + +# Class: EnvoyPluginStorage + +A key-value storage that can be scoped to a specific install, +or to the plugin itself. + +## Table of contents + +### Constructors + +- [constructor](envoypluginstorage.md#constructor) + +### Properties + +- [api](envoypluginstorage.md#api) +- [installId](envoypluginstorage.md#installid) + +### Methods + +- [get](envoypluginstorage.md#get) +- [pipeline](envoypluginstorage.md#pipeline) +- [set](envoypluginstorage.md#set) +- [setUnique](envoypluginstorage.md#setunique) +- [setUniqueNum](envoypluginstorage.md#setuniquenum) +- [unset](envoypluginstorage.md#unset) + +## Constructors + +### constructor + +• **new EnvoyPluginStorage**(`pluginAPI`, `installId?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `installId?` | `string` | + +#### Defined in + +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L13) + +## Properties + +### api + +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L11) + +___ + +### installId + +• `Readonly` **installId**: `undefined` \| `string` + +#### Defined in + +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L13) + +## Methods + +### get + +▸ **get**(`key`): `Promise`<``null`` \| default\> + +Wrapper for single pipeline get. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`Promise`<``null`` \| default\> + +#### Defined in + +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L30) + +___ + +### pipeline + +▸ **pipeline**(): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +Creates a new pipeline instance. + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L23) + +___ + +### set + +▸ **set**(`key`, `value`): `Promise`<``null`` \| default\> + +Wrapper for single pipeline set. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `unknown` | + +#### Returns + +`Promise`<``null`` \| default\> + +#### Defined in + +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L37) + +___ + +### setUnique + +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| default\> + +Wrapper for single pipeline setUnique. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `EnvoyStorageSetUniqueOptions` | + +#### Returns + +`Promise`<``null`` \| default\> + +#### Defined in + +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L44) + +___ + +### setUniqueNum + +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| default\> + +Wrapper for single pipeline setUnique. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `EnvoyStorageSetUniqueNumOptions` | + +#### Returns + +`Promise`<``null`` \| default\> + +#### Defined in + +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L51) + +___ + +### unset + +▸ **unset**(`key`): `Promise`<``null`` \| default\> + +Wrapper for single pipeline unset. +Returns null if the item did not previously exist. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`Promise`<``null`` \| default\> + +#### Defined in + +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md new file mode 100644 index 0000000..388641c --- /dev/null +++ b/docs/classes/envoypluginstoragepipeline.md @@ -0,0 +1,232 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStoragePipeline + +# Class: EnvoyPluginStoragePipeline + +Builds up a request pipeline for submitting storage commands. + +## Table of contents + +### Constructors + +- [constructor](envoypluginstoragepipeline.md#constructor) + +### Properties + +- [api](envoypluginstoragepipeline.md#api) +- [installId](envoypluginstoragepipeline.md#installid) + +### Methods + +- [addCommand](envoypluginstoragepipeline.md#addcommand) +- [execute](envoypluginstoragepipeline.md#execute) +- [executeSingle](envoypluginstoragepipeline.md#executesingle) +- [get](envoypluginstoragepipeline.md#get) +- [set](envoypluginstoragepipeline.md#set) +- [setUnique](envoypluginstoragepipeline.md#setunique) +- [setUniqueNum](envoypluginstoragepipeline.md#setuniquenum) +- [unset](envoypluginstoragepipeline.md#unset) + +## Constructors + +### constructor + +• **new EnvoyPluginStoragePipeline**(`pluginAPI`, `installId?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `installId?` | `string` | + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L16) + +## Properties + +### api + +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L12) + +___ + +### installId + +• `Readonly` **installId**: `undefined` \| `string` + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L14) + +## Methods + +### addCommand + +▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `command` | `EnvoyStorageCommand` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L39) + +___ + +### execute + +▸ **execute**(): `Promise`<(``null`` \| default)[]\> + +Executes all the commands in the pipeline. + +#### Returns + +`Promise`<(``null`` \| default)[]\> + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L27) + +___ + +### executeSingle + +▸ **executeSingle**(): `Promise`<``null`` \| default\> + +Executes the pipeline and returns the first result. + +#### Returns + +`Promise`<``null`` \| default\> + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L34) + +___ + +### get + +▸ **get**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +Gets a storage item. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L47) + +___ + +### set + +▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +Sets a value for a storage item, +and returns that item. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `unknown` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L55) + +___ + +### setUnique + +▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +Sets a unique value for a storage item, +and returns that item. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `EnvoyStorageSetUniqueOptions` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L63) + +___ + +### setUniqueNum + +▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +Sets a unique number value for a storage item, +and returns that item. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `EnvoyStorageSetUniqueNumOptions` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L71) + +___ + +### unset + +▸ **unset**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +Unsets a storage item. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md new file mode 100644 index 0000000..4f723dc --- /dev/null +++ b/docs/classes/envoysignatureverifier.md @@ -0,0 +1,54 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifier + +# Class: EnvoySignatureVerifier + +Verifies that a request is coming from Envoy. + +## Table of contents + +### Constructors + +- [constructor](envoysignatureverifier.md#constructor) + +### Methods + +- [verify](envoysignatureverifier.md#verify) + +## Constructors + +### constructor + +• **new EnvoySignatureVerifier**(`options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `EnvoySignatureVerifierOptions` | + +#### Defined in + +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoySignatureVerifier.ts#L23) + +## Methods + +### verify + +▸ **verify**(`req`, `rawBody`): `boolean` + +Verifies that the signature provided matches the request body. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request`\> | +| `rawBody` | `Buffer` | + +#### Returns + +`boolean` + +#### Defined in + +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md new file mode 100644 index 0000000..b5a4758 --- /dev/null +++ b/docs/classes/envoyuserapi.md @@ -0,0 +1,516 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyUserAPI + +# Class: EnvoyUserAPI + +API endpoints for *user-scoped* tokens. +To access Envoy resources, this is the API you'd want. + +## Hierarchy + +- `EnvoyAPI` + + ↳ **EnvoyUserAPI** + +## Table of contents + +### Constructors + +- [constructor](envoyuserapi.md#constructor) + +### Properties + +- [axios](envoyuserapi.md#axios) + +### Methods + +- [createInvite](envoyuserapi.md#createinvite) +- [getAgreement](envoyuserapi.md#getagreement) +- [getAgreementPage](envoyuserapi.md#getagreementpage) +- [getCompany](envoyuserapi.md#getcompany) +- [getEmployee](envoyuserapi.md#getemployee) +- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) +- [getEmployees](envoyuserapi.md#getemployees) +- [getFlow](envoyuserapi.md#getflow) +- [getFlows](envoyuserapi.md#getflows) +- [getInvites](envoyuserapi.md#getinvites) +- [getLocation](envoyuserapi.md#getlocation) +- [getLocations](envoyuserapi.md#getlocations) +- [getSignInField](envoyuserapi.md#getsigninfield) +- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) +- [getSignInFields](envoyuserapi.md#getsigninfields) +- [me](envoyuserapi.md#me) +- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) +- [removeInvite](envoyuserapi.md#removeinvite) +- [updateInvite](envoyuserapi.md#updateinvite) +- [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) +- [loginAsUser](envoyuserapi.md#loginasuser) + +## Constructors + +### constructor + +• **new EnvoyUserAPI**(`accessToken`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `accessToken` | `string` | + +#### Inherited from + +EnvoyAPI.constructor + +#### Defined in + +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L58) + +## Properties + +### axios + +• `Readonly` **axios**: `AxiosInstance` + +HTTP Client with Envoy's defaults. + +#### Inherited from + +EnvoyAPI.axios + +#### Defined in + +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L31) + +## Methods + +### createInvite + +▸ **createInvite**(`invite`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `InviteCreationModel` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L111) + +___ + +### getAgreement + +▸ **getAgreement**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L28) + +___ + +### getAgreementPage + +▸ **getAgreementPage**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L24) + +___ + +### getCompany + +▸ **getCompany**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L32) + +___ + +### getEmployee + +▸ **getEmployee**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L36) + +___ + +### getEmployeeByEmail + +▸ **getEmployeeByEmail**(`email`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L56) + +___ + +### getEmployees + +▸ **getEmployees**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L75) + +___ + +### getFlow + +▸ **getFlow**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L40) + +___ + +### getFlows + +▸ **getFlows**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L82) + +___ + +### getInvites + +▸ **getInvites**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L99) + +___ + +### getLocation + +▸ **getLocation**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L44) + +___ + +### getLocations + +▸ **getLocations**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L87) + +___ + +### getSignInField + +▸ **getSignInField**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L52) + +___ + +### getSignInFieldPage + +▸ **getSignInFieldPage**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L48) + +___ + +### getSignInFields + +▸ **getSignInFields**(`signInFieldPageId`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signInFieldPageId` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L94) + +___ + +### me + +▸ **me**(): `Promise` + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L106) + +___ + +### partialUpdateInvite + +▸ **partialUpdateInvite**(`inviteId`, `invite`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `string` | +| `invite` | `InviteCreationModel` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L130) + +___ + +### removeInvite + +▸ **removeInvite**(`inviteId`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L140) + +___ + +### updateInvite + +▸ **updateInvite**(`inviteId`, `invite`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `string` | +| `invite` | `InviteCreationModel` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L120) + +___ + +### loginAsPluginInstaller + +▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise` + +Gets a user access token using `plugin_install` as the grant type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | +| `id` | `string` | +| `secret` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L177) + +___ + +### loginAsUser + +▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise` + +Gets a user access token using `password` as the grant type (discouraged). + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `username` | `string` | +| `password` | `string` | +| `id` | `string` | +| `secret` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md new file mode 100644 index 0000000..7e246cd --- /dev/null +++ b/docs/enums/httpstatus.md @@ -0,0 +1,54 @@ +[@envoy/envoy-integrations-sdk](../README.md) / HttpStatus + +# Enumeration: HttpStatus + +Use these status codes to inform Envoy of a job's or route's status. + +## Table of contents + +### Enumeration members + +- [FAILED](httpstatus.md#failed) +- [IGNORED](httpstatus.md#ignored) +- [ONGOING](httpstatus.md#ongoing) +- [UNEXPECTED\_FAILURE](httpstatus.md#unexpected_failure) + +## Enumeration members + +### FAILED + +• **FAILED** = 412 + +#### Defined in + +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L7) + +___ + +### IGNORED + +• **IGNORED** = 400 + +#### Defined in + +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L6) + +___ + +### ONGOING + +• **ONGOING** = 202 + +#### Defined in + +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L5) + +___ + +### UNEXPECTED\_FAILURE + +• **UNEXPECTED\_FAILURE** = 500 + +#### Defined in + +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L8) diff --git a/envoyapi.md b/envoyapi.md deleted file mode 100644 index 4ca3ce0..0000000 --- a/envoyapi.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -description: Makes calls to the Envoy API. ---- - -# EnvoyAPI - -Note that there are many API calls not covered by this class. Please add to this class as necessary! - -## Constructor - -#### const api = new EnvoyAPI\(token\) - -| Param | Type | -| :--- | :--- | -| token | `string` | - -## Properties and Methods - -* _instance_ - * .flows\(locationId\) ⇒ `Promise.>` - * .signInPage\(flowId\) ⇒ `Promise.` - * .signInFields\(pageId\) ⇒ `Promise.>` - * .createNotificationEvent\(event\) ⇒ `Promise.` - * .updateJob\(jobId, updates\) ⇒ `Promise.` - * .storagePipeline\(commands, \[installId\]\) ⇒ `Promise.>` -* _static_ - * .login\(\[id\], \[secret\]\) - -#### envoyAPI.flows\(locationId\) ⇒ `Promise.>` - -Fetches the visitor types for this location. - -**Kind**: instance method of `EnvoyAPI` - -| Param | Type | -| :--- | :--- | -| locationId | `string` \| `number` | - -#### envoyAPI.signInPage\(flowId\) ⇒ `Promise.` - -Fetches the sign-in page details for this flow. - -**Kind**: instance method of `EnvoyAPI` - -| Param | Type | -| :--- | :--- | -| flowId | `string` \| `number` | - -#### envoyAPI.signInFields\(pageId\) ⇒ `Promise.>` - -Fetches the sign-in fields for this page. - -**Kind**: instance method of `EnvoyAPI` - -| Param | Type | -| :--- | :--- | -| pageId | `string` \| `number` | - -#### envoyAPI.createNotificationEvent\(event\) ⇒ `Promise.` - -Creates a notification event. - -**Kind**: instance method of `EnvoyAPI` - -| Param | Type | -| :--- | :--- | -| event | `Object` | - -#### envoyAPI.updateJob\(jobId, updates\) ⇒ `Promise.` - -Updates the job. - -**Kind**: instance method of `EnvoyAPI` - -| Param | Type | -| :--- | :--- | -| jobId | `string` \| `uuid` | -| updates | `JobUpdate` | - -#### envoyAPI.storagePipeline\(commands, \[installId\]\) ⇒ `Promise.>` - -Runs the storage pipeline. - -**Kind**: instance method of `EnvoyAPI` - -| Param | Type | Default | -| :--- | :--- | :--- | -| commands | `Array.` | | -| \[installId\] | `string` \| `uuid` \| `number` | `null` | - -#### EnvoyAPI.login\(\[id\], \[secret\]\) - -Gets an access token using client\_credentials as the grant type. - -**Kind**: static method of `EnvoyAPI` - -| Param | Type | Default | -| :--- | :--- | :--- | -| \[id\] | `string` | `process.env.ENVOY_CLIENT_ID` | -| \[secret\] | `string` | `process.env.ENVOY_CLIENT_SECRET` | - -## Related Classes - -### EnvoyObject : `Object` - -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| id | `string` \| `number` \| `uuid` | the ID of the object | -| attributes | `Object` | the object's attributes, in dash-case. | - -### Attachment : `Object` - -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| type | `string` | only "password" supported :\( | -| label | `string` | the label to display in Garaje | -| value | `string` | the value to display in Garaje | - -### JobUpdate : `Object` - -**Properties** - -| Name | Type | -| :--- | :--- | -| \[status\] | `string` | -| \[status\_message\] | `string` | -| \[failure\_reason\] | `string` | -| \[attachments\] | `Array.` | - -### PluginStorageItem : `Object` - -**Properties** - -| Name | Type | -| :--- | :--- | -| key | `string` | -| value | | - -### Command : `Object` - -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| action | `string` | the type of command to run | -| key | `string` | the key to operate on | diff --git a/envoyjwt.md b/envoyjwt.md deleted file mode 100644 index 6f7408c..0000000 --- a/envoyjwt.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: Encodes/decodes JWTs ---- - -# EnvoyJWT - -## Constructor - -#### const jwt = new EnvoyJWT\(\[secret\], \[algorithm\]\) - -| Param | Type | Default | -| :--- | :--- | :--- | -| \[secret\] | `string` | `process.env.JWT_SECRET` | -| \[algorithm\] | `string` | `"HS256"` | - -## Properties and Methods - -* _instance_ - * .encode\(subject, expiresIn, \[payload\]\) ⇒ `Promise.` - * .decode\(token, \[options\]\) ⇒ `Promise.<{}>` - -#### envoyJWT.encode\(subject, expiresIn, \[payload\]\) ⇒ `Promise.` - -Creates a JWT. - -**Kind**: instance method of `EnvoyJWT` - -| Param | Type | Description | -| :--- | :--- | :--- | -| subject | `string` \| `number` \| `null` | | -| expiresIn | `string` \| `number` \| `null` | seconds or string like: [https://github.com/zeit/ms](https://github.com/zeit/ms) | -| \[payload\] | `Object` | | - -#### envoyJWT.decode\(token, \[options\]\) ⇒ `Promise.<{}>` - -**Kind**: instance method of `EnvoyJWT` - -| Param | Type | -| :--- | :--- | -| token | `string` | -| \[options\] | `JWTOptions` | - -### JWTOptions : `Object` - -[https://www.npmjs.com/package/jsonwebtoken\#jwtverifytoken-secretorpublickey-options-callback](https://www.npmjs.com/package/jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback) - diff --git a/envoypluginjob.md b/envoypluginjob.md deleted file mode 100644 index 14febbe..0000000 --- a/envoypluginjob.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -description: 'Updates jobs by updating statuses, adding attachments, etc.' ---- - -# EnvoyPluginJob - -## Constructor - -#### const job = new EnvoyPluginJob\(pluginAPI, jobId\) - -| Param | Type | -| :--- | :--- | -| pluginAPI | `EnvoyAPI` | -| jobId | `string` \| `uuid` | - -## Properties and Methods - -* _instance_ - * .api : `EnvoyAPI` - * .id : `string` \| `uuid` - * .execute\(status, message, \[reason\], \[attachments\]\) ⇒ `Promise.` - * .attach\(...attachments\) ⇒ `Promise.` - * .complete\(message, \[...attachments\]\) ⇒ `Promise.` - * .ignore\(message, reason\) ⇒ `Promise.` - * .fail\(message, reason\) ⇒ `Promise.` - * .update\(message, \[...attachments\]\) ⇒ `Promise.` - -#### envoyPluginJob.execute\(status, message, \[reason\], \[attachments\]\) ⇒ `Promise.` - -Updates a job. - -**Kind**: instance method of `EnvoyPluginJob` - -| Param | Type | -| :--- | :--- | -| status | `string` \| `null` | -| message | `string` \| `null` | -| \[reason\] | `string` \| `null` | -| \[attachments\] | `Array.` \| `null` | - -#### envoyPluginJob.attach\(...attachments\) ⇒ `Promise.` - -Attaches items to an in-progress job. - -**Kind**: instance method of `EnvoyPluginJob` - -| Param | Type | -| :--- | :--- | -| ...attachments | `Attachment` | - -#### envoyPluginJob.complete\(message, \[...attachments\]\) ⇒ `Promise.` - -Completes the job. - -**Kind**: instance method of `EnvoyPluginJob` - -| Param | Type | -| :--- | :--- | -| message | `string` | -| \[...attachments\] | `Attachment` | - -#### envoyPluginJob.ignore\(message, reason\) ⇒ `Promise.` - -Ignores the job. - -**Kind**: instance method of `EnvoyPluginJob` - -| Param | Type | -| :--- | :--- | -| message | `string` | -| reason | `string` | - -#### envoyPluginJob.fail\(message, reason\) ⇒ `Promise.` - -Fails the job. - -**Kind**: instance method of `EnvoyPluginJob` - -| Param | Type | -| :--- | :--- | -| message | `string` | -| reason | `string` | - -#### envoyPluginJob.update\(message, \[...attachments\]\) ⇒ `Promise.` - -Updates the job's message, with optional attachments. Useful for multi-step jobs. - -**Kind**: instance method of `EnvoyPluginJob` - -| Param | Type | -| :--- | :--- | -| message | | -| \[...attachments\] | `Attachment` | - -## Related Classes - -### Attachment : `Object` - -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| \[type\] | `string` | only "password" supported :\( | -| label | `string` | the label to display in Garaje | -| value | `string` | the value to display in Garaje | - diff --git a/envoypluginsdk.md b/envoypluginsdk.md deleted file mode 100644 index 0d6c41e..0000000 --- a/envoypluginsdk.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -description: The Envoy SDK. Typically you'd interact with this directly. ---- - -# EnvoyPluginSDK - -## Constructor - -#### const envoy = new EnvoyPluginSDK\(body, \[isVerified=false\], \[pluginAccessToken=null\]\) - -| Param | Type | Default | -| :--- | :--- | :--- | -| body | `Object` | | -| \[isVerified\] | `boolean` | `false` | -| \[pluginAccessToken\] | `string` | `null` | - -## Properties and Methods - -* _instance_ - * .body : `Object` - * Comes from `req.body` - * .isVerified : `boolean` - * If the request is verified to have come from Envoy - * .pluginAccessToken : `string` - * Access token for use with plugin-scoped endpoints - * .meta : `Meta` - * Metadata associated with this request - * .payload : `EnvoyObject` \| `Object` - * The object that the event is about - * .userAPI : `EnvoyAPI` - * Envoy's API scoped to the installer \(user\) - * Applicable only in setup routes - * .pluginAPI : `EnvoyAPI` - * Envoy's API scoped to the plugin itself - * For use with jobs and storage - * .installStorage : `EnvoyPluginStorage` - * Key/value storage scoped to the current install - * .globalStorage : `EnvoyPluginStorage` - * Key/value storage scoped across installs - * .job : `EnvoyPluginJob` - * Represents the current job - * Applicable only in workers \(event listeners\) - * .jobId : `string` \| `uuid` \| `null` - * The current job ID - * Applicable only in workers - * .jwt : `EnvoyJWT` - * Helper to encode and decode JWTs - * .getJob\(jobId\) ⇒ `EnvoyPluginJob` - * Load a job other than the current - -#### envoyPluginSDK.getJob\(jobId\) ⇒ `EnvoyPluginJob` - -Returns a job based on an ID. - -**Kind**: instance method of `EnvoyPluginSDK` - -| Param | Type | -| :--- | :--- | -| jobId | `string` \| `uuid` | - -## Related Classes - -### EnvoyObject : `Object` - -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| id | `string` \| `number` \| `uuid` | the ID of the object | -| attributes | `Object` | the object's attributes, in dash-case. | - -### Meta : `Object` - -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| event | `string` | the name of the event \(workers only\) | -| route | `string` | the name of the route \(routes only\) | -| plugin\_id | `number` | the plugin ID | -| install\_id | `number` | the plugin install ID | -| config | `Object` | config data for this install | -| params | `Object` | The optional URL query params sent in the request \(routes only\) | -| location | `EnvoyObject` | the location this event happened \(location installs only\) | -| company | `EnvoyObject` | the company that installed the plugin | -| auth | `Object` | contains the installer's `access_token` | - diff --git a/envoypluginstorage.md b/envoypluginstorage.md deleted file mode 100644 index 8aa0288..0000000 --- a/envoypluginstorage.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: Interacts with the key/value storage system. ---- - -# EnvoyPluginStorage - -## Constructor - -#### const storage = new EnvoyPluginStorage\(pluginAPI, \[installId\]\) - -| Param | Type | Default | -| :--- | :--- | :--- | -| pluginAPI | `EnvoyAPI` | | -| \[installId\] | `number` \| `null` | | - -## Properties and Methods - -* _instance_ - * .api : `EnvoyAPI` - * .installId : `number` \| `null` - * .pipeline\(\) ⇒ `EnvoyPluginStoragePipeline` - * .get\(key\) ⇒ `Promise.<(PluginStorageItem|null)>` - * .set\(key, value\) ⇒ `Promise.` - * .setUnique\(key, options\) ⇒ `Promise.` - * .unset\(key\) ⇒ `Promise.<(PluginStorageItem|null)>` - -#### envoyPluginStorage.pipeline\(\) ⇒ `EnvoyPluginStoragePipeline` - -Creates a new pipeline instance. - -**Kind**: instance method of `EnvoyPluginStorage` - - -#### envoyPluginStorage.get\(key\) ⇒ `Promise.<(PluginStorageItem|null)>` - -Wrapper for single pipeline get. - -**Kind**: instance method of `EnvoyPluginStorage` - -| Param | Type | -| :--- | :--- | -| key | `string` | - -#### envoyPluginStorage.set\(key, value\) ⇒ `Promise.` - -Wrapper for single pipeline set. - -**Kind**: instance method of `EnvoyPluginStorage` - -| Param | Type | -| :--- | :--- | -| key | `string` | -| value | `*` | - -#### envoyPluginStorage.setUnique\(key, \[options\]\) ⇒ `Promise.` - -Wrapper for single pipeline setUnique. - -**Kind**: instance method of `EnvoyPluginStorage` - -| Param | Type | -| :--- | :--- | -| key | `string` | -| \[options\] | `UniqueOptions` | - -#### envoyPluginStorage.unset\(key\) ⇒ `Promise.<(PluginStorageItem|null)>` - -Wrapper for single pipeline unset. Returns null if the item did not previously exist. - -**Kind**: instance method of `EnvoyPluginStorage` - -| Param | Type | -| :--- | :--- | -| key | `string` | - -## Related Classes - -### PluginStorageItem : `Object` - -**Properties** - -| Name | Type | -| :--- | :--- | -| key | `string` | -| value | | - -### UniqueOptions : `Object` - -**Properties** - -| Name | Type | Default | Description | -| :--- | :--- | :--- | :--- | -| chars | `string` | `"0123456789"` | the possible characters to pick from | -| size | `number` | `12` | the length of the value | - diff --git a/envoypluginstoragepipeline.md b/envoypluginstoragepipeline.md deleted file mode 100644 index e87f1f4..0000000 --- a/envoypluginstoragepipeline.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -description: Interacts with the storage pipeline system. ---- - -# EnvoyPluginStoragePipeline - -## Constructor - -#### const storagePipeline = new EnvoyPluginStoragePipeline\(pluginAPI, \[installId\]\) - -| Param | Type | Default | -| :--- | :--- | :--- | -| pluginAPI | `EnvoyAPI` | | -| \[installId\] | `number` \| `null` | | - -## Properties and Methods - -* _instance_ - * .api : `EnvoyAPI` - * .installId : `number` \| `null` - * .commands : `Array.` - * .execute\(\) ⇒ `Promise.>` - * .executeSingle\(\) ⇒ `Promise.` - * .addCommand\(command\) ⇒ `EnvoyPluginStoragePipeline` - * .get\(key\) ⇒ `EnvoyPluginStoragePipeline` - * .set\(key, value\) ⇒ `EnvoyPluginStoragePipeline` - * .setUnique\(key, \[options\]\) ⇒ `EnvoyPluginStoragePipeline` - * .unset\(key\) ⇒ `EnvoyPluginStoragePipeline` - -#### envoyPluginStoragePipeline.execute\(\) ⇒ `Promise.>` - -Executes all the commands in the pipeline. - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - - -#### envoyPluginStoragePipeline.executeSingle\(\) ⇒ `Promise.` - -Executes the pipeline and returns the first result. - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - - -#### envoyPluginStoragePipeline.addCommand\(command\) ⇒ `EnvoyPluginStoragePipeline` - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - -| Param | Type | -| :--- | :--- | -| command | `Command` | - -#### envoyPluginStoragePipeline.get\(key\) ⇒ `EnvoyPluginStoragePipeline` - -Gets a storage item. - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - -| Param | Type | -| :--- | :--- | -| key | `string` | - -#### envoyPluginStoragePipeline.set\(key, value\) ⇒ `EnvoyPluginStoragePipeline` - -Sets a value for a storage item, and returns that item. - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - -| Param | Type | -| :--- | :--- | -| key | `string` | -| value | | - -#### envoyPluginStoragePipeline.setUnique\(key, \[options\]\) ⇒ `EnvoyPluginStoragePipeline` - -Sets a unique value for a storage item, and returns that item. - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - -| Param | Type | -| :--- | :--- | -| key | `string` | -| \[options\] | `UniqueOptions` | - -#### envoyPluginStoragePipeline.unset\(key\) ⇒ `EnvoyPluginStoragePipeline` - -Unsets a storage item. - -**Kind**: instance method of `EnvoyPluginStoragePipeline` - -| Param | Type | -| :--- | :--- | -| key | `string` | - -## Related Classes - -### PluginStorageItem : `Object` - -**Kind**: global typedef -**Properties** - -| Name | Type | -| :--- | :--- | -| key | `string` | -| value | | - -### Command : `Object` - -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| :--- | :--- | :--- | -| action | `string` | the type of command to run | -| key | `string` | the key to operate on | - -### UniqueOptions : `Object` - -**Kind**: global typedef -**Properties** - -| Name | Type | Default | Description | -| :--- | :--- | :--- | :--- | -| chars | `string` | `"\"0123456789\""` | the possible characters to pick from | -| size | `number` | `12` | the length of the value | - diff --git a/envoysignatureverifier.md b/envoysignatureverifier.md deleted file mode 100644 index 40f26dc..0000000 --- a/envoysignatureverifier.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: Verifies that request bodies are from Envoy and are meant for your plugin. ---- - -# EnvoySignatureVerifier - -## Constructor - -#### const signatureVerifier = new EnvoySignatureVerifier\(\[options\]\) - -| Param | Type | -| :--- | :--- | -| \[options\] | `SignatureVerifierOptions` | - -## Properties and Methods - -* _instance_ - * .verify\(req, rawBody\) ⇒ `boolean` - -#### envoySignatureVerifier.verify\(req, rawBody\) ⇒ `boolean` - -Verifies that the signature provided matches the request body. - -**Kind**: instance method of `EnvoySignatureVerifier` - -| Param | Type | -| :--- | :--- | -| req | | -| rawBody | `Buffer` | - -## Related Classes - -### SignatureVerifierOptions : `Object` - -**Properties** - -| Name | Type | Default | -| :--- | :--- | :--- | -| algorithm | `string` | `"sha256"` | -| encoding | `string` | `"base64"` | -| secret | `string` | `process.env.ENVOY_CLIENT_SECRET` | -| header | `string` | `"x-envoy-signature"` | - diff --git a/errormiddleware.md b/errormiddleware.md deleted file mode 100644 index 9fbe575..0000000 --- a/errormiddleware.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: Use this middleware to safely catch and serialize unexpected errors. ---- - -# errorMiddleware - -## Example - -```javascript -const express = require('express'); -const { middleware, errorMiddleware } = require('envoy-integrations-sdk-nodejs'); - -const app = express(); -app.use(middleware()); -// define endpoints here -app.use(errorMiddleware()); -``` - -## Functions - -### errorMiddleware\(\) ⇒ `expressErrorMiddleware` - -Returns an [Express.js error middleware](http://expressjs.com/en/guide/error-handling.html#writing-error-handlers), which serializes unexpected errors. - -**Kind**: global function - -### Related Functions and Classes - -### `expressErrorMiddleware` : `function` - -Express/connect middleware. - -**Kind**: global typedef - -| Param | Type | -| :--- | :--- | -| err | `Error` | -| req | [http://expressjs.com/en/4x/api.html\#req](http://expressjs.com/en/4x/api.html#req) | -| res | [http://expressjs.com/en/4x/api.html\#res](http://expressjs.com/en/4x/api.html#res) | -| next | `function` | - diff --git a/index.js b/index.js deleted file mode 100644 index 4b33fe4..0000000 --- a/index.js +++ /dev/null @@ -1,47 +0,0 @@ -require('dotenv').config(); -const EnvoyAPI = require('./lib/EnvoyAPI'); -const EnvoyJWT = require('./lib/EnvoyJWT'); -const EnvoyPluginJob = require('./lib/EnvoyPluginJob'); -const EnvoyPluginSDK = require('./lib/EnvoyPluginSDK'); -const EnvoyPluginStorage = require('./lib/EnvoyPluginStorage'); -const EnvoyPluginStoragePipeline = require('./lib/EnvoyPluginStoragePipeline'); -const EnvoyResponseError = require('./lib/EnvoyResponseError'); -const EnvoySignatureVerifier = require('./lib/EnvoySignatureVerifier'); -const HttpStatus = require('./lib/HttpStatus'); -const middleware = require('./lib/middleware'); -const errorMiddleware = require('./lib/errorMiddleware'); -const asyncHandler = require('./lib/asyncHandler'); - -/** - * @typedef {Object} Envoy - * @property {EnvoyAPI} EnvoyAPI - * @property {EnvoyJWT} EnvoyJWT - * @property {EnvoyPluginJob} EnvoyPluginJob - * @property {EnvoyPluginSDK} EnvoyPluginSDK - * @property {EnvoyPluginStorage} EnvoyPluginStorage - * @property {EnvoyPluginStoragePipeline} EnvoyPluginStoragePipeline - * @property {EnvoyResponseError} EnvoyResponseError - * @property {EnvoySignatureVerifier} EnvoySignatureVerifier - * @property {HttpStatus} HttpStatus - * @property {Function} middleware - * @property {Function} errorMiddleware - * @property {Function} asyncHandler - */ - -/** - * @type {Envoy} - */ -module.exports = { - EnvoyAPI, - EnvoyJWT, - EnvoyPluginJob, - EnvoyPluginSDK, - EnvoyPluginStorage, - EnvoyPluginStoragePipeline, - EnvoyResponseError, - EnvoySignatureVerifier, - HttpStatus, - middleware, - errorMiddleware, - asyncHandler, -}; diff --git a/lib/EnvoyAPI.js b/lib/EnvoyAPI.js deleted file mode 100644 index 5ab3048..0000000 --- a/lib/EnvoyAPI.js +++ /dev/null @@ -1,477 +0,0 @@ -const request = require('request-promise-native'); -const EnvoyResponseError = require('./EnvoyResponseError'); - -/** - * @typedef {Object} EnvoyObject - * @property {string|number|uuid} id - the ID of the object - * @property {{}} attributes - the object's attributes, in dash-case. - */ - -/** - * @typedef {Object} Attachment - * @property {string} type - only "password" supported :( - * @property {string} label - the label to display in Garaje - * @property {string} value - the value to display in Garaje - */ - -/** - * @typedef {Object} JobUpdate - * @property {string} [status] - * @property {string} [status_message] - * @property {string} [failure_reason] - * @property {Attachment[]} [attachments] - */ - -/** - * @typedef {Object} PluginStorageItem - * @property {string} key - * @property value - */ - -/** - * @typedef {Object} Command - * @property {string} action - the type of command to run - * @property {string} key - the key to operate on - */ - -class EnvoyAPI { - - /** - * @param {string} token - */ - constructor(token) { - - if (!token) { - throw new Error('No token supplied.'); - } - - this.baseUrl = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; - this.request = request.defaults({ - headers: { - Authorization: `Bearer ${token}`, - 'Content-Type': 'application/vnd.api+json', - Accept: 'application/vnd.api+json', - }, - json: true, - baseUrl: this.baseUrl, - }); - } - - /** - * Fetches the visitor types for this location. - * - * @param {string|number} locationId - * @returns {Promise} - */ - async flows(locationId) { - - const body = await this.request({ - url: '/api/v3/flows', - qs: { - filter: { - location: locationId, - }, - include: 'location', - }, - }); - - return EnvoyAPI.getDataFromBody(body, data => Array.isArray(data)); - } - - async flow(flowId) { - - const body = await this.request({ - url: `/api/v3/flows/${flowId}`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - async locations() { - - const body = await this.request({ - url: `/api/v3/locations`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - async location(locationId) { - - const body = await this.request({ - url: `/api/v3/locations/${locationId}`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - async company() { - - const body = await this.request({ - url: '/api/v2/companies', - }); - - return EnvoyAPI.getDataFromBody(body); - } - - async me() { - - const body = await this.request({ - url: '/api/v2/users/me', - }); - - return EnvoyAPI.getDataFromBody(body); - } - - async companyRoles(userId) { - - const body = await this.request({ - url: `/api/v3/users/${userId}/relationships/company-roles`, - }); - - return EnvoyAPI.getDataFromBody(body, data => Array.isArray(data)); - } - - async employee(companyRoleId) { - - const body = await this.request({ - url: `/api/v3/company-roles/${companyRoleId}/employee`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Fetches the employees for this location. - * - * @param {string|number} locationId - * @param {{}} params - * @returns {Promise} - */ - async locationEmployees(locationId, params = {}) { - - const body = await this.request({ - url: `/api/v3/locations/${locationId}/employees`, - qs: params, - }); - - return EnvoyAPI.getDataFromBody(body, data => Array.isArray(data)); - } - - /** - * Fetches an employee. - * - * @param {string|number} employeeId - * @returns {Promise} - */ - async locationEmployee(employeeId) { - - const body = await this.request({ - url: `/api/v3/employees/${employeeId}`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Fetches the sign-in page details for this flow. - * - * @param {string|number} flowId - * @returns {Promise} - */ - async flowBadge(flowId) { - - const body = await this.request({ - url: `/api/v3/flows/${flowId}/badge`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Fetches the sign-in page details for this flow. - * - * @param {string|number} flowId - * @returns {Promise} - */ - async signInPage(flowId) { - - const body = await this.request({ - url: `/api/v3/flows/${flowId}/sign-in-field-page`, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Fetches the sign-in fields for this page. - * - * @param {string|number} pageId - * @returns {Promise} - */ - async signInFields(pageId) { - - const body = await this.request({ - url: `/api/v3/sign-in-field-pages/${pageId}/sign-in-fields`, - }); - - return EnvoyAPI.getDataFromBody(body, data => Array.isArray(data)); - } - - /** - * Creates a notification event. - * - * @param {{}} event - * @returns {Promise} - */ - async createNotificationEvent(event) { - - const body = await this.request({ - method: 'POST', - url: '/api/v2/platform/notification-events', - body: event, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Creates an invite. - * - * @param {{}} invite - * @returns {Promise} - */ - async createInvite(invite) { - - const body = await this.request({ - method: 'POST', - url: '/api/v3/invites', - body: invite, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Updates an invite. - * - * @param inviteId - * @param {{}} invite - * @returns {Promise} - */ - async updateInvite(inviteId, invite) { - - // eslint-disable-next-line no-param-reassign - invite.data.id = inviteId; - const body = await this.request({ - method: 'PUT', - url: `/api/v3/invites/${inviteId}`, - body: invite, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Updates an invite. - * - * @param inviteId - * @param {{}} invite - * @returns {Promise} - */ - async partialUpdateInvite(inviteId, invite) { - - // eslint-disable-next-line no-param-reassign - invite.data.id = inviteId; - const body = await this.request({ - method: 'PATCH', - url: `/api/v3/invites/${inviteId}`, - body: invite, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Removes an invite. - * - * @param inviteId - * @returns {Promise} - */ - async removeInvite(inviteId) { - return this.request({ - method: 'DELETE', - url: `/api/v3/invites/${inviteId}`, - }); - } - - /** - * Updates the job. - * - * @param {string|uuid} jobId - * @param {JobUpdate} updates - * @returns {Promise} - */ - async updateJob(jobId, updates) { - - const body = await this.request({ - method: 'PATCH', - url: `/api/v2/plugin-services/jobs/${jobId}`, - body: updates, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Gets the plugin install's config. - * - * @param {number} installId - * @returns {Promise<{}>} - */ - async getPluginInstallConfig(installId) { - return new Promise((resolve, reject) => { - this.request({ - method: 'GET', - url: `/api/v2/plugin-services/installs/${installId}/config`, - }).then(body => resolve(EnvoyAPI.getDataFromBody(body))) - .catch(err => reject(err)); - }); - } - - /** - * Sets the plugin install's config. - * - * @param {number} installId - * @param {{}} config - * @returns {Promise<{}>} - */ - async setPluginInstallConfig(installId, config = {}) { - const body = await this.request({ - method: 'PUT', - url: `/api/v2/plugin-services/installs/${installId}/config`, - body: config, - }); - - return EnvoyAPI.getDataFromBody(body); - } - - /** - * Runs the storage pipeline. - * - * @param {Command[]} commands - * @param {string|uuid|number} [installId] - * @returns {Promise} - */ - async storagePipeline(commands, installId = null) { - - const request = { commands }; - if (installId) { - request.install_id = installId; - } - const body = await this.request({ - method: 'POST', - url: '/api/v2/plugin-services/storage', - body: request, - }); - - return EnvoyAPI.getDataFromBody(body, data => Array.isArray(data)); - } - - async createNotification(installId, params = {}) { - const body = await this.request({ - method: 'POST', - url: `/api/v2/plugin-services/installs/${installId}/notifications`, - body: params, - }); - return EnvoyAPI.getDataFromBody(body); - } - - static getDataFromBody(body, isValid = () => true) { - - /** - * Valid response bodies look like: - * { data: * } - */ - if (body.data === undefined || !isValid(body.data)) { - throw new EnvoyResponseError(body); - } - - return body.data; - } - - /** - * Gets an access token using client_credentials as the grant type. - * - * @param {string} [id=process.env.ENVOY_CLIENT_ID] - * @param {string} [secret=process.env.ENVOY_CLIENT_SECRET] - */ - static login(id = process.env.ENVOY_CLIENT_ID, secret = process.env.ENVOY_CLIENT_SECRET) { - const baseUrl = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; - return request({ - auth: { - user: id, - pass: secret, - }, - json: true, - method: 'POST', - body: { - grant_type: 'client_credentials', - client_id: id, - client_secret: secret, - scope: 'plugin,token.refresh', - }, - url: '/a/auth/v0/token', - baseUrl, - }); - } - - static loginAsUser( - username, - password, - id = process.env.ENVOY_CLIENT_ID, - secret = process.env.ENVOY_CLIENT_SECRET, - ) { - const baseUrl = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; - return request({ - auth: { - user: id, - pass: secret, - }, - json: true, - method: 'POST', - body: { - grant_type: 'password', - username, - password, - scope: 'plugin,token.refresh', - }, - url: '/a/auth/v0/token', - baseUrl, - }); - } - - static loginAsPluginInstaller( - installId, - id = process.env.ENVOY_CLIENT_ID, - secret = process.env.ENVOY_CLIENT_SECRET, - ) { - const baseUrl = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; - return request({ - auth: { - user: id, - pass: secret, - }, - json: true, - method: 'POST', - body: { - grant_type: 'plugin_install', - install_id: installId, - }, - url: '/a/auth/v0/token', - baseUrl, - }); - } -} - -module.exports = EnvoyAPI; diff --git a/lib/EnvoyJWT.js b/lib/EnvoyJWT.js deleted file mode 100644 index 107d952..0000000 --- a/lib/EnvoyJWT.js +++ /dev/null @@ -1,72 +0,0 @@ -const util = require('util'); -const jwt = require('jsonwebtoken'); - -const sign = util.promisify(jwt.sign); -const verify = util.promisify(jwt.verify); - -/** - * @typedef {Object} JWTOptions - https://www.npmjs.com/package/jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback - */ - - -class EnvoyJWT { - - /** - * - * @param {string} [secret=process.env.JWT_SECRET] - * @param {string} [algorithm='HS256'] - */ - constructor(secret = process.env.JWT_SECRET, algorithm = 'HS256') { - - if (!secret) { - throw new Error('JWT secret missing.'); - } - this.secret = secret; - this.algorithm = algorithm; - } - - /** - * Creates a JWT. - * - * @param {string|number|null} subject - * @param {string|number|null} expiresIn - seconds or string like: https://github.com/zeit/ms - * @param {{}} [payload] - * @returns {Promise} - */ - encode(subject, expiresIn, payload = {}) { - - const { secret, algorithm } = this; - const options = { algorithm }; - if (subject) { - options.subject = subject; - } - if (expiresIn) { - options.expiresIn = expiresIn; - } - - return sign(payload, secret, options); - } - - /** - * - * @param {string} token - * @param {JWTOptions} [options] - * @returns {Promise<{}>} - */ - decode(token, options = {}) { - - const { secret, algorithm } = this; - return verify(token, secret, Object.assign( - { - ignoreExpiration: false, - ignoreNotBefore: false, - }, - options, - { - algorithms: [algorithm], // force the algorithm - }, - )); - } -} - -module.exports = EnvoyJWT; diff --git a/lib/EnvoyPluginJob.js b/lib/EnvoyPluginJob.js deleted file mode 100644 index 9bfb45d..0000000 --- a/lib/EnvoyPluginJob.js +++ /dev/null @@ -1,124 +0,0 @@ -/** - * @typedef {Object} Attachment - * @property {string} [type] - only "password" supported :( - * @property {string} label - the label to display in Garaje - * @property {string} value - the value to display in Garaje - */ - -class EnvoyPluginJob { - - /** - * @param {EnvoyAPI} pluginAPI - * @param {string|uuid} jobId - */ - constructor(pluginAPI, jobId) { - - /** - * @type {EnvoyAPI} - */ - this.api = pluginAPI; - /** - * @type {string|uuid} - */ - this.id = jobId; - } - - /** - * Updates a job. - * - * @param {string|null} status - * @param {string|null} message - * @param {string|null} [reason] - * @param {Attachment[]|null} [attachments] - * @returns {Promise} - */ - execute(status, message, reason, attachments = []) { - - const updates = {}; - if (status) { - updates.status = status; - } - if (message) { - updates.status_message = message; - } - if (reason) { - updates.failure_reason = reason; - } - if (attachments) { - if (!Array.isArray(attachments)) { - throw new Error('Attachments must be an array of objects: [{type, label, value}].'); - } - if (attachments.length) { - updates.attachments = attachments.map(attachment => { - if (!attachment.label || !attachment.value) { - throw new Error('Attachments must be an array of objects: [{type, label, value}].'); - } - return Object.assign({ type: 'password' }, attachment); - }); - } - } - return this.api.updateJob(this.id, updates); - } - - /** - * Attaches items to an in-progress job. - * - * @param {...Attachment} attachments - * @returns {Promise} - */ - attach(...attachments) { - - return this.execute(null, null, null, attachments); - } - - /** - * Completes the job. - * - * @param {string} message - * @param {...Attachment} [attachments] - * @returns {Promise} - */ - complete(message, ...attachments) { - - return this.execute('done', message, null, attachments); - } - - /** - * Ignores the job. - * - * @param {string} message - * @param {string} reason - * @returns {Promise} - */ - ignore(message, reason) { - - return this.execute('ignored', message, reason); - } - - /** - * Fails the job. - * - * @param {string} message - * @param {string} reason - * @returns {Promise} - */ - fail(message, reason) { - - return this.execute('failed', message, reason); - } - - /** - * Updates the job's message, with optional attachments. - * Useful for multi-step jobs. - * - * @param message - * @param {...Attachment} [attachments] - * @returns {Promise} - */ - update(message, ...attachments) { - - return this.execute(null, message, null, attachments); - } -} - -module.exports = EnvoyPluginJob; diff --git a/lib/EnvoyPluginSDK.js b/lib/EnvoyPluginSDK.js deleted file mode 100644 index 8454f29..0000000 --- a/lib/EnvoyPluginSDK.js +++ /dev/null @@ -1,192 +0,0 @@ -const EnvoyAPI = require('./EnvoyAPI'); -const EnvoyJWT = require('./EnvoyJWT'); -const EnvoyPluginStorage = require('./EnvoyPluginStorage'); -const EnvoyPluginJob = require('./EnvoyPluginJob'); - -/** - * @typedef {Object} EnvoyObject - * @property {string|number|uuid} id - the ID of the object - * @property {{}} attributes - the object's attributes, in dash-case. - */ - -/** - * @typedef {Object} Meta - * @property {string} event - the name of the event - * @property {string} route - the name of the route - * @property {number} plugin_id - the plugin ID - * @property {number} install_id - the plugin install ID - * @property {Object} env - config data for this install - * @property {EnvoyObject} location - the location this event happened - * @property {EnvoyObject} company - the company that installed the plugin - * @property {string} forwarded_bearer_token - the Garaje user's token - */ - -class EnvoyPluginSDK { - - /** - * Usually comes from req.body in Express. - * @param {{}} body - * @param {boolean} [isVerified] - * @param {string} [pluginAccessToken] - */ - constructor(body, isVerified = false, pluginAccessToken = null) { - - /** - * @type {{}} - */ - this.body = body; - /** - * @type {boolean} - */ - this.isVerified = isVerified; - /** - * @type {string} - */ - this.pluginAccessToken = pluginAccessToken; - } - - /** - * The request_meta of the platform_event. - * - * @returns {Meta} - */ - get meta() { - - if (!this.isVerified) { - throw new Error('Could not verify meta.'); - } - return this.body.meta; - } - - /** - * The request_body of the platform_event. - * - * @returns {{}|EnvoyObject} - */ - get payload() { - - if (!this.isVerified) { - throw new Error('Could not verify payload.'); - } - return this.body.payload; - } - - /** - * Envoy API scoped to the user. - * Used only in routes. - * - * @returns {EnvoyAPI} - */ - get userAPI() { - - const { forwarded_bearer_token: token, auth } = this.meta; - const accessToken = token || (auth ? auth.access_token : null); - if (!accessToken) { - throw new Error("This user's API token was not found. Are you in a route?"); - } - return new EnvoyAPI(accessToken); - } - - /** - * Envoy API scoped to the plugin. - * Used to perform storage or job operations. - * - * @returns {EnvoyAPI} - */ - get pluginAPI() { - - const { pluginAccessToken } = this; - if (!pluginAccessToken) { - throw new Error('No API token found. Are your Envoy client ID and secret set?'); - } - return new EnvoyAPI(pluginAccessToken); - } - - /** - * Storage scoped to the install. - * - * @returns {EnvoyPluginStorage} - */ - get installStorage() { - - const { install_id: installId } = this.meta; - if (!installId) { - throw new Error('No install ID found in meta.'); - } - return this.getStorage(installId); - } - - /** - * Storage scoped globally (across installs). - * - * @returns {EnvoyPluginStorage} - */ - get globalStorage() { - - return this.getStorage(); - } - - /** - * Perform operations on the current job. - * - * @returns {EnvoyPluginJob} - */ - get job() { - - const { jobId } = this; - if (!jobId) { - throw new Error('No job found in meta. Are you in a worker?'); - } - return this.getJob(jobId); - } - - /** - * Returns the current job's ID. - * - * @returns {string|uuid|null} - */ - get jobId() { - const { job } = this.meta; - return job ? job.id : null; - } - - /** - * A utility to encode and decode JWTs. - * Useful for verifiable communications between plugin endpoints. - * - * @returns {EnvoyJWT} - */ - get jwt() { - - const { JWT_SECRET: secret } = process.env; - if (!secret) { - throw new Error('No JWT_SECRET environment variable set.'); - } - return new EnvoyJWT(secret); - } - - /** - * Returns a job based on an ID. - * - * @returns {Function} - */ - get getJob() { - - /** - * @param {string|uuid} jobId - * @returns {EnvoyPluginJob} - */ - return jobId => new EnvoyPluginJob(this.pluginAPI, jobId); - } - - get getStorage() { - - /** - * @param {string|number} installId - * @returns {EnvoyPluginStorage} - */ - return (installId = null) => new EnvoyPluginStorage(this.pluginAPI, installId); - } -} - -module.exports = EnvoyPluginSDK; diff --git a/lib/EnvoyPluginStorage.js b/lib/EnvoyPluginStorage.js deleted file mode 100644 index 083e8ba..0000000 --- a/lib/EnvoyPluginStorage.js +++ /dev/null @@ -1,109 +0,0 @@ -const EnvoyPluginStoragePipeline = require('./EnvoyPluginStoragePipeline'); - -/** - * @typedef {Object} PluginStorageItem - * @property {string} key - * @property value - */ - -/** - * @typedef {Object} UniqueOptions - * @property {string} chars="0123456789" - the possible characters to pick from - * @property {number} size=12 - the length of the value - */ - -/** - * @typedef {Object} UniqueNumOptions - * @property {number} min=0 - the minimum number to pick from - * @property {number} max=Number.MAX_SAFE_INTEGER - the maximum number to pick from - */ - -class EnvoyPluginStorage { - - /** - * @param {EnvoyAPI} pluginAPI - * @param {number|null} [installId] - */ - constructor(pluginAPI, installId = null) { - - /** - * @type {EnvoyAPI} - */ - this.api = pluginAPI; - /** - * @type {number|null} - */ - this.installId = installId; - } - - /** - * Creates a new pipeline instance. - * - * @returns {EnvoyPluginStoragePipeline} - */ - pipeline() { - - return new EnvoyPluginStoragePipeline(this.api, this.installId); - } - - /** - * Wrapper for single pipeline get. - * - * @param {string} key - * @returns {Promise} - */ - get(key) { - - return this.pipeline().get(key).executeSingle(); - } - - /** - * Wrapper for single pipeline set. - * - * @param {string} key - * @param {*} value - * @returns {Promise} - */ - set(key, value) { - - return this.pipeline().set(key, value).executeSingle(); - } - - /** - * Wrapper for single pipeline setUnique. - * - * @param {string} key - * @param {UniqueOptions} [options] - * @returns {Promise} - */ - setUnique(key, options = {}) { - - return this.pipeline().setUnique(key, options).executeSingle(); - } - - /** - * Wrapper for single pipeline setUnique. - * - * @param {string} key - * @param {UniqueNumOptions} [options] - * @returns {Promise} - */ - setUniqueNum(key, options = {}) { - - return this.pipeline().setUniqueNum(key, options).executeSingle(); - } - - /** - * Wrapper for single pipeline unset. - * Returns null if the item did not previously exist. - * - * @param {string} key - * @returns {Promise} - */ - unset(key) { - - return this.pipeline().unset(key).executeSingle(); - } -} - -module.exports = EnvoyPluginStorage; diff --git a/lib/EnvoyPluginStoragePipeline.js b/lib/EnvoyPluginStoragePipeline.js deleted file mode 100644 index 9f6b622..0000000 --- a/lib/EnvoyPluginStoragePipeline.js +++ /dev/null @@ -1,142 +0,0 @@ -/** - * @typedef {Object} PluginStorageItem - * @property {string} key - * @property value - */ - -/** - * @typedef {Object} Command - * @property {string} action - the type of command to run - * @property {string} key - the key to operate on - */ - -/** - * @typedef {Object} UniqueOptions - * @property {string} chars="0123456789" - the possible characters to pick from - * @property {number} size=12 - the length of the value - */ - -/** - * @typedef {Object} UniqueNumOptions - * @property {number} min=0 - the minimum number to pick from - * @property {number} max=Number.MAX_SAFE_INTEGER - the maximum number to pick from - */ - -class EnvoyPluginStoragePipeline { - - /** - * - * @param {EnvoyAPI} pluginAPI - * @param {number|null} [installId] - */ - constructor(pluginAPI, installId = null) { - - /** - * @type {EnvoyAPI} - */ - this.api = pluginAPI; - /** - * @type {number|null} - */ - this.installId = installId; - /** - * @type {Command[]} - */ - this.commands = []; - } - - /** - * Executes all the commands in the pipeline. - * - * @returns {Promise.>} - */ - execute() { - - return this.api.storagePipeline(this.commands, this.installId); - } - - /** - * Executes the pipeline and returns the first result. - * - * @returns {Promise} - */ - async executeSingle() { - - const [result] = await this.execute(); - return result; - } - - /** - * - * @param {Command} command - * @returns {EnvoyPluginStoragePipeline} - */ - addCommand(command) { - - this.commands.push(command); - return this; - } - - /** - * Gets a storage item. - * - * @param {string} key - * @returns {EnvoyPluginStoragePipeline} - */ - get(key) { - - return this.addCommand({ action: 'get', key }); - } - - /** - * Sets a value for a storage item, - * and returns that item. - * - * @param {string} key - * @param value - * @returns {EnvoyPluginStoragePipeline} - */ - set(key, value) { - - return this.addCommand({ action: 'set', key, value }); - } - - /** - * Sets a unique value for a storage item, - * and returns that item. - * - * @param {string} key - * @param {UniqueOptions} [options] - * @returns {EnvoyPluginStoragePipeline} - */ - setUnique(key, options = {}) { - - return this.addCommand(Object.assign({ action: 'set_unique', key }, options)); - } - - /** - * Sets a unique number value for a storage item, - * and returns that item. - * - * @param {string} key - * @param {UniqueNumOptions} [options] - * @returns {EnvoyPluginStoragePipeline} - */ - setUniqueNum(key, options = {}) { - - return this.addCommand(Object.assign({ action: 'set_unique_num', key }, options)); - } - - /** - * Unsets a storage item. - * - * @param {string} key - * @returns {EnvoyPluginStoragePipeline} - */ - unset(key) { - - return this.addCommand({ action: 'unset', key }); - } -} - -module.exports = EnvoyPluginStoragePipeline; diff --git a/lib/EnvoyResponseError.js b/lib/EnvoyResponseError.js deleted file mode 100644 index aac98a9..0000000 --- a/lib/EnvoyResponseError.js +++ /dev/null @@ -1,18 +0,0 @@ -/** - * Using a custom error for easy identification in logs, - * and for checking error types if necessary. - */ -class EnvoyResponseError extends Error { - - constructor(body, message = 'Envoy API response caused an error.') { - super(message); - // Ensure the name of this error is the same as the class name - this.name = this.constructor.name; - this.body = body; - // This clips the constructor invocation from the stack trace. - // It's not absolutely essential, but it does make the stack trace a little nicer. - Error.captureStackTrace(this, this.constructor); - } -} - -module.exports = EnvoyResponseError; diff --git a/lib/EnvoySignatureVerifier.js b/lib/EnvoySignatureVerifier.js deleted file mode 100644 index 0e75830..0000000 --- a/lib/EnvoySignatureVerifier.js +++ /dev/null @@ -1,67 +0,0 @@ -const crypto = require('crypto'); - -/** - * @typedef {Object} SignatureVerifierOptions - * @property {string} algorithm="sha256" - * @property {string} encoding="base64" - * @property {string} secret=process.env.ENVOY_CLIENT_SECRET - * @property {string} header="x-envoy-signature" - */ - -/** - * - * @type {SignatureVerifierOptions} - */ -const defaultOptions = { - algorithm: 'sha256', - encoding: 'base64', - secret: process.env.ENVOY_CLIENT_SECRET, - header: 'x-envoy-signature', -}; - -class EnvoySignatureVerifier { - - /** - * - * @param {SignatureVerifierOptions} [options] - */ - constructor(options = defaultOptions) { - - this.options = Object.assign({}, defaultOptions, options); - - if (!this.options.secret) { - throw new Error('No client secret found in the ENVOY_CLIENT_SECRET environment variable.'); - } - } - - /** - * Verifies that the signature provided matches the request body. - * - * @param req - * @param {Buffer} rawBody - * @returns {boolean} - */ - verify(req, rawBody) { - - const { - algorithm, - encoding, - secret, - header, - } = this.options; - - if (!req.headers[header]) { - return false; - } - const receivedDigest = req.headers[header]; - const computedHmac = crypto.createHmac(algorithm, secret); - computedHmac.update(rawBody); - - return crypto.timingSafeEqual( - Buffer.from(receivedDigest), - Buffer.from(computedHmac.digest(encoding)), - ); - } -} - -module.exports = EnvoySignatureVerifier; diff --git a/lib/HttpStatus.js b/lib/HttpStatus.js deleted file mode 100644 index 651eac5..0000000 --- a/lib/HttpStatus.js +++ /dev/null @@ -1,20 +0,0 @@ -class HttpStatus { - - static get ONGOING() { - return 202; - } - - static get IGNORED() { - return 400; - } - - static get FAILED() { - return 412; - } - - static get UNEXPECTED_FAILURE() { - return 500; - } -} - -module.exports = HttpStatus; diff --git a/lib/asyncHandler.js b/lib/asyncHandler.js deleted file mode 100644 index 92cc0fe..0000000 --- a/lib/asyncHandler.js +++ /dev/null @@ -1,17 +0,0 @@ -/** - * Catches Promise-based errors. - * - * @param {Function} handler - * @returns {Function} - */ -function asyncHandler(handler) { - return async (req, res, next) => { - try { - await handler(req, res, next); - } catch (err) { - next(err); - } - }; -} - -module.exports = asyncHandler; diff --git a/lib/errorMiddleware.js b/lib/errorMiddleware.js deleted file mode 100644 index 1acd5a3..0000000 --- a/lib/errorMiddleware.js +++ /dev/null @@ -1,27 +0,0 @@ -const HttpStatus = require('./HttpStatus'); - -/** - * - * @param {Function} onError - * @returns {Function} - */ -function errorMiddleware(onError = () => {}) { - - /** - * @param err - * @param req - * @param res - * @param next - */ - return (err, req, res, next) => { - onError(err); - if (res.headersSent) { - return next(err); - } - res.statusCode = HttpStatus.UNEXPECTED_FAILURE; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ message: err.message })); - }; -} - -module.exports = errorMiddleware; diff --git a/lib/middleware.js b/lib/middleware.js deleted file mode 100644 index 4a2f769..0000000 --- a/lib/middleware.js +++ /dev/null @@ -1,110 +0,0 @@ -const bodyParser = require('body-parser'); -const EnvoyAPI = require('./EnvoyAPI'); -const EnvoyPluginSDK = require('./EnvoyPluginSDK'); -const EnvoySignatureVerifier = require('./EnvoySignatureVerifier'); -const HttpStatus = require('./HttpStatus'); - -const VERIFIED = Symbol('verified'); - -/** - * Express/connect middleware. - * - * @callback connectMiddleware - * @param req - * @param res - * @param {Function} next - */ - -/** - * @typedef {Object} EnvoyRequest - * @property {EnvoyPluginSDK} envoy - the SDK - */ - -/** - * @typedef {Object} EnvoyResponse - * @property {Function} sendOngoing - * @property {Function} sendIgnored - * @property {Function} sendFailed - */ - -/** - * Returns an instance of bodyParser.json, - * which also verifies that the request came from Envoy. - * - * @param {SignatureVerifierOptions} [options] - * @returns {connectMiddleware} - */ -function middleware(options) { - - const signatureVerifier = new EnvoySignatureVerifier(options); - const verify = (req, res, rawBody) => { - - req[VERIFIED] = signatureVerifier.verify(req, rawBody); - }; - const json = bodyParser.json({ verify }); - let accessToken = null; - let threshold = 0; - - return (req, res, next) => { - - json(req, res, async err => { - - if (err) { - return next(err); - } - try { - const now = Date.now(); - if (now > threshold) { - const { - access_token: rawAccessToken, - expires_in: expiresIn, - } = await EnvoyAPI.login(); - accessToken = rawAccessToken; - threshold = now + (expiresIn * 1000) - (1000 * 60 * 10); - } - - /** - * @type {EnvoyPluginSDK} - */ - req.envoy = new EnvoyPluginSDK(req.body, req[VERIFIED], accessToken); - /** - * @param {object} [data] - */ - res.sendOngoing = (data = {}) => { - res.statusCode = HttpStatus.ONGOING; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(data)); - }; - /** - * @param {string} [message] - * @param {object} [data] - */ - res.sendIgnored = (message = '', data = {}) => { - if (message && data.message) { - console.warn('Data to be sent already has a message.'); - } - res.statusCode = HttpStatus.IGNORED; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(Object.assign({ message }, data))); - }; - /** - * @param {string} [message] - * @param {object} [data] - */ - res.sendFailed = (message = '', data = {}) => { - if (message && data.message) { - console.warn('Data to be sent already has a message.'); - } - res.statusCode = HttpStatus.FAILED; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(Object.assign({ message }, data))); - }; - next(); - } catch (err) { - next(err); - } - }); - }; -} - -module.exports = middleware; diff --git a/middleware.md b/middleware.md deleted file mode 100644 index e7ea882..0000000 --- a/middleware.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Use this middleware to automatically and safely include Envoy in your plugin. ---- - -# middleware - -## Example - -```javascript -const express = require('express'); -const { middleware } = require('envoy-integrations-sdk-nodejs'); - -const app = express(); -app.use(middleware()); -``` - -## Functions - -### middleware\(\[options\]\) ⇒ `connectMiddleware` - -Returns an instance of `bodyParser.json`, which also verifies that the request came from Envoy. It also attaches an instance of `EnvoyPluginSDK` attached to the `req` object, accessible at `req.envoy`. - -**Kind**: global function - -| Param | Type | -| :--- | :--- | -| \[options\] | `SignatureVerifierOptions` | - -### Related Functions and Classes - -### connectMiddleware : `function` - -Express/connect middleware. - -**Kind**: global typedef - -| Param | Type | -| :--- | :--- | -| req | [http://expressjs.com/en/4x/api.html\#req](http://expressjs.com/en/4x/api.html#req) | -| res | [http://expressjs.com/en/4x/api.html\#res](http://expressjs.com/en/4x/api.html#res) | -| next | `function` | - -### SignatureVerifierOptions : `Object` - -**Properties** - -| Name | Type | Default | -| :--- | :--- | :--- | -| algorithm | `string` | `"sha256"` | -| encoding | `string` | `"base64"` | -| secret | `string` | `process.env.ENVOY_CLIENT_SECRET` | -| header | `string` | `"x-envoy-signature"` | - diff --git a/package-lock.json b/package-lock.json index 1812891..8c02e03 100644 --- a/package-lock.json +++ b/package-lock.json @@ -175,7 +175,6 @@ "version": "1.19.0", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", - "dev": true, "requires": { "@types/connect": "*", "@types/node": "*" @@ -185,16 +184,22 @@ "version": "3.4.34", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", - "dev": true, "requires": { "@types/node": "*" } }, + "@types/dotenv": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/@types/dotenv/-/dotenv-8.2.0.tgz", + "integrity": "sha512-ylSC9GhfRH7m1EUXBXofhgx4lUWmFeQDINW5oLuS+gxWdfUeW4zJdeVTYVkexEW+e2VUvlZR2kGnGGipAWR7kw==", + "requires": { + "dotenv": "*" + } + }, "@types/express": { "version": "4.17.12", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", "integrity": "sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==", - "dev": true, "requires": { "@types/body-parser": "*", "@types/express-serve-static-core": "^4.17.18", @@ -206,7 +211,6 @@ "version": "4.17.21", "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.21.tgz", "integrity": "sha512-gwCiEZqW6f7EoR8TTEfalyEhb1zA5jQJnRngr97+3pzMaO1RKoI1w2bw07TK72renMUVWcWS5mLI6rk1NqN0nA==", - "dev": true, "requires": { "@types/node": "*", "@types/qs": "*", @@ -229,7 +233,6 @@ "version": "8.5.1", "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", "integrity": "sha512-rNAPdomlIUX0i0cg2+I+Q1wOUr531zHBQ+cV/28PJ39bSPKjahatZZ2LMuhiguETkCgLVzfruw/ZvNMNkKoSzw==", - "dev": true, "requires": { "@types/node": "*" } @@ -237,32 +240,27 @@ "@types/mime": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", - "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", - "dev": true + "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==" }, "@types/node": { "version": "15.12.0", "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.0.tgz", - "integrity": "sha512-+aHJvoCsVhO2ZCuT4o5JtcPrCPyDE3+1nvbDprYes+pPkEsbjH7AGUCNtjMOXS0fqH14t+B7yLzaqSz92FPWyw==", - "dev": true + "integrity": "sha512-+aHJvoCsVhO2ZCuT4o5JtcPrCPyDE3+1nvbDprYes+pPkEsbjH7AGUCNtjMOXS0fqH14t+B7yLzaqSz92FPWyw==" }, "@types/qs": { "version": "6.9.6", "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", - "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==", - "dev": true + "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==" }, "@types/range-parser": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", - "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", - "dev": true + "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==" }, "@types/serve-static": { "version": "1.13.9", "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", - "dev": true, "requires": { "@types/mime": "^1", "@types/node": "*" @@ -442,6 +440,7 @@ "version": "6.10.2", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.10.2.tgz", "integrity": "sha512-TXtUUEYHuaTEbLZWIKUr5pmBuhDLy+8KYtPYdcV8qC+pOZL+NKqYwvWSRrVXHn+ZmRRAu8vJTAznH7Oag6RVRw==", + "dev": true, "requires": { "fast-deep-equal": "^2.0.1", "fast-json-stable-stringify": "^2.0.0", @@ -672,19 +671,6 @@ } } }, - "asn1": { - "version": "0.2.4", - "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", - "integrity": "sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg==", - "requires": { - "safer-buffer": "~2.1.0" - } - }, - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=" - }, "assertion-error": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", @@ -697,20 +683,11 @@ "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", "dev": true }, - "asynckit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", - "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" - }, - "aws-sign2": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", - "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=" - }, - "aws4": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.8.0.tgz", - "integrity": "sha512-ReZxvNHIOv88FlT7rxcXIIC0fPt4KZqZbOlivyWtXLt8ESx84zd3kMC6iK5jVeS2qt+g7ftS7ye4fi06X5rtRQ==" + "at-least-node": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", + "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "dev": true }, "axios": { "version": "0.21.1", @@ -726,14 +703,6 @@ "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", "dev": true }, - "bcrypt-pbkdf": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", - "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", - "requires": { - "tweetnacl": "^0.14.3" - } - }, "bluebird": { "version": "3.5.5", "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.5.5.tgz", @@ -842,11 +811,6 @@ "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", "dev": true }, - "caseless": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", - "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=" - }, "catharsis": { "version": "0.8.11", "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.8.11.tgz", @@ -947,13 +911,11 @@ "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", "dev": true }, - "combined-stream": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", - "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", - "requires": { - "delayed-stream": "~1.0.0" - } + "colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true }, "command-line-args": { "version": "5.1.1", @@ -1063,11 +1025,6 @@ "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==" }, - "core-util-is": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", - "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=" - }, "cross-spawn": { "version": "6.0.5", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", @@ -1081,14 +1038,6 @@ "which": "^1.2.9" } }, - "dashdash": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", - "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", - "requires": { - "assert-plus": "^1.0.0" - } - }, "dataloader": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-2.0.0.tgz", @@ -1138,11 +1087,6 @@ "object-keys": "^1.0.12" } }, - "delayed-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", - "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=" - }, "depd": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", @@ -1201,18 +1145,9 @@ } }, "dotenv": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.1.0.tgz", - "integrity": "sha512-GUE3gqcDCaMltj2++g6bRQ5rBJWtkWTmqmD0fo1RnnMuUqHNCt2oTPeDnS9n6fKYvlhn7AeBkb38lymBtWBQdA==" - }, - "ecc-jsbn": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", - "integrity": "sha1-OoOpBOVDUyh4dMVkt1SThoSamMk=", - "requires": { - "jsbn": "~0.1.0", - "safer-buffer": "^2.1.0" - } + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz", + "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==" }, "ecdsa-sig-formatter": { "version": "1.0.11", @@ -1948,20 +1883,11 @@ "strip-eof": "^1.0.0" } }, - "extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" - }, - "extsprintf": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", - "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=" - }, "fast-deep-equal": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", - "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=" + "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=", + "dev": true }, "fast-glob": { "version": "3.2.5", @@ -1980,7 +1906,8 @@ "fast-json-stable-stringify": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", - "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=" + "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=", + "dev": true }, "fast-levenshtein": { "version": "2.0.6", @@ -2094,19 +2021,16 @@ "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.1.tgz", "integrity": "sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg==" }, - "forever-agent": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", - "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=" - }, - "form-data": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", - "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", + "fs-extra": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", + "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "dev": true, "requires": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.6", - "mime-types": "^2.1.12" + "at-least-node": "^1.0.0", + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" } }, "fs-then-native": { @@ -2170,14 +2094,6 @@ "pump": "^3.0.0" } }, - "getpass": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", - "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", - "requires": { - "assert-plus": "^1.0.0" - } - }, "glob": { "version": "7.1.4", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.4.tgz", @@ -2265,20 +2181,6 @@ } } }, - "har-schema": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", - "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=" - }, - "har-validator": { - "version": "5.1.3", - "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.3.tgz", - "integrity": "sha512-sNvOCzEQNr/qrvJgc3UG/kD4QtlHycrzwS+6mfTrrSq97BvaYcPZZI1ZSqGSPR73Cxn4LKTD4PttRwfU7jWq5g==", - "requires": { - "ajv": "^6.5.5", - "har-schema": "^2.0.0" - } - }, "has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", @@ -2329,16 +2231,6 @@ "toidentifier": "1.0.0" } }, - "http-signature": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", - "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", - "requires": { - "assert-plus": "^1.0.0", - "jsprim": "^1.2.2", - "sshpk": "^1.7.0" - } - }, "iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", @@ -2384,6 +2276,12 @@ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" }, + "interpret": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", + "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", + "dev": true + }, "invert-kv": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", @@ -2513,22 +2411,12 @@ "has-symbols": "^1.0.0" } }, - "is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=" - }, "isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", "dev": true }, - "isstream": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", - "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=" - }, "js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -2554,11 +2442,6 @@ "xmlcreate": "^2.0.0" } }, - "jsbn": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", - "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" - }, "jsdoc": { "version": "3.6.3", "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.3.tgz", @@ -2664,15 +2547,11 @@ "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", "dev": true }, - "json-schema": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", - "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=" - }, "json-schema-traverse": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true }, "json-stable-stringify-without-jsonify": { "version": "1.0.1", @@ -2680,11 +2559,6 @@ "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", "dev": true }, - "json-stringify-safe": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", - "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=" - }, "json5": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", @@ -2702,6 +2576,16 @@ } } }, + "jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6", + "universalify": "^2.0.0" + } + }, "jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", @@ -2726,17 +2610,6 @@ } } }, - "jsprim": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", - "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", - "requires": { - "assert-plus": "1.0.0", - "extsprintf": "1.3.0", - "json-schema": "0.2.3", - "verror": "1.10.0" - } - }, "just-extend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.0.2.tgz", @@ -2824,7 +2697,8 @@ "lodash": { "version": "4.17.15", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz", - "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==" + "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==", + "dev": true }, "lodash.camelcase": { "version": "4.3.0", @@ -2927,6 +2801,12 @@ "yallist": "^4.0.0" } }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "map-age-cleaner": { "version": "0.1.3", "resolved": "https://registry.npmjs.org/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz", @@ -3247,11 +3127,6 @@ "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", "dev": true }, - "oauth-sign": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", - "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==" - }, "object-get": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.0.tgz", @@ -3396,6 +3271,32 @@ "wrappy": "1" } }, + "onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "requires": { + "lru-cache": "^5.1.1" + }, + "dependencies": { + "lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "requires": { + "yallist": "^3.0.2" + } + }, + "yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + } + } + }, "optionator": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", @@ -3535,11 +3436,6 @@ "integrity": "sha1-uULm1L3mUwBe9rcTYd74cn0GReA=", "dev": true }, - "performance-now": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", - "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=" - }, "picomatch": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", @@ -3593,11 +3489,6 @@ "resolve": "^1.11.1" } }, - "psl": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/psl/-/psl-1.3.0.tgz", - "integrity": "sha512-avHdspHO+9rQTLbv1RO+MPYeP/SzsCoxofjVnHanETfQhTJrmB0HlDoW+EiN/R+C0BZ+gERab9NY0lPN2TxNag==" - }, "pump": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", @@ -3611,7 +3502,8 @@ "punycode": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true }, "qs": { "version": "6.10.1", @@ -3670,6 +3562,15 @@ "read-pkg": "^3.0.0" } }, + "rechoir": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", + "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", + "dev": true, + "requires": { + "resolve": "^1.1.6" + } + }, "reduce-extract": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz", @@ -3748,58 +3649,6 @@ "integrity": "sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q==", "dev": true }, - "request": { - "version": "2.88.0", - "resolved": "https://registry.npmjs.org/request/-/request-2.88.0.tgz", - "integrity": "sha512-NAqBSrijGLZdM0WZNsInLJpkJokL72XYjUpnB0iwsRgxh7dB6COrHnTBNwN0E+lHDAJzu7kLAkDeY08z2/A0hg==", - "requires": { - "aws-sign2": "~0.7.0", - "aws4": "^1.8.0", - "caseless": "~0.12.0", - "combined-stream": "~1.0.6", - "extend": "~3.0.2", - "forever-agent": "~0.6.1", - "form-data": "~2.3.2", - "har-validator": "~5.1.0", - "http-signature": "~1.2.0", - "is-typedarray": "~1.0.0", - "isstream": "~0.1.2", - "json-stringify-safe": "~5.0.1", - "mime-types": "~2.1.19", - "oauth-sign": "~0.9.0", - "performance-now": "^2.1.0", - "qs": "~6.5.2", - "safe-buffer": "^5.1.2", - "tough-cookie": "~2.4.3", - "tunnel-agent": "^0.6.0", - "uuid": "^3.3.2" - }, - "dependencies": { - "qs": { - "version": "6.5.2", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", - "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==" - } - } - }, - "request-promise-core": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.2.tgz", - "integrity": "sha512-UHYyq1MO8GsefGEt7EprS8UrXsm1TxEvFUX1IMTuSLU2Rh7fTIdFtl8xD7JiEYiWU2dl+NYAjCTksTehQUxPag==", - "requires": { - "lodash": "^4.17.11" - } - }, - "request-promise-native": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.7.tgz", - "integrity": "sha512-rIMnbBdgNViL37nZ1b3L/VfPOpSi0TqVDQPAvO6U14lMzOLrt5nilxCQqtDKhZeDiW0/hkCXGoQjhgJd/tCh6w==", - "requires": { - "request-promise-core": "1.1.2", - "stealthy-require": "^1.1.1", - "tough-cookie": "^2.3.3" - } - }, "require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -3907,6 +3756,27 @@ "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", "dev": true }, + "shelljs": { + "version": "0.8.4", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz", + "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==", + "dev": true, + "requires": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + } + }, + "shiki": { + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz", + "integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==", + "dev": true, + "requires": { + "onigasm": "^2.2.5", + "vscode-textmate": "^5.2.0" + } + }, "side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -4047,32 +3917,11 @@ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, - "sshpk": { - "version": "1.16.1", - "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz", - "integrity": "sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg==", - "requires": { - "asn1": "~0.2.3", - "assert-plus": "^1.0.0", - "bcrypt-pbkdf": "^1.0.0", - "dashdash": "^1.12.0", - "ecc-jsbn": "~0.1.1", - "getpass": "^0.1.1", - "jsbn": "~0.1.0", - "safer-buffer": "^2.0.2", - "tweetnacl": "~0.14.0" - } - }, "statuses": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=" }, - "stealthy-require": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/stealthy-require/-/stealthy-require-1.1.1.tgz", - "integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=" - }, "stream-connect": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz", @@ -4323,22 +4172,6 @@ "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==" }, - "tough-cookie": { - "version": "2.4.3", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.4.3.tgz", - "integrity": "sha512-Q5srk/4vDM54WJsJio3XNn6K2sCG+CQ8G5Wz6bZhRZoAe/+TxjWB/GlFAnYEbkYVlON9FMk/fE3h2RLpPXo4lQ==", - "requires": { - "psl": "^1.1.24", - "punycode": "^1.4.1" - }, - "dependencies": { - "punycode": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", - "integrity": "sha1-wNWmOycYgArY4esPpSachN1BhF4=" - } - } - }, "tsconfig-paths": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", @@ -4374,19 +4207,6 @@ "tslib": "^1.8.1" } }, - "tunnel-agent": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", - "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", - "requires": { - "safe-buffer": "^5.0.1" - } - }, - "tweetnacl": { - "version": "0.14.5", - "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", - "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=" - }, "type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", @@ -4417,10 +4237,98 @@ "mime-types": "~2.1.24" } }, + "typedoc": { + "version": "0.20.36", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.36.tgz", + "integrity": "sha512-qFU+DWMV/hifQ9ZAlTjdFO9wbUIHuUBpNXzv68ZyURAP9pInjZiO4+jCPeAzHVcaBCHER9WL/+YzzTt6ZlN/Nw==", + "dev": true, + "requires": { + "colors": "^1.4.0", + "fs-extra": "^9.1.0", + "handlebars": "^4.7.7", + "lodash": "^4.17.21", + "lunr": "^2.3.9", + "marked": "^2.0.3", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "shelljs": "^0.8.4", + "shiki": "^0.9.3", + "typedoc-default-themes": "^0.12.10" + }, + "dependencies": { + "handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "requires": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "uglify-js": "^3.1.4", + "wordwrap": "^1.0.0" + } + }, + "lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "marked": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", + "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", + "dev": true + }, + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + } + } + }, + "typedoc-default-themes": { + "version": "0.12.10", + "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", + "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", + "dev": true + }, + "typedoc-plugin-markdown": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.9.0.tgz", + "integrity": "sha512-s445YeUe8bH7me15T+hsHZgNmAvvF7QIpX02vFgseLGtghAwmtdZYVOqPneWoKqRv/JNpPSuyZb3CeblML9jOg==", + "dev": true, + "requires": { + "handlebars": "^4.7.7" + }, + "dependencies": { + "handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "requires": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "uglify-js": "^3.1.4", + "wordwrap": "^1.0.0" + } + }, + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + } + } + }, "typescript": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.3.2.tgz", - "integrity": "sha512-zZ4hShnmnoVnAHpVHWpTcxdv7dWP60S2FsydQLV8V5PbS3FifjWFFRiHSWpDJahly88PRyV5teTSLoq4eG7mKw==", + "version": "4.2.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz", + "integrity": "sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==", "dev": true }, "typical": { @@ -4472,6 +4380,12 @@ "integrity": "sha512-5/4etnCkd9c8gwgowi5/om/mYO5ajCaOgdzj/oW+0eQV9WxKBDZw5+ycmKmeaTXjInS/W0BzpGLo2xR2aBwZdg==", "dev": true }, + "universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "dev": true + }, "unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", @@ -4481,15 +4395,11 @@ "version": "4.2.2", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", "integrity": "sha512-KY9Frmirql91X2Qgjry0Wd4Y+YTdrdZheS8TFwvkbLWf/G5KNJDCh6pKL5OZctEW4+0Baa5idK2ZQuELRwPznQ==", + "dev": true, "requires": { "punycode": "^2.1.0" } }, - "uuid": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.3.tgz", - "integrity": "sha512-pW0No1RGHgzlpHJO1nsVrHKpOEIxkGg1xB+v0ZmdNH5OAeAwzAVrCnI2/6Mtx+Uys6iaylxa+D3g4j63IKKjSQ==" - }, "v8-compile-cache": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", @@ -4506,15 +4416,11 @@ "spdx-expression-parse": "^3.0.0" } }, - "verror": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", - "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", - "requires": { - "assert-plus": "^1.0.0", - "core-util-is": "1.0.2", - "extsprintf": "^1.2.0" - } + "vscode-textmate": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.4.0.tgz", + "integrity": "sha512-c0Q4zYZkcLizeYJ3hNyaVUM2AA8KDhNCA3JvXY8CeZSJuBdAy3bAvSbv46RClC4P3dSO9BdwhnKEx2zOo6vP/w==", + "dev": true }, "walk-back": { "version": "3.0.1", diff --git a/package.json b/package.json index f5779ea..0f4146c 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,19 @@ { "name": "@envoy/envoy-integrations-sdk", "version": "1.2.1", - "description": "", - "main": "index.js", + "description": "SDK for building integrations.", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "directories": { + "lib": "src", + "doc": "docs" + }, + "files": [ + "dist/*.d.ts", + "dist/*.d.ts.map", + "dist", + "src" + ], "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -17,20 +28,19 @@ }, "homepage": "https://github.com/envoy/envoy-integrations-sdk-nodejs#readme", "dependencies": { + "@types/dotenv": "^8.2.0", + "@types/express": "^4.17.12", + "@types/jsonwebtoken": "^8.5.1", + "@types/node": "^15.12.0", + "@types/qs": "^6.9.6", "axios": "^0.21.1", "body-parser": "^1.19.0", "dataloader": "^2.0.0", - "dotenv": "^8.1.0", + "dotenv": "^10.0.0", "jsonwebtoken": "^8.5.1", - "qs": "^6.10.1", - "request": "^2.88.0", - "request-promise-native": "^1.0.7" + "qs": "^6.10.1" }, "devDependencies": { - "@types/express": "^4.17.12", - "@types/jsonwebtoken": "^8.5.1", - "@types/node": "^15.12.0", - "@types/qs": "^6.9.6", "@typescript-eslint/eslint-plugin": "^4.26.0", "@typescript-eslint/parser": "^4.26.0", "chai": "^4.2.0", @@ -41,6 +51,8 @@ "mocha": "^6.1.4", "proxyquire": "^2.1.0", "sinon": "^7.3.2", - "typescript": "^4.3.2" + "typedoc": "^0.20.36", + "typedoc-plugin-markdown": "^3.9.0", + "typescript": "4.2" } } diff --git a/src/EnvoyAPI.ts b/src/EnvoyAPI.ts index 3e9950f..1295b57 100644 --- a/src/EnvoyAPI.ts +++ b/src/EnvoyAPI.ts @@ -1,34 +1,9 @@ import axios from 'axios'; import qs from 'qs'; import DataLoader from 'dataloader'; - -/** - * JSON-API generic types - */ -import JSONAPIPaginationParams from './util/json-api/JSONAPIPaginationParams'; import JSONAPIData from './util/json-api/JSONAPIData'; - -/** - * Envoy Web's JSON-API Resources - */ -import { AgreementPageModel } from './resources/AgreementPageResource'; -import { AgreementModel } from './resources/AgreementResource'; -import { CompanyModel } from './resources/CompanyResource'; -import { EmployeeFilterFields, EmployeeModel, EmployeeSortFields } from './resources/EmployeeResource'; -import { FlowFilterFields, FlowModel, FlowSortFields } from './resources/FlowResource'; -import { - InviteCreationModel, InviteFilterFields, InviteModel, InviteSortFields, -} from './resources/InviteResource'; -import { LocationFilterFields, LocationModel, LocationSortFields } from './resources/LocationResource'; -import { SignInFieldModel } from './resources/SignInFieldResource'; -import { SignInFieldPageModel } from './resources/SignInFieldPageResource'; -import { UserModel } from './resources/UserResource'; - import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; -import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; import { EnvoyMetaAuth } from './EnvoyMeta'; -import EnvoyStorageCommand from './EnvoyStorageCommand'; -import EnvoyStorageItem from './EnvoyStorageItem'; interface EnvoyWebDataLoaderKey extends JSONAPIData { include?: string; @@ -44,14 +19,14 @@ const TYPE_ALIASES = new Map([ ]); /** - * Make typed API calls to Envoy Web. + * Make typed API calls to Envoy. * Uses a data loader to leverage JSONAPI's "include" functionality. * This allows us to save everything that was included in the initial response * to be used later without re-fetching from the API. */ export default class EnvoyAPI { /** - * HTTP Client + * HTTP Client with Envoy's defaults. */ readonly axios = axios.create({ baseURL: envoyBaseURL, @@ -70,8 +45,7 @@ export default class EnvoyAPI { * Will fetch individual resources from the API, * unless they exist in cache (which they usually will). */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any - readonly dataLoader = new DataLoader( + protected readonly dataLoader = new DataLoader( (keys) => Promise.all( keys.map(async ({ type, id, include }) => { const { data } = await this.axios.get(`api/v3/${type}/${id}`, { params: { include } }); @@ -109,239 +83,4 @@ export default class EnvoyAPI { return response; }, (error) => Promise.reject(error)); } - - async getAgreementPage(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'agreement-pages', id, include }); - } - - async getAgreement(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'agreements', id, include }); - } - - async getCompany(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'companies', id, include }); - } - - async getEmployee(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'employees', id, include }); - } - - async getFlow(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'flows', id, include }); - } - - async getLocation(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'locations', id, include }); - } - - async getSignInFieldPage(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'sign-in-field-pages', id, include }); - } - - async getSignInField(id: string, include?: string): Promise { - return this.dataLoader.load({ type: 'sign-in-fields', id, include }); - } - - async getEmployeeByEmail(email: string, include?: string): Promise { - const paginationParams: JSONAPIPaginationParams = { - filter: { - email, - }, - page: { - limit: 1, - }, - }; - const { data: { data: [employee] } } = await this.axios.get('/api/v3/employees', { - params: { - include, - ...paginationParams, - }, - }); - - return employee; - } - - async getEmployees( - params?: JSONAPIPaginationParams, - ): Promise> { - const { data } = await this.axios.get('/api/v3/employees', { params }); - return data.data; - } - - async getFlows(params?: JSONAPIPaginationParams): Promise> { - const { data } = await this.axios.get('/api/v3/flows', { params }); - return data.data; - } - - async getLocations( - params?: JSONAPIPaginationParams, - ): Promise> { - const { data } = await this.axios.get('/api/v3/locations', { params }); - return data.data; - } - - async getSignInFields(signInFieldPageId: string): Promise> { - const { data } = await this.axios.get(`/api/v3/sign-in-field-pages/${signInFieldPageId}/sign-in-fields`); - return data.data; - } - - async getInvites( - params?: JSONAPIPaginationParams, - ): Promise> { - const { data } = await this.axios.get('/api/v3/invites', { params }); - return data.data; - } - - async me(): Promise { - const { data } = await this.axios.get('/api/v2/users/me'); - return data.data; - } - - async createInvite(invite: InviteCreationModel): Promise { - const { data } = await this.axios({ - method: 'POST', - url: '/api/v3/invites', - data: { data: invite }, - }); - return data.data; - } - - async updateInvite(inviteId: string, invite: InviteCreationModel): Promise { - const { data } = await this.axios({ - method: 'PUT', - url: `/api/v3/invites/${inviteId}`, - data: { data: { ...invite, id: inviteId } }, - }); - - return data.data; - } - - async partialUpdateInvite(inviteId: string, invite: InviteCreationModel): Promise { - const { data } = await this.axios({ - method: 'PATCH', - url: `/api/v3/invites/${inviteId}`, - data: { data: { ...invite, id: inviteId } }, - }); - - return data.data; - } - - async removeInvite(inviteId: string): Promise { - await this.axios({ - method: 'DELETE', - url: `/api/v3/invites/${inviteId}`, - }); - } - - async updateJob(jobId: string, update: EnvoyPluginJobUpdate): Promise { - await this.axios({ - method: 'PATCH', - url: `/api/v2/plugin-services/jobs/${jobId}`, - data: update, - }); - } - - async getPluginInstallConfig(installId: string): Promise> { - const { data } = await this.axios.get(`/api/v2/plugin-services/installs/${installId}/config`); - return data.data; - } - - async setPluginInstallConfig(installId: string, config: Record): Promise { - await this.axios({ - method: 'PUT', - url: `/api/v2/plugin-services/installs/${installId}/config`, - data: config, - }); - } - - async storagePipeline( - commands: Array, - installId?: string, - ): Promise> { - const request: Record = { commands }; - if (installId) { - request.install_id = installId; - } - const { data } = await this.axios({ - method: 'POST', - url: '/api/v2/plugin-services/storage', - data: request, - }); - return data.data; - } - - async createNotification(installId: string, params = {}): Promise { - await this.axios({ - method: 'POST', - url: `/api/v2/plugin-services/installs/${installId}/notifications`, - data: params, - }); - } - - /** - * Gets an access token using client_credentials as the grant type. - */ - static async login(id = envoyClientId, secret = envoyClientSecret): Promise { - const { data } = await axios({ - auth: { - username: id, - password: secret, - }, - method: 'POST', - data: { - grant_type: 'client_credentials', - client_id: id, - client_secret: secret, - scope: 'plugin,token.refresh', - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; - } - - static async loginAsUser( - username: string, - password: string, - id = envoyClientId, - secret = envoyClientSecret, - ): Promise { - const { data } = await axios({ - auth: { - username: id, - password: secret, - }, - method: 'POST', - data: { - grant_type: 'password', - username, - password, - scope: 'plugin,token.refresh', - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; - } - - static async loginAsPluginInstaller( - installId: string, - id = envoyClientId, - secret = envoyClientSecret, - ): Promise { - const { data } = await axios({ - auth: { - username: id, - password: secret, - }, - method: 'POST', - data: { - grant_type: 'plugin_install', - install_id: installId, - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; - } } diff --git a/src/EnvoyJWT.ts b/src/EnvoyJWT.ts index 6720c1b..881c7f4 100644 --- a/src/EnvoyJWT.ts +++ b/src/EnvoyJWT.ts @@ -1,12 +1,17 @@ import jwt, { SignOptions, Algorithm, VerifyOptions } from 'jsonwebtoken'; import { jwtSecret } from './constants'; +export type EnvoyJWTAlgorithm = Algorithm; +export type EnvoyJWTDecodeOptions = VerifyOptions; +/** + * Helper to encode and decode JWTs. + */ export default class EnvoyJWT { private secret: string; private algorithm: Algorithm; - constructor(secret = jwtSecret, algorithm: Algorithm = 'HS256') { + constructor(secret = jwtSecret, algorithm: EnvoyJWTAlgorithm = 'HS256') { if (!secret) { throw new Error('JWT secret missing.'); } @@ -14,7 +19,11 @@ export default class EnvoyJWT { this.algorithm = algorithm; } - encode(subject: string | number | null | undefined, expiresIn: string | number | null | undefined, payload = {}) { + encode( + subject: string | number | null, + expiresIn: string | number | null, + payload: Record = {}, + ): string { const { secret, algorithm } = this; const options: SignOptions = { algorithm }; if (subject) { @@ -27,13 +36,13 @@ export default class EnvoyJWT { return jwt.sign(payload, secret, options); } - decode(token: string, options: VerifyOptions = {}) { + decode(token: string, options: EnvoyJWTDecodeOptions = {}): Record { const { secret, algorithm } = this; return jwt.verify(token, secret, { ignoreExpiration: false, ignoreNotBefore: false, ...options, algorithms: [algorithm], // force the algorithm - }); + }) as Record; } } diff --git a/src/EnvoyMeta.ts b/src/EnvoyMeta.ts index 8d52afb..b6b34e7 100644 --- a/src/EnvoyMeta.ts +++ b/src/EnvoyMeta.ts @@ -35,6 +35,11 @@ export interface EnvoyMetaCompany { } } +/** + * A short-lived userAPI token. + * Will be used to construct the userAPI property + * found in req.envoy.userAPI. + */ export type EnvoyMetaAuth = { token_type: 'Bearer', access_token: string, @@ -43,28 +48,38 @@ export type EnvoyMetaAuth = { refresh_token_expires_in: number | null, }; +/** + * Metadata that will be included in the request body for events. + */ export interface EnvoyEventMeta { event: string, plugin_id: string, install_id: string, - config: Record, + config: Record, job: EnvoyMetaJob, location: EnvoyMetaLocation, company: EnvoyMetaCompany, auth: EnvoyMetaAuth | null, - forwarded_bearer_token?: string, } +/** + * Metadata that will be included in the request body for setup routes, + * like validation URLs or options URLs. + */ export interface EnvoyRouteMeta { route: string, plugin_id: string, install_id: string, - config: Record, - params: Record, + config: Record, + params: Record, location: EnvoyMetaLocation, company: EnvoyMetaCompany, auth: EnvoyMetaAuth | null, + forwarded_bearer_token?: string, } +/** + * Metadata that will be included in every request Envoy sends to your plugin. + */ type EnvoyMeta = EnvoyEventMeta | EnvoyRouteMeta; export default EnvoyMeta; diff --git a/src/EnvoyPluginAPI.ts b/src/EnvoyPluginAPI.ts new file mode 100644 index 0000000..d2e5f36 --- /dev/null +++ b/src/EnvoyPluginAPI.ts @@ -0,0 +1,79 @@ +import axios from 'axios'; +import EnvoyAPI from './EnvoyAPI'; +import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; +import EnvoyStorageCommand from './EnvoyStorageCommand'; +import EnvoyStorageItem from './EnvoyStorageItem'; +import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; +import { EnvoyMetaAuth } from './EnvoyMeta'; + +/** + * API endpoints for *plugin-scoped* tokens. + */ +export default class EnvoyPluginAPI extends EnvoyAPI { + async updateJob(jobId: string, update: EnvoyPluginJobUpdate): Promise { + await this.axios({ + method: 'PATCH', + url: `/api/v2/plugin-services/jobs/${jobId}`, + data: update, + }); + } + + async getPluginInstallConfig(installId: string): Promise> { + const { data } = await this.axios.get(`/api/v2/plugin-services/installs/${installId}/config`); + return data.data; + } + + async setPluginInstallConfig(installId: string, config: Record): Promise { + await this.axios({ + method: 'PUT', + url: `/api/v2/plugin-services/installs/${installId}/config`, + data: config, + }); + } + + async storagePipeline( + commands: Array, + installId?: string, + ): Promise> { + const request: Record = { commands }; + if (installId) { + request.install_id = installId; + } + const { data } = await this.axios({ + method: 'POST', + url: '/api/v2/plugin-services/storage', + data: request, + }); + return data.data; + } + + async createNotification(installId: string, params = {}): Promise { + await this.axios({ + method: 'POST', + url: `/api/v2/plugin-services/installs/${installId}/notifications`, + data: params, + }); + } + + /** + * Gets a plugin access token using `client_credentials` as the grant type. + */ + static async login(id = envoyClientId, secret = envoyClientSecret): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'client_credentials', + client_id: id, + client_secret: secret, + scope: 'plugin,token.refresh', + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } +} diff --git a/src/EnvoyPluginJob.ts b/src/EnvoyPluginJob.ts index ed02553..5781b95 100644 --- a/src/EnvoyPluginJob.ts +++ b/src/EnvoyPluginJob.ts @@ -1,13 +1,20 @@ -import EnvoyAPI from './EnvoyAPI'; import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; - +import EnvoyPluginAPI from './EnvoyPluginAPI'; + +/** + * A "job" is an event, like `entry_sign_in`. + * When your plugin handles the event, you can use this job concept + * to update the status (e.g. complete, failed, ignored) + * as well as attach extra data to the event's subject + * (e.g. showing a generated card number in the dashboard for a visitor on `entry_sign_in`). + */ export default class EnvoyPluginJob { - readonly api: EnvoyAPI; + readonly api: EnvoyPluginAPI; readonly id: string; - constructor(pluginAPI: EnvoyAPI, jobId: string) { + constructor(pluginAPI: EnvoyPluginAPI, jobId: string) { this.api = pluginAPI; this.id = jobId; } diff --git a/src/EnvoyPluginJobAttachment.ts b/src/EnvoyPluginJobAttachment.ts index 905e04b..93c95cc 100644 --- a/src/EnvoyPluginJobAttachment.ts +++ b/src/EnvoyPluginJobAttachment.ts @@ -1,14 +1,24 @@ +/** + * Display some text in Envoy's dashboard. + */ export interface EnvoyPluginTextJobAttachment { type?: 'text' | 'password' | 'link' | 'credential_image', label: string, value: string, } +/** + * Display a link in Envoy's dashboard. + */ export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachment { type: 'link', url: string, } +/** + * Display a credential in Envoy's dashboard, + * and include the credential's image in the invitee's welcome email. + */ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAttachment { type: 'credential_image', title: string, @@ -18,6 +28,11 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt }, } +/** + * Attachments to jobs, which will be displayed in the Envoy dashboard. + * Some attachments like `credential_image` can show up in other places, + * like an invitee's welcome email. + */ type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment | EnvoyPluginLinkJobAttachment | EnvoyPluginCredentialJobAttachment; diff --git a/src/EnvoyPluginSDK.ts b/src/EnvoyPluginSDK.ts index 08c9a40..9cb3601 100644 --- a/src/EnvoyPluginSDK.ts +++ b/src/EnvoyPluginSDK.ts @@ -1,20 +1,41 @@ -import EnvoyMeta from './EnvoyMeta'; -import EnvoyAPI from './EnvoyAPI'; +import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta'; import EnvoyPluginStorage from './EnvoyPluginStorage'; import EnvoyPluginJob from './EnvoyPluginJob'; import EnvoyJWT from './EnvoyJWT'; +import EnvoyUserAPI from './EnvoyUserAPI'; +import EnvoyPluginAPI from './EnvoyPluginAPI'; +/** + * Every Envoy request has a `meta` and `payload`. + */ export interface EnvoyRequestBody { meta: Meta, payload: Payload, } -export default class EnvoyPluginSDK { - readonly body: EnvoyRequestBody; +/** + * Sets up all relevant Envoy functions. + * Attaches itself to every request object using our `middleware`, + * to allow for easy access to Envoy functions. + */ +export default class EnvoyPluginSDK { + /** + * Body of the request. + * use `meta` or `payload` to access the relevant properties, + * instead of this directly. + */ + private readonly body: EnvoyRequestBody; - isVerified = false; + /** + * Verified that the request comes from Envoy. + */ + private readonly isVerified: boolean; - pluginAccessToken: string | null = null; + /** + * The internally managed plugin access token. + * Use the `pluginAPI` instead of this directly. + */ + private readonly pluginAccessToken: string | null = null; constructor(body: EnvoyRequestBody, isVerified = false, pluginAccessToken: string | null = null) { this.body = body; @@ -22,6 +43,10 @@ export default class EnvoyPluginSDK EnvoyPluginStorage { + /** + * A function that returns an instance of EnvoyPluginStorage, + * optionally scoped to an install ID. + * + * Use `installStorage` or `globalStorage` instead of this directly. + */ + private get getStorage(): (installId?: string) => EnvoyPluginStorage { return (installId?) => new EnvoyPluginStorage(this.pluginAPI, installId); } @@ -100,7 +136,7 @@ export default class EnvoyPluginSDK { + set(key: string, value: unknown): Promise { return this.pipeline().set(key, value).executeSingle(); } diff --git a/src/EnvoyPluginStoragePipeline.ts b/src/EnvoyPluginStoragePipeline.ts index b6437a3..c1bba66 100644 --- a/src/EnvoyPluginStoragePipeline.ts +++ b/src/EnvoyPluginStoragePipeline.ts @@ -1,18 +1,21 @@ -import EnvoyAPI from './EnvoyAPI'; import EnvoyStorageCommand, { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions, } from './EnvoyStorageCommand'; import EnvoyStorageItem from './EnvoyStorageItem'; +import EnvoyPluginAPI from './EnvoyPluginAPI'; +/** + * Builds up a request pipeline for submitting storage commands. + */ export default class EnvoyPluginStoragePipeline { - readonly api: EnvoyAPI; + readonly api: EnvoyPluginAPI; readonly installId: string | undefined; - private commands: Array; + private readonly commands: Array; - constructor(pluginAPI: EnvoyAPI, installId?: string) { + constructor(pluginAPI: EnvoyPluginAPI, installId?: string) { this.api = pluginAPI; this.installId = installId; this.commands = []; @@ -49,8 +52,7 @@ export default class EnvoyPluginStoragePipeline { * Sets a value for a storage item, * and returns that item. */ - // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types - set(key: string, value: any): EnvoyPluginStoragePipeline { + set(key: string, value: unknown): EnvoyPluginStoragePipeline { return this.addCommand({ action: 'set', key, value }); } diff --git a/src/EnvoyRequest.ts b/src/EnvoyRequest.ts index 2bdba20..63f7b1b 100644 --- a/src/EnvoyRequest.ts +++ b/src/EnvoyRequest.ts @@ -10,10 +10,24 @@ export interface VerifiedRequest extends Request { [VERIFIED]: boolean } -export default interface EnvoyRequest extends VerifiedRequest { +export default interface EnvoyRequest extends VerifiedRequest { envoy: EnvoyPluginSDK } -export type EnvoyRouteRequest = EnvoyRequest; +/** + * Use to type your `req` object in route handlers, + * such as validation URLS or options URLs. + */ +export type EnvoyRouteRequest = EnvoyRequest; + +/** + * Use to type your `req` object in entry event handlers, + * such as handlers for `entry_sign_in`. + */ export type EnvoyEntryEventRequest = EnvoyRequest; + +/** + * Use to type your `req` object in invite event handlers, + * such as handlers for `invite_created` or `upcoming_visit`. + */ export type EnvoyInviteEventRequest = EnvoyRequest; diff --git a/src/EnvoyResponse.ts b/src/EnvoyResponse.ts index e7bd05f..80fc580 100644 --- a/src/EnvoyResponse.ts +++ b/src/EnvoyResponse.ts @@ -1,7 +1,11 @@ import { Response } from 'express'; +import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; +/** + * Use to type your `res` object in Envoy request handlers. + */ export default interface EnvoyResponse extends Response { - sendOngoing: (data: any) => void; - sendIgnored: (message: string, data?: Record) => void; - sendFailed: (message: string, data?: Record) => void; + sendOngoing: (debugInfo?: unknown) => void; + sendIgnored: (message: string, debugInfo?: unknown, ...attachments: Array) => void; + sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array) => void; } diff --git a/src/EnvoySignatureVerifier.ts b/src/EnvoySignatureVerifier.ts index fd87560..13b3957 100644 --- a/src/EnvoySignatureVerifier.ts +++ b/src/EnvoySignatureVerifier.ts @@ -16,6 +16,9 @@ const defaultOptions: EnvoySignatureVerifierOptions = { header: 'x-envoy-signature', }; +/** + * Verifies that a request is coming from Envoy. + */ export default class EnvoySignatureVerifier { private readonly options: EnvoySignatureVerifierOptions; diff --git a/src/EnvoyStorageCommand.ts b/src/EnvoyStorageCommand.ts index 16cf877..359d486 100644 --- a/src/EnvoyStorageCommand.ts +++ b/src/EnvoyStorageCommand.ts @@ -19,7 +19,7 @@ export interface EnvoyGetStorageCommand extends EnvoyBaseStorageCommand { export interface EnvoySetStorageCommand extends EnvoyBaseStorageCommand { action: 'set', - value: any, + value: unknown, } export interface EnvoySetUniqueStorageCommand extends EnvoyBaseStorageCommand, EnvoyStorageSetUniqueOptions { diff --git a/src/EnvoyStorageItem.ts b/src/EnvoyStorageItem.ts index 5835ca4..975a174 100644 --- a/src/EnvoyStorageItem.ts +++ b/src/EnvoyStorageItem.ts @@ -1,4 +1,4 @@ export default interface EnvoyStorageItem { key: string, - value: any, + value: unknown, } diff --git a/src/EnvoyUserAPI.ts b/src/EnvoyUserAPI.ts new file mode 100644 index 0000000..d7307de --- /dev/null +++ b/src/EnvoyUserAPI.ts @@ -0,0 +1,197 @@ +import axios from 'axios'; +import EnvoyAPI from './EnvoyAPI'; +import { AgreementPageModel } from './resources/AgreementPageResource'; +import { AgreementModel } from './resources/AgreementResource'; +import { CompanyModel } from './resources/CompanyResource'; +import { EmployeeFilterFields, EmployeeModel, EmployeeSortFields } from './resources/EmployeeResource'; +import { FlowFilterFields, FlowModel, FlowSortFields } from './resources/FlowResource'; +import { LocationFilterFields, LocationModel, LocationSortFields } from './resources/LocationResource'; +import { SignInFieldPageModel } from './resources/SignInFieldPageResource'; +import { SignInFieldModel } from './resources/SignInFieldResource'; +import JSONAPIPaginationParams from './util/json-api/JSONAPIPaginationParams'; +import { + InviteCreationModel, InviteFilterFields, InviteModel, InviteSortFields, +} from './resources/InviteResource'; +import { UserModel } from './resources/UserResource'; +import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; +import { EnvoyMetaAuth } from './EnvoyMeta'; + +/** + * API endpoints for *user-scoped* tokens. + * To access Envoy resources, this is the API you'd want. + */ +export default class EnvoyUserAPI extends EnvoyAPI { + async getAgreementPage(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'agreement-pages', id, include }); + } + + async getAgreement(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'agreements', id, include }); + } + + async getCompany(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'companies', id, include }); + } + + async getEmployee(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'employees', id, include }); + } + + async getFlow(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'flows', id, include }); + } + + async getLocation(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'locations', id, include }); + } + + async getSignInFieldPage(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'sign-in-field-pages', id, include }); + } + + async getSignInField(id: string, include?: string): Promise { + return this.dataLoader.load({ type: 'sign-in-fields', id, include }); + } + + async getEmployeeByEmail(email: string, include?: string): Promise { + const paginationParams: JSONAPIPaginationParams = { + filter: { + email, + }, + page: { + limit: 1, + }, + }; + const { data: { data: [employee] } } = await this.axios.get('/api/v3/employees', { + params: { + include, + ...paginationParams, + }, + }); + + return employee; + } + + async getEmployees( + params?: JSONAPIPaginationParams, + ): Promise> { + const { data } = await this.axios.get('/api/v3/employees', { params }); + return data.data; + } + + async getFlows(params?: JSONAPIPaginationParams): Promise> { + const { data } = await this.axios.get('/api/v3/flows', { params }); + return data.data; + } + + async getLocations( + params?: JSONAPIPaginationParams, + ): Promise> { + const { data } = await this.axios.get('/api/v3/locations', { params }); + return data.data; + } + + async getSignInFields(signInFieldPageId: string): Promise> { + const { data } = await this.axios.get(`/api/v3/sign-in-field-pages/${signInFieldPageId}/sign-in-fields`); + return data.data; + } + + async getInvites( + params?: JSONAPIPaginationParams, + ): Promise> { + const { data } = await this.axios.get('/api/v3/invites', { params }); + return data.data; + } + + async me(): Promise { + const { data } = await this.axios.get('/api/v2/users/me'); + return data.data; + } + + async createInvite(invite: InviteCreationModel): Promise { + const { data } = await this.axios({ + method: 'POST', + url: '/api/v3/invites', + data: { data: invite }, + }); + return data.data; + } + + async updateInvite(inviteId: string, invite: InviteCreationModel): Promise { + const { data } = await this.axios({ + method: 'PUT', + url: `/api/v3/invites/${inviteId}`, + data: { data: { ...invite, id: inviteId } }, + }); + + return data.data; + } + + async partialUpdateInvite(inviteId: string, invite: InviteCreationModel): Promise { + const { data } = await this.axios({ + method: 'PATCH', + url: `/api/v3/invites/${inviteId}`, + data: { data: { ...invite, id: inviteId } }, + }); + + return data.data; + } + + async removeInvite(inviteId: string): Promise { + await this.axios({ + method: 'DELETE', + url: `/api/v3/invites/${inviteId}`, + }); + } + + /** + * Gets a user access token using `password` as the grant type (discouraged). + */ + static async loginAsUser( + username: string, + password: string, + id = envoyClientId, + secret = envoyClientSecret, + ): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'password', + username, + password, + scope: 'plugin,token.refresh', + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } + + /** + * Gets a user access token using `plugin_install` as the grant type. + */ + static async loginAsPluginInstaller( + installId: string, + id = envoyClientId, + secret = envoyClientSecret, + ): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'plugin_install', + install_id: installId, + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } +} diff --git a/src/HttpStatus.ts b/src/HttpStatus.ts index 4464b96..37bf8a0 100644 --- a/src/HttpStatus.ts +++ b/src/HttpStatus.ts @@ -1,3 +1,6 @@ +/** + * Use these status codes to inform Envoy of a job's or route's status. + */ enum HttpStatus { ONGOING = 202, IGNORED = 400, diff --git a/src/asyncHandler.ts b/src/asyncHandler.ts index db9fc9d..0410c36 100644 --- a/src/asyncHandler.ts +++ b/src/asyncHandler.ts @@ -1,12 +1,12 @@ -/** - * Catches Promise-based errors. - */ import { RequestHandler, NextFunction } from 'express'; import EnvoyRequest from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; -type EnvoyHandler = (req: EnvoyRequest, res: EnvoyResponse) => void | Promise; +export type EnvoyHandler = (req: EnvoyRequest, res: EnvoyResponse) => void | Promise; +/** + * Catches Promise-based errors. + */ export default function asyncHandler(handler: RequestHandler | EnvoyHandler) { return async (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): Promise => { try { diff --git a/src/constants.ts b/src/constants.ts index 4bbdc7e..918a64f 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -1,3 +1,6 @@ +import dotenv from 'dotenv'; + +dotenv.config(); export const envoyBaseURL = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; export const envoyClientId = process.env.ENVOY_CLIENT_ID as string; export const envoyClientSecret = process.env.ENVOY_CLIENT_SECRET as string; diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..67e3a9b --- /dev/null +++ b/src/index.ts @@ -0,0 +1,27 @@ +import asyncHandler from './asyncHandler'; +import EnvoyJWT from './EnvoyJWT'; +import EnvoyPluginJob from './EnvoyPluginJob'; +import EnvoyPluginSDK from './EnvoyPluginSDK'; +import EnvoyPluginStorage from './EnvoyPluginStorage'; +import EnvoyPluginStoragePipeline from './EnvoyPluginStoragePipeline'; +import EnvoySignatureVerifier from './EnvoySignatureVerifier'; +import EnvoyUserAPI from './EnvoyUserAPI'; +import EnvoyPluginAPI from './EnvoyPluginAPI'; +import HttpStatus from './HttpStatus'; +import middleware from './middleware'; +import errorMiddleware from './errorMiddleware'; + +export { + asyncHandler, + EnvoyJWT, + EnvoyPluginJob, + EnvoyPluginSDK, + EnvoyPluginStorage, + EnvoyPluginStoragePipeline, + EnvoySignatureVerifier, + EnvoyUserAPI, + EnvoyPluginAPI, + HttpStatus, + middleware, + errorMiddleware, +}; diff --git a/src/middleware.ts b/src/middleware.ts index 02f865b..db18729 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -1,16 +1,24 @@ import bodyParser from 'body-parser'; import { Response, NextFunction } from 'express'; -import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './EnvoySignatureVerifier'; -import EnvoyAPI from './EnvoyAPI'; -import EnvoyPluginSDK from './EnvoyPluginSDK'; import HttpStatus from './HttpStatus'; +import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './EnvoySignatureVerifier'; import EnvoyRequest, { VERIFIED, VerifiedRequest } from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; +import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; +import EnvoyPluginSDK from './EnvoyPluginSDK'; +import EnvoyPluginAPI from './EnvoyPluginAPI'; export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => void; -export default function middleware(options: EnvoySignatureVerifierOptions): EnvoyMiddleware { +/** + * Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. + * Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. + * + * Also verifies that the request is coming from Envoy, + * as well as managing the plugin access token lifecycle. + */ +export default function middleware(options?: EnvoySignatureVerifierOptions): EnvoyMiddleware { const signatureVerifier = new EnvoySignatureVerifier(options); const verify = (req: VerifiedRequest, res: Response, rawBody: Buffer) => { req[VERIFIED] = signatureVerifier.verify(req, rawBody); @@ -27,7 +35,7 @@ export default function middleware(options: EnvoySignatureVerifierOptions): Envo try { const now = Date.now(); if (now > threshold) { - const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyAPI.login(); + const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyPluginAPI.login(); accessToken = rawAccessToken; threshold = now + (expiresIn * 1000) - (1000 * 60 * 10); } @@ -37,28 +45,28 @@ export default function middleware(options: EnvoySignatureVerifierOptions): Envo /** * Respond with "ongoing" for long jobs. */ - res.sendOngoing = (data = {}) => { + res.sendOngoing = (debugInfo: unknown = {}) => { res.statusCode = HttpStatus.ONGOING; res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(data)); + res.end(JSON.stringify({ debugInfo })); }; /** * Respond with "ignored" if no action will be performed. */ - res.sendIgnored = (message = '', data = {}) => { + res.sendIgnored = (message = '', debugInfo: unknown = {}, ...attachments: Array) => { res.statusCode = HttpStatus.IGNORED; res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ ...(data || {}), message })); + res.end(JSON.stringify({ message, debugInfo, attachments })); }; /** * Respond with "failed" in case of errors. */ - res.sendFailed = (message = '', data = {}) => { + res.sendFailed = (message = '', debugInfo: unknown = {}, ...attachments: Array) => { res.statusCode = HttpStatus.FAILED; res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ ...(data || {}), message })); + res.end(JSON.stringify({ message, debugInfo, attachments })); }; next(); } catch (error) { diff --git a/src/util/json-api/JSONAPIResponse.ts b/src/util/json-api/JSONAPIResponse.ts index fbde6a7..0b20c90 100644 --- a/src/util/json-api/JSONAPIResponse.ts +++ b/src/util/json-api/JSONAPIResponse.ts @@ -1,7 +1,5 @@ export default interface JSONAPIResponse { data: Model, - // eslint-disable-next-line @typescript-eslint/no-explicit-any - included?: Array, - // eslint-disable-next-line @typescript-eslint/no-explicit-any - meta?: Array + included?: Array, + meta?: Array } diff --git a/tsconfig.json b/tsconfig.json index b293d60..5118a0a 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -10,12 +10,12 @@ // "allowJs": true, /* Allow javascript files to be compiled. */ // "checkJs": true, /* Report errors in .js files. */ // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */ - // "declaration": true, /* Generates corresponding '.d.ts' file. */ - // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + "declaration": true, /* Generates corresponding '.d.ts' file. */ + "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ // "sourceMap": true, /* Generates corresponding '.map' file. */ // "outFile": "./", /* Concatenate and emit output to single file. */ - // "outDir": "./", /* Redirect output structure to the directory. */ - // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + "outDir": "dist", /* Redirect output structure to the directory. */ + "rootDir": "src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ // "composite": true, /* Enable project compilation */ // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ // "removeComments": true, /* Do not emit comments to output. */ @@ -72,6 +72,7 @@ "src/**/*.ts" ], "exclude": [ - "node_modules" + "node_modules", + "dist" ] } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..0469080 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,7 @@ +{ + "entryPoints": ["./src/index.ts"], + "out": "docs", + "excludePrivate": true, + "excludeProtected": true, + "readme": "none" +} From 2bdd02650712a981153c62bf0977b18f46feb710 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:19:33 -0400 Subject: [PATCH 06/91] fixing docs --- docs/README.md | 22 +- docs/classes/envoyjwt.md | 50 +-- docs/classes/envoypluginapi.md | 115 +----- docs/classes/envoypluginjob.md | 163 +------- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 59 +-- docs/classes/envoypluginstoragepipeline.md | 70 +--- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 412 +-------------------- docs/enums/httpstatus.md | 8 +- src/EnvoyRequest.ts | 17 +- src/EnvoyStorageItem.ts | 6 +- src/errorMiddleware.ts | 6 +- src/index.ts | 6 + typedoc.json | 2 + 15 files changed, 97 insertions(+), 865 deletions(-) diff --git a/docs/README.md b/docs/README.md index a9e87dc..a5bb8ee 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,6 +19,10 @@ - [EnvoySignatureVerifier](classes/envoysignatureverifier.md) - [EnvoyUserAPI](classes/envoyuserapi.md) +### Interfaces + +- [EnvoyResponse](interfaces/envoyresponse.md) + ### Functions - [asyncHandler](README.md#asynchandler) @@ -29,7 +33,7 @@ ### asyncHandler -▸ **asyncHandler**(`handler`): (`req`: `default`, `res`: `default`, `next`: `NextFunction`) => `Promise` +▸ **asyncHandler**(`handler`): (`req`: `EnvoyRequest`, `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` Catches Promise-based errors. @@ -49,8 +53,8 @@ Catches Promise-based errors. | Name | Type | | :------ | :------ | -| `req` | `default` | -| `res` | `default` | +| `req` | `EnvoyRequest` | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -59,13 +63,13 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/asyncHandler.ts#L10) ___ ### errorMiddleware -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: `Request`\>, `res`: `Response`\>, `next`: `NextFunction`) => `void` +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: `EnvoyRequest`, `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` Catches errors and sets the proper status code. @@ -86,8 +90,8 @@ Catches errors and sets the proper status code. | Name | Type | | :------ | :------ | | `err` | `Error` | -| `req` | `Request`\> | -| `res` | `Response`\> | +| `req` | `EnvoyRequest` | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -96,7 +100,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/errorMiddleware.ts#L7) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/errorMiddleware.ts#L9) ___ @@ -122,4 +126,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 6ffe62c..4818140 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -10,11 +10,6 @@ Helper to encode and decode JWTs. - [constructor](envoyjwt.md#constructor) -### Methods - -- [decode](envoyjwt.md#decode) -- [encode](envoyjwt.md#encode) - ## Constructors ### constructor @@ -30,47 +25,4 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyJWT.ts#L12) - -## Methods - -### decode - -▸ **decode**(`token`, `options?`): `Record` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `token` | `string` | -| `options` | `VerifyOptions` | - -#### Returns - -`Record` - -#### Defined in - -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyJWT.ts#L39) - -___ - -### encode - -▸ **encode**(`subject`, `expiresIn`, `payload?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `subject` | ``null`` \| `string` \| `number` | -| `expiresIn` | ``null`` \| `string` \| `number` | -| `payload` | `Record` | - -#### Returns - -`string` - -#### Defined in - -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyJWT.ts#L12) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index f1643d5..1275114 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -22,11 +22,6 @@ API endpoints for *plugin-scoped* tokens. ### Methods -- [createNotification](envoypluginapi.md#createnotification) -- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) -- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) -- [storagePipeline](envoypluginapi.md#storagepipeline) -- [updateJob](envoypluginapi.md#updatejob) - [login](envoypluginapi.md#login) ## Constructors @@ -47,7 +42,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L58) ## Properties @@ -63,114 +58,10 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L31) ## Methods -### createNotification - -▸ **createNotification**(`installId`, `params?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `installId` | `string` | -| `params` | `Object` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L50) - -___ - -### getPluginInstallConfig - -▸ **getPluginInstallConfig**(`installId`): `Promise`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `installId` | `string` | - -#### Returns - -`Promise`\> - -#### Defined in - -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L21) - -___ - -### setPluginInstallConfig - -▸ **setPluginInstallConfig**(`installId`, `config`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `installId` | `string` | -| `config` | `Record` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L26) - -___ - -### storagePipeline - -▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| default)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `commands` | `EnvoyStorageCommand`[] | -| `installId?` | `string` | - -#### Returns - -`Promise`<(``null`` \| default)[]\> - -#### Defined in - -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L34) - -___ - -### updateJob - -▸ **updateJob**(`jobId`, `update`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jobId` | `string` | -| `update` | `default` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L13) - -___ - ### login ▸ `Static` **login**(`id?`, `secret?`): `Promise` @@ -190,4 +81,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index e226699..de53d07 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -14,20 +14,6 @@ as well as attach extra data to the event's subject - [constructor](envoypluginjob.md#constructor) -### Properties - -- [api](envoypluginjob.md#api) -- [id](envoypluginjob.md#id) - -### Methods - -- [attach](envoypluginjob.md#attach) -- [complete](envoypluginjob.md#complete) -- [execute](envoypluginjob.md#execute) -- [fail](envoypluginjob.md#fail) -- [ignore](envoypluginjob.md#ignore) -- [update](envoypluginjob.md#update) - ## Constructors ### constructor @@ -43,151 +29,4 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L15) - -## Properties - -### api - -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) - -#### Defined in - -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L13) - -___ - -### id - -• `Readonly` **id**: `string` - -#### Defined in - -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L15) - -## Methods - -### attach - -▸ **attach**(...`attachments`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...attachments` | `EnvoyPluginJobAttachment`[] | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L43) - -___ - -### complete - -▸ **complete**(`message`, ...`attachments`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...attachments` | `EnvoyPluginJobAttachment`[] | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L47) - -___ - -### execute - -▸ **execute**(`status`, `message`, `reason`, `attachments?`): `Promise` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `status` | ``null`` \| `string` | `undefined` | -| `message` | ``null`` \| `string` | `undefined` | -| `reason` | ``null`` \| `string` | `undefined` | -| `attachments` | `EnvoyPluginJobAttachment`[] | [] | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L22) - -___ - -### fail - -▸ **fail**(`message`, `reason`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `reason` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L55) - -___ - -### ignore - -▸ **ignore**(`message`, `reason`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `reason` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L51) - -___ - -### update - -▸ **update**(`message`, ...`attachments`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...attachments` | `EnvoyPluginJobAttachment`[] | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginJob.ts#L15) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 813b75d..81bd598 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index 1b22426..fd308ea 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -11,11 +11,6 @@ or to the plugin itself. - [constructor](envoypluginstorage.md#constructor) -### Properties - -- [api](envoypluginstorage.md#api) -- [installId](envoypluginstorage.md#installid) - ### Methods - [get](envoypluginstorage.md#get) @@ -40,33 +35,13 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L13) - -## Properties - -### api - -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) - -#### Defined in - -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L11) - -___ - -### installId - -• `Readonly` **installId**: `undefined` \| `string` - -#### Defined in - -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L13) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| default\> +▸ **get**(`key`): `Promise`<``null`` \| EnvoyStorageItem\> Wrapper for single pipeline get. @@ -78,11 +53,11 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| default\> +`Promise`<``null`` \| EnvoyStorageItem\> #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,13 +73,13 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L23) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| default\> +▸ **set**(`key`, `value`): `Promise`<``null`` \| EnvoyStorageItem\> Wrapper for single pipeline set. @@ -117,17 +92,17 @@ Wrapper for single pipeline set. #### Returns -`Promise`<``null`` \| default\> +`Promise`<``null`` \| EnvoyStorageItem\> #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L37) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| default\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| EnvoyStorageItem\> Wrapper for single pipeline setUnique. @@ -140,17 +115,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| default\> +`Promise`<``null`` \| EnvoyStorageItem\> #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L44) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| default\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| EnvoyStorageItem\> Wrapper for single pipeline setUnique. @@ -163,17 +138,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| default\> +`Promise`<``null`` \| EnvoyStorageItem\> #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L51) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| default\> +▸ **unset**(`key`): `Promise`<``null`` \| EnvoyStorageItem\> Wrapper for single pipeline unset. Returns null if the item did not previously exist. @@ -186,8 +161,8 @@ Returns null if the item did not previously exist. #### Returns -`Promise`<``null`` \| default\> +`Promise`<``null`` \| EnvoyStorageItem\> #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 388641c..5cb0236 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -10,14 +10,8 @@ Builds up a request pipeline for submitting storage commands. - [constructor](envoypluginstoragepipeline.md#constructor) -### Properties - -- [api](envoypluginstoragepipeline.md#api) -- [installId](envoypluginstoragepipeline.md#installid) - ### Methods -- [addCommand](envoypluginstoragepipeline.md#addcommand) - [execute](envoypluginstoragepipeline.md#execute) - [executeSingle](envoypluginstoragepipeline.md#executesingle) - [get](envoypluginstoragepipeline.md#get) @@ -41,79 +35,39 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L16) - -## Properties - -### api - -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L12) - -___ - -### installId - -• `Readonly` **installId**: `undefined` \| `string` - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L16) ## Methods -### addCommand - -▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `EnvoyStorageCommand` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L39) - -___ - ### execute -▸ **execute**(): `Promise`<(``null`` \| default)[]\> +▸ **execute**(): `Promise`<(``null`` \| EnvoyStorageItem)[]\> Executes all the commands in the pipeline. #### Returns -`Promise`<(``null`` \| default)[]\> +`Promise`<(``null`` \| EnvoyStorageItem)[]\> #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L27) ___ ### executeSingle -▸ **executeSingle**(): `Promise`<``null`` \| default\> +▸ **executeSingle**(): `Promise`<``null`` \| EnvoyStorageItem\> Executes the pipeline and returns the first result. #### Returns -`Promise`<``null`` \| default\> +`Promise`<``null`` \| EnvoyStorageItem\> #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +89,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +113,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +137,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +161,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +183,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index 4f723dc..d1e3a54 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index b5a4758..2eff114 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -23,25 +23,6 @@ To access Envoy resources, this is the API you'd want. ### Methods -- [createInvite](envoyuserapi.md#createinvite) -- [getAgreement](envoyuserapi.md#getagreement) -- [getAgreementPage](envoyuserapi.md#getagreementpage) -- [getCompany](envoyuserapi.md#getcompany) -- [getEmployee](envoyuserapi.md#getemployee) -- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) -- [getEmployees](envoyuserapi.md#getemployees) -- [getFlow](envoyuserapi.md#getflow) -- [getFlows](envoyuserapi.md#getflows) -- [getInvites](envoyuserapi.md#getinvites) -- [getLocation](envoyuserapi.md#getlocation) -- [getLocations](envoyuserapi.md#getlocations) -- [getSignInField](envoyuserapi.md#getsigninfield) -- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) -- [getSignInFields](envoyuserapi.md#getsigninfields) -- [me](envoyuserapi.md#me) -- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) -- [removeInvite](envoyuserapi.md#removeinvite) -- [updateInvite](envoyuserapi.md#updateinvite) - [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) - [loginAsUser](envoyuserapi.md#loginasuser) @@ -63,7 +44,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L58) ## Properties @@ -79,395 +60,10 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L31) ## Methods -### createInvite - -▸ **createInvite**(`invite`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `invite` | `InviteCreationModel` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L111) - -___ - -### getAgreement - -▸ **getAgreement**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L28) - -___ - -### getAgreementPage - -▸ **getAgreementPage**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L24) - -___ - -### getCompany - -▸ **getCompany**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L32) - -___ - -### getEmployee - -▸ **getEmployee**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L36) - -___ - -### getEmployeeByEmail - -▸ **getEmployeeByEmail**(`email`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `email` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L56) - -___ - -### getEmployees - -▸ **getEmployees**(`params?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params?` | `default` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L75) - -___ - -### getFlow - -▸ **getFlow**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L40) - -___ - -### getFlows - -▸ **getFlows**(`params?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params?` | `default` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L82) - -___ - -### getInvites - -▸ **getInvites**(`params?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params?` | `default` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L99) - -___ - -### getLocation - -▸ **getLocation**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L44) - -___ - -### getLocations - -▸ **getLocations**(`params?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params?` | `default` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L87) - -___ - -### getSignInField - -▸ **getSignInField**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L52) - -___ - -### getSignInFieldPage - -▸ **getSignInFieldPage**(`id`, `include?`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `include?` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L48) - -___ - -### getSignInFields - -▸ **getSignInFields**(`signInFieldPageId`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signInFieldPageId` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L94) - -___ - -### me - -▸ **me**(): `Promise` - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L106) - -___ - -### partialUpdateInvite - -▸ **partialUpdateInvite**(`inviteId`, `invite`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `inviteId` | `string` | -| `invite` | `InviteCreationModel` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L130) - -___ - -### removeInvite - -▸ **removeInvite**(`inviteId`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `inviteId` | `string` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L140) - -___ - -### updateInvite - -▸ **updateInvite**(`inviteId`, `invite`): `Promise` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `inviteId` | `string` | -| `invite` | `InviteCreationModel` | - -#### Returns - -`Promise` - -#### Defined in - -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L120) - -___ - ### loginAsPluginInstaller ▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise` @@ -488,7 +84,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +109,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 7e246cd..b52295c 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c08fadc/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L8) diff --git a/src/EnvoyRequest.ts b/src/EnvoyRequest.ts index 63f7b1b..e8d22c6 100644 --- a/src/EnvoyRequest.ts +++ b/src/EnvoyRequest.ts @@ -10,7 +10,7 @@ export interface VerifiedRequest extends Request { [VERIFIED]: boolean } -export default interface EnvoyRequest extends VerifiedRequest { +export interface EnvoyBaseRequest extends VerifiedRequest { envoy: EnvoyPluginSDK } @@ -18,16 +18,25 @@ export default interface EnvoyRequest = EnvoyRequest; +export type EnvoyRouteRequest = EnvoyBaseRequest; + +/** + * Use to type your `req` object in route handlers, + * such as validation URLS or options URLs. + */ +export type EnvoyEventRequest = EnvoyBaseRequest; /** * Use to type your `req` object in entry event handlers, * such as handlers for `entry_sign_in`. */ -export type EnvoyEntryEventRequest = EnvoyRequest; +export type EnvoyEntryEventRequest = EnvoyEventRequest; /** * Use to type your `req` object in invite event handlers, * such as handlers for `invite_created` or `upcoming_visit`. */ -export type EnvoyInviteEventRequest = EnvoyRequest; +export type EnvoyInviteEventRequest = EnvoyEventRequest; + +type EnvoyRequest = EnvoyBaseRequest; +export default EnvoyRequest; diff --git a/src/EnvoyStorageItem.ts b/src/EnvoyStorageItem.ts index 975a174..0308305 100644 --- a/src/EnvoyStorageItem.ts +++ b/src/EnvoyStorageItem.ts @@ -1,4 +1,6 @@ -export default interface EnvoyStorageItem { +type EnvoyStorageItem = { key: string, value: unknown, -} +}; + +export default EnvoyStorageItem; diff --git a/src/errorMiddleware.ts b/src/errorMiddleware.ts index ce0e66a..94c256e 100644 --- a/src/errorMiddleware.ts +++ b/src/errorMiddleware.ts @@ -1,11 +1,13 @@ -import { Request, Response, NextFunction } from 'express'; +import { NextFunction } from 'express'; import HttpStatus from './HttpStatus'; +import EnvoyBaseRequest from './EnvoyRequest'; +import EnvoyResponse from './EnvoyResponse'; /** * Catches errors and sets the proper status code. */ export default function errorMiddleware(onError: (err: Error) => void = () => {}) { - return (err: Error, req: Request, res: Response, next: NextFunction): void => { + return (err: Error, req: EnvoyBaseRequest, res: EnvoyResponse, next: NextFunction): void => { onError(err); if (res.headersSent) { return next(err); diff --git a/src/index.ts b/src/index.ts index 67e3a9b..1306436 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3,7 +3,10 @@ import EnvoyJWT from './EnvoyJWT'; import EnvoyPluginJob from './EnvoyPluginJob'; import EnvoyPluginSDK from './EnvoyPluginSDK'; import EnvoyPluginStorage from './EnvoyPluginStorage'; +import EnvoyStorageItem from './EnvoyStorageItem'; import EnvoyPluginStoragePipeline from './EnvoyPluginStoragePipeline'; +import EnvoyRequest from './EnvoyRequest'; +import EnvoyResponse from './EnvoyResponse'; import EnvoySignatureVerifier from './EnvoySignatureVerifier'; import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; @@ -17,8 +20,11 @@ export { EnvoyPluginJob, EnvoyPluginSDK, EnvoyPluginStorage, + EnvoyStorageItem, EnvoyPluginStoragePipeline, EnvoySignatureVerifier, + EnvoyRequest, + EnvoyResponse, EnvoyUserAPI, EnvoyPluginAPI, HttpStatus, diff --git a/typedoc.json b/typedoc.json index 0469080..f3c2ae7 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,5 +3,7 @@ "out": "docs", "excludePrivate": true, "excludeProtected": true, + "excludeExternals": true, + "excludeNotDocumented": true, "readme": "none" } From 2e09643bf27691070b9e37382a51fe793747c45b Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:21:04 -0400 Subject: [PATCH 07/91] fixing docs --- docs/README.md | 52 ++- docs/classes/envoyjwt.md | 50 ++- docs/classes/envoypluginapi.md | 115 +++++- docs/classes/envoypluginjob.md | 163 +++++++- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 59 ++- docs/classes/envoypluginstoragepipeline.md | 70 +++- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 412 ++++++++++++++++++++- docs/enums/httpstatus.md | 8 +- typedoc.json | 2 - 11 files changed, 893 insertions(+), 64 deletions(-) diff --git a/docs/README.md b/docs/README.md index a5bb8ee..f79376b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,17 +23,55 @@ - [EnvoyResponse](interfaces/envoyresponse.md) +### Type aliases + +- [EnvoyRequest](README.md#envoyrequest) +- [EnvoyStorageItem](README.md#envoystorageitem) + ### Functions - [asyncHandler](README.md#asynchandler) - [errorMiddleware](README.md#errormiddleware) - [middleware](README.md#middleware) +## Type aliases + +### EnvoyRequest + +Ƭ **EnvoyRequest**: `EnvoyBaseRequest` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[src/EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyRequest.ts#L41) + +___ + +### EnvoyStorageItem + +Ƭ **EnvoyStorageItem**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `unknown` | + +#### Defined in + +[src/EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyStorageItem.ts#L1) + ## Functions ### asyncHandler -▸ **asyncHandler**(`handler`): (`req`: `EnvoyRequest`, `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` +▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` Catches Promise-based errors. @@ -53,7 +91,7 @@ Catches Promise-based errors. | Name | Type | | :------ | :------ | -| `req` | `EnvoyRequest` | +| `req` | [EnvoyRequest](README.md#envoyrequest) | | `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | @@ -63,13 +101,13 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/asyncHandler.ts#L10) +[src/asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/asyncHandler.ts#L10) ___ ### errorMiddleware -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: `EnvoyRequest`, `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` Catches errors and sets the proper status code. @@ -90,7 +128,7 @@ Catches errors and sets the proper status code. | Name | Type | | :------ | :------ | | `err` | `Error` | -| `req` | `EnvoyRequest` | +| `req` | [EnvoyRequest](README.md#envoyrequest) | | `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | @@ -100,7 +138,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/errorMiddleware.ts#L9) +[src/errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/errorMiddleware.ts#L9) ___ @@ -126,4 +164,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/middleware.ts#L21) +[src/middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 4818140..67d2ff2 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -10,6 +10,11 @@ Helper to encode and decode JWTs. - [constructor](envoyjwt.md#constructor) +### Methods + +- [decode](envoyjwt.md#decode) +- [encode](envoyjwt.md#encode) + ## Constructors ### constructor @@ -25,4 +30,47 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyJWT.ts#L12) +[src/EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyJWT.ts#L12) + +## Methods + +### decode + +▸ **decode**(`token`, `options?`): `Record` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `options` | `VerifyOptions` | + +#### Returns + +`Record` + +#### Defined in + +[src/EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyJWT.ts#L39) + +___ + +### encode + +▸ **encode**(`subject`, `expiresIn`, `payload?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subject` | ``null`` \| `string` \| `number` | +| `expiresIn` | ``null`` \| `string` \| `number` | +| `payload` | `Record` | + +#### Returns + +`string` + +#### Defined in + +[src/EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 1275114..f4a3844 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -22,6 +22,11 @@ API endpoints for *plugin-scoped* tokens. ### Methods +- [createNotification](envoypluginapi.md#createnotification) +- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) +- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) +- [storagePipeline](envoypluginapi.md#storagepipeline) +- [updateJob](envoypluginapi.md#updatejob) - [login](envoypluginapi.md#login) ## Constructors @@ -42,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L58) +[src/EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L58) ## Properties @@ -58,10 +63,114 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L31) +[src/EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L31) ## Methods +### createNotification + +▸ **createNotification**(`installId`, `params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | +| `params` | `Object` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L50) + +___ + +### getPluginInstallConfig + +▸ **getPluginInstallConfig**(`installId`): `Promise`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | + +#### Returns + +`Promise`\> + +#### Defined in + +[src/EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L21) + +___ + +### setPluginInstallConfig + +▸ **setPluginInstallConfig**(`installId`, `config`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `installId` | `string` | +| `config` | `Record` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L26) + +___ + +### storagePipeline + +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `commands` | `EnvoyStorageCommand`[] | +| `installId?` | `string` | + +#### Returns + +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> + +#### Defined in + +[src/EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L34) + +___ + +### updateJob + +▸ **updateJob**(`jobId`, `update`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `jobId` | `string` | +| `update` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L13) + +___ + ### login ▸ `Static` **login**(`id?`, `secret?`): `Promise` @@ -81,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginAPI.ts#L61) +[src/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index de53d07..3b26b37 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -14,6 +14,20 @@ as well as attach extra data to the event's subject - [constructor](envoypluginjob.md#constructor) +### Properties + +- [api](envoypluginjob.md#api) +- [id](envoypluginjob.md#id) + +### Methods + +- [attach](envoypluginjob.md#attach) +- [complete](envoypluginjob.md#complete) +- [execute](envoypluginjob.md#execute) +- [fail](envoypluginjob.md#fail) +- [ignore](envoypluginjob.md#ignore) +- [update](envoypluginjob.md#update) + ## Constructors ### constructor @@ -29,4 +43,151 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginJob.ts#L15) +[src/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L15) + +## Properties + +### api + +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[src/EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L13) + +___ + +### id + +• `Readonly` **id**: `string` + +#### Defined in + +[src/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L15) + +## Methods + +### attach + +▸ **attach**(...`attachments`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L43) + +___ + +### complete + +▸ **complete**(`message`, ...`attachments`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L47) + +___ + +### execute + +▸ **execute**(`status`, `message`, `reason`, `attachments?`): `Promise` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `status` | ``null`` \| `string` | `undefined` | +| `message` | ``null`` \| `string` | `undefined` | +| `reason` | ``null`` \| `string` | `undefined` | +| `attachments` | `EnvoyPluginJobAttachment`[] | [] | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L22) + +___ + +### fail + +▸ **fail**(`message`, `reason`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `reason` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L55) + +___ + +### ignore + +▸ **ignore**(`message`, `reason`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `reason` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L51) + +___ + +### update + +▸ **update**(`message`, ...`attachments`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 81bd598..2ad6f91 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L38) +[src/EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L129) +[src/EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L122) +[src/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L111) +[src/EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L147) +[src/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L136) +[src/EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L160) +[src/EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L50) +[src/EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L62) +[src/EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L90) +[src/EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginSDK.ts#L73) +[src/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index fd308ea..87d7caa 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -11,6 +11,11 @@ or to the plugin itself. - [constructor](envoypluginstorage.md#constructor) +### Properties + +- [api](envoypluginstorage.md#api) +- [installId](envoypluginstorage.md#installid) + ### Methods - [get](envoypluginstorage.md#get) @@ -35,13 +40,33 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L13) +[src/EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L13) + +## Properties + +### api + +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[src/EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L11) + +___ + +### installId + +• `Readonly` **installId**: `undefined` \| `string` + +#### Defined in + +[src/EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L13) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| EnvoyStorageItem\> +▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline get. @@ -53,11 +78,11 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| EnvoyStorageItem\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L30) +[src/EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L30) ___ @@ -73,13 +98,13 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L23) +[src/EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L23) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| EnvoyStorageItem\> +▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline set. @@ -92,17 +117,17 @@ Wrapper for single pipeline set. #### Returns -`Promise`<``null`` \| EnvoyStorageItem\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L37) +[src/EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L37) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| EnvoyStorageItem\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -115,17 +140,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| EnvoyStorageItem\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L44) +[src/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L44) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| EnvoyStorageItem\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -138,17 +163,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| EnvoyStorageItem\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L51) +[src/EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L51) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| EnvoyStorageItem\> +▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline unset. Returns null if the item did not previously exist. @@ -161,8 +186,8 @@ Returns null if the item did not previously exist. #### Returns -`Promise`<``null`` \| EnvoyStorageItem\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStorage.ts#L59) +[src/EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 5cb0236..b2d3869 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -10,8 +10,14 @@ Builds up a request pipeline for submitting storage commands. - [constructor](envoypluginstoragepipeline.md#constructor) +### Properties + +- [api](envoypluginstoragepipeline.md#api) +- [installId](envoypluginstoragepipeline.md#installid) + ### Methods +- [addCommand](envoypluginstoragepipeline.md#addcommand) - [execute](envoypluginstoragepipeline.md#execute) - [executeSingle](envoypluginstoragepipeline.md#executesingle) - [get](envoypluginstoragepipeline.md#get) @@ -35,39 +41,79 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L16) +[src/EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L16) + +## Properties + +### api + +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) + +#### Defined in + +[src/EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L12) + +___ + +### installId + +• `Readonly` **installId**: `undefined` \| `string` + +#### Defined in + +[src/EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods +### addCommand + +▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `command` | `EnvoyStorageCommand` | + +#### Returns + +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) + +#### Defined in + +[src/EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L39) + +___ + ### execute -▸ **execute**(): `Promise`<(``null`` \| EnvoyStorageItem)[]\> +▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> Executes all the commands in the pipeline. #### Returns -`Promise`<(``null`` \| EnvoyStorageItem)[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L27) +[src/EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L27) ___ ### executeSingle -▸ **executeSingle**(): `Promise`<``null`` \| EnvoyStorageItem\> +▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Executes the pipeline and returns the first result. #### Returns -`Promise`<``null`` \| EnvoyStorageItem\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L34) +[src/EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -89,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L47) +[src/EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -113,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L55) +[src/EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -137,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L63) +[src/EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -161,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L71) +[src/EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -183,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyPluginStoragePipeline.ts#L78) +[src/EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index d1e3a54..edc7028 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoySignatureVerifier.ts#L23) +[src/EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoySignatureVerifier.ts#L36) +[src/EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 2eff114..7d1a314 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -23,6 +23,25 @@ To access Envoy resources, this is the API you'd want. ### Methods +- [createInvite](envoyuserapi.md#createinvite) +- [getAgreement](envoyuserapi.md#getagreement) +- [getAgreementPage](envoyuserapi.md#getagreementpage) +- [getCompany](envoyuserapi.md#getcompany) +- [getEmployee](envoyuserapi.md#getemployee) +- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) +- [getEmployees](envoyuserapi.md#getemployees) +- [getFlow](envoyuserapi.md#getflow) +- [getFlows](envoyuserapi.md#getflows) +- [getInvites](envoyuserapi.md#getinvites) +- [getLocation](envoyuserapi.md#getlocation) +- [getLocations](envoyuserapi.md#getlocations) +- [getSignInField](envoyuserapi.md#getsigninfield) +- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) +- [getSignInFields](envoyuserapi.md#getsigninfields) +- [me](envoyuserapi.md#me) +- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) +- [removeInvite](envoyuserapi.md#removeinvite) +- [updateInvite](envoyuserapi.md#updateinvite) - [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) - [loginAsUser](envoyuserapi.md#loginasuser) @@ -44,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L58) +[src/EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L58) ## Properties @@ -60,10 +79,395 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyAPI.ts#L31) +[src/EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L31) ## Methods +### createInvite + +▸ **createInvite**(`invite`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `InviteCreationModel` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L111) + +___ + +### getAgreement + +▸ **getAgreement**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L28) + +___ + +### getAgreementPage + +▸ **getAgreementPage**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L24) + +___ + +### getCompany + +▸ **getCompany**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L32) + +___ + +### getEmployee + +▸ **getEmployee**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L36) + +___ + +### getEmployeeByEmail + +▸ **getEmployeeByEmail**(`email`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L56) + +___ + +### getEmployees + +▸ **getEmployees**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L75) + +___ + +### getFlow + +▸ **getFlow**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L40) + +___ + +### getFlows + +▸ **getFlows**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L82) + +___ + +### getInvites + +▸ **getInvites**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L99) + +___ + +### getLocation + +▸ **getLocation**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L44) + +___ + +### getLocations + +▸ **getLocations**(`params?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params?` | `default` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L87) + +___ + +### getSignInField + +▸ **getSignInField**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L52) + +___ + +### getSignInFieldPage + +▸ **getSignInFieldPage**(`id`, `include?`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `include?` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L48) + +___ + +### getSignInFields + +▸ **getSignInFields**(`signInFieldPageId`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signInFieldPageId` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L94) + +___ + +### me + +▸ **me**(): `Promise` + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L106) + +___ + +### partialUpdateInvite + +▸ **partialUpdateInvite**(`inviteId`, `invite`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `string` | +| `invite` | `InviteCreationModel` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L130) + +___ + +### removeInvite + +▸ **removeInvite**(`inviteId`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `string` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L140) + +___ + +### updateInvite + +▸ **updateInvite**(`inviteId`, `invite`): `Promise` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `string` | +| `invite` | `InviteCreationModel` | + +#### Returns + +`Promise` + +#### Defined in + +[src/EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L120) + +___ + ### loginAsPluginInstaller ▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise` @@ -84,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyUserAPI.ts#L177) +[src/EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L177) ___ @@ -109,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/EnvoyUserAPI.ts#L150) +[src/EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index b52295c..1c5ea9b 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L7) +[src/HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L6) +[src/HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L5) +[src/HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/aecf47b/src/HttpStatus.ts#L8) +[src/HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L8) diff --git a/typedoc.json b/typedoc.json index f3c2ae7..0469080 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,7 +3,5 @@ "out": "docs", "excludePrivate": true, "excludeProtected": true, - "excludeExternals": true, - "excludeNotDocumented": true, "readme": "none" } From 229a60c588eb67974b44940ee3fb1d0d975f10bd Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:21:58 -0400 Subject: [PATCH 08/91] fixing docs --- docs/interfaces/envoyresponse.md | 3519 ++++++++++++++++++++++++++++++ 1 file changed, 3519 insertions(+) create mode 100644 docs/interfaces/envoyresponse.md diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md new file mode 100644 index 0000000..1480f41 --- /dev/null +++ b/docs/interfaces/envoyresponse.md @@ -0,0 +1,3519 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyResponse + +# Interface: EnvoyResponse + +Use to type your `res` object in Envoy request handlers. + +## Hierarchy + +- `Response` + + ↳ **EnvoyResponse** + +## Table of contents + +### Properties + +- [app](envoyresponse.md#app) +- [charset](envoyresponse.md#charset) +- [chunkedEncoding](envoyresponse.md#chunkedencoding) +- [connection](envoyresponse.md#connection) +- [destroyed](envoyresponse.md#destroyed) +- [finished](envoyresponse.md#finished) +- [headersSent](envoyresponse.md#headerssent) +- [json](envoyresponse.md#json) +- [jsonp](envoyresponse.md#jsonp) +- [locals](envoyresponse.md#locals) +- [req](envoyresponse.md#req) +- [send](envoyresponse.md#send) +- [sendDate](envoyresponse.md#senddate) +- [sendFailed](envoyresponse.md#sendfailed) +- [sendIgnored](envoyresponse.md#sendignored) +- [sendOngoing](envoyresponse.md#sendongoing) +- [shouldKeepAlive](envoyresponse.md#shouldkeepalive) +- [socket](envoyresponse.md#socket) +- [statusCode](envoyresponse.md#statuscode) +- [statusMessage](envoyresponse.md#statusmessage) +- [useChunkedEncodingByDefault](envoyresponse.md#usechunkedencodingbydefault) +- [writable](envoyresponse.md#writable) +- [writableCorked](envoyresponse.md#writablecorked) +- [writableEnded](envoyresponse.md#writableended) +- [writableFinished](envoyresponse.md#writablefinished) +- [writableHighWaterMark](envoyresponse.md#writablehighwatermark) +- [writableLength](envoyresponse.md#writablelength) +- [writableObjectMode](envoyresponse.md#writableobjectmode) + +### Methods + +- [\_construct](envoyresponse.md#_construct) +- [\_destroy](envoyresponse.md#_destroy) +- [\_final](envoyresponse.md#_final) +- [\_write](envoyresponse.md#_write) +- [\_writev](envoyresponse.md#_writev) +- [addListener](envoyresponse.md#addlistener) +- [addTrailers](envoyresponse.md#addtrailers) +- [append](envoyresponse.md#append) +- [assignSocket](envoyresponse.md#assignsocket) +- [attachment](envoyresponse.md#attachment) +- [clearCookie](envoyresponse.md#clearcookie) +- [contentType](envoyresponse.md#contenttype) +- [cookie](envoyresponse.md#cookie) +- [cork](envoyresponse.md#cork) +- [destroy](envoyresponse.md#destroy) +- [detachSocket](envoyresponse.md#detachsocket) +- [download](envoyresponse.md#download) +- [emit](envoyresponse.md#emit) +- [end](envoyresponse.md#end) +- [eventNames](envoyresponse.md#eventnames) +- [flushHeaders](envoyresponse.md#flushheaders) +- [format](envoyresponse.md#format) +- [get](envoyresponse.md#get) +- [getHeader](envoyresponse.md#getheader) +- [getHeaderNames](envoyresponse.md#getheadernames) +- [getHeaders](envoyresponse.md#getheaders) +- [getMaxListeners](envoyresponse.md#getmaxlisteners) +- [hasHeader](envoyresponse.md#hasheader) +- [header](envoyresponse.md#header) +- [links](envoyresponse.md#links) +- [listenerCount](envoyresponse.md#listenercount) +- [listeners](envoyresponse.md#listeners) +- [location](envoyresponse.md#location) +- [off](envoyresponse.md#off) +- [on](envoyresponse.md#on) +- [once](envoyresponse.md#once) +- [pipe](envoyresponse.md#pipe) +- [prependListener](envoyresponse.md#prependlistener) +- [prependOnceListener](envoyresponse.md#prependoncelistener) +- [rawListeners](envoyresponse.md#rawlisteners) +- [redirect](envoyresponse.md#redirect) +- [removeAllListeners](envoyresponse.md#removealllisteners) +- [removeHeader](envoyresponse.md#removeheader) +- [removeListener](envoyresponse.md#removelistener) +- [render](envoyresponse.md#render) +- [sendFile](envoyresponse.md#sendfile) +- [sendStatus](envoyresponse.md#sendstatus) +- [sendfile](envoyresponse.md#sendfile) +- [set](envoyresponse.md#set) +- [setDefaultEncoding](envoyresponse.md#setdefaultencoding) +- [setHeader](envoyresponse.md#setheader) +- [setMaxListeners](envoyresponse.md#setmaxlisteners) +- [setTimeout](envoyresponse.md#settimeout) +- [status](envoyresponse.md#status) +- [type](envoyresponse.md#type) +- [uncork](envoyresponse.md#uncork) +- [vary](envoyresponse.md#vary) +- [write](envoyresponse.md#write) +- [writeContinue](envoyresponse.md#writecontinue) +- [writeHead](envoyresponse.md#writehead) +- [writeProcessing](envoyresponse.md#writeprocessing) + +## Properties + +### app + +• **app**: `Application` + +#### Inherited from + +Response.app + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:1005 + +___ + +### charset + +• **charset**: `string` + +#### Inherited from + +Response.charset + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:994 + +___ + +### chunkedEncoding + +• **chunkedEncoding**: `boolean` + +#### Inherited from + +Response.chunkedEncoding + +#### Defined in + +node_modules/@types/node/http.d.ts:161 + +___ + +### connection + +• `Readonly` **connection**: ``null`` \| `Socket` + +**`deprecated`** Use `socket` instead. + +#### Inherited from + +Response.connection + +#### Defined in + +node_modules/@types/node/http.d.ts:173 + +___ + +### destroyed + +• **destroyed**: `boolean` + +#### Inherited from + +Response.destroyed + +#### Defined in + +node_modules/@types/node/stream.d.ts:150 + +___ + +### finished + +• **finished**: `boolean` + +**`deprecated`** Use `writableEnded` instead. + +#### Inherited from + +Response.finished + +#### Defined in + +node_modules/@types/node/http.d.ts:168 + +___ + +### headersSent + +• **headersSent**: `boolean` + +#### Inherited from + +Response.headersSent + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:902 + +___ + +### json + +• **json**: `Send` + +Send JSON response. + +Examples: + + res.json(null); + res.json({ user: 'tj' }); + res.status(500).json('oh noes!'); + res.status(404).json('I dont have that'); + +#### Inherited from + +Response.json + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:705 + +___ + +### jsonp + +• **jsonp**: `Send` + +Send JSON response with JSONP callback support. + +Examples: + + res.jsonp(null); + res.jsonp({ user: 'tj' }); + res.status(500).jsonp('oh noes!'); + res.status(404).jsonp('I dont have that'); + +#### Inherited from + +Response.jsonp + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:717 + +___ + +### locals + +• **locals**: `Record` + +#### Inherited from + +Response.locals + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:992 + +___ + +### req + +• **req**: `Request`\> + +After middleware.init executed, Response will contain req property +See: express/lib/middleware/init.js + +#### Inherited from + +Response.req + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:1022 + +___ + +### send + +• **send**: `Send` + +Send a response. + +Examples: + + res.send(new Buffer('wahoo')); + res.send({ some: 'json' }); + res.send('

some html

'); + res.status(404).send('Sorry, cant find that'); + +#### Inherited from + +Response.send + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:693 + +___ + +### sendDate + +• **sendDate**: `boolean` + +#### Inherited from + +Response.sendDate + +#### Defined in + +node_modules/@types/node/http.d.ts:164 + +___ + +### sendFailed + +• **sendFailed**: (`message`: `string`, `debugInfo?`: `unknown`, ...`attachments`: `EnvoyPluginJobAttachment`[]) => `void` + +#### Type declaration + +▸ (`message`, `debugInfo?`, ...`attachments`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `debugInfo?` | `unknown` | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +##### Returns + +`void` + +#### Defined in + +[src/EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyResponse.ts#L10) + +___ + +### sendIgnored + +• **sendIgnored**: (`message`: `string`, `debugInfo?`: `unknown`, ...`attachments`: `EnvoyPluginJobAttachment`[]) => `void` + +#### Type declaration + +▸ (`message`, `debugInfo?`, ...`attachments`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `debugInfo?` | `unknown` | +| `...attachments` | `EnvoyPluginJobAttachment`[] | + +##### Returns + +`void` + +#### Defined in + +[src/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyResponse.ts#L9) + +___ + +### sendOngoing + +• **sendOngoing**: (`debugInfo?`: `unknown`) => `void` + +#### Type declaration + +▸ (`debugInfo?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `debugInfo?` | `unknown` | + +##### Returns + +`void` + +#### Defined in + +[src/EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyResponse.ts#L8) + +___ + +### shouldKeepAlive + +• **shouldKeepAlive**: `boolean` + +#### Inherited from + +Response.shouldKeepAlive + +#### Defined in + +node_modules/@types/node/http.d.ts:162 + +___ + +### socket + +• `Readonly` **socket**: ``null`` \| `Socket` + +#### Inherited from + +Response.socket + +#### Defined in + +node_modules/@types/node/http.d.ts:174 + +___ + +### statusCode + +• **statusCode**: `number` + +#### Inherited from + +Response.statusCode + +#### Defined in + +node_modules/@types/node/http.d.ts:191 + +___ + +### statusMessage + +• **statusMessage**: `string` + +#### Inherited from + +Response.statusMessage + +#### Defined in + +node_modules/@types/node/http.d.ts:192 + +___ + +### useChunkedEncodingByDefault + +• **useChunkedEncodingByDefault**: `boolean` + +#### Inherited from + +Response.useChunkedEncodingByDefault + +#### Defined in + +node_modules/@types/node/http.d.ts:163 + +___ + +### writable + +• `Readonly` **writable**: `boolean` + +#### Inherited from + +Response.writable + +#### Defined in + +node_modules/@types/node/stream.d.ts:143 + +___ + +### writableCorked + +• `Readonly` **writableCorked**: `number` + +#### Inherited from + +Response.writableCorked + +#### Defined in + +node_modules/@types/node/stream.d.ts:149 + +___ + +### writableEnded + +• `Readonly` **writableEnded**: `boolean` + +#### Inherited from + +Response.writableEnded + +#### Defined in + +node_modules/@types/node/stream.d.ts:144 + +___ + +### writableFinished + +• `Readonly` **writableFinished**: `boolean` + +#### Inherited from + +Response.writableFinished + +#### Defined in + +node_modules/@types/node/stream.d.ts:145 + +___ + +### writableHighWaterMark + +• `Readonly` **writableHighWaterMark**: `number` + +#### Inherited from + +Response.writableHighWaterMark + +#### Defined in + +node_modules/@types/node/stream.d.ts:146 + +___ + +### writableLength + +• `Readonly` **writableLength**: `number` + +#### Inherited from + +Response.writableLength + +#### Defined in + +node_modules/@types/node/stream.d.ts:147 + +___ + +### writableObjectMode + +• `Readonly` **writableObjectMode**: `boolean` + +#### Inherited from + +Response.writableObjectMode + +#### Defined in + +node_modules/@types/node/stream.d.ts:148 + +## Methods + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| `Error`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.\_construct + +#### Defined in + +node_modules/@types/node/stream.d.ts:154 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| `Error` | +| `callback` | (`error?`: ``null`` \| `Error`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.\_destroy + +#### Defined in + +node_modules/@types/node/stream.d.ts:155 + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| `Error`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.\_final + +#### Defined in + +node_modules/@types/node/stream.d.ts:156 + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | `BufferEncoding` | +| `callback` | (`error?`: ``null`` \| `Error`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.\_write + +#### Defined in + +node_modules/@types/node/stream.d.ts:152 + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | { `chunk`: `any` ; `encoding`: `BufferEncoding` }[] | +| `callback` | (`error?`: ``null`` \| `Error`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.\_writev + +#### Defined in + +node_modules/@types/node/stream.d.ts:153 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +Event emitter +The defined events on documents including: +1. close +2. drain +3. error +4. finish +5. pipe +6. unpipe + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:177 + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:178 + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: `Error`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:179 + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:180 + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:181 + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:182 + +▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.addListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:183 + +___ + +### addTrailers + +▸ **addTrailers**(`headers`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `headers` | `OutgoingHttpHeaders` \| readonly [`string`, `string`][] | + +#### Returns + +`void` + +#### Inherited from + +Response.addTrailers + +#### Defined in + +node_modules/@types/node/http.d.ts:185 + +___ + +### append + +▸ **append**(`field`, `value?`): [EnvoyResponse](envoyresponse.md) + +Appends the specified value to the HTTP response header field. +If the header is not already set, it creates the header with the specified value. +The value parameter can be a string or an array. + +Note: calling res.set() after res.append() will reset the previously-set header value. + +**`since`** 4.11.0 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `string` | +| `value?` | `string` \| `string`[] | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.append + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:1016 + +___ + +### assignSocket + +▸ **assignSocket**(`socket`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `socket` | `Socket` | + +#### Returns + +`void` + +#### Inherited from + +Response.assignSocket + +#### Defined in + +node_modules/@types/node/http.d.ts:196 + +___ + +### attachment + +▸ **attachment**(`filename?`): [EnvoyResponse](envoyresponse.md) + +Set _Content-Disposition_ header to _attachment_ with optional `filename`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filename?` | `string` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.attachment + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:881 + +___ + +### clearCookie + +▸ **clearCookie**(`name`, `options?`): [EnvoyResponse](envoyresponse.md) + +Clear cookie `name`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `options?` | `any` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.clearCookie + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:908 + +___ + +### contentType + +▸ **contentType**(`type`): [EnvoyResponse](envoyresponse.md) + +Set _Content-Type_ response header with `type` through `mime.lookup()` +when it does not contain "/", or set the Content-Type to `type` otherwise. + +Examples: + + res.type('.html'); + res.type('html'); + res.type('json'); + res.type('application/json'); + res.type('png'); + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.contentType + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:808 + +___ + +### cookie + +▸ **cookie**(`name`, `val`, `options`): [EnvoyResponse](envoyresponse.md) + +Set cookie `name` to `val`, with the given `options`. + +Options: + + - `maxAge` max-age in milliseconds, converted to `expires` + - `signed` sign the cookie + - `path` defaults to "/" + +Examples: + + // "Remember Me" for 15 minutes + res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true }); + + // save as above + res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true }) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `val` | `string` | +| `options` | `CookieOptions` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.cookie + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:927 + +▸ **cookie**(`name`, `val`, `options`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `val` | `any` | +| `options` | `CookieOptions` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.cookie + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:928 + +▸ **cookie**(`name`, `val`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `val` | `any` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.cookie + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:929 + +___ + +### cork + +▸ **cork**(): `void` + +#### Returns + +`void` + +#### Inherited from + +Response.cork + +#### Defined in + +node_modules/@types/node/stream.d.ts:163 + +___ + +### destroy + +▸ **destroy**(`error?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error?` | `Error` | + +#### Returns + +`void` + +#### Inherited from + +Response.destroy + +#### Defined in + +node_modules/@types/node/stream.d.ts:165 + +___ + +### detachSocket + +▸ **detachSocket**(`socket`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `socket` | `Socket` | + +#### Returns + +`void` + +#### Inherited from + +Response.detachSocket + +#### Defined in + +node_modules/@types/node/http.d.ts:197 + +___ + +### download + +▸ **download**(`path`, `fn?`): `void` + +Transfer the file at the given `path` as an attachment. + +Optionally providing an alternate attachment `filename`, +and optional callback `fn(err)`. The callback is invoked +when the data transfer is complete, or when an error has +ocurred. Be sure to check `res.headersSent` if you plan to respond. + +The optional options argument passes through to the underlying +res.sendFile() call, and takes the exact same parameters. + +This method uses `res.sendfile()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `fn?` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.download + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:792 + +▸ **download**(`path`, `filename`, `fn?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `filename` | `string` | +| `fn?` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.download + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:793 + +▸ **download**(`path`, `filename`, `options`, `fn?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `filename` | `string` | +| `options` | `any` | +| `fn?` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.download + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:794 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:185 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:186 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | `Error` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:187 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:188 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `src` | `Readable` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:189 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `src` | `Readable` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:190 + +▸ **emit**(`event`, ...`args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +Response.emit + +#### Defined in + +node_modules/@types/node/stream.d.ts:191 + +___ + +### end + +▸ **end**(`cb?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.end + +#### Defined in + +node_modules/@types/node/stream.d.ts:160 + +▸ **end**(`chunk`, `cb?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.end + +#### Defined in + +node_modules/@types/node/stream.d.ts:161 + +▸ **end**(`chunk`, `encoding`, `cb?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | `BufferEncoding` | +| `cb?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.end + +#### Defined in + +node_modules/@types/node/stream.d.ts:162 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +#### Returns + +(`string` \| `symbol`)[] + +#### Inherited from + +Response.eventNames + +#### Defined in + +node_modules/@types/node/events.d.ts:87 + +___ + +### flushHeaders + +▸ **flushHeaders**(): `void` + +#### Returns + +`void` + +#### Inherited from + +Response.flushHeaders + +#### Defined in + +node_modules/@types/node/http.d.ts:186 + +___ + +### format + +▸ **format**(`obj`): [EnvoyResponse](envoyresponse.md) + +Respond to the Acceptable formats using an `obj` +of mime-type callbacks. + +This method uses `req.accepted`, an array of +acceptable types ordered by their quality values. +When "Accept" is not present the _first_ callback +is invoked, otherwise the first match is used. When +no match is performed the server responds with +406 "Not Acceptable". + +Content-Type is set for you, however if you choose +you may alter this within the callback using `res.type()` +or `res.set('Content-Type', ...)`. + + res.format({ + 'text/plain': function(){ + res.send('hey'); + }, + + 'text/html': function(){ + res.send('

hey

'); + }, + + 'appliation/json': function(){ + res.send({ message: 'hey' }); + } + }); + +In addition to canonicalized MIME types you may +also use extnames mapped to these types: + + res.format({ + text: function(){ + res.send('hey'); + }, + + html: function(){ + res.send('

hey

'); + }, + + json: function(){ + res.send({ message: 'hey' }); + } + }); + +By default Express passes an `Error` +with a `.status` of 406 to `next(err)` +if a match is not made. If you provide +a `.default` callback it will be invoked +instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `any` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.format + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:876 + +___ + +### get + +▸ **get**(`field`): `string` + +Get value for header `field`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `string` | + +#### Returns + +`string` + +#### Inherited from + +Response.get + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:905 + +___ + +### getHeader + +▸ **getHeader**(`name`): `undefined` \| `string` \| `number` \| `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`undefined` \| `string` \| `number` \| `string`[] + +#### Inherited from + +Response.getHeader + +#### Defined in + +node_modules/@types/node/http.d.ts:180 + +___ + +### getHeaderNames + +▸ **getHeaderNames**(): `string`[] + +#### Returns + +`string`[] + +#### Inherited from + +Response.getHeaderNames + +#### Defined in + +node_modules/@types/node/http.d.ts:182 + +___ + +### getHeaders + +▸ **getHeaders**(): `OutgoingHttpHeaders` + +#### Returns + +`OutgoingHttpHeaders` + +#### Inherited from + +Response.getHeaders + +#### Defined in + +node_modules/@types/node/http.d.ts:181 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +#### Returns + +`number` + +#### Inherited from + +Response.getMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:79 + +___ + +### hasHeader + +▸ **hasHeader**(`name`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.hasHeader + +#### Defined in + +node_modules/@types/node/http.d.ts:183 + +___ + +### header + +▸ **header**(`field`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `any` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.header + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:898 + +▸ **header**(`field`, `value?`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `string` | +| `value?` | `string` \| `string`[] | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.header + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:899 + +___ + +### links + +▸ **links**(`links`): [EnvoyResponse](envoyresponse.md) + +Set Link header field with the given `links`. + +Examples: + + res.links({ + next: 'http://api.example.com/users?page=2', + last: 'http://api.example.com/users?page=5' + }); + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `links` | `any` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.links + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:681 + +___ + +### listenerCount + +▸ **listenerCount**(`event`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | + +#### Returns + +`number` + +#### Inherited from + +Response.listenerCount + +#### Defined in + +node_modules/@types/node/events.d.ts:83 + +___ + +### listeners + +▸ **listeners**(`event`): `Function`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +Response.listeners + +#### Defined in + +node_modules/@types/node/events.d.ts:80 + +___ + +### location + +▸ **location**(`url`): [EnvoyResponse](envoyresponse.md) + +Set the location header to `url`. + +The given `url` can also be the name of a mapped url, for +example by default express supports "back" which redirects +to the _Referrer_ or _Referer_ headers or "/". + +Examples: + + res.location('/foo/bar').; + res.location('http://example.com'); + res.location('../login'); // /blog/post/1 -> /blog/login + +Mounting: + + When an application is mounted and `res.location()` + is given a path that does _not_ lead with "/" it becomes + relative to the mount-point. For example if the application + is mounted at "/blog", the following would become "/blog/login". + + res.location('login'); + + While the leading slash would result in a location of "/login": + + res.location('/login'); + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.location + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:957 + +___ + +### off + +▸ **off**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.off + +#### Defined in + +node_modules/@types/node/events.d.ts:76 + +___ + +### on + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:193 + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:194 + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: `Error`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:195 + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:196 + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:197 + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:198 + +▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.on + +#### Defined in + +node_modules/@types/node/stream.d.ts:199 + +___ + +### once + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:201 + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:202 + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: `Error`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:203 + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:204 + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:205 + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:206 + +▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.once + +#### Defined in + +node_modules/@types/node/stream.d.ts:207 + +___ + +### pipe + +▸ **pipe**(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T`: `WritableStream` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +Response.pipe + +#### Defined in + +node_modules/@types/node/stream.d.ts:6 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:209 + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:210 + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: `Error`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:211 + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:212 + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:213 + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:214 + +▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:215 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:217 + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:218 + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: `Error`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:219 + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:220 + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:221 + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:222 + +▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.prependOnceListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:223 + +___ + +### rawListeners + +▸ **rawListeners**(`event`): `Function`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +Response.rawListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:81 + +___ + +### redirect + +▸ **redirect**(`url`): `void` + +Redirect to the given `url` with optional response `status` +defaulting to 302. + +The resulting `url` is determined by `res.location()`, so +it will play nicely with mounted apps, relative paths, +`"back"` etc. + +Examples: + + res.redirect('/foo/bar'); + res.redirect('http://example.com'); + res.redirect(301, 'http://example.com'); + res.redirect('http://example.com', 301); + res.redirect('../login'); // /blog/post/1 -> /blog/login + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | + +#### Returns + +`void` + +#### Inherited from + +Response.redirect + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:975 + +▸ **redirect**(`status`, `url`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `status` | `number` | +| `url` | `string` | + +#### Returns + +`void` + +#### Inherited from + +Response.redirect + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:976 + +▸ **redirect**(`url`, `status`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `status` | `number` | + +#### Returns + +`void` + +#### Inherited from + +Response.redirect + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:977 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeAllListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:77 + +___ + +### removeHeader + +▸ **removeHeader**(`name`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`void` + +#### Inherited from + +Response.removeHeader + +#### Defined in + +node_modules/@types/node/http.d.ts:184 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:225 + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:226 + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: `Error`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:227 + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:228 + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:229 + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: `Readable`) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:230 + +▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.removeListener + +#### Defined in + +node_modules/@types/node/stream.d.ts:231 + +___ + +### render + +▸ **render**(`view`, `options?`, `callback?`): `void` + +Render `view` with the given `options` and optional callback `fn`. +When a callback function is given a response will _not_ be made +automatically, otherwise a response of _200_ and _text/html_ is given. + +Options: + + - `cache` boolean hinting to the engine it should cache + - `filename` filename of the view being rendered + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `view` | `string` | +| `options?` | `object` | +| `callback?` | (`err`: `Error`, `html`: `string`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.render + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:989 + +▸ **render**(`view`, `callback?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `view` | `string` | +| `callback?` | (`err`: `Error`, `html`: `string`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.render + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:990 + +___ + +### sendFile + +▸ **sendFile**(`path`, `fn?`): `void` + +Transfer the file at the given `path`. + +Automatically sets the _Content-Type_ response header field. +The callback `fn(err)` is invoked when the transfer is complete +or when an error occurs. Be sure to check `res.headersSent` +if you wish to attempt responding, as the header and some data +may have already been transferred. + +Options: + + - `maxAge` defaulting to 0 (can be string converted by `ms`) + - `root` root directory for relative filenames + - `headers` object of headers to serve with file + - `dotfiles` serve dotfiles, defaulting to false; can be `"allow"` to send them + +Other options are passed along to `send`. + +Examples: + + The following example illustrates how `res.sendFile()` may + be used as an alternative for the `static()` middleware for + dynamic situations. The code backing `res.sendFile()` is actually + the same code, so HTTP cache support etc is identical. + + app.get('/user/:uid/photos/:file', function(req, res){ + var uid = req.params.uid + , file = req.params.file; + + req.user.mayViewFilesFrom(uid, function(yes){ + if (yes) { + res.sendFile('/uploads/' + uid + '/' + file); + } else { + res.send(403, 'Sorry! you cant see that.'); + } + }); + }); + +**`api`** public + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `fn?` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.sendFile + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:759 + +▸ **sendFile**(`path`, `options`, `fn?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `options` | `any` | +| `fn?` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.sendFile + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:760 + +___ + +### sendStatus + +▸ **sendStatus**(`code`): [EnvoyResponse](envoyresponse.md) + +Set the response HTTP status code to `statusCode` and send its string representation as the response body. + +**`link`** http://expressjs.com/4x/api.html#res.sendStatus + +Examples: + + res.sendStatus(200); // equivalent to res.status(200).send('OK') + res.sendStatus(403); // equivalent to res.status(403).send('Forbidden') + res.sendStatus(404); // equivalent to res.status(404).send('Not Found') + res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error') + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `number` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.sendStatus + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:669 + +___ + +### sendfile + +▸ **sendfile**(`path`): `void` + +**`deprecated`** Use sendFile instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`void` + +#### Inherited from + +Response.sendfile + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:765 + +▸ **sendfile**(`path`, `options`): `void` + +**`deprecated`** Use sendFile instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `options` | `any` | + +#### Returns + +`void` + +#### Inherited from + +Response.sendfile + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:769 + +▸ **sendfile**(`path`, `fn`): `void` + +**`deprecated`** Use sendFile instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `fn` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.sendfile + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:773 + +▸ **sendfile**(`path`, `options`, `fn`): `void` + +**`deprecated`** Use sendFile instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `options` | `any` | +| `fn` | `Errback` | + +#### Returns + +`void` + +#### Inherited from + +Response.sendfile + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:777 + +___ + +### set + +▸ **set**(`field`): [EnvoyResponse](envoyresponse.md) + +Set header `field` to `val`, or pass +an object of header fields. + +Examples: + + res.set('Foo', ['bar', 'baz']); + res.set('Accept', 'application/json'); + res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' }); + +Aliased as `res.header()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `any` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.set + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:895 + +▸ **set**(`field`, `value?`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `string` | +| `value?` | `string` \| `string`[] | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.set + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:896 + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encoding` | `BufferEncoding` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.setDefaultEncoding + +#### Defined in + +node_modules/@types/node/stream.d.ts:159 + +___ + +### setHeader + +▸ **setHeader**(`name`, `value`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `value` | `string` \| `number` \| readonly `string`[] | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.setHeader + +#### Defined in + +node_modules/@types/node/http.d.ts:179 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.setMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:78 + +___ + +### setTimeout + +▸ **setTimeout**(`msecs`, `callback?`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msecs` | `number` | +| `callback?` | () => `void` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.setTimeout + +#### Defined in + +node_modules/@types/node/http.d.ts:178 + +___ + +### status + +▸ **status**(`code`): [EnvoyResponse](envoyresponse.md) + +Set status `code`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `number` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.status + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:656 + +___ + +### type + +▸ **type**(`type`): [EnvoyResponse](envoyresponse.md) + +Set _Content-Type_ response header with `type` through `mime.lookup()` +when it does not contain "/", or set the Content-Type to `type` otherwise. + +Examples: + + res.type('.html'); + res.type('html'); + res.type('json'); + res.type('application/json'); + res.type('png'); + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.type + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:822 + +___ + +### uncork + +▸ **uncork**(): `void` + +#### Returns + +`void` + +#### Inherited from + +Response.uncork + +#### Defined in + +node_modules/@types/node/stream.d.ts:164 + +___ + +### vary + +▸ **vary**(`field`): [EnvoyResponse](envoyresponse.md) + +Adds the field to the Vary response header, if it is not there already. +Examples: + + res.vary('User-Agent').render('docs'); + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `string` | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.vary + +#### Defined in + +node_modules/@types/express-serve-static-core/index.d.ts:1003 + +___ + +### write + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | (`error`: `undefined` \| ``null`` \| `Error`) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.write + +#### Defined in + +node_modules/@types/node/stream.d.ts:157 + +▸ **write**(`chunk`, `encoding`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | `BufferEncoding` | +| `cb?` | (`error`: `undefined` \| ``null`` \| `Error`) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +Response.write + +#### Defined in + +node_modules/@types/node/stream.d.ts:158 + +___ + +### writeContinue + +▸ **writeContinue**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +Response.writeContinue + +#### Defined in + +node_modules/@types/node/http.d.ts:200 + +___ + +### writeHead + +▸ **writeHead**(`statusCode`, `reasonPhrase?`, `headers?`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `statusCode` | `number` | +| `reasonPhrase?` | `string` | +| `headers?` | `OutgoingHttpHeaders` \| `OutgoingHttpHeader`[] | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.writeHead + +#### Defined in + +node_modules/@types/node/http.d.ts:201 + +▸ **writeHead**(`statusCode`, `headers?`): [EnvoyResponse](envoyresponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `statusCode` | `number` | +| `headers?` | `OutgoingHttpHeaders` \| `OutgoingHttpHeader`[] | + +#### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Inherited from + +Response.writeHead + +#### Defined in + +node_modules/@types/node/http.d.ts:202 + +___ + +### writeProcessing + +▸ **writeProcessing**(): `void` + +#### Returns + +`void` + +#### Inherited from + +Response.writeProcessing + +#### Defined in + +node_modules/@types/node/http.d.ts:203 From 7d4de59fe8cdf65dfe149c50ee8910e10d9dd977 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:23:59 -0400 Subject: [PATCH 09/91] fixing docs --- docs/README.md | 10 +- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 18 +- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 18 +- docs/classes/envoypluginstoragepipeline.md | 22 +- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 46 +- docs/enums/httpstatus.md | 8 +- docs/interfaces/envoyresponse.md | 3430 +------------------- typedoc.json | 1 + 12 files changed, 89 insertions(+), 3512 deletions(-) diff --git a/docs/README.md b/docs/README.md index f79376b..01ae7f4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -48,7 +48,7 @@ #### Defined in -[src/EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyRequest.ts#L41) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyStorageItem.ts#L1) ## Functions @@ -101,7 +101,7 @@ Catches Promise-based errors. #### Defined in -[src/asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/asyncHandler.ts#L10) ___ @@ -138,7 +138,7 @@ Catches errors and sets the proper status code. #### Defined in -[src/errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/errorMiddleware.ts#L9) ___ @@ -164,4 +164,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[src/middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 67d2ff2..4e3a3b2 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[src/EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[src/EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[src/EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index f4a3844..4f284ba 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[src/EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[src/EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[src/EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[src/EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[src/EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[src/EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[src/EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[src/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 3b26b37..e9b2f11 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[src/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[src/EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[src/EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 2ad6f91..6c07830 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[src/EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[src/EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[src/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[src/EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[src/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[src/EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[src/EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[src/EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[src/EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[src/EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[src/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index 87d7caa..d2722b1 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[src/EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[src/EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[src/EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[src/EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[src/EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[src/EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[src/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[src/EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[src/EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index b2d3869..4834647 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[src/EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[src/EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index edc7028..58d8410 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[src/EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[src/EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 7d1a314..048855b 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[src/EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[src/EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[src/EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[src/EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[src/EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[src/EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 1c5ea9b..2ca336a 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[src/HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[src/HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 1480f41..28f7b29 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -14,317 +14,12 @@ Use to type your `res` object in Envoy request handlers. ### Properties -- [app](envoyresponse.md#app) -- [charset](envoyresponse.md#charset) -- [chunkedEncoding](envoyresponse.md#chunkedencoding) -- [connection](envoyresponse.md#connection) -- [destroyed](envoyresponse.md#destroyed) -- [finished](envoyresponse.md#finished) -- [headersSent](envoyresponse.md#headerssent) -- [json](envoyresponse.md#json) -- [jsonp](envoyresponse.md#jsonp) -- [locals](envoyresponse.md#locals) -- [req](envoyresponse.md#req) -- [send](envoyresponse.md#send) -- [sendDate](envoyresponse.md#senddate) - [sendFailed](envoyresponse.md#sendfailed) - [sendIgnored](envoyresponse.md#sendignored) - [sendOngoing](envoyresponse.md#sendongoing) -- [shouldKeepAlive](envoyresponse.md#shouldkeepalive) -- [socket](envoyresponse.md#socket) -- [statusCode](envoyresponse.md#statuscode) -- [statusMessage](envoyresponse.md#statusmessage) -- [useChunkedEncodingByDefault](envoyresponse.md#usechunkedencodingbydefault) -- [writable](envoyresponse.md#writable) -- [writableCorked](envoyresponse.md#writablecorked) -- [writableEnded](envoyresponse.md#writableended) -- [writableFinished](envoyresponse.md#writablefinished) -- [writableHighWaterMark](envoyresponse.md#writablehighwatermark) -- [writableLength](envoyresponse.md#writablelength) -- [writableObjectMode](envoyresponse.md#writableobjectmode) - -### Methods - -- [\_construct](envoyresponse.md#_construct) -- [\_destroy](envoyresponse.md#_destroy) -- [\_final](envoyresponse.md#_final) -- [\_write](envoyresponse.md#_write) -- [\_writev](envoyresponse.md#_writev) -- [addListener](envoyresponse.md#addlistener) -- [addTrailers](envoyresponse.md#addtrailers) -- [append](envoyresponse.md#append) -- [assignSocket](envoyresponse.md#assignsocket) -- [attachment](envoyresponse.md#attachment) -- [clearCookie](envoyresponse.md#clearcookie) -- [contentType](envoyresponse.md#contenttype) -- [cookie](envoyresponse.md#cookie) -- [cork](envoyresponse.md#cork) -- [destroy](envoyresponse.md#destroy) -- [detachSocket](envoyresponse.md#detachsocket) -- [download](envoyresponse.md#download) -- [emit](envoyresponse.md#emit) -- [end](envoyresponse.md#end) -- [eventNames](envoyresponse.md#eventnames) -- [flushHeaders](envoyresponse.md#flushheaders) -- [format](envoyresponse.md#format) -- [get](envoyresponse.md#get) -- [getHeader](envoyresponse.md#getheader) -- [getHeaderNames](envoyresponse.md#getheadernames) -- [getHeaders](envoyresponse.md#getheaders) -- [getMaxListeners](envoyresponse.md#getmaxlisteners) -- [hasHeader](envoyresponse.md#hasheader) -- [header](envoyresponse.md#header) -- [links](envoyresponse.md#links) -- [listenerCount](envoyresponse.md#listenercount) -- [listeners](envoyresponse.md#listeners) -- [location](envoyresponse.md#location) -- [off](envoyresponse.md#off) -- [on](envoyresponse.md#on) -- [once](envoyresponse.md#once) -- [pipe](envoyresponse.md#pipe) -- [prependListener](envoyresponse.md#prependlistener) -- [prependOnceListener](envoyresponse.md#prependoncelistener) -- [rawListeners](envoyresponse.md#rawlisteners) -- [redirect](envoyresponse.md#redirect) -- [removeAllListeners](envoyresponse.md#removealllisteners) -- [removeHeader](envoyresponse.md#removeheader) -- [removeListener](envoyresponse.md#removelistener) -- [render](envoyresponse.md#render) -- [sendFile](envoyresponse.md#sendfile) -- [sendStatus](envoyresponse.md#sendstatus) -- [sendfile](envoyresponse.md#sendfile) -- [set](envoyresponse.md#set) -- [setDefaultEncoding](envoyresponse.md#setdefaultencoding) -- [setHeader](envoyresponse.md#setheader) -- [setMaxListeners](envoyresponse.md#setmaxlisteners) -- [setTimeout](envoyresponse.md#settimeout) -- [status](envoyresponse.md#status) -- [type](envoyresponse.md#type) -- [uncork](envoyresponse.md#uncork) -- [vary](envoyresponse.md#vary) -- [write](envoyresponse.md#write) -- [writeContinue](envoyresponse.md#writecontinue) -- [writeHead](envoyresponse.md#writehead) -- [writeProcessing](envoyresponse.md#writeprocessing) ## Properties -### app - -• **app**: `Application` - -#### Inherited from - -Response.app - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:1005 - -___ - -### charset - -• **charset**: `string` - -#### Inherited from - -Response.charset - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:994 - -___ - -### chunkedEncoding - -• **chunkedEncoding**: `boolean` - -#### Inherited from - -Response.chunkedEncoding - -#### Defined in - -node_modules/@types/node/http.d.ts:161 - -___ - -### connection - -• `Readonly` **connection**: ``null`` \| `Socket` - -**`deprecated`** Use `socket` instead. - -#### Inherited from - -Response.connection - -#### Defined in - -node_modules/@types/node/http.d.ts:173 - -___ - -### destroyed - -• **destroyed**: `boolean` - -#### Inherited from - -Response.destroyed - -#### Defined in - -node_modules/@types/node/stream.d.ts:150 - -___ - -### finished - -• **finished**: `boolean` - -**`deprecated`** Use `writableEnded` instead. - -#### Inherited from - -Response.finished - -#### Defined in - -node_modules/@types/node/http.d.ts:168 - -___ - -### headersSent - -• **headersSent**: `boolean` - -#### Inherited from - -Response.headersSent - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:902 - -___ - -### json - -• **json**: `Send` - -Send JSON response. - -Examples: - - res.json(null); - res.json({ user: 'tj' }); - res.status(500).json('oh noes!'); - res.status(404).json('I dont have that'); - -#### Inherited from - -Response.json - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:705 - -___ - -### jsonp - -• **jsonp**: `Send` - -Send JSON response with JSONP callback support. - -Examples: - - res.jsonp(null); - res.jsonp({ user: 'tj' }); - res.status(500).jsonp('oh noes!'); - res.status(404).jsonp('I dont have that'); - -#### Inherited from - -Response.jsonp - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:717 - -___ - -### locals - -• **locals**: `Record` - -#### Inherited from - -Response.locals - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:992 - -___ - -### req - -• **req**: `Request`\> - -After middleware.init executed, Response will contain req property -See: express/lib/middleware/init.js - -#### Inherited from - -Response.req - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:1022 - -___ - -### send - -• **send**: `Send` - -Send a response. - -Examples: - - res.send(new Buffer('wahoo')); - res.send({ some: 'json' }); - res.send('

some html

'); - res.status(404).send('Sorry, cant find that'); - -#### Inherited from - -Response.send - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:693 - -___ - -### sendDate - -• **sendDate**: `boolean` - -#### Inherited from - -Response.sendDate - -#### Defined in - -node_modules/@types/node/http.d.ts:164 - -___ - ### sendFailed • **sendFailed**: (`message`: `string`, `debugInfo?`: `unknown`, ...`attachments`: `EnvoyPluginJobAttachment`[]) => `void` @@ -347,7 +42,7 @@ ___ #### Defined in -[src/EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyResponse.ts#L10) ___ @@ -373,7 +68,7 @@ ___ #### Defined in -[src/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyResponse.ts#L9) ___ @@ -397,3123 +92,4 @@ ___ #### Defined in -[src/EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/2bdd026/src/EnvoyResponse.ts#L8) - -___ - -### shouldKeepAlive - -• **shouldKeepAlive**: `boolean` - -#### Inherited from - -Response.shouldKeepAlive - -#### Defined in - -node_modules/@types/node/http.d.ts:162 - -___ - -### socket - -• `Readonly` **socket**: ``null`` \| `Socket` - -#### Inherited from - -Response.socket - -#### Defined in - -node_modules/@types/node/http.d.ts:174 - -___ - -### statusCode - -• **statusCode**: `number` - -#### Inherited from - -Response.statusCode - -#### Defined in - -node_modules/@types/node/http.d.ts:191 - -___ - -### statusMessage - -• **statusMessage**: `string` - -#### Inherited from - -Response.statusMessage - -#### Defined in - -node_modules/@types/node/http.d.ts:192 - -___ - -### useChunkedEncodingByDefault - -• **useChunkedEncodingByDefault**: `boolean` - -#### Inherited from - -Response.useChunkedEncodingByDefault - -#### Defined in - -node_modules/@types/node/http.d.ts:163 - -___ - -### writable - -• `Readonly` **writable**: `boolean` - -#### Inherited from - -Response.writable - -#### Defined in - -node_modules/@types/node/stream.d.ts:143 - -___ - -### writableCorked - -• `Readonly` **writableCorked**: `number` - -#### Inherited from - -Response.writableCorked - -#### Defined in - -node_modules/@types/node/stream.d.ts:149 - -___ - -### writableEnded - -• `Readonly` **writableEnded**: `boolean` - -#### Inherited from - -Response.writableEnded - -#### Defined in - -node_modules/@types/node/stream.d.ts:144 - -___ - -### writableFinished - -• `Readonly` **writableFinished**: `boolean` - -#### Inherited from - -Response.writableFinished - -#### Defined in - -node_modules/@types/node/stream.d.ts:145 - -___ - -### writableHighWaterMark - -• `Readonly` **writableHighWaterMark**: `number` - -#### Inherited from - -Response.writableHighWaterMark - -#### Defined in - -node_modules/@types/node/stream.d.ts:146 - -___ - -### writableLength - -• `Readonly` **writableLength**: `number` - -#### Inherited from - -Response.writableLength - -#### Defined in - -node_modules/@types/node/stream.d.ts:147 - -___ - -### writableObjectMode - -• `Readonly` **writableObjectMode**: `boolean` - -#### Inherited from - -Response.writableObjectMode - -#### Defined in - -node_modules/@types/node/stream.d.ts:148 - -## Methods - -### \_construct - -▸ `Optional` **_construct**(`callback`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`error?`: ``null`` \| `Error`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.\_construct - -#### Defined in - -node_modules/@types/node/stream.d.ts:154 - -___ - -### \_destroy - -▸ **_destroy**(`error`, `callback`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | ``null`` \| `Error` | -| `callback` | (`error?`: ``null`` \| `Error`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.\_destroy - -#### Defined in - -node_modules/@types/node/stream.d.ts:155 - -___ - -### \_final - -▸ **_final**(`callback`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`error?`: ``null`` \| `Error`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.\_final - -#### Defined in - -node_modules/@types/node/stream.d.ts:156 - -___ - -### \_write - -▸ **_write**(`chunk`, `encoding`, `callback`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chunk` | `any` | -| `encoding` | `BufferEncoding` | -| `callback` | (`error?`: ``null`` \| `Error`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.\_write - -#### Defined in - -node_modules/@types/node/stream.d.ts:152 - -___ - -### \_writev - -▸ `Optional` **_writev**(`chunks`, `callback`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chunks` | { `chunk`: `any` ; `encoding`: `BufferEncoding` }[] | -| `callback` | (`error?`: ``null`` \| `Error`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.\_writev - -#### Defined in - -node_modules/@types/node/stream.d.ts:153 - -___ - -### addListener - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -Event emitter -The defined events on documents including: -1. close -2. drain -3. error -4. finish -5. pipe -6. unpipe - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:177 - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:178 - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `listener` | (`err`: `Error`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:179 - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:180 - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:181 - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:182 - -▸ **addListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.addListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:183 - -___ - -### addTrailers - -▸ **addTrailers**(`headers`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `headers` | `OutgoingHttpHeaders` \| readonly [`string`, `string`][] | - -#### Returns - -`void` - -#### Inherited from - -Response.addTrailers - -#### Defined in - -node_modules/@types/node/http.d.ts:185 - -___ - -### append - -▸ **append**(`field`, `value?`): [EnvoyResponse](envoyresponse.md) - -Appends the specified value to the HTTP response header field. -If the header is not already set, it creates the header with the specified value. -The value parameter can be a string or an array. - -Note: calling res.set() after res.append() will reset the previously-set header value. - -**`since`** 4.11.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `string` | -| `value?` | `string` \| `string`[] | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.append - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:1016 - -___ - -### assignSocket - -▸ **assignSocket**(`socket`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `socket` | `Socket` | - -#### Returns - -`void` - -#### Inherited from - -Response.assignSocket - -#### Defined in - -node_modules/@types/node/http.d.ts:196 - -___ - -### attachment - -▸ **attachment**(`filename?`): [EnvoyResponse](envoyresponse.md) - -Set _Content-Disposition_ header to _attachment_ with optional `filename`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filename?` | `string` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.attachment - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:881 - -___ - -### clearCookie - -▸ **clearCookie**(`name`, `options?`): [EnvoyResponse](envoyresponse.md) - -Clear cookie `name`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `options?` | `any` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.clearCookie - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:908 - -___ - -### contentType - -▸ **contentType**(`type`): [EnvoyResponse](envoyresponse.md) - -Set _Content-Type_ response header with `type` through `mime.lookup()` -when it does not contain "/", or set the Content-Type to `type` otherwise. - -Examples: - - res.type('.html'); - res.type('html'); - res.type('json'); - res.type('application/json'); - res.type('png'); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.contentType - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:808 - -___ - -### cookie - -▸ **cookie**(`name`, `val`, `options`): [EnvoyResponse](envoyresponse.md) - -Set cookie `name` to `val`, with the given `options`. - -Options: - - - `maxAge` max-age in milliseconds, converted to `expires` - - `signed` sign the cookie - - `path` defaults to "/" - -Examples: - - // "Remember Me" for 15 minutes - res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true }); - - // save as above - res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true }) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `val` | `string` | -| `options` | `CookieOptions` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.cookie - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:927 - -▸ **cookie**(`name`, `val`, `options`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `val` | `any` | -| `options` | `CookieOptions` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.cookie - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:928 - -▸ **cookie**(`name`, `val`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `val` | `any` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.cookie - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:929 - -___ - -### cork - -▸ **cork**(): `void` - -#### Returns - -`void` - -#### Inherited from - -Response.cork - -#### Defined in - -node_modules/@types/node/stream.d.ts:163 - -___ - -### destroy - -▸ **destroy**(`error?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error?` | `Error` | - -#### Returns - -`void` - -#### Inherited from - -Response.destroy - -#### Defined in - -node_modules/@types/node/stream.d.ts:165 - -___ - -### detachSocket - -▸ **detachSocket**(`socket`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `socket` | `Socket` | - -#### Returns - -`void` - -#### Inherited from - -Response.detachSocket - -#### Defined in - -node_modules/@types/node/http.d.ts:197 - -___ - -### download - -▸ **download**(`path`, `fn?`): `void` - -Transfer the file at the given `path` as an attachment. - -Optionally providing an alternate attachment `filename`, -and optional callback `fn(err)`. The callback is invoked -when the data transfer is complete, or when an error has -ocurred. Be sure to check `res.headersSent` if you plan to respond. - -The optional options argument passes through to the underlying -res.sendFile() call, and takes the exact same parameters. - -This method uses `res.sendfile()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `fn?` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.download - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:792 - -▸ **download**(`path`, `filename`, `fn?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `filename` | `string` | -| `fn?` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.download - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:793 - -▸ **download**(`path`, `filename`, `options`, `fn?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `filename` | `string` | -| `options` | `any` | -| `fn?` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.download - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:794 - -___ - -### emit - -▸ **emit**(`event`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:185 - -▸ **emit**(`event`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:186 - -▸ **emit**(`event`, `err`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `err` | `Error` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:187 - -▸ **emit**(`event`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:188 - -▸ **emit**(`event`, `src`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `src` | `Readable` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:189 - -▸ **emit**(`event`, `src`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `src` | `Readable` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:190 - -▸ **emit**(`event`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -Response.emit - -#### Defined in - -node_modules/@types/node/stream.d.ts:191 - -___ - -### end - -▸ **end**(`cb?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb?` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.end - -#### Defined in - -node_modules/@types/node/stream.d.ts:160 - -▸ **end**(`chunk`, `cb?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chunk` | `any` | -| `cb?` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.end - -#### Defined in - -node_modules/@types/node/stream.d.ts:161 - -▸ **end**(`chunk`, `encoding`, `cb?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chunk` | `any` | -| `encoding` | `BufferEncoding` | -| `cb?` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.end - -#### Defined in - -node_modules/@types/node/stream.d.ts:162 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -Response.eventNames - -#### Defined in - -node_modules/@types/node/events.d.ts:87 - -___ - -### flushHeaders - -▸ **flushHeaders**(): `void` - -#### Returns - -`void` - -#### Inherited from - -Response.flushHeaders - -#### Defined in - -node_modules/@types/node/http.d.ts:186 - -___ - -### format - -▸ **format**(`obj`): [EnvoyResponse](envoyresponse.md) - -Respond to the Acceptable formats using an `obj` -of mime-type callbacks. - -This method uses `req.accepted`, an array of -acceptable types ordered by their quality values. -When "Accept" is not present the _first_ callback -is invoked, otherwise the first match is used. When -no match is performed the server responds with -406 "Not Acceptable". - -Content-Type is set for you, however if you choose -you may alter this within the callback using `res.type()` -or `res.set('Content-Type', ...)`. - - res.format({ - 'text/plain': function(){ - res.send('hey'); - }, - - 'text/html': function(){ - res.send('

hey

'); - }, - - 'appliation/json': function(){ - res.send({ message: 'hey' }); - } - }); - -In addition to canonicalized MIME types you may -also use extnames mapped to these types: - - res.format({ - text: function(){ - res.send('hey'); - }, - - html: function(){ - res.send('

hey

'); - }, - - json: function(){ - res.send({ message: 'hey' }); - } - }); - -By default Express passes an `Error` -with a `.status` of 406 to `next(err)` -if a match is not made. If you provide -a `.default` callback it will be invoked -instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | `any` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.format - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:876 - -___ - -### get - -▸ **get**(`field`): `string` - -Get value for header `field`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `string` | - -#### Returns - -`string` - -#### Inherited from - -Response.get - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:905 - -___ - -### getHeader - -▸ **getHeader**(`name`): `undefined` \| `string` \| `number` \| `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`undefined` \| `string` \| `number` \| `string`[] - -#### Inherited from - -Response.getHeader - -#### Defined in - -node_modules/@types/node/http.d.ts:180 - -___ - -### getHeaderNames - -▸ **getHeaderNames**(): `string`[] - -#### Returns - -`string`[] - -#### Inherited from - -Response.getHeaderNames - -#### Defined in - -node_modules/@types/node/http.d.ts:182 - -___ - -### getHeaders - -▸ **getHeaders**(): `OutgoingHttpHeaders` - -#### Returns - -`OutgoingHttpHeaders` - -#### Inherited from - -Response.getHeaders - -#### Defined in - -node_modules/@types/node/http.d.ts:181 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -#### Returns - -`number` - -#### Inherited from - -Response.getMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:79 - -___ - -### hasHeader - -▸ **hasHeader**(`name`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.hasHeader - -#### Defined in - -node_modules/@types/node/http.d.ts:183 - -___ - -### header - -▸ **header**(`field`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `any` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.header - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:898 - -▸ **header**(`field`, `value?`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `string` | -| `value?` | `string` \| `string`[] | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.header - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:899 - -___ - -### links - -▸ **links**(`links`): [EnvoyResponse](envoyresponse.md) - -Set Link header field with the given `links`. - -Examples: - - res.links({ - next: 'http://api.example.com/users?page=2', - last: 'http://api.example.com/users?page=5' - }); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `links` | `any` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.links - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:681 - -___ - -### listenerCount - -▸ **listenerCount**(`event`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | - -#### Returns - -`number` - -#### Inherited from - -Response.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:83 - -___ - -### listeners - -▸ **listeners**(`event`): `Function`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -Response.listeners - -#### Defined in - -node_modules/@types/node/events.d.ts:80 - -___ - -### location - -▸ **location**(`url`): [EnvoyResponse](envoyresponse.md) - -Set the location header to `url`. - -The given `url` can also be the name of a mapped url, for -example by default express supports "back" which redirects -to the _Referrer_ or _Referer_ headers or "/". - -Examples: - - res.location('/foo/bar').; - res.location('http://example.com'); - res.location('../login'); // /blog/post/1 -> /blog/login - -Mounting: - - When an application is mounted and `res.location()` - is given a path that does _not_ lead with "/" it becomes - relative to the mount-point. For example if the application - is mounted at "/blog", the following would become "/blog/login". - - res.location('login'); - - While the leading slash would result in a location of "/login": - - res.location('/login'); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.location - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:957 - -___ - -### off - -▸ **off**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.off - -#### Defined in - -node_modules/@types/node/events.d.ts:76 - -___ - -### on - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:193 - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:194 - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `listener` | (`err`: `Error`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:195 - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:196 - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:197 - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:198 - -▸ **on**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.on - -#### Defined in - -node_modules/@types/node/stream.d.ts:199 - -___ - -### once - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:201 - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:202 - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `listener` | (`err`: `Error`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:203 - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:204 - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:205 - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:206 - -▸ **once**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.once - -#### Defined in - -node_modules/@types/node/stream.d.ts:207 - -___ - -### pipe - -▸ **pipe**(`destination`, `options?`): `T` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T`: `WritableStream` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `destination` | `T` | -| `options?` | `Object` | -| `options.end?` | `boolean` | - -#### Returns - -`T` - -#### Inherited from - -Response.pipe - -#### Defined in - -node_modules/@types/node/stream.d.ts:6 - -___ - -### prependListener - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:209 - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:210 - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `listener` | (`err`: `Error`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:211 - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:212 - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:213 - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:214 - -▸ **prependListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:215 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:217 - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:218 - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `listener` | (`err`: `Error`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:219 - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:220 - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:221 - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:222 - -▸ **prependOnceListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.prependOnceListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:223 - -___ - -### rawListeners - -▸ **rawListeners**(`event`): `Function`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -Response.rawListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:81 - -___ - -### redirect - -▸ **redirect**(`url`): `void` - -Redirect to the given `url` with optional response `status` -defaulting to 302. - -The resulting `url` is determined by `res.location()`, so -it will play nicely with mounted apps, relative paths, -`"back"` etc. - -Examples: - - res.redirect('/foo/bar'); - res.redirect('http://example.com'); - res.redirect(301, 'http://example.com'); - res.redirect('http://example.com', 301); - res.redirect('../login'); // /blog/post/1 -> /blog/login - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`void` - -#### Inherited from - -Response.redirect - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:975 - -▸ **redirect**(`status`, `url`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `status` | `number` | -| `url` | `string` | - -#### Returns - -`void` - -#### Inherited from - -Response.redirect - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:976 - -▸ **redirect**(`url`, `status`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `status` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Response.redirect - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:977 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeAllListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:77 - -___ - -### removeHeader - -▸ **removeHeader**(`name`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`void` - -#### Inherited from - -Response.removeHeader - -#### Defined in - -node_modules/@types/node/http.d.ts:184 - -___ - -### removeListener - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"close"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:225 - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"drain"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:226 - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"error"`` | -| `listener` | (`err`: `Error`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:227 - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"finish"`` | -| `listener` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:228 - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"pipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:229 - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"unpipe"`` | -| `listener` | (`src`: `Readable`) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:230 - -▸ **removeListener**(`event`, `listener`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.removeListener - -#### Defined in - -node_modules/@types/node/stream.d.ts:231 - -___ - -### render - -▸ **render**(`view`, `options?`, `callback?`): `void` - -Render `view` with the given `options` and optional callback `fn`. -When a callback function is given a response will _not_ be made -automatically, otherwise a response of _200_ and _text/html_ is given. - -Options: - - - `cache` boolean hinting to the engine it should cache - - `filename` filename of the view being rendered - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `view` | `string` | -| `options?` | `object` | -| `callback?` | (`err`: `Error`, `html`: `string`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.render - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:989 - -▸ **render**(`view`, `callback?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `view` | `string` | -| `callback?` | (`err`: `Error`, `html`: `string`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.render - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:990 - -___ - -### sendFile - -▸ **sendFile**(`path`, `fn?`): `void` - -Transfer the file at the given `path`. - -Automatically sets the _Content-Type_ response header field. -The callback `fn(err)` is invoked when the transfer is complete -or when an error occurs. Be sure to check `res.headersSent` -if you wish to attempt responding, as the header and some data -may have already been transferred. - -Options: - - - `maxAge` defaulting to 0 (can be string converted by `ms`) - - `root` root directory for relative filenames - - `headers` object of headers to serve with file - - `dotfiles` serve dotfiles, defaulting to false; can be `"allow"` to send them - -Other options are passed along to `send`. - -Examples: - - The following example illustrates how `res.sendFile()` may - be used as an alternative for the `static()` middleware for - dynamic situations. The code backing `res.sendFile()` is actually - the same code, so HTTP cache support etc is identical. - - app.get('/user/:uid/photos/:file', function(req, res){ - var uid = req.params.uid - , file = req.params.file; - - req.user.mayViewFilesFrom(uid, function(yes){ - if (yes) { - res.sendFile('/uploads/' + uid + '/' + file); - } else { - res.send(403, 'Sorry! you cant see that.'); - } - }); - }); - -**`api`** public - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `fn?` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.sendFile - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:759 - -▸ **sendFile**(`path`, `options`, `fn?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `options` | `any` | -| `fn?` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.sendFile - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:760 - -___ - -### sendStatus - -▸ **sendStatus**(`code`): [EnvoyResponse](envoyresponse.md) - -Set the response HTTP status code to `statusCode` and send its string representation as the response body. - -**`link`** http://expressjs.com/4x/api.html#res.sendStatus - -Examples: - - res.sendStatus(200); // equivalent to res.status(200).send('OK') - res.sendStatus(403); // equivalent to res.status(403).send('Forbidden') - res.sendStatus(404); // equivalent to res.status(404).send('Not Found') - res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error') - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `number` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.sendStatus - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:669 - -___ - -### sendfile - -▸ **sendfile**(`path`): `void` - -**`deprecated`** Use sendFile instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | - -#### Returns - -`void` - -#### Inherited from - -Response.sendfile - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:765 - -▸ **sendfile**(`path`, `options`): `void` - -**`deprecated`** Use sendFile instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `options` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Response.sendfile - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:769 - -▸ **sendfile**(`path`, `fn`): `void` - -**`deprecated`** Use sendFile instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `fn` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.sendfile - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:773 - -▸ **sendfile**(`path`, `options`, `fn`): `void` - -**`deprecated`** Use sendFile instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `options` | `any` | -| `fn` | `Errback` | - -#### Returns - -`void` - -#### Inherited from - -Response.sendfile - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:777 - -___ - -### set - -▸ **set**(`field`): [EnvoyResponse](envoyresponse.md) - -Set header `field` to `val`, or pass -an object of header fields. - -Examples: - - res.set('Foo', ['bar', 'baz']); - res.set('Accept', 'application/json'); - res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' }); - -Aliased as `res.header()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `any` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.set - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:895 - -▸ **set**(`field`, `value?`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `string` | -| `value?` | `string` \| `string`[] | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.set - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:896 - -___ - -### setDefaultEncoding - -▸ **setDefaultEncoding**(`encoding`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `encoding` | `BufferEncoding` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.setDefaultEncoding - -#### Defined in - -node_modules/@types/node/stream.d.ts:159 - -___ - -### setHeader - -▸ **setHeader**(`name`, `value`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `string` \| `number` \| readonly `string`[] | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.setHeader - -#### Defined in - -node_modules/@types/node/http.d.ts:179 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.setMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:78 - -___ - -### setTimeout - -▸ **setTimeout**(`msecs`, `callback?`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `msecs` | `number` | -| `callback?` | () => `void` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.setTimeout - -#### Defined in - -node_modules/@types/node/http.d.ts:178 - -___ - -### status - -▸ **status**(`code`): [EnvoyResponse](envoyresponse.md) - -Set status `code`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `number` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.status - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:656 - -___ - -### type - -▸ **type**(`type`): [EnvoyResponse](envoyresponse.md) - -Set _Content-Type_ response header with `type` through `mime.lookup()` -when it does not contain "/", or set the Content-Type to `type` otherwise. - -Examples: - - res.type('.html'); - res.type('html'); - res.type('json'); - res.type('application/json'); - res.type('png'); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.type - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:822 - -___ - -### uncork - -▸ **uncork**(): `void` - -#### Returns - -`void` - -#### Inherited from - -Response.uncork - -#### Defined in - -node_modules/@types/node/stream.d.ts:164 - -___ - -### vary - -▸ **vary**(`field`): [EnvoyResponse](envoyresponse.md) - -Adds the field to the Vary response header, if it is not there already. -Examples: - - res.vary('User-Agent').render('docs'); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `string` | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.vary - -#### Defined in - -node_modules/@types/express-serve-static-core/index.d.ts:1003 - -___ - -### write - -▸ **write**(`chunk`, `cb?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chunk` | `any` | -| `cb?` | (`error`: `undefined` \| ``null`` \| `Error`) => `void` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.write - -#### Defined in - -node_modules/@types/node/stream.d.ts:157 - -▸ **write**(`chunk`, `encoding`, `cb?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chunk` | `any` | -| `encoding` | `BufferEncoding` | -| `cb?` | (`error`: `undefined` \| ``null`` \| `Error`) => `void` | - -#### Returns - -`boolean` - -#### Inherited from - -Response.write - -#### Defined in - -node_modules/@types/node/stream.d.ts:158 - -___ - -### writeContinue - -▸ **writeContinue**(`callback?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback?` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -Response.writeContinue - -#### Defined in - -node_modules/@types/node/http.d.ts:200 - -___ - -### writeHead - -▸ **writeHead**(`statusCode`, `reasonPhrase?`, `headers?`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `statusCode` | `number` | -| `reasonPhrase?` | `string` | -| `headers?` | `OutgoingHttpHeaders` \| `OutgoingHttpHeader`[] | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.writeHead - -#### Defined in - -node_modules/@types/node/http.d.ts:201 - -▸ **writeHead**(`statusCode`, `headers?`): [EnvoyResponse](envoyresponse.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `statusCode` | `number` | -| `headers?` | `OutgoingHttpHeaders` \| `OutgoingHttpHeader`[] | - -#### Returns - -[EnvoyResponse](envoyresponse.md) - -#### Inherited from - -Response.writeHead - -#### Defined in - -node_modules/@types/node/http.d.ts:202 - -___ - -### writeProcessing - -▸ **writeProcessing**(): `void` - -#### Returns - -`void` - -#### Inherited from - -Response.writeProcessing - -#### Defined in - -node_modules/@types/node/http.d.ts:203 +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyResponse.ts#L8) diff --git a/typedoc.json b/typedoc.json index 0469080..e2bc5f8 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,5 +3,6 @@ "out": "docs", "excludePrivate": true, "excludeProtected": true, + "excludeExternals": true, "readme": "none" } From 97c68c9e4a8a5363d8b03e84aee52c39c2507497 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:25:26 -0400 Subject: [PATCH 10/91] fixing docs --- src/EnvoyResponse.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/EnvoyResponse.ts b/src/EnvoyResponse.ts index 80fc580..2d2d104 100644 --- a/src/EnvoyResponse.ts +++ b/src/EnvoyResponse.ts @@ -5,6 +5,7 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; * Use to type your `res` object in Envoy request handlers. */ export default interface EnvoyResponse extends Response { + send: (debugInfo?: unknown) => this; sendOngoing: (debugInfo?: unknown) => void; sendIgnored: (message: string, debugInfo?: unknown, ...attachments: Array) => void; sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array) => void; From 015c9eb1ccd64ce627dae471b6b7a53322128414 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:25:40 -0400 Subject: [PATCH 11/91] fixing docs --- docs/README.md | 10 ++--- docs/classes/envoyjwt.md | 6 +-- docs/classes/envoypluginapi.md | 16 ++++---- docs/classes/envoypluginjob.md | 18 ++++----- docs/classes/envoypluginsdk.md | 22 +++++------ docs/classes/envoypluginstorage.md | 18 ++++----- docs/classes/envoypluginstoragepipeline.md | 22 +++++------ docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 46 +++++++++++----------- docs/enums/httpstatus.md | 8 ++-- docs/interfaces/envoyresponse.md | 35 ++++++++++++++-- 11 files changed, 117 insertions(+), 88 deletions(-) diff --git a/docs/README.md b/docs/README.md index 01ae7f4..17f6ea2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -48,7 +48,7 @@ #### Defined in -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyRequest.ts#L41) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyStorageItem.ts#L1) ## Functions @@ -101,7 +101,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/asyncHandler.ts#L10) ___ @@ -138,7 +138,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/errorMiddleware.ts#L9) ___ @@ -164,4 +164,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 4e3a3b2..b087ea4 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 4f284ba..0935f72 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index e9b2f11..5de13d9 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 6c07830..0fb6fe7 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index d2722b1..dc839fe 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 4834647..2168489 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index 58d8410..a40a668 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 048855b..2f78e1f 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 2ca336a..ac31f6b 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 28f7b29..f45194d 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -14,12 +14,41 @@ Use to type your `res` object in Envoy request handlers. ### Properties +- [send](envoyresponse.md#send) - [sendFailed](envoyresponse.md#sendfailed) - [sendIgnored](envoyresponse.md#sendignored) - [sendOngoing](envoyresponse.md#sendongoing) ## Properties +### send + +• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](envoyresponse.md) + +#### Type declaration + +▸ (`debugInfo?`): [EnvoyResponse](envoyresponse.md) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `debugInfo?` | `unknown` | + +##### Returns + +[EnvoyResponse](envoyresponse.md) + +#### Overrides + +Response.send + +#### Defined in + +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L8) + +___ + ### sendFailed • **sendFailed**: (`message`: `string`, `debugInfo?`: `unknown`, ...`attachments`: `EnvoyPluginJobAttachment`[]) => `void` @@ -42,7 +71,7 @@ Use to type your `res` object in Envoy request handlers. #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L11) ___ @@ -68,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L10) ___ @@ -92,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/229a60c/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L9) From 39da2e13d9a3c6cc4c8bd4bf29a487d5f05f45da Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:29:40 -0400 Subject: [PATCH 12/91] fixing docs --- docs/README.md | 44 ++++++++++++++++++---- docs/classes/envoypluginstorage.md | 18 ++++----- docs/classes/envoypluginstoragepipeline.md | 22 +++++------ src/index.ts | 18 +++++---- 4 files changed, 66 insertions(+), 36 deletions(-) diff --git a/docs/README.md b/docs/README.md index 17f6ea2..71fb6fd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,9 +22,11 @@ ### Interfaces - [EnvoyResponse](interfaces/envoyresponse.md) +- [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) ### Type aliases +- [EnvoyMiddleware](README.md#envoymiddleware) - [EnvoyRequest](README.md#envoyrequest) - [EnvoyStorageItem](README.md#envoystorageitem) @@ -36,6 +38,32 @@ ## Type aliases +### EnvoyMiddleware + +Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` + +#### Type declaration + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/middleware.ts#L12) + +___ + ### EnvoyRequest Ƭ **EnvoyRequest**: `EnvoyBaseRequest` @@ -48,7 +76,7 @@ #### Defined in -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyRequest.ts#L41) ___ @@ -65,7 +93,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyStorageItem.ts#L1) ## Functions @@ -101,7 +129,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/asyncHandler.ts#L10) ___ @@ -138,13 +166,13 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/errorMiddleware.ts#L9) ___ ### middleware -▸ **middleware**(`options?`): `EnvoyMiddleware` +▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. @@ -156,12 +184,12 @@ as well as managing the plugin access token lifecycle. | Name | Type | | :------ | :------ | -| `options?` | `EnvoySignatureVerifierOptions` | +| `options?` | [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) | #### Returns -`EnvoyMiddleware` +[EnvoyMiddleware](README.md#envoymiddleware) #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/middleware.ts#L21) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index dc839fe..03dfdd2 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 2168489..4fb062a 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/src/index.ts b/src/index.ts index 1306436..75223a4 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,33 +1,35 @@ import asyncHandler from './asyncHandler'; +import errorMiddleware from './errorMiddleware'; import EnvoyJWT from './EnvoyJWT'; import EnvoyPluginJob from './EnvoyPluginJob'; import EnvoyPluginSDK from './EnvoyPluginSDK'; import EnvoyPluginStorage from './EnvoyPluginStorage'; -import EnvoyStorageItem from './EnvoyStorageItem'; import EnvoyPluginStoragePipeline from './EnvoyPluginStoragePipeline'; import EnvoyRequest from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; -import EnvoySignatureVerifier from './EnvoySignatureVerifier'; +import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './EnvoySignatureVerifier'; +import EnvoyStorageItem from './EnvoyStorageItem'; import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; import HttpStatus from './HttpStatus'; -import middleware from './middleware'; -import errorMiddleware from './errorMiddleware'; +import middleware, { EnvoyMiddleware } from './middleware'; export { asyncHandler, + errorMiddleware, EnvoyJWT, + EnvoyMiddleware, EnvoyPluginJob, EnvoyPluginSDK, EnvoyPluginStorage, - EnvoyStorageItem, EnvoyPluginStoragePipeline, - EnvoySignatureVerifier, EnvoyRequest, EnvoyResponse, - EnvoyUserAPI, + EnvoySignatureVerifier, + EnvoySignatureVerifierOptions, + EnvoyStorageItem, EnvoyPluginAPI, + EnvoyUserAPI, HttpStatus, middleware, - errorMiddleware, }; From d8fa581345c1cd614ec9646ff433f995c0cda73d Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:30:33 -0400 Subject: [PATCH 13/91] fixing docs --- docs/classes/envoyjwt.md | 6 +-- docs/classes/envoypluginapi.md | 16 +++--- docs/classes/envoypluginjob.md | 18 +++---- docs/classes/envoypluginsdk.md | 22 ++++---- docs/classes/envoysignatureverifier.md | 6 +-- docs/classes/envoyuserapi.md | 46 ++++++++-------- docs/enums/httpstatus.md | 8 +-- docs/interfaces/envoyresponse.md | 8 +-- .../envoysignatureverifieroptions.md | 52 +++++++++++++++++++ 9 files changed, 117 insertions(+), 65 deletions(-) create mode 100644 docs/interfaces/envoysignatureverifieroptions.md diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index b087ea4..8763899 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 0935f72..00eba2f 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 5de13d9..df2f233 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 0fb6fe7..3df0553 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index a40a668..4c88777 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -24,11 +24,11 @@ Verifies that a request is coming from Envoy. | Name | Type | | :------ | :------ | -| `options` | `EnvoySignatureVerifierOptions` | +| `options` | [EnvoySignatureVerifierOptions](../interfaces/envoysignatureverifieroptions.md) | #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 2f78e1f..e31ec63 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index ac31f6b..a35d854 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index f45194d..78db18e 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/97c68c9/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/envoysignatureverifieroptions.md b/docs/interfaces/envoysignatureverifieroptions.md new file mode 100644 index 0000000..433b99a --- /dev/null +++ b/docs/interfaces/envoysignatureverifieroptions.md @@ -0,0 +1,52 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifierOptions + +# Interface: EnvoySignatureVerifierOptions + +## Table of contents + +### Properties + +- [algorithm](envoysignatureverifieroptions.md#algorithm) +- [encoding](envoysignatureverifieroptions.md#encoding) +- [header](envoysignatureverifieroptions.md#header) +- [secret](envoysignatureverifieroptions.md#secret) + +## Properties + +### algorithm + +• **algorithm**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L6) + +___ + +### encoding + +• **encoding**: `BinaryToTextEncoding` + +#### Defined in + +[EnvoySignatureVerifier.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L7) + +___ + +### header + +• **header**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L9) + +___ + +### secret + +• **secret**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L8) From a7d8339519aaf381d6a3ebc5d2980d8fd74fef62 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 15:34:45 -0400 Subject: [PATCH 14/91] fixing docs --- docs/README.md | 192 +---------- .../{envoyjwt.md => index.envoyjwt.md} | 16 +- ...oypluginapi.md => index.envoypluginapi.md} | 44 +-- ...oypluginjob.md => index.envoypluginjob.md} | 44 +-- ...oypluginsdk.md => index.envoypluginsdk.md} | 78 ++--- ...storage.md => index.envoypluginstorage.md} | 68 ++-- ...md => index.envoypluginstoragepipeline.md} | 84 ++--- ...ier.md => index.envoysignatureverifier.md} | 14 +- ...{envoyuserapi.md => index.envoyuserapi.md} | 104 +++--- .../{httpstatus.md => index.httpstatus.md} | 20 +- .../envoysignatureverifieroptions.md | 52 --- docs/interfaces/index.envoybaserequest.md | 49 +++ docs/interfaces/index.envoyeventmeta.md | 100 ++++++ docs/interfaces/index.envoymetacompany.md | 51 +++ docs/interfaces/index.envoymetajob.md | 43 +++ docs/interfaces/index.envoymetalocation.md | 62 ++++ ...nvoyresponse.md => index.envoyresponse.md} | 26 +- docs/interfaces/index.envoyroutemeta.md | 112 +++++++ .../index.envoysignatureverifieroptions.md | 54 +++ docs/interfaces/index.verifiedrequest.md | 29 ++ .../payloads_entrypayload.default.md | 95 ++++++ .../payloads_invitepayload.default.md | 97 ++++++ docs/modules/index.md | 309 ++++++++++++++++++ docs/modules/payloads_entrypayload.md | 9 + docs/modules/payloads_invitepayload.md | 9 + src/index.ts | 2 + typedoc.json | 2 +- 27 files changed, 1285 insertions(+), 480 deletions(-) rename docs/classes/{envoyjwt.md => index.envoyjwt.md} (75%) rename docs/classes/{envoypluginapi.md => index.envoypluginapi.md} (66%) rename docs/classes/{envoypluginjob.md => index.envoypluginjob.md} (71%) rename docs/classes/{envoypluginsdk.md => index.envoypluginsdk.md} (60%) rename docs/classes/{envoypluginstorage.md => index.envoypluginstorage.md} (54%) rename docs/classes/{envoypluginstoragepipeline.md => index.envoypluginstoragepipeline.md} (52%) rename docs/classes/{envoysignatureverifier.md => index.envoysignatureverifier.md} (60%) rename docs/classes/{envoyuserapi.md => index.envoyuserapi.md} (72%) rename docs/enums/{httpstatus.md => index.httpstatus.md} (57%) delete mode 100644 docs/interfaces/envoysignatureverifieroptions.md create mode 100644 docs/interfaces/index.envoybaserequest.md create mode 100644 docs/interfaces/index.envoyeventmeta.md create mode 100644 docs/interfaces/index.envoymetacompany.md create mode 100644 docs/interfaces/index.envoymetajob.md create mode 100644 docs/interfaces/index.envoymetalocation.md rename docs/interfaces/{envoyresponse.md => index.envoyresponse.md} (71%) create mode 100644 docs/interfaces/index.envoyroutemeta.md create mode 100644 docs/interfaces/index.envoysignatureverifieroptions.md create mode 100644 docs/interfaces/index.verifiedrequest.md create mode 100644 docs/interfaces/payloads_entrypayload.default.md create mode 100644 docs/interfaces/payloads_invitepayload.default.md create mode 100644 docs/modules/index.md create mode 100644 docs/modules/payloads_entrypayload.md create mode 100644 docs/modules/payloads_invitepayload.md diff --git a/docs/README.md b/docs/README.md index 71fb6fd..3abcb20 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,192 +4,8 @@ ## Table of contents -### Enumerations +### Modules -- [HttpStatus](enums/httpstatus.md) - -### Classes - -- [EnvoyJWT](classes/envoyjwt.md) -- [EnvoyPluginAPI](classes/envoypluginapi.md) -- [EnvoyPluginJob](classes/envoypluginjob.md) -- [EnvoyPluginSDK](classes/envoypluginsdk.md) -- [EnvoyPluginStorage](classes/envoypluginstorage.md) -- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) -- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) -- [EnvoyUserAPI](classes/envoyuserapi.md) - -### Interfaces - -- [EnvoyResponse](interfaces/envoyresponse.md) -- [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) - -### Type aliases - -- [EnvoyMiddleware](README.md#envoymiddleware) -- [EnvoyRequest](README.md#envoyrequest) -- [EnvoyStorageItem](README.md#envoystorageitem) - -### Functions - -- [asyncHandler](README.md#asynchandler) -- [errorMiddleware](README.md#errormiddleware) -- [middleware](README.md#middleware) - -## Type aliases - -### EnvoyMiddleware - -Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` - -#### Type declaration - -▸ (`req`, `res`, `next`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | - -##### Returns - -`void` - -#### Defined in - -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/middleware.ts#L12) - -___ - -### EnvoyRequest - -Ƭ **EnvoyRequest**: `EnvoyBaseRequest` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Payload` | `Payload` = `unknown` | - -#### Defined in - -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyRequest.ts#L41) - -___ - -### EnvoyStorageItem - -Ƭ **EnvoyStorageItem**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `unknown` | - -#### Defined in - -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyStorageItem.ts#L1) - -## Functions - -### asyncHandler - -▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` - -Catches Promise-based errors. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `handler` | `RequestHandler` \| `EnvoyHandler` | - -#### Returns - -`fn` - -▸ (`req`, `res`, `next`): `Promise` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | - -##### Returns - -`Promise` - -#### Defined in - -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/asyncHandler.ts#L10) - -___ - -### errorMiddleware - -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` - -Catches errors and sets the proper status code. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onError` | (`err`: `Error`) => `void` | - -#### Returns - -`fn` - -▸ (`err`, `req`, `res`, `next`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | - -##### Returns - -`void` - -#### Defined in - -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/errorMiddleware.ts#L9) - -___ - -### middleware - -▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) - -Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. -Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. - -Also verifies that the request is coming from Envoy, -as well as managing the plugin access token lifecycle. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) | - -#### Returns - -[EnvoyMiddleware](README.md#envoymiddleware) - -#### Defined in - -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/middleware.ts#L21) +- [index](modules/index.md) +- [payloads/EntryPayload](modules/payloads_entrypayload.md) +- [payloads/InvitePayload](modules/payloads_invitepayload.md) diff --git a/docs/classes/envoyjwt.md b/docs/classes/index.envoyjwt.md similarity index 75% rename from docs/classes/envoyjwt.md rename to docs/classes/index.envoyjwt.md index 8763899..e10e3d2 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/index.envoyjwt.md @@ -1,19 +1,21 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyJWT +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyJWT # Class: EnvoyJWT +[index](../modules/index.md).EnvoyJWT + Helper to encode and decode JWTs. ## Table of contents ### Constructors -- [constructor](envoyjwt.md#constructor) +- [constructor](index.envoyjwt.md#constructor) ### Methods -- [decode](envoyjwt.md#decode) -- [encode](envoyjwt.md#encode) +- [decode](index.envoyjwt.md#decode) +- [encode](index.envoyjwt.md#encode) ## Constructors @@ -30,7 +32,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +53,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +75,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/index.envoypluginapi.md similarity index 66% rename from docs/classes/envoypluginapi.md rename to docs/classes/index.envoypluginapi.md index 00eba2f..1689804 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/index.envoypluginapi.md @@ -1,7 +1,9 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginAPI +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginAPI # Class: EnvoyPluginAPI +[index](../modules/index.md).EnvoyPluginAPI + API endpoints for *plugin-scoped* tokens. ## Hierarchy @@ -14,20 +16,20 @@ API endpoints for *plugin-scoped* tokens. ### Constructors -- [constructor](envoypluginapi.md#constructor) +- [constructor](index.envoypluginapi.md#constructor) ### Properties -- [axios](envoypluginapi.md#axios) +- [axios](index.envoypluginapi.md#axios) ### Methods -- [createNotification](envoypluginapi.md#createnotification) -- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) -- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) -- [storagePipeline](envoypluginapi.md#storagepipeline) -- [updateJob](envoypluginapi.md#updatejob) -- [login](envoypluginapi.md#login) +- [createNotification](index.envoypluginapi.md#createnotification) +- [getPluginInstallConfig](index.envoypluginapi.md#getplugininstallconfig) +- [setPluginInstallConfig](index.envoypluginapi.md#setplugininstallconfig) +- [storagePipeline](index.envoypluginapi.md#storagepipeline) +- [updateJob](index.envoypluginapi.md#updatejob) +- [login](index.envoypluginapi.md#login) ## Constructors @@ -47,7 +49,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +65,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +86,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +106,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,13 +127,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L26) ___ ### storagePipeline -▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> #### Parameters @@ -142,11 +144,11 @@ ___ #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,13 +169,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L13) ___ ### login -▸ `Static` **login**(`id?`, `secret?`): `Promise` +▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> Gets a plugin access token using `client_credentials` as the grant type. @@ -186,8 +188,8 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Returns -`Promise` +`Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/index.envoypluginjob.md similarity index 71% rename from docs/classes/envoypluginjob.md rename to docs/classes/index.envoypluginjob.md index df2f233..a4044e6 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/index.envoypluginjob.md @@ -1,7 +1,9 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginJob +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginJob # Class: EnvoyPluginJob +[index](../modules/index.md).EnvoyPluginJob + A "job" is an event, like `entry_sign_in`. When your plugin handles the event, you can use this job concept to update the status (e.g. complete, failed, ignored) @@ -12,21 +14,21 @@ as well as attach extra data to the event's subject ### Constructors -- [constructor](envoypluginjob.md#constructor) +- [constructor](index.envoypluginjob.md#constructor) ### Properties -- [api](envoypluginjob.md#api) -- [id](envoypluginjob.md#id) +- [api](index.envoypluginjob.md#api) +- [id](index.envoypluginjob.md#id) ### Methods -- [attach](envoypluginjob.md#attach) -- [complete](envoypluginjob.md#complete) -- [execute](envoypluginjob.md#execute) -- [fail](envoypluginjob.md#fail) -- [ignore](envoypluginjob.md#ignore) -- [update](envoypluginjob.md#update) +- [attach](index.envoypluginjob.md#attach) +- [complete](index.envoypluginjob.md#complete) +- [execute](index.envoypluginjob.md#execute) +- [fail](index.envoypluginjob.md#fail) +- [ignore](index.envoypluginjob.md#ignore) +- [update](index.envoypluginjob.md#update) ## Constructors @@ -38,22 +40,22 @@ as well as attach extra data to the event's subject | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](index.envoypluginapi.md) | | `jobId` | `string` | #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L15) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](index.envoypluginapi.md) #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +65,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +85,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +106,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +129,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +150,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +171,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +192,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/index.envoypluginsdk.md similarity index 60% rename from docs/classes/envoypluginsdk.md rename to docs/classes/index.envoypluginsdk.md index 3df0553..a09b668 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/index.envoypluginsdk.md @@ -1,7 +1,9 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginSDK +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginSDK # Class: EnvoyPluginSDK +[index](../modules/index.md).EnvoyPluginSDK + Sets up all relevant Envoy functions. Attaches itself to every request object using our `middleware`, to allow for easy access to Envoy functions. @@ -17,20 +19,20 @@ to allow for easy access to Envoy functions. ### Constructors -- [constructor](envoypluginsdk.md#constructor) +- [constructor](index.envoypluginsdk.md#constructor) ### Accessors -- [getJob](envoypluginsdk.md#getjob) -- [globalStorage](envoypluginsdk.md#globalstorage) -- [installStorage](envoypluginsdk.md#installstorage) -- [job](envoypluginsdk.md#job) -- [jobId](envoypluginsdk.md#jobid) -- [jwt](envoypluginsdk.md#jwt) -- [meta](envoypluginsdk.md#meta) -- [payload](envoypluginsdk.md#payload) -- [pluginAPI](envoypluginsdk.md#pluginapi) -- [userAPI](envoypluginsdk.md#userapi) +- [getJob](index.envoypluginsdk.md#getjob) +- [globalStorage](index.envoypluginsdk.md#globalstorage) +- [installStorage](index.envoypluginsdk.md#installstorage) +- [job](index.envoypluginsdk.md#job) +- [jobId](index.envoypluginsdk.md#jobid) +- [jwt](index.envoypluginsdk.md#jwt) +- [meta](index.envoypluginsdk.md#meta) +- [payload](index.envoypluginsdk.md#payload) +- [pluginAPI](index.envoypluginsdk.md#pluginapi) +- [userAPI](index.envoypluginsdk.md#userapi) ## Constructors @@ -55,13 +57,13 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L38) ## Accessors ### getJob -• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](envoypluginjob.md) +• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](index.envoypluginjob.md) Returns a job based on an ID. @@ -69,7 +71,7 @@ Returns a job based on an ID. `fn` -▸ (`jobId`): [EnvoyPluginJob](envoypluginjob.md) +▸ (`jobId`): [EnvoyPluginJob](index.envoypluginjob.md) ##### Parameters @@ -79,59 +81,59 @@ Returns a job based on an ID. ##### Returns -[EnvoyPluginJob](envoypluginjob.md) +[EnvoyPluginJob](index.envoypluginjob.md) #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L129) ___ ### globalStorage -• `get` **globalStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) +• `get` **globalStorage**(): [EnvoyPluginStorage](index.envoypluginstorage.md) Storage scoped globally (across installs). #### Returns -[EnvoyPluginStorage](envoypluginstorage.md) +[EnvoyPluginStorage](index.envoypluginstorage.md) #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L122) ___ ### installStorage -• `get` **installStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) +• `get` **installStorage**(): [EnvoyPluginStorage](index.envoypluginstorage.md) Storage scoped to the install. #### Returns -[EnvoyPluginStorage](envoypluginstorage.md) +[EnvoyPluginStorage](index.envoypluginstorage.md) #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L111) ___ ### job -• `get` **job**(): [EnvoyPluginJob](envoypluginjob.md) +• `get` **job**(): [EnvoyPluginJob](index.envoypluginjob.md) Perform operations on the current job. #### Returns -[EnvoyPluginJob](envoypluginjob.md) +[EnvoyPluginJob](index.envoypluginjob.md) #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,24 +149,24 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L136) ___ ### jwt -• `get` **jwt**(): [EnvoyJWT](envoyjwt.md) +• `get` **jwt**(): [EnvoyJWT](index.envoyjwt.md) A utility to encode and decode JWTs. Useful for verifiable communications between plugin endpoints. #### Returns -[EnvoyJWT](envoyjwt.md) +[EnvoyJWT](index.envoyjwt.md) #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +183,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,38 +201,38 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L62) ___ ### pluginAPI -• `get` **pluginAPI**(): [EnvoyPluginAPI](envoypluginapi.md) +• `get` **pluginAPI**(): [EnvoyPluginAPI](index.envoypluginapi.md) Envoy API scoped to the plugin. Used to perform storage or job operations. #### Returns -[EnvoyPluginAPI](envoypluginapi.md) +[EnvoyPluginAPI](index.envoypluginapi.md) #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L90) ___ ### userAPI -• `get` **userAPI**(): [EnvoyUserAPI](envoyuserapi.md) +• `get` **userAPI**(): [EnvoyUserAPI](index.envoyuserapi.md) Envoy API scoped to the user. Used only in routes. #### Returns -[EnvoyUserAPI](envoyuserapi.md) +[EnvoyUserAPI](index.envoyuserapi.md) #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/index.envoypluginstorage.md similarity index 54% rename from docs/classes/envoypluginstorage.md rename to docs/classes/index.envoypluginstorage.md index 03dfdd2..c317266 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/index.envoypluginstorage.md @@ -1,7 +1,9 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStorage +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginStorage # Class: EnvoyPluginStorage +[index](../modules/index.md).EnvoyPluginStorage + A key-value storage that can be scoped to a specific install, or to the plugin itself. @@ -9,21 +11,21 @@ or to the plugin itself. ### Constructors -- [constructor](envoypluginstorage.md#constructor) +- [constructor](index.envoypluginstorage.md#constructor) ### Properties -- [api](envoypluginstorage.md#api) -- [installId](envoypluginstorage.md#installid) +- [api](index.envoypluginstorage.md#api) +- [installId](index.envoypluginstorage.md#installid) ### Methods -- [get](envoypluginstorage.md#get) -- [pipeline](envoypluginstorage.md#pipeline) -- [set](envoypluginstorage.md#set) -- [setUnique](envoypluginstorage.md#setunique) -- [setUniqueNum](envoypluginstorage.md#setuniquenum) -- [unset](envoypluginstorage.md#unset) +- [get](index.envoypluginstorage.md#get) +- [pipeline](index.envoypluginstorage.md#pipeline) +- [set](index.envoypluginstorage.md#set) +- [setUnique](index.envoypluginstorage.md#setunique) +- [setUniqueNum](index.envoypluginstorage.md#setuniquenum) +- [unset](index.envoypluginstorage.md#unset) ## Constructors @@ -35,22 +37,22 @@ or to the plugin itself. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](index.envoypluginapi.md) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L13) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](index.envoypluginapi.md) #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,13 +62,13 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L13) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> Wrapper for single pipeline get. @@ -78,33 +80,33 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L30) ___ ### pipeline -▸ **pipeline**(): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **pipeline**(): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) Creates a new pipeline instance. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L23) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> Wrapper for single pipeline set. @@ -117,17 +119,17 @@ Wrapper for single pipeline set. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L37) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -140,17 +142,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L44) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -163,17 +165,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L51) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> Wrapper for single pipeline unset. Returns null if the item did not previously exist. @@ -186,8 +188,8 @@ Returns null if the item did not previously exist. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/index.envoypluginstoragepipeline.md similarity index 52% rename from docs/classes/envoypluginstoragepipeline.md rename to docs/classes/index.envoypluginstoragepipeline.md index 4fb062a..ed9ba19 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/index.envoypluginstoragepipeline.md @@ -1,30 +1,32 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStoragePipeline +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginStoragePipeline # Class: EnvoyPluginStoragePipeline +[index](../modules/index.md).EnvoyPluginStoragePipeline + Builds up a request pipeline for submitting storage commands. ## Table of contents ### Constructors -- [constructor](envoypluginstoragepipeline.md#constructor) +- [constructor](index.envoypluginstoragepipeline.md#constructor) ### Properties -- [api](envoypluginstoragepipeline.md#api) -- [installId](envoypluginstoragepipeline.md#installid) +- [api](index.envoypluginstoragepipeline.md#api) +- [installId](index.envoypluginstoragepipeline.md#installid) ### Methods -- [addCommand](envoypluginstoragepipeline.md#addcommand) -- [execute](envoypluginstoragepipeline.md#execute) -- [executeSingle](envoypluginstoragepipeline.md#executesingle) -- [get](envoypluginstoragepipeline.md#get) -- [set](envoypluginstoragepipeline.md#set) -- [setUnique](envoypluginstoragepipeline.md#setunique) -- [setUniqueNum](envoypluginstoragepipeline.md#setuniquenum) -- [unset](envoypluginstoragepipeline.md#unset) +- [addCommand](index.envoypluginstoragepipeline.md#addcommand) +- [execute](index.envoypluginstoragepipeline.md#execute) +- [executeSingle](index.envoypluginstoragepipeline.md#executesingle) +- [get](index.envoypluginstoragepipeline.md#get) +- [set](index.envoypluginstoragepipeline.md#set) +- [setUnique](index.envoypluginstoragepipeline.md#setunique) +- [setUniqueNum](index.envoypluginstoragepipeline.md#setuniquenum) +- [unset](index.envoypluginstoragepipeline.md#unset) ## Constructors @@ -36,22 +38,22 @@ Builds up a request pipeline for submitting storage commands. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](index.envoypluginapi.md) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](index.envoypluginapi.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,13 +63,13 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods ### addCommand -▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Parameters @@ -77,49 +79,49 @@ ___ #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L39) ___ ### execute -▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> Executes all the commands in the pipeline. #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L27) ___ ### executeSingle -▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> Executes the pipeline and returns the first result. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L34) ___ ### get -▸ **get**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **get**(`key`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) Gets a storage item. @@ -131,17 +133,17 @@ Gets a storage item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L47) ___ ### set -▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) Sets a value for a storage item, and returns that item. @@ -155,17 +157,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L55) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) Sets a unique value for a storage item, and returns that item. @@ -179,17 +181,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L63) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) Sets a unique number value for a storage item, and returns that item. @@ -203,17 +205,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L71) ___ ### unset -▸ **unset**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **unset**(`key`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) Unsets a storage item. @@ -225,8 +227,8 @@ Unsets a storage item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/index.envoysignatureverifier.md similarity index 60% rename from docs/classes/envoysignatureverifier.md rename to docs/classes/index.envoysignatureverifier.md index 4c88777..449c9ee 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/index.envoysignatureverifier.md @@ -1,18 +1,20 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifier +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoySignatureVerifier # Class: EnvoySignatureVerifier +[index](../modules/index.md).EnvoySignatureVerifier + Verifies that a request is coming from Envoy. ## Table of contents ### Constructors -- [constructor](envoysignatureverifier.md#constructor) +- [constructor](index.envoysignatureverifier.md#constructor) ### Methods -- [verify](envoysignatureverifier.md#verify) +- [verify](index.envoysignatureverifier.md#verify) ## Constructors @@ -24,11 +26,11 @@ Verifies that a request is coming from Envoy. | Name | Type | | :------ | :------ | -| `options` | [EnvoySignatureVerifierOptions](../interfaces/envoysignatureverifieroptions.md) | +| `options` | [EnvoySignatureVerifierOptions](../interfaces/index.envoysignatureverifieroptions.md) | #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +53,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/index.envoyuserapi.md similarity index 72% rename from docs/classes/envoyuserapi.md rename to docs/classes/index.envoyuserapi.md index e31ec63..2355c40 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/index.envoyuserapi.md @@ -1,7 +1,9 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyUserAPI +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyUserAPI # Class: EnvoyUserAPI +[index](../modules/index.md).EnvoyUserAPI + API endpoints for *user-scoped* tokens. To access Envoy resources, this is the API you'd want. @@ -15,35 +17,35 @@ To access Envoy resources, this is the API you'd want. ### Constructors -- [constructor](envoyuserapi.md#constructor) +- [constructor](index.envoyuserapi.md#constructor) ### Properties -- [axios](envoyuserapi.md#axios) +- [axios](index.envoyuserapi.md#axios) ### Methods -- [createInvite](envoyuserapi.md#createinvite) -- [getAgreement](envoyuserapi.md#getagreement) -- [getAgreementPage](envoyuserapi.md#getagreementpage) -- [getCompany](envoyuserapi.md#getcompany) -- [getEmployee](envoyuserapi.md#getemployee) -- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) -- [getEmployees](envoyuserapi.md#getemployees) -- [getFlow](envoyuserapi.md#getflow) -- [getFlows](envoyuserapi.md#getflows) -- [getInvites](envoyuserapi.md#getinvites) -- [getLocation](envoyuserapi.md#getlocation) -- [getLocations](envoyuserapi.md#getlocations) -- [getSignInField](envoyuserapi.md#getsigninfield) -- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) -- [getSignInFields](envoyuserapi.md#getsigninfields) -- [me](envoyuserapi.md#me) -- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) -- [removeInvite](envoyuserapi.md#removeinvite) -- [updateInvite](envoyuserapi.md#updateinvite) -- [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) -- [loginAsUser](envoyuserapi.md#loginasuser) +- [createInvite](index.envoyuserapi.md#createinvite) +- [getAgreement](index.envoyuserapi.md#getagreement) +- [getAgreementPage](index.envoyuserapi.md#getagreementpage) +- [getCompany](index.envoyuserapi.md#getcompany) +- [getEmployee](index.envoyuserapi.md#getemployee) +- [getEmployeeByEmail](index.envoyuserapi.md#getemployeebyemail) +- [getEmployees](index.envoyuserapi.md#getemployees) +- [getFlow](index.envoyuserapi.md#getflow) +- [getFlows](index.envoyuserapi.md#getflows) +- [getInvites](index.envoyuserapi.md#getinvites) +- [getLocation](index.envoyuserapi.md#getlocation) +- [getLocations](index.envoyuserapi.md#getlocations) +- [getSignInField](index.envoyuserapi.md#getsigninfield) +- [getSignInFieldPage](index.envoyuserapi.md#getsigninfieldpage) +- [getSignInFields](index.envoyuserapi.md#getsigninfields) +- [me](index.envoyuserapi.md#me) +- [partialUpdateInvite](index.envoyuserapi.md#partialupdateinvite) +- [removeInvite](index.envoyuserapi.md#removeinvite) +- [updateInvite](index.envoyuserapi.md#updateinvite) +- [loginAsPluginInstaller](index.envoyuserapi.md#loginasplugininstaller) +- [loginAsUser](index.envoyuserapi.md#loginasuser) ## Constructors @@ -63,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +101,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +122,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +143,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +164,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +185,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +206,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +226,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +247,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +267,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +287,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +308,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +328,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +349,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +370,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +390,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +404,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +425,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +445,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L140) ___ @@ -464,13 +466,13 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L120) ___ ### loginAsPluginInstaller -▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise` +▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> Gets a user access token using `plugin_install` as the grant type. @@ -484,17 +486,17 @@ Gets a user access token using `plugin_install` as the grant type. #### Returns -`Promise` +`Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L177) ___ ### loginAsUser -▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise` +▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> Gets a user access token using `password` as the grant type (discouraged). @@ -509,8 +511,8 @@ Gets a user access token using `password` as the grant type (discouraged). #### Returns -`Promise` +`Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/index.httpstatus.md similarity index 57% rename from docs/enums/httpstatus.md rename to docs/enums/index.httpstatus.md index a35d854..c2cbed1 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/index.httpstatus.md @@ -1,17 +1,19 @@ -[@envoy/envoy-integrations-sdk](../README.md) / HttpStatus +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / HttpStatus # Enumeration: HttpStatus +[index](../modules/index.md).HttpStatus + Use these status codes to inform Envoy of a job's or route's status. ## Table of contents ### Enumeration members -- [FAILED](httpstatus.md#failed) -- [IGNORED](httpstatus.md#ignored) -- [ONGOING](httpstatus.md#ongoing) -- [UNEXPECTED\_FAILURE](httpstatus.md#unexpected_failure) +- [FAILED](index.httpstatus.md#failed) +- [IGNORED](index.httpstatus.md#ignored) +- [ONGOING](index.httpstatus.md#ongoing) +- [UNEXPECTED\_FAILURE](index.httpstatus.md#unexpected_failure) ## Enumeration members @@ -21,7 +23,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L7) ___ @@ -31,7 +33,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L6) ___ @@ -41,7 +43,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L5) ___ @@ -51,4 +53,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoysignatureverifieroptions.md b/docs/interfaces/envoysignatureverifieroptions.md deleted file mode 100644 index 433b99a..0000000 --- a/docs/interfaces/envoysignatureverifieroptions.md +++ /dev/null @@ -1,52 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifierOptions - -# Interface: EnvoySignatureVerifierOptions - -## Table of contents - -### Properties - -- [algorithm](envoysignatureverifieroptions.md#algorithm) -- [encoding](envoysignatureverifieroptions.md#encoding) -- [header](envoysignatureverifieroptions.md#header) -- [secret](envoysignatureverifieroptions.md#secret) - -## Properties - -### algorithm - -• **algorithm**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L6) - -___ - -### encoding - -• **encoding**: `BinaryToTextEncoding` - -#### Defined in - -[EnvoySignatureVerifier.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L7) - -___ - -### header - -• **header**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L9) - -___ - -### secret - -• **secret**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoySignatureVerifier.ts#L8) diff --git a/docs/interfaces/index.envoybaserequest.md b/docs/interfaces/index.envoybaserequest.md new file mode 100644 index 0000000..4f996ac --- /dev/null +++ b/docs/interfaces/index.envoybaserequest.md @@ -0,0 +1,49 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyBaseRequest + +# Interface: EnvoyBaseRequest + +[index](../modules/index.md).EnvoyBaseRequest + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Payload` | `Payload` = `unknown` | + +## Hierarchy + +- [VerifiedRequest](index.verifiedrequest.md) + + ↳ **EnvoyBaseRequest** + +## Table of contents + +### Properties + +- [[VERIFIED]](index.envoybaserequest.md#[verified]) +- [envoy](index.envoybaserequest.md#envoy) + +## Properties + +### [VERIFIED] + +• **[VERIFIED]**: `boolean` + +#### Inherited from + +[VerifiedRequest](index.verifiedrequest.md).[[VERIFIED]](index.verifiedrequest.md#[verified]) + +#### Defined in + +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L10) + +___ + +### envoy + +• **envoy**: [EnvoyPluginSDK](../classes/index.envoypluginsdk.md) + +#### Defined in + +[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L14) diff --git a/docs/interfaces/index.envoyeventmeta.md b/docs/interfaces/index.envoyeventmeta.md new file mode 100644 index 0000000..27226c5 --- /dev/null +++ b/docs/interfaces/index.envoyeventmeta.md @@ -0,0 +1,100 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyEventMeta + +# Interface: EnvoyEventMeta + +[index](../modules/index.md).EnvoyEventMeta + +Metadata that will be included in the request body for events. + +## Table of contents + +### Properties + +- [auth](index.envoyeventmeta.md#auth) +- [company](index.envoyeventmeta.md#company) +- [config](index.envoyeventmeta.md#config) +- [event](index.envoyeventmeta.md#event) +- [install\_id](index.envoyeventmeta.md#install_id) +- [job](index.envoyeventmeta.md#job) +- [location](index.envoyeventmeta.md#location) +- [plugin\_id](index.envoyeventmeta.md#plugin_id) + +## Properties + +### auth + +• **auth**: ``null`` \| [EnvoyMetaAuth](../modules/index.md#envoymetaauth) + +#### Defined in + +[EnvoyMeta.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L62) + +___ + +### company + +• **company**: [EnvoyMetaCompany](index.envoymetacompany.md) + +#### Defined in + +[EnvoyMeta.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L61) + +___ + +### config + +• **config**: `Record` + +#### Defined in + +[EnvoyMeta.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L58) + +___ + +### event + +• **event**: `string` + +#### Defined in + +[EnvoyMeta.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L55) + +___ + +### install\_id + +• **install\_id**: `string` + +#### Defined in + +[EnvoyMeta.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L57) + +___ + +### job + +• **job**: [EnvoyMetaJob](index.envoymetajob.md) + +#### Defined in + +[EnvoyMeta.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L59) + +___ + +### location + +• **location**: [EnvoyMetaLocation](index.envoymetalocation.md) + +#### Defined in + +[EnvoyMeta.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L60) + +___ + +### plugin\_id + +• **plugin\_id**: `string` + +#### Defined in + +[EnvoyMeta.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L56) diff --git a/docs/interfaces/index.envoymetacompany.md b/docs/interfaces/index.envoymetacompany.md new file mode 100644 index 0000000..c27a3ca --- /dev/null +++ b/docs/interfaces/index.envoymetacompany.md @@ -0,0 +1,51 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyMetaCompany + +# Interface: EnvoyMetaCompany + +[index](../modules/index.md).EnvoyMetaCompany + +## Table of contents + +### Properties + +- [attributes](index.envoymetacompany.md#attributes) +- [id](index.envoymetacompany.md#id) +- [type](index.envoymetacompany.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `active` | `boolean` | +| `created-at` | `string` | +| `name` | `string` | + +#### Defined in + +[EnvoyMeta.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L31) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[EnvoyMeta.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L29) + +___ + +### type + +• **type**: ``"companies"`` + +#### Defined in + +[EnvoyMeta.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L30) diff --git a/docs/interfaces/index.envoymetajob.md b/docs/interfaces/index.envoymetajob.md new file mode 100644 index 0000000..394c3c2 --- /dev/null +++ b/docs/interfaces/index.envoymetajob.md @@ -0,0 +1,43 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyMetaJob + +# Interface: EnvoyMetaJob + +[index](../modules/index.md).EnvoyMetaJob + +## Table of contents + +### Properties + +- [id](index.envoymetajob.md#id) +- [identifier](index.envoymetajob.md#identifier) +- [name](index.envoymetajob.md#name) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[EnvoyMeta.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L2) + +___ + +### identifier + +• **identifier**: `string` + +#### Defined in + +[EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L4) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[EnvoyMeta.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L3) diff --git a/docs/interfaces/index.envoymetalocation.md b/docs/interfaces/index.envoymetalocation.md new file mode 100644 index 0000000..5ced759 --- /dev/null +++ b/docs/interfaces/index.envoymetalocation.md @@ -0,0 +1,62 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyMetaLocation + +# Interface: EnvoyMetaLocation + +[index](../modules/index.md).EnvoyMetaLocation + +## Table of contents + +### Properties + +- [attributes](index.envoymetalocation.md#attributes) +- [id](index.envoymetalocation.md#id) +- [type](index.envoymetalocation.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `address-line-one` | ``null`` \| `string` | +| `address-line-two` | ``null`` \| `string` | +| `city` | ``null`` \| `string` | +| `company-name-override` | ``null`` \| `string` | +| `country` | ``null`` \| `string` | +| `created-at` | `string` | +| `latitude` | ``null`` \| `number` | +| `locale` | ``null`` \| `string` | +| `longitude` | ``null`` \| `number` | +| `name` | `string` | +| `state` | ``null`` \| `string` | +| `timezone` | `string` | +| `zip` | ``null`` \| `string` | + +#### Defined in + +[EnvoyMeta.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L10) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[EnvoyMeta.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L8) + +___ + +### type + +• **type**: ``"locations"`` + +#### Defined in + +[EnvoyMeta.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L9) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/index.envoyresponse.md similarity index 71% rename from docs/interfaces/envoyresponse.md rename to docs/interfaces/index.envoyresponse.md index 78db18e..8e9cab7 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/index.envoyresponse.md @@ -1,7 +1,9 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyResponse +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyResponse # Interface: EnvoyResponse +[index](../modules/index.md).EnvoyResponse + Use to type your `res` object in Envoy request handlers. ## Hierarchy @@ -14,20 +16,20 @@ Use to type your `res` object in Envoy request handlers. ### Properties -- [send](envoyresponse.md#send) -- [sendFailed](envoyresponse.md#sendfailed) -- [sendIgnored](envoyresponse.md#sendignored) -- [sendOngoing](envoyresponse.md#sendongoing) +- [send](index.envoyresponse.md#send) +- [sendFailed](index.envoyresponse.md#sendfailed) +- [sendIgnored](index.envoyresponse.md#sendignored) +- [sendOngoing](index.envoyresponse.md#sendongoing) ## Properties ### send -• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](envoyresponse.md) +• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](index.envoyresponse.md) #### Type declaration -▸ (`debugInfo?`): [EnvoyResponse](envoyresponse.md) +▸ (`debugInfo?`): [EnvoyResponse](index.envoyresponse.md) ##### Parameters @@ -37,7 +39,7 @@ Use to type your `res` object in Envoy request handlers. ##### Returns -[EnvoyResponse](envoyresponse.md) +[EnvoyResponse](index.envoyresponse.md) #### Overrides @@ -45,7 +47,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +73,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +99,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +123,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/015c9eb/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/index.envoyroutemeta.md b/docs/interfaces/index.envoyroutemeta.md new file mode 100644 index 0000000..25e6288 --- /dev/null +++ b/docs/interfaces/index.envoyroutemeta.md @@ -0,0 +1,112 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyRouteMeta + +# Interface: EnvoyRouteMeta + +[index](../modules/index.md).EnvoyRouteMeta + +Metadata that will be included in the request body for setup routes, +like validation URLs or options URLs. + +## Table of contents + +### Properties + +- [auth](index.envoyroutemeta.md#auth) +- [company](index.envoyroutemeta.md#company) +- [config](index.envoyroutemeta.md#config) +- [forwarded\_bearer\_token](index.envoyroutemeta.md#forwarded_bearer_token) +- [install\_id](index.envoyroutemeta.md#install_id) +- [location](index.envoyroutemeta.md#location) +- [params](index.envoyroutemeta.md#params) +- [plugin\_id](index.envoyroutemeta.md#plugin_id) +- [route](index.envoyroutemeta.md#route) + +## Properties + +### auth + +• **auth**: ``null`` \| [EnvoyMetaAuth](../modules/index.md#envoymetaauth) + +#### Defined in + +[EnvoyMeta.ts:77](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L77) + +___ + +### company + +• **company**: [EnvoyMetaCompany](index.envoymetacompany.md) + +#### Defined in + +[EnvoyMeta.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L76) + +___ + +### config + +• **config**: `Record` + +#### Defined in + +[EnvoyMeta.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L73) + +___ + +### forwarded\_bearer\_token + +• `Optional` **forwarded\_bearer\_token**: `string` + +#### Defined in + +[EnvoyMeta.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L78) + +___ + +### install\_id + +• **install\_id**: `string` + +#### Defined in + +[EnvoyMeta.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L72) + +___ + +### location + +• **location**: [EnvoyMetaLocation](index.envoymetalocation.md) + +#### Defined in + +[EnvoyMeta.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L75) + +___ + +### params + +• **params**: `Record` + +#### Defined in + +[EnvoyMeta.ts:74](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L74) + +___ + +### plugin\_id + +• **plugin\_id**: `string` + +#### Defined in + +[EnvoyMeta.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L71) + +___ + +### route + +• **route**: `string` + +#### Defined in + +[EnvoyMeta.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L70) diff --git a/docs/interfaces/index.envoysignatureverifieroptions.md b/docs/interfaces/index.envoysignatureverifieroptions.md new file mode 100644 index 0000000..5731371 --- /dev/null +++ b/docs/interfaces/index.envoysignatureverifieroptions.md @@ -0,0 +1,54 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoySignatureVerifierOptions + +# Interface: EnvoySignatureVerifierOptions + +[index](../modules/index.md).EnvoySignatureVerifierOptions + +## Table of contents + +### Properties + +- [algorithm](index.envoysignatureverifieroptions.md#algorithm) +- [encoding](index.envoysignatureverifieroptions.md#encoding) +- [header](index.envoysignatureverifieroptions.md#header) +- [secret](index.envoysignatureverifieroptions.md#secret) + +## Properties + +### algorithm + +• **algorithm**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L6) + +___ + +### encoding + +• **encoding**: `BinaryToTextEncoding` + +#### Defined in + +[EnvoySignatureVerifier.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L7) + +___ + +### header + +• **header**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L9) + +___ + +### secret + +• **secret**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L8) diff --git a/docs/interfaces/index.verifiedrequest.md b/docs/interfaces/index.verifiedrequest.md new file mode 100644 index 0000000..e796071 --- /dev/null +++ b/docs/interfaces/index.verifiedrequest.md @@ -0,0 +1,29 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / VerifiedRequest + +# Interface: VerifiedRequest + +[index](../modules/index.md).VerifiedRequest + +## Hierarchy + +- `Request` + + ↳ **VerifiedRequest** + + ↳↳ [EnvoyBaseRequest](index.envoybaserequest.md) + +## Table of contents + +### Properties + +- [[VERIFIED]](index.verifiedrequest.md#[verified]) + +## Properties + +### [VERIFIED] + +• **[VERIFIED]**: `boolean` + +#### Defined in + +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L10) diff --git a/docs/interfaces/payloads_entrypayload.default.md b/docs/interfaces/payloads_entrypayload.default.md new file mode 100644 index 0000000..e8b51dd --- /dev/null +++ b/docs/interfaces/payloads_entrypayload.default.md @@ -0,0 +1,95 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [payloads/EntryPayload](../modules/payloads_entrypayload.md) / default + +# Interface: default + +[payloads/EntryPayload](../modules/payloads_entrypayload.md).default + +## Table of contents + +### Properties + +- [attributes](payloads_entrypayload.default.md#attributes) +- [id](payloads_entrypayload.default.md#id) +- [relationships](payloads_entrypayload.default.md#relationships) +- [type](payloads_entrypayload.default.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | ``null`` \| `string` | +| `employee-screening-flow` | `boolean` | +| `flow-name` | `string` | +| `full-name` | `string` | +| `host` | ``null`` \| `string` | +| `host-email` | ``null`` \| `string` | +| `legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `nda?` | `string` | +| `phone-number?` | `string` | +| `private-notes` | ``null`` \| `string` | +| `signed-in-at` | `string` | +| `signed-out-at?` | `string` | +| `thumbnails` | `Object` | +| `thumbnails.large` | ``null`` \| `string` | +| `thumbnails.original` | ``null`` \| `string` | +| `thumbnails.small` | ``null`` \| `string` | +| `user-data` | { `field`: `string` ; `value`: ``null`` \| `string` }[] | + +#### Defined in + +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L6) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[payloads/EntryPayload.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L4) + +___ + +### relationships + +• **relationships**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `agreeable-ndas?` | `Object` | +| `agreeable-ndas.data` | `default`<``"agreeable-ndas"``, string\>[] | +| `device?` | `Object` | +| `device.data` | `default`<``"devices"``, string\> | +| `employee?` | `Object` | +| `employee.data` | `default`<``"employees"``, string\> | +| `flow?` | `Object` | +| `flow.data` | `default`<``"flows"``, string\> | +| `invite?` | `Object` | +| `invite.data` | `default`<``"invites"``, string\> | +| `location` | `Object` | +| `location.data` | `default`<``"locations"``, string\> | +| `visitor-entrance?` | `Object` | +| `visitor-entrance.data` | `default`<``"visitor-entrances"``, string\> | + +#### Defined in + +[payloads/EntryPayload.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L36) + +___ + +### type + +• **type**: ``"entries"`` + +#### Defined in + +[payloads/EntryPayload.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L5) diff --git a/docs/interfaces/payloads_invitepayload.default.md b/docs/interfaces/payloads_invitepayload.default.md new file mode 100644 index 0000000..d34c770 --- /dev/null +++ b/docs/interfaces/payloads_invitepayload.default.md @@ -0,0 +1,97 @@ +[@envoy/envoy-integrations-sdk](../README.md) / [payloads/InvitePayload](../modules/payloads_invitepayload.md) / default + +# Interface: default + +[payloads/InvitePayload](../modules/payloads_invitepayload.md).default + +## Table of contents + +### Properties + +- [attributes](payloads_invitepayload.default.md#attributes) +- [id](payloads_invitepayload.default.md#id) +- [relationships](payloads_invitepayload.default.md#relationships) +- [type](payloads_invitepayload.default.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `arrived` | `boolean` | +| `been-here-before` | `boolean` | +| `edit-token` | `string` | +| `email` | ``null`` \| `string` | +| `employee-screening-flow` | `boolean` | +| `expected-arrival-time` | `string` | +| `flow-id` | `string` | +| `flow-name` | `string` | +| `full-name` | `string` | +| `inviter-email` | ``null`` \| `string` | +| `inviter-name` | ``null`` \| `string` | +| `legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `nda?` | `string` | +| `photo-url` | ``null`` \| `string` | +| `preregistration-complete` | `boolean` | +| `private-notes` | ``null`` \| `string` | +| `qr-code` | ``null`` \| `string` | +| `qr-code-sent-at` | ``null`` \| `string` | +| `reminder-sent-at` | ``null`` \| `string` | +| `secret-token` | `string` | +| `signed-in-at?` | `string` | +| `signed-out-at?` | `string` | +| `user-data` | { `field`: `string` ; `value`: ``null`` \| `string` }[] | + +#### Defined in + +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L6) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[payloads/InvitePayload.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L4) + +___ + +### relationships + +• **relationships**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `agreeable-ndas?` | `Object` | +| `agreeable-ndas.data` | `default`<``"agreeable-ndas"``, string\>[] | +| `employee?` | `Object` | +| `employee.data` | `default`<``"employees"``, string\> | +| `entry?` | `Object` | +| `entry.data` | `default`<``"entries"``, string\> | +| `flow?` | `Object` | +| `flow.data` | `default`<``"flows"``, string\> | +| `location` | `Object` | +| `location.data` | `default`<``"locations"``, string\> | + +#### Defined in + +[payloads/InvitePayload.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L41) + +___ + +### type + +• **type**: ``"invites"`` + +#### Defined in + +[payloads/InvitePayload.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L5) diff --git a/docs/modules/index.md b/docs/modules/index.md new file mode 100644 index 0000000..5106f4c --- /dev/null +++ b/docs/modules/index.md @@ -0,0 +1,309 @@ +[@envoy/envoy-integrations-sdk](../README.md) / index + +# Module: index + +## Table of contents + +### Enumerations + +- [HttpStatus](../enums/index.httpstatus.md) + +### Classes + +- [EnvoyJWT](../classes/index.envoyjwt.md) +- [EnvoyPluginAPI](../classes/index.envoypluginapi.md) +- [EnvoyPluginJob](../classes/index.envoypluginjob.md) +- [EnvoyPluginSDK](../classes/index.envoypluginsdk.md) +- [EnvoyPluginStorage](../classes/index.envoypluginstorage.md) +- [EnvoyPluginStoragePipeline](../classes/index.envoypluginstoragepipeline.md) +- [EnvoySignatureVerifier](../classes/index.envoysignatureverifier.md) +- [EnvoyUserAPI](../classes/index.envoyuserapi.md) + +### Interfaces + +- [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md) +- [EnvoyEventMeta](../interfaces/index.envoyeventmeta.md) +- [EnvoyMetaCompany](../interfaces/index.envoymetacompany.md) +- [EnvoyMetaJob](../interfaces/index.envoymetajob.md) +- [EnvoyMetaLocation](../interfaces/index.envoymetalocation.md) +- [EnvoyResponse](../interfaces/index.envoyresponse.md) +- [EnvoyRouteMeta](../interfaces/index.envoyroutemeta.md) +- [EnvoySignatureVerifierOptions](../interfaces/index.envoysignatureverifieroptions.md) +- [VerifiedRequest](../interfaces/index.verifiedrequest.md) + +### Type aliases + +- [EnvoyEntryEventRequest](index.md#envoyentryeventrequest) +- [EnvoyEventRequest](index.md#envoyeventrequest) +- [EnvoyInviteEventRequest](index.md#envoyinviteeventrequest) +- [EnvoyMetaAuth](index.md#envoymetaauth) +- [EnvoyMiddleware](index.md#envoymiddleware) +- [EnvoyRequest](index.md#envoyrequest) +- [EnvoyRouteRequest](index.md#envoyrouterequest) +- [EnvoyStorageItem](index.md#envoystorageitem) + +### Variables + +- [VERIFIED](index.md#verified) + +### Functions + +- [asyncHandler](index.md#asynchandler) +- [errorMiddleware](index.md#errormiddleware) +- [middleware](index.md#middleware) + +## Type aliases + +### EnvoyEntryEventRequest + +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](index.md#envoyeventrequest)<[default](../interfaces/payloads_entrypayload.default.md)\> + +Use to type your `req` object in entry event handlers, +such as handlers for `entry_sign_in`. + +#### Defined in + +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L33) + +___ + +### EnvoyEventRequest + +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md)<[EnvoyEventMeta](../interfaces/index.envoyeventmeta.md), Payload\> + +Use to type your `req` object in route handlers, +such as validation URLS or options URLs. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L27) + +___ + +### EnvoyInviteEventRequest + +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](index.md#envoyeventrequest)<[default](../interfaces/payloads_invitepayload.default.md)\> + +Use to type your `req` object in invite event handlers, +such as handlers for `invite_created` or `upcoming_visit`. + +#### Defined in + +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L39) + +___ + +### EnvoyMetaAuth + +Ƭ **EnvoyMetaAuth**: `Object` + +A short-lived userAPI token. +Will be used to construct the userAPI property +found in req.envoy.userAPI. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `access_token` | `string` | +| `expires_in` | `number` | +| `refresh_token` | `string` \| ``null`` | +| `refresh_token_expires_in` | `number` \| ``null`` | +| `token_type` | ``"Bearer"`` | + +#### Defined in + +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L43) + +___ + +### EnvoyMiddleware + +Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](index.md#envoyrequest), `res`: [EnvoyResponse](../interfaces/index.envoyresponse.md), `next`: `NextFunction`) => `void` + +#### Type declaration + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyRequest](index.md#envoyrequest) | +| `res` | [EnvoyResponse](../interfaces/index.envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/middleware.ts#L12) + +___ + +### EnvoyRequest + +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md)<[EnvoyRouteMeta](../interfaces/index.envoyroutemeta.md) \| [EnvoyEventMeta](../interfaces/index.envoyeventmeta.md), Payload\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L41) + +___ + +### EnvoyRouteRequest + +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md)<[EnvoyRouteMeta](../interfaces/index.envoyroutemeta.md), Payload\> + +Use to type your `req` object in route handlers, +such as validation URLS or options URLs. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L21) + +___ + +### EnvoyStorageItem + +Ƭ **EnvoyStorageItem**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `unknown` | + +#### Defined in + +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyStorageItem.ts#L1) + +## Variables + +### VERIFIED + +• `Const` **VERIFIED**: typeof [VERIFIED](index.md#verified) + +#### Defined in + +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L7) + +## Functions + +### asyncHandler + +▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](index.md#envoyrequest), `res`: [EnvoyResponse](../interfaces/index.envoyresponse.md), `next`: `NextFunction`) => `Promise` + +Catches Promise-based errors. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | `RequestHandler` \| `EnvoyHandler` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `Promise` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyRequest](index.md#envoyrequest) | +| `res` | [EnvoyResponse](../interfaces/index.envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`Promise` + +#### Defined in + +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/asyncHandler.ts#L10) + +___ + +### errorMiddleware + +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](index.md#envoyrequest), `res`: [EnvoyResponse](../interfaces/index.envoyresponse.md), `next`: `NextFunction`) => `void` + +Catches errors and sets the proper status code. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `onError` | (`err`: `Error`) => `void` | + +#### Returns + +`fn` + +▸ (`err`, `req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `req` | [EnvoyRequest](index.md#envoyrequest) | +| `res` | [EnvoyResponse](../interfaces/index.envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/errorMiddleware.ts#L9) + +___ + +### middleware + +▸ **middleware**(`options?`): [EnvoyMiddleware](index.md#envoymiddleware) + +Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. +Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. + +Also verifies that the request is coming from Envoy, +as well as managing the plugin access token lifecycle. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [EnvoySignatureVerifierOptions](../interfaces/index.envoysignatureverifieroptions.md) | + +#### Returns + +[EnvoyMiddleware](index.md#envoymiddleware) + +#### Defined in + +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/middleware.ts#L21) diff --git a/docs/modules/payloads_entrypayload.md b/docs/modules/payloads_entrypayload.md new file mode 100644 index 0000000..3deb400 --- /dev/null +++ b/docs/modules/payloads_entrypayload.md @@ -0,0 +1,9 @@ +[@envoy/envoy-integrations-sdk](../README.md) / payloads/EntryPayload + +# Module: payloads/EntryPayload + +## Table of contents + +### Interfaces + +- [default](../interfaces/payloads_entrypayload.default.md) diff --git a/docs/modules/payloads_invitepayload.md b/docs/modules/payloads_invitepayload.md new file mode 100644 index 0000000..ef9d87c --- /dev/null +++ b/docs/modules/payloads_invitepayload.md @@ -0,0 +1,9 @@ +[@envoy/envoy-integrations-sdk](../README.md) / payloads/InvitePayload + +# Module: payloads/InvitePayload + +## Table of contents + +### Interfaces + +- [default](../interfaces/payloads_invitepayload.default.md) diff --git a/src/index.ts b/src/index.ts index 75223a4..5d3bbf8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -14,6 +14,8 @@ import EnvoyPluginAPI from './EnvoyPluginAPI'; import HttpStatus from './HttpStatus'; import middleware, { EnvoyMiddleware } from './middleware'; +export * from './EnvoyMeta'; +export * from './EnvoyRequest'; export { asyncHandler, errorMiddleware, diff --git a/typedoc.json b/typedoc.json index e2bc5f8..fa36893 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,5 @@ { - "entryPoints": ["./src/index.ts"], + "entryPoints": ["./src/index.ts", "./src/payloads"], "out": "docs", "excludePrivate": true, "excludeProtected": true, From 5338e75946ee6da93f9c3083aebdcd06f1c1897c Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:06:10 -0400 Subject: [PATCH 15/91] fixing docs --- docs/README.md | 410 +++++++++++++++++- .../{index.envoyjwt.md => envoyjwt.md} | 16 +- ...ex.envoypluginapi.md => envoypluginapi.md} | 44 +- ...ex.envoypluginjob.md => envoypluginjob.md} | 44 +- ...ex.envoypluginsdk.md => envoypluginsdk.md} | 78 ++-- ...pluginstorage.md => envoypluginstorage.md} | 68 ++- ...eline.md => envoypluginstoragepipeline.md} | 84 ++-- ...everifier.md => envoysignatureverifier.md} | 14 +- ...{index.envoyuserapi.md => envoyuserapi.md} | 104 +++-- .../{index.httpstatus.md => httpstatus.md} | 20 +- docs/interfaces/envoybaserequest.md | 47 ++ docs/interfaces/envoyeventmeta.md | 98 +++++ ...nvoymetacompany.md => envoymetacompany.md} | 16 +- ...{index.envoymetajob.md => envoymetajob.md} | 16 +- ...oymetalocation.md => envoymetalocation.md} | 16 +- ...ndex.envoyresponse.md => envoyresponse.md} | 26 +- ...ex.envoyroutemeta.md => envoyroutemeta.md} | 46 +- .../envoysignatureverifieroptions.md | 52 +++ docs/interfaces/index.envoybaserequest.md | 49 --- docs/interfaces/index.envoyeventmeta.md | 100 ----- .../index.envoysignatureverifieroptions.md | 54 --- docs/interfaces/index.verifiedrequest.md | 29 -- .../payloads_entrypayload.default.md | 95 ---- .../payloads_invitepayload.default.md | 97 ----- docs/interfaces/verifiedrequest.md | 27 ++ docs/modules/index.md | 309 ------------- docs/modules/payloads_entrypayload.md | 9 - docs/modules/payloads_invitepayload.md | 9 - src/index.ts | 4 + src/payloads/EntryPayload.ts | 6 +- src/payloads/InvitePayload.ts | 6 +- typedoc.json | 2 +- 32 files changed, 925 insertions(+), 1070 deletions(-) rename docs/classes/{index.envoyjwt.md => envoyjwt.md} (75%) rename docs/classes/{index.envoypluginapi.md => envoypluginapi.md} (67%) rename docs/classes/{index.envoypluginjob.md => envoypluginjob.md} (71%) rename docs/classes/{index.envoypluginsdk.md => envoypluginsdk.md} (60%) rename docs/classes/{index.envoypluginstorage.md => envoypluginstorage.md} (54%) rename docs/classes/{index.envoypluginstoragepipeline.md => envoypluginstoragepipeline.md} (52%) rename docs/classes/{index.envoysignatureverifier.md => envoysignatureverifier.md} (60%) rename docs/classes/{index.envoyuserapi.md => envoyuserapi.md} (72%) rename docs/enums/{index.httpstatus.md => httpstatus.md} (57%) create mode 100644 docs/interfaces/envoybaserequest.md create mode 100644 docs/interfaces/envoyeventmeta.md rename docs/interfaces/{index.envoymetacompany.md => envoymetacompany.md} (59%) rename docs/interfaces/{index.envoymetajob.md => envoymetajob.md} (54%) rename docs/interfaces/{index.envoymetalocation.md => envoymetalocation.md} (71%) rename docs/interfaces/{index.envoyresponse.md => envoyresponse.md} (71%) rename docs/interfaces/{index.envoyroutemeta.md => envoyroutemeta.md} (53%) create mode 100644 docs/interfaces/envoysignatureverifieroptions.md delete mode 100644 docs/interfaces/index.envoybaserequest.md delete mode 100644 docs/interfaces/index.envoyeventmeta.md delete mode 100644 docs/interfaces/index.envoysignatureverifieroptions.md delete mode 100644 docs/interfaces/index.verifiedrequest.md delete mode 100644 docs/interfaces/payloads_entrypayload.default.md delete mode 100644 docs/interfaces/payloads_invitepayload.default.md create mode 100644 docs/interfaces/verifiedrequest.md delete mode 100644 docs/modules/index.md delete mode 100644 docs/modules/payloads_entrypayload.md delete mode 100644 docs/modules/payloads_invitepayload.md diff --git a/docs/README.md b/docs/README.md index 3abcb20..ee02653 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,8 +4,410 @@ ## Table of contents -### Modules +### Enumerations -- [index](modules/index.md) -- [payloads/EntryPayload](modules/payloads_entrypayload.md) -- [payloads/InvitePayload](modules/payloads_invitepayload.md) +- [HttpStatus](enums/httpstatus.md) + +### Classes + +- [EnvoyJWT](classes/envoyjwt.md) +- [EnvoyPluginAPI](classes/envoypluginapi.md) +- [EnvoyPluginJob](classes/envoypluginjob.md) +- [EnvoyPluginSDK](classes/envoypluginsdk.md) +- [EnvoyPluginStorage](classes/envoypluginstorage.md) +- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) +- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) +- [EnvoyUserAPI](classes/envoyuserapi.md) + +### Interfaces + +- [EnvoyBaseRequest](interfaces/envoybaserequest.md) +- [EnvoyEventMeta](interfaces/envoyeventmeta.md) +- [EnvoyMetaCompany](interfaces/envoymetacompany.md) +- [EnvoyMetaJob](interfaces/envoymetajob.md) +- [EnvoyMetaLocation](interfaces/envoymetalocation.md) +- [EnvoyResponse](interfaces/envoyresponse.md) +- [EnvoyRouteMeta](interfaces/envoyroutemeta.md) +- [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) +- [VerifiedRequest](interfaces/verifiedrequest.md) + +### Type aliases + +- [EntryPayload](README.md#entrypayload) +- [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) +- [EnvoyEventRequest](README.md#envoyeventrequest) +- [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) +- [EnvoyMetaAuth](README.md#envoymetaauth) +- [EnvoyMiddleware](README.md#envoymiddleware) +- [EnvoyRequest](README.md#envoyrequest) +- [EnvoyRouteRequest](README.md#envoyrouterequest) +- [EnvoyStorageItem](README.md#envoystorageitem) +- [InvitePayload](README.md#invitepayload) + +### Variables + +- [VERIFIED](README.md#verified) + +### Functions + +- [asyncHandler](README.md#asynchandler) +- [errorMiddleware](README.md#errormiddleware) +- [middleware](README.md#middleware) + +## Type aliases + +### EntryPayload + +Ƭ **EntryPayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.email` | `string` \| ``null`` | +| `attributes.employee-screening-flow` | `boolean` | +| `attributes.flow-name` | `string` | +| `attributes.full-name` | `string` | +| `attributes.host` | `string` \| ``null`` | +| `attributes.host-email` | `string` \| ``null`` | +| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `attributes.nda?` | `string` | +| `attributes.phone-number?` | `string` | +| `attributes.private-notes` | `string` \| ``null`` | +| `attributes.signed-in-at` | `string` | +| `attributes.signed-out-at?` | `string` | +| `attributes.thumbnails` | `Object` | +| `attributes.thumbnails.large` | `string` \| ``null`` | +| `attributes.thumbnails.original` | `string` \| ``null`` | +| `attributes.thumbnails.small` | `string` \| ``null`` | +| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | +| `id` | `string` | +| `relationships` | `Object` | +| `relationships.agreeable-ndas?` | `Object` | +| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | +| `relationships.device?` | `Object` | +| `relationships.device.data` | `JSONAPIData`<``"devices"``\> | +| `relationships.employee?` | `Object` | +| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | +| `relationships.flow?` | `Object` | +| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | +| `relationships.invite?` | `Object` | +| `relationships.invite.data` | `JSONAPIData`<``"invites"``\> | +| `relationships.location` | `Object` | +| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | +| `relationships.visitor-entrance?` | `Object` | +| `relationships.visitor-entrance.data` | `JSONAPIData`<``"visitor-entrances"``\> | +| `type` | ``"entries"`` | + +#### Defined in + +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/payloads/EntryPayload.ts#L3) + +___ + +### EnvoyEntryEventRequest + +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> + +Use to type your `req` object in entry event handlers, +such as handlers for `entry_sign_in`. + +#### Defined in + +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L33) + +___ + +### EnvoyEventRequest + +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](interfaces/envoyeventmeta.md), Payload\> + +Use to type your `req` object in route handlers, +such as validation URLS or options URLs. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L27) + +___ + +### EnvoyInviteEventRequest + +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> + +Use to type your `req` object in invite event handlers, +such as handlers for `invite_created` or `upcoming_visit`. + +#### Defined in + +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L39) + +___ + +### EnvoyMetaAuth + +Ƭ **EnvoyMetaAuth**: `Object` + +A short-lived userAPI token. +Will be used to construct the userAPI property +found in req.envoy.userAPI. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `access_token` | `string` | +| `expires_in` | `number` | +| `refresh_token` | `string` \| ``null`` | +| `refresh_token_expires_in` | `number` \| ``null`` | +| `token_type` | ``"Bearer"`` | + +#### Defined in + +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L43) + +___ + +### EnvoyMiddleware + +Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` + +#### Type declaration + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/middleware.ts#L12) + +___ + +### EnvoyRequest + +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](interfaces/envoyroutemeta.md) \| [EnvoyEventMeta](interfaces/envoyeventmeta.md), Payload\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L41) + +___ + +### EnvoyRouteRequest + +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](interfaces/envoyroutemeta.md), Payload\> + +Use to type your `req` object in route handlers, +such as validation URLS or options URLs. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L21) + +___ + +### EnvoyStorageItem + +Ƭ **EnvoyStorageItem**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `unknown` | + +#### Defined in + +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyStorageItem.ts#L1) + +___ + +### InvitePayload + +Ƭ **InvitePayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.arrived` | `boolean` | +| `attributes.been-here-before` | `boolean` | +| `attributes.edit-token` | `string` | +| `attributes.email` | `string` \| ``null`` | +| `attributes.employee-screening-flow` | `boolean` | +| `attributes.expected-arrival-time` | `string` | +| `attributes.flow-id` | `string` | +| `attributes.flow-name` | `string` | +| `attributes.full-name` | `string` | +| `attributes.inviter-email` | `string` \| ``null`` | +| `attributes.inviter-name` | `string` \| ``null`` | +| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `attributes.nda?` | `string` | +| `attributes.photo-url` | `string` \| ``null`` | +| `attributes.preregistration-complete` | `boolean` | +| `attributes.private-notes` | `string` \| ``null`` | +| `attributes.qr-code` | `string` \| ``null`` | +| `attributes.qr-code-sent-at` | `string` \| ``null`` | +| `attributes.reminder-sent-at` | `string` \| ``null`` | +| `attributes.secret-token` | `string` | +| `attributes.signed-in-at?` | `string` | +| `attributes.signed-out-at?` | `string` | +| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | +| `id` | `string` | +| `relationships` | `Object` | +| `relationships.agreeable-ndas?` | `Object` | +| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | +| `relationships.employee?` | `Object` | +| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | +| `relationships.entry?` | `Object` | +| `relationships.entry.data` | `JSONAPIData`<``"entries"``\> | +| `relationships.flow?` | `Object` | +| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | +| `relationships.location` | `Object` | +| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | +| `type` | ``"invites"`` | + +#### Defined in + +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/payloads/InvitePayload.ts#L3) + +## Variables + +### VERIFIED + +• `Const` **VERIFIED**: typeof [VERIFIED](README.md#verified) + +#### Defined in + +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L7) + +## Functions + +### asyncHandler + +▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` + +Catches Promise-based errors. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | `RequestHandler` \| `EnvoyHandler` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `Promise` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`Promise` + +#### Defined in + +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/asyncHandler.ts#L10) + +___ + +### errorMiddleware + +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` + +Catches errors and sets the proper status code. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `onError` | (`err`: `Error`) => `void` | + +#### Returns + +`fn` + +▸ (`err`, `req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/errorMiddleware.ts#L9) + +___ + +### middleware + +▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) + +Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. +Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. + +Also verifies that the request is coming from Envoy, +as well as managing the plugin access token lifecycle. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) | + +#### Returns + +[EnvoyMiddleware](README.md#envoymiddleware) + +#### Defined in + +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/middleware.ts#L21) diff --git a/docs/classes/index.envoyjwt.md b/docs/classes/envoyjwt.md similarity index 75% rename from docs/classes/index.envoyjwt.md rename to docs/classes/envoyjwt.md index e10e3d2..bd32fd7 100644 --- a/docs/classes/index.envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -1,21 +1,19 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyJWT +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyJWT # Class: EnvoyJWT -[index](../modules/index.md).EnvoyJWT - Helper to encode and decode JWTs. ## Table of contents ### Constructors -- [constructor](index.envoyjwt.md#constructor) +- [constructor](envoyjwt.md#constructor) ### Methods -- [decode](index.envoyjwt.md#decode) -- [encode](index.envoyjwt.md#encode) +- [decode](envoyjwt.md#decode) +- [encode](envoyjwt.md#encode) ## Constructors @@ -32,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyJWT.ts#L12) ## Methods @@ -53,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyJWT.ts#L39) ___ @@ -75,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/index.envoypluginapi.md b/docs/classes/envoypluginapi.md similarity index 67% rename from docs/classes/index.envoypluginapi.md rename to docs/classes/envoypluginapi.md index 1689804..1dc23c7 100644 --- a/docs/classes/index.envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginAPI +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginAPI # Class: EnvoyPluginAPI -[index](../modules/index.md).EnvoyPluginAPI - API endpoints for *plugin-scoped* tokens. ## Hierarchy @@ -16,20 +14,20 @@ API endpoints for *plugin-scoped* tokens. ### Constructors -- [constructor](index.envoypluginapi.md#constructor) +- [constructor](envoypluginapi.md#constructor) ### Properties -- [axios](index.envoypluginapi.md#axios) +- [axios](envoypluginapi.md#axios) ### Methods -- [createNotification](index.envoypluginapi.md#createnotification) -- [getPluginInstallConfig](index.envoypluginapi.md#getplugininstallconfig) -- [setPluginInstallConfig](index.envoypluginapi.md#setplugininstallconfig) -- [storagePipeline](index.envoypluginapi.md#storagepipeline) -- [updateJob](index.envoypluginapi.md#updatejob) -- [login](index.envoypluginapi.md#login) +- [createNotification](envoypluginapi.md#createnotification) +- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) +- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) +- [storagePipeline](envoypluginapi.md#storagepipeline) +- [updateJob](envoypluginapi.md#updatejob) +- [login](envoypluginapi.md#login) ## Constructors @@ -49,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L58) ## Properties @@ -65,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L31) ## Methods @@ -86,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L50) ___ @@ -106,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L21) ___ @@ -127,13 +125,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L26) ___ ### storagePipeline -▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Parameters @@ -144,11 +142,11 @@ ___ #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L34) ___ @@ -169,13 +167,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L13) ___ ### login -▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> +▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a plugin access token using `client_credentials` as the grant type. @@ -188,8 +186,8 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Returns -`Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/index.envoypluginjob.md b/docs/classes/envoypluginjob.md similarity index 71% rename from docs/classes/index.envoypluginjob.md rename to docs/classes/envoypluginjob.md index a4044e6..ffaa0f9 100644 --- a/docs/classes/index.envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginJob +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginJob # Class: EnvoyPluginJob -[index](../modules/index.md).EnvoyPluginJob - A "job" is an event, like `entry_sign_in`. When your plugin handles the event, you can use this job concept to update the status (e.g. complete, failed, ignored) @@ -14,21 +12,21 @@ as well as attach extra data to the event's subject ### Constructors -- [constructor](index.envoypluginjob.md#constructor) +- [constructor](envoypluginjob.md#constructor) ### Properties -- [api](index.envoypluginjob.md#api) -- [id](index.envoypluginjob.md#id) +- [api](envoypluginjob.md#api) +- [id](envoypluginjob.md#id) ### Methods -- [attach](index.envoypluginjob.md#attach) -- [complete](index.envoypluginjob.md#complete) -- [execute](index.envoypluginjob.md#execute) -- [fail](index.envoypluginjob.md#fail) -- [ignore](index.envoypluginjob.md#ignore) -- [update](index.envoypluginjob.md#update) +- [attach](envoypluginjob.md#attach) +- [complete](envoypluginjob.md#complete) +- [execute](envoypluginjob.md#execute) +- [fail](envoypluginjob.md#fail) +- [ignore](envoypluginjob.md#ignore) +- [update](envoypluginjob.md#update) ## Constructors @@ -40,22 +38,22 @@ as well as attach extra data to the event's subject | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](index.envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | | `jobId` | `string` | #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L15) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](index.envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L13) ___ @@ -65,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L15) ## Methods @@ -85,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L43) ___ @@ -106,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L47) ___ @@ -129,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L22) ___ @@ -150,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L55) ___ @@ -171,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L51) ___ @@ -192,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/index.envoypluginsdk.md b/docs/classes/envoypluginsdk.md similarity index 60% rename from docs/classes/index.envoypluginsdk.md rename to docs/classes/envoypluginsdk.md index a09b668..7b56b1d 100644 --- a/docs/classes/index.envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginSDK +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginSDK # Class: EnvoyPluginSDK -[index](../modules/index.md).EnvoyPluginSDK - Sets up all relevant Envoy functions. Attaches itself to every request object using our `middleware`, to allow for easy access to Envoy functions. @@ -19,20 +17,20 @@ to allow for easy access to Envoy functions. ### Constructors -- [constructor](index.envoypluginsdk.md#constructor) +- [constructor](envoypluginsdk.md#constructor) ### Accessors -- [getJob](index.envoypluginsdk.md#getjob) -- [globalStorage](index.envoypluginsdk.md#globalstorage) -- [installStorage](index.envoypluginsdk.md#installstorage) -- [job](index.envoypluginsdk.md#job) -- [jobId](index.envoypluginsdk.md#jobid) -- [jwt](index.envoypluginsdk.md#jwt) -- [meta](index.envoypluginsdk.md#meta) -- [payload](index.envoypluginsdk.md#payload) -- [pluginAPI](index.envoypluginsdk.md#pluginapi) -- [userAPI](index.envoypluginsdk.md#userapi) +- [getJob](envoypluginsdk.md#getjob) +- [globalStorage](envoypluginsdk.md#globalstorage) +- [installStorage](envoypluginsdk.md#installstorage) +- [job](envoypluginsdk.md#job) +- [jobId](envoypluginsdk.md#jobid) +- [jwt](envoypluginsdk.md#jwt) +- [meta](envoypluginsdk.md#meta) +- [payload](envoypluginsdk.md#payload) +- [pluginAPI](envoypluginsdk.md#pluginapi) +- [userAPI](envoypluginsdk.md#userapi) ## Constructors @@ -57,13 +55,13 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L38) ## Accessors ### getJob -• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](index.envoypluginjob.md) +• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](envoypluginjob.md) Returns a job based on an ID. @@ -71,7 +69,7 @@ Returns a job based on an ID. `fn` -▸ (`jobId`): [EnvoyPluginJob](index.envoypluginjob.md) +▸ (`jobId`): [EnvoyPluginJob](envoypluginjob.md) ##### Parameters @@ -81,59 +79,59 @@ Returns a job based on an ID. ##### Returns -[EnvoyPluginJob](index.envoypluginjob.md) +[EnvoyPluginJob](envoypluginjob.md) #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L129) ___ ### globalStorage -• `get` **globalStorage**(): [EnvoyPluginStorage](index.envoypluginstorage.md) +• `get` **globalStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) Storage scoped globally (across installs). #### Returns -[EnvoyPluginStorage](index.envoypluginstorage.md) +[EnvoyPluginStorage](envoypluginstorage.md) #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L122) ___ ### installStorage -• `get` **installStorage**(): [EnvoyPluginStorage](index.envoypluginstorage.md) +• `get` **installStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) Storage scoped to the install. #### Returns -[EnvoyPluginStorage](index.envoypluginstorage.md) +[EnvoyPluginStorage](envoypluginstorage.md) #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L111) ___ ### job -• `get` **job**(): [EnvoyPluginJob](index.envoypluginjob.md) +• `get` **job**(): [EnvoyPluginJob](envoypluginjob.md) Perform operations on the current job. #### Returns -[EnvoyPluginJob](index.envoypluginjob.md) +[EnvoyPluginJob](envoypluginjob.md) #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L147) ___ @@ -149,24 +147,24 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L136) ___ ### jwt -• `get` **jwt**(): [EnvoyJWT](index.envoyjwt.md) +• `get` **jwt**(): [EnvoyJWT](envoyjwt.md) A utility to encode and decode JWTs. Useful for verifiable communications between plugin endpoints. #### Returns -[EnvoyJWT](index.envoyjwt.md) +[EnvoyJWT](envoyjwt.md) #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L160) ___ @@ -183,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L50) ___ @@ -201,38 +199,38 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L62) ___ ### pluginAPI -• `get` **pluginAPI**(): [EnvoyPluginAPI](index.envoypluginapi.md) +• `get` **pluginAPI**(): [EnvoyPluginAPI](envoypluginapi.md) Envoy API scoped to the plugin. Used to perform storage or job operations. #### Returns -[EnvoyPluginAPI](index.envoypluginapi.md) +[EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L90) ___ ### userAPI -• `get` **userAPI**(): [EnvoyUserAPI](index.envoyuserapi.md) +• `get` **userAPI**(): [EnvoyUserAPI](envoyuserapi.md) Envoy API scoped to the user. Used only in routes. #### Returns -[EnvoyUserAPI](index.envoyuserapi.md) +[EnvoyUserAPI](envoyuserapi.md) #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/index.envoypluginstorage.md b/docs/classes/envoypluginstorage.md similarity index 54% rename from docs/classes/index.envoypluginstorage.md rename to docs/classes/envoypluginstorage.md index c317266..a9fdcf8 100644 --- a/docs/classes/index.envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginStorage +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStorage # Class: EnvoyPluginStorage -[index](../modules/index.md).EnvoyPluginStorage - A key-value storage that can be scoped to a specific install, or to the plugin itself. @@ -11,21 +9,21 @@ or to the plugin itself. ### Constructors -- [constructor](index.envoypluginstorage.md#constructor) +- [constructor](envoypluginstorage.md#constructor) ### Properties -- [api](index.envoypluginstorage.md#api) -- [installId](index.envoypluginstorage.md#installid) +- [api](envoypluginstorage.md#api) +- [installId](envoypluginstorage.md#installid) ### Methods -- [get](index.envoypluginstorage.md#get) -- [pipeline](index.envoypluginstorage.md#pipeline) -- [set](index.envoypluginstorage.md#set) -- [setUnique](index.envoypluginstorage.md#setunique) -- [setUniqueNum](index.envoypluginstorage.md#setuniquenum) -- [unset](index.envoypluginstorage.md#unset) +- [get](envoypluginstorage.md#get) +- [pipeline](envoypluginstorage.md#pipeline) +- [set](envoypluginstorage.md#set) +- [setUnique](envoypluginstorage.md#setunique) +- [setUniqueNum](envoypluginstorage.md#setuniquenum) +- [unset](envoypluginstorage.md#unset) ## Constructors @@ -37,22 +35,22 @@ or to the plugin itself. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](index.envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L13) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](index.envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L11) ___ @@ -62,13 +60,13 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L13) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline get. @@ -80,33 +78,33 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L30) ___ ### pipeline -▸ **pipeline**(): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **pipeline**(): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Creates a new pipeline instance. #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L23) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline set. @@ -119,17 +117,17 @@ Wrapper for single pipeline set. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L37) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -142,17 +140,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L44) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -165,17 +163,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L51) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline unset. Returns null if the item did not previously exist. @@ -188,8 +186,8 @@ Returns null if the item did not previously exist. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/index.envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md similarity index 52% rename from docs/classes/index.envoypluginstoragepipeline.md rename to docs/classes/envoypluginstoragepipeline.md index ed9ba19..716c482 100644 --- a/docs/classes/index.envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -1,32 +1,30 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyPluginStoragePipeline +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStoragePipeline # Class: EnvoyPluginStoragePipeline -[index](../modules/index.md).EnvoyPluginStoragePipeline - Builds up a request pipeline for submitting storage commands. ## Table of contents ### Constructors -- [constructor](index.envoypluginstoragepipeline.md#constructor) +- [constructor](envoypluginstoragepipeline.md#constructor) ### Properties -- [api](index.envoypluginstoragepipeline.md#api) -- [installId](index.envoypluginstoragepipeline.md#installid) +- [api](envoypluginstoragepipeline.md#api) +- [installId](envoypluginstoragepipeline.md#installid) ### Methods -- [addCommand](index.envoypluginstoragepipeline.md#addcommand) -- [execute](index.envoypluginstoragepipeline.md#execute) -- [executeSingle](index.envoypluginstoragepipeline.md#executesingle) -- [get](index.envoypluginstoragepipeline.md#get) -- [set](index.envoypluginstoragepipeline.md#set) -- [setUnique](index.envoypluginstoragepipeline.md#setunique) -- [setUniqueNum](index.envoypluginstoragepipeline.md#setuniquenum) -- [unset](index.envoypluginstoragepipeline.md#unset) +- [addCommand](envoypluginstoragepipeline.md#addcommand) +- [execute](envoypluginstoragepipeline.md#execute) +- [executeSingle](envoypluginstoragepipeline.md#executesingle) +- [get](envoypluginstoragepipeline.md#get) +- [set](envoypluginstoragepipeline.md#set) +- [setUnique](envoypluginstoragepipeline.md#setunique) +- [setUniqueNum](envoypluginstoragepipeline.md#setuniquenum) +- [unset](envoypluginstoragepipeline.md#unset) ## Constructors @@ -38,22 +36,22 @@ Builds up a request pipeline for submitting storage commands. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](index.envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](index.envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -63,13 +61,13 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods ### addCommand -▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Parameters @@ -79,49 +77,49 @@ ___ #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L39) ___ ### execute -▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> +▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> Executes all the commands in the pipeline. #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L27) ___ ### executeSingle -▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Executes the pipeline and returns the first result. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../modules/index.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L34) ___ ### get -▸ **get**(`key`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **get**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Gets a storage item. @@ -133,17 +131,17 @@ Gets a storage item. #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L47) ___ ### set -▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Sets a value for a storage item, and returns that item. @@ -157,17 +155,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L55) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Sets a unique value for a storage item, and returns that item. @@ -181,17 +179,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L63) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Sets a unique number value for a storage item, and returns that item. @@ -205,17 +203,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L71) ___ ### unset -▸ **unset**(`key`): [EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +▸ **unset**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Unsets a storage item. @@ -227,8 +225,8 @@ Unsets a storage item. #### Returns -[EnvoyPluginStoragePipeline](index.envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/index.envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md similarity index 60% rename from docs/classes/index.envoysignatureverifier.md rename to docs/classes/envoysignatureverifier.md index 449c9ee..b4c3052 100644 --- a/docs/classes/index.envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -1,20 +1,18 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoySignatureVerifier +[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifier # Class: EnvoySignatureVerifier -[index](../modules/index.md).EnvoySignatureVerifier - Verifies that a request is coming from Envoy. ## Table of contents ### Constructors -- [constructor](index.envoysignatureverifier.md#constructor) +- [constructor](envoysignatureverifier.md#constructor) ### Methods -- [verify](index.envoysignatureverifier.md#verify) +- [verify](envoysignatureverifier.md#verify) ## Constructors @@ -26,11 +24,11 @@ Verifies that a request is coming from Envoy. | Name | Type | | :------ | :------ | -| `options` | [EnvoySignatureVerifierOptions](../interfaces/index.envoysignatureverifieroptions.md) | +| `options` | [EnvoySignatureVerifierOptions](../interfaces/envoysignatureverifieroptions.md) | #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -53,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/index.envoyuserapi.md b/docs/classes/envoyuserapi.md similarity index 72% rename from docs/classes/index.envoyuserapi.md rename to docs/classes/envoyuserapi.md index 2355c40..d4f7f66 100644 --- a/docs/classes/index.envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyUserAPI +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyUserAPI # Class: EnvoyUserAPI -[index](../modules/index.md).EnvoyUserAPI - API endpoints for *user-scoped* tokens. To access Envoy resources, this is the API you'd want. @@ -17,35 +15,35 @@ To access Envoy resources, this is the API you'd want. ### Constructors -- [constructor](index.envoyuserapi.md#constructor) +- [constructor](envoyuserapi.md#constructor) ### Properties -- [axios](index.envoyuserapi.md#axios) +- [axios](envoyuserapi.md#axios) ### Methods -- [createInvite](index.envoyuserapi.md#createinvite) -- [getAgreement](index.envoyuserapi.md#getagreement) -- [getAgreementPage](index.envoyuserapi.md#getagreementpage) -- [getCompany](index.envoyuserapi.md#getcompany) -- [getEmployee](index.envoyuserapi.md#getemployee) -- [getEmployeeByEmail](index.envoyuserapi.md#getemployeebyemail) -- [getEmployees](index.envoyuserapi.md#getemployees) -- [getFlow](index.envoyuserapi.md#getflow) -- [getFlows](index.envoyuserapi.md#getflows) -- [getInvites](index.envoyuserapi.md#getinvites) -- [getLocation](index.envoyuserapi.md#getlocation) -- [getLocations](index.envoyuserapi.md#getlocations) -- [getSignInField](index.envoyuserapi.md#getsigninfield) -- [getSignInFieldPage](index.envoyuserapi.md#getsigninfieldpage) -- [getSignInFields](index.envoyuserapi.md#getsigninfields) -- [me](index.envoyuserapi.md#me) -- [partialUpdateInvite](index.envoyuserapi.md#partialupdateinvite) -- [removeInvite](index.envoyuserapi.md#removeinvite) -- [updateInvite](index.envoyuserapi.md#updateinvite) -- [loginAsPluginInstaller](index.envoyuserapi.md#loginasplugininstaller) -- [loginAsUser](index.envoyuserapi.md#loginasuser) +- [createInvite](envoyuserapi.md#createinvite) +- [getAgreement](envoyuserapi.md#getagreement) +- [getAgreementPage](envoyuserapi.md#getagreementpage) +- [getCompany](envoyuserapi.md#getcompany) +- [getEmployee](envoyuserapi.md#getemployee) +- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) +- [getEmployees](envoyuserapi.md#getemployees) +- [getFlow](envoyuserapi.md#getflow) +- [getFlows](envoyuserapi.md#getflows) +- [getInvites](envoyuserapi.md#getinvites) +- [getLocation](envoyuserapi.md#getlocation) +- [getLocations](envoyuserapi.md#getlocations) +- [getSignInField](envoyuserapi.md#getsigninfield) +- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) +- [getSignInFields](envoyuserapi.md#getsigninfields) +- [me](envoyuserapi.md#me) +- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) +- [removeInvite](envoyuserapi.md#removeinvite) +- [updateInvite](envoyuserapi.md#updateinvite) +- [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) +- [loginAsUser](envoyuserapi.md#loginasuser) ## Constructors @@ -65,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L58) ## Properties @@ -81,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L31) ## Methods @@ -101,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L111) ___ @@ -122,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L28) ___ @@ -143,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L24) ___ @@ -164,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L32) ___ @@ -185,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L36) ___ @@ -206,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L56) ___ @@ -226,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L75) ___ @@ -247,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L40) ___ @@ -267,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L82) ___ @@ -287,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L99) ___ @@ -308,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L44) ___ @@ -328,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L87) ___ @@ -349,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L52) ___ @@ -370,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L48) ___ @@ -390,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L94) ___ @@ -404,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L106) ___ @@ -425,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L130) ___ @@ -445,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L140) ___ @@ -466,13 +464,13 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L120) ___ ### loginAsPluginInstaller -▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> +▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `plugin_install` as the grant type. @@ -486,17 +484,17 @@ Gets a user access token using `plugin_install` as the grant type. #### Returns -`Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L177) ___ ### loginAsUser -▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> +▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `password` as the grant type (discouraged). @@ -511,8 +509,8 @@ Gets a user access token using `password` as the grant type (discouraged). #### Returns -`Promise`<[EnvoyMetaAuth](../modules/index.md#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/index.httpstatus.md b/docs/enums/httpstatus.md similarity index 57% rename from docs/enums/index.httpstatus.md rename to docs/enums/httpstatus.md index c2cbed1..23fbda1 100644 --- a/docs/enums/index.httpstatus.md +++ b/docs/enums/httpstatus.md @@ -1,19 +1,17 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / HttpStatus +[@envoy/envoy-integrations-sdk](../README.md) / HttpStatus # Enumeration: HttpStatus -[index](../modules/index.md).HttpStatus - Use these status codes to inform Envoy of a job's or route's status. ## Table of contents ### Enumeration members -- [FAILED](index.httpstatus.md#failed) -- [IGNORED](index.httpstatus.md#ignored) -- [ONGOING](index.httpstatus.md#ongoing) -- [UNEXPECTED\_FAILURE](index.httpstatus.md#unexpected_failure) +- [FAILED](httpstatus.md#failed) +- [IGNORED](httpstatus.md#ignored) +- [ONGOING](httpstatus.md#ongoing) +- [UNEXPECTED\_FAILURE](httpstatus.md#unexpected_failure) ## Enumeration members @@ -23,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L7) ___ @@ -33,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L6) ___ @@ -43,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L5) ___ @@ -53,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md new file mode 100644 index 0000000..185401a --- /dev/null +++ b/docs/interfaces/envoybaserequest.md @@ -0,0 +1,47 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyBaseRequest + +# Interface: EnvoyBaseRequest + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Payload` | `Payload` = `unknown` | + +## Hierarchy + +- [VerifiedRequest](verifiedrequest.md) + + ↳ **EnvoyBaseRequest** + +## Table of contents + +### Properties + +- [[VERIFIED]](envoybaserequest.md#[verified]) +- [envoy](envoybaserequest.md#envoy) + +## Properties + +### [VERIFIED] + +• **[VERIFIED]**: `boolean` + +#### Inherited from + +[VerifiedRequest](verifiedrequest.md).[[VERIFIED]](verifiedrequest.md#[verified]) + +#### Defined in + +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L10) + +___ + +### envoy + +• **envoy**: [EnvoyPluginSDK](../classes/envoypluginsdk.md) + +#### Defined in + +[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L14) diff --git a/docs/interfaces/envoyeventmeta.md b/docs/interfaces/envoyeventmeta.md new file mode 100644 index 0000000..1cd887c --- /dev/null +++ b/docs/interfaces/envoyeventmeta.md @@ -0,0 +1,98 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyEventMeta + +# Interface: EnvoyEventMeta + +Metadata that will be included in the request body for events. + +## Table of contents + +### Properties + +- [auth](envoyeventmeta.md#auth) +- [company](envoyeventmeta.md#company) +- [config](envoyeventmeta.md#config) +- [event](envoyeventmeta.md#event) +- [install\_id](envoyeventmeta.md#install_id) +- [job](envoyeventmeta.md#job) +- [location](envoyeventmeta.md#location) +- [plugin\_id](envoyeventmeta.md#plugin_id) + +## Properties + +### auth + +• **auth**: ``null`` \| [EnvoyMetaAuth](../README.md#envoymetaauth) + +#### Defined in + +[EnvoyMeta.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L62) + +___ + +### company + +• **company**: [EnvoyMetaCompany](envoymetacompany.md) + +#### Defined in + +[EnvoyMeta.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L61) + +___ + +### config + +• **config**: `Record` + +#### Defined in + +[EnvoyMeta.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L58) + +___ + +### event + +• **event**: `string` + +#### Defined in + +[EnvoyMeta.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L55) + +___ + +### install\_id + +• **install\_id**: `string` + +#### Defined in + +[EnvoyMeta.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L57) + +___ + +### job + +• **job**: [EnvoyMetaJob](envoymetajob.md) + +#### Defined in + +[EnvoyMeta.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L59) + +___ + +### location + +• **location**: [EnvoyMetaLocation](envoymetalocation.md) + +#### Defined in + +[EnvoyMeta.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L60) + +___ + +### plugin\_id + +• **plugin\_id**: `string` + +#### Defined in + +[EnvoyMeta.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L56) diff --git a/docs/interfaces/index.envoymetacompany.md b/docs/interfaces/envoymetacompany.md similarity index 59% rename from docs/interfaces/index.envoymetacompany.md rename to docs/interfaces/envoymetacompany.md index c27a3ca..96e791b 100644 --- a/docs/interfaces/index.envoymetacompany.md +++ b/docs/interfaces/envoymetacompany.md @@ -1,16 +1,14 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyMetaCompany +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyMetaCompany # Interface: EnvoyMetaCompany -[index](../modules/index.md).EnvoyMetaCompany - ## Table of contents ### Properties -- [attributes](index.envoymetacompany.md#attributes) -- [id](index.envoymetacompany.md#id) -- [type](index.envoymetacompany.md#type) +- [attributes](envoymetacompany.md#attributes) +- [id](envoymetacompany.md#id) +- [type](envoymetacompany.md#type) ## Properties @@ -28,7 +26,7 @@ #### Defined in -[EnvoyMeta.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L31) +[EnvoyMeta.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L31) ___ @@ -38,7 +36,7 @@ ___ #### Defined in -[EnvoyMeta.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L29) +[EnvoyMeta.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L29) ___ @@ -48,4 +46,4 @@ ___ #### Defined in -[EnvoyMeta.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L30) +[EnvoyMeta.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L30) diff --git a/docs/interfaces/index.envoymetajob.md b/docs/interfaces/envoymetajob.md similarity index 54% rename from docs/interfaces/index.envoymetajob.md rename to docs/interfaces/envoymetajob.md index 394c3c2..94ba1ab 100644 --- a/docs/interfaces/index.envoymetajob.md +++ b/docs/interfaces/envoymetajob.md @@ -1,16 +1,14 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyMetaJob +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyMetaJob # Interface: EnvoyMetaJob -[index](../modules/index.md).EnvoyMetaJob - ## Table of contents ### Properties -- [id](index.envoymetajob.md#id) -- [identifier](index.envoymetajob.md#identifier) -- [name](index.envoymetajob.md#name) +- [id](envoymetajob.md#id) +- [identifier](envoymetajob.md#identifier) +- [name](envoymetajob.md#name) ## Properties @@ -20,7 +18,7 @@ #### Defined in -[EnvoyMeta.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L2) +[EnvoyMeta.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L2) ___ @@ -30,7 +28,7 @@ ___ #### Defined in -[EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L4) +[EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L4) ___ @@ -40,4 +38,4 @@ ___ #### Defined in -[EnvoyMeta.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L3) +[EnvoyMeta.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L3) diff --git a/docs/interfaces/index.envoymetalocation.md b/docs/interfaces/envoymetalocation.md similarity index 71% rename from docs/interfaces/index.envoymetalocation.md rename to docs/interfaces/envoymetalocation.md index 5ced759..e7ae182 100644 --- a/docs/interfaces/index.envoymetalocation.md +++ b/docs/interfaces/envoymetalocation.md @@ -1,16 +1,14 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyMetaLocation +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyMetaLocation # Interface: EnvoyMetaLocation -[index](../modules/index.md).EnvoyMetaLocation - ## Table of contents ### Properties -- [attributes](index.envoymetalocation.md#attributes) -- [id](index.envoymetalocation.md#id) -- [type](index.envoymetalocation.md#type) +- [attributes](envoymetalocation.md#attributes) +- [id](envoymetalocation.md#id) +- [type](envoymetalocation.md#type) ## Properties @@ -39,7 +37,7 @@ #### Defined in -[EnvoyMeta.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L10) +[EnvoyMeta.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L10) ___ @@ -49,7 +47,7 @@ ___ #### Defined in -[EnvoyMeta.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L8) +[EnvoyMeta.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L8) ___ @@ -59,4 +57,4 @@ ___ #### Defined in -[EnvoyMeta.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L9) +[EnvoyMeta.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L9) diff --git a/docs/interfaces/index.envoyresponse.md b/docs/interfaces/envoyresponse.md similarity index 71% rename from docs/interfaces/index.envoyresponse.md rename to docs/interfaces/envoyresponse.md index 8e9cab7..41b3ab9 100644 --- a/docs/interfaces/index.envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyResponse +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyResponse # Interface: EnvoyResponse -[index](../modules/index.md).EnvoyResponse - Use to type your `res` object in Envoy request handlers. ## Hierarchy @@ -16,20 +14,20 @@ Use to type your `res` object in Envoy request handlers. ### Properties -- [send](index.envoyresponse.md#send) -- [sendFailed](index.envoyresponse.md#sendfailed) -- [sendIgnored](index.envoyresponse.md#sendignored) -- [sendOngoing](index.envoyresponse.md#sendongoing) +- [send](envoyresponse.md#send) +- [sendFailed](envoyresponse.md#sendfailed) +- [sendIgnored](envoyresponse.md#sendignored) +- [sendOngoing](envoyresponse.md#sendongoing) ## Properties ### send -• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](index.envoyresponse.md) +• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](envoyresponse.md) #### Type declaration -▸ (`debugInfo?`): [EnvoyResponse](index.envoyresponse.md) +▸ (`debugInfo?`): [EnvoyResponse](envoyresponse.md) ##### Parameters @@ -39,7 +37,7 @@ Use to type your `res` object in Envoy request handlers. ##### Returns -[EnvoyResponse](index.envoyresponse.md) +[EnvoyResponse](envoyresponse.md) #### Overrides @@ -47,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L8) ___ @@ -73,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L11) ___ @@ -99,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L10) ___ @@ -123,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/index.envoyroutemeta.md b/docs/interfaces/envoyroutemeta.md similarity index 53% rename from docs/interfaces/index.envoyroutemeta.md rename to docs/interfaces/envoyroutemeta.md index 25e6288..2c5f232 100644 --- a/docs/interfaces/index.envoyroutemeta.md +++ b/docs/interfaces/envoyroutemeta.md @@ -1,9 +1,7 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyRouteMeta +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyRouteMeta # Interface: EnvoyRouteMeta -[index](../modules/index.md).EnvoyRouteMeta - Metadata that will be included in the request body for setup routes, like validation URLs or options URLs. @@ -11,35 +9,35 @@ like validation URLs or options URLs. ### Properties -- [auth](index.envoyroutemeta.md#auth) -- [company](index.envoyroutemeta.md#company) -- [config](index.envoyroutemeta.md#config) -- [forwarded\_bearer\_token](index.envoyroutemeta.md#forwarded_bearer_token) -- [install\_id](index.envoyroutemeta.md#install_id) -- [location](index.envoyroutemeta.md#location) -- [params](index.envoyroutemeta.md#params) -- [plugin\_id](index.envoyroutemeta.md#plugin_id) -- [route](index.envoyroutemeta.md#route) +- [auth](envoyroutemeta.md#auth) +- [company](envoyroutemeta.md#company) +- [config](envoyroutemeta.md#config) +- [forwarded\_bearer\_token](envoyroutemeta.md#forwarded_bearer_token) +- [install\_id](envoyroutemeta.md#install_id) +- [location](envoyroutemeta.md#location) +- [params](envoyroutemeta.md#params) +- [plugin\_id](envoyroutemeta.md#plugin_id) +- [route](envoyroutemeta.md#route) ## Properties ### auth -• **auth**: ``null`` \| [EnvoyMetaAuth](../modules/index.md#envoymetaauth) +• **auth**: ``null`` \| [EnvoyMetaAuth](../README.md#envoymetaauth) #### Defined in -[EnvoyMeta.ts:77](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L77) +[EnvoyMeta.ts:77](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L77) ___ ### company -• **company**: [EnvoyMetaCompany](index.envoymetacompany.md) +• **company**: [EnvoyMetaCompany](envoymetacompany.md) #### Defined in -[EnvoyMeta.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L76) +[EnvoyMeta.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L76) ___ @@ -49,7 +47,7 @@ ___ #### Defined in -[EnvoyMeta.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L73) +[EnvoyMeta.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L73) ___ @@ -59,7 +57,7 @@ ___ #### Defined in -[EnvoyMeta.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L78) +[EnvoyMeta.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L78) ___ @@ -69,17 +67,17 @@ ___ #### Defined in -[EnvoyMeta.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L72) +[EnvoyMeta.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L72) ___ ### location -• **location**: [EnvoyMetaLocation](index.envoymetalocation.md) +• **location**: [EnvoyMetaLocation](envoymetalocation.md) #### Defined in -[EnvoyMeta.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L75) +[EnvoyMeta.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L75) ___ @@ -89,7 +87,7 @@ ___ #### Defined in -[EnvoyMeta.ts:74](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L74) +[EnvoyMeta.ts:74](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L74) ___ @@ -99,7 +97,7 @@ ___ #### Defined in -[EnvoyMeta.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L71) +[EnvoyMeta.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L71) ___ @@ -109,4 +107,4 @@ ___ #### Defined in -[EnvoyMeta.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L70) +[EnvoyMeta.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L70) diff --git a/docs/interfaces/envoysignatureverifieroptions.md b/docs/interfaces/envoysignatureverifieroptions.md new file mode 100644 index 0000000..16a9ddb --- /dev/null +++ b/docs/interfaces/envoysignatureverifieroptions.md @@ -0,0 +1,52 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifierOptions + +# Interface: EnvoySignatureVerifierOptions + +## Table of contents + +### Properties + +- [algorithm](envoysignatureverifieroptions.md#algorithm) +- [encoding](envoysignatureverifieroptions.md#encoding) +- [header](envoysignatureverifieroptions.md#header) +- [secret](envoysignatureverifieroptions.md#secret) + +## Properties + +### algorithm + +• **algorithm**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L6) + +___ + +### encoding + +• **encoding**: `BinaryToTextEncoding` + +#### Defined in + +[EnvoySignatureVerifier.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L7) + +___ + +### header + +• **header**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L9) + +___ + +### secret + +• **secret**: `string` + +#### Defined in + +[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L8) diff --git a/docs/interfaces/index.envoybaserequest.md b/docs/interfaces/index.envoybaserequest.md deleted file mode 100644 index 4f996ac..0000000 --- a/docs/interfaces/index.envoybaserequest.md +++ /dev/null @@ -1,49 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyBaseRequest - -# Interface: EnvoyBaseRequest - -[index](../modules/index.md).EnvoyBaseRequest - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | -| `Payload` | `Payload` = `unknown` | - -## Hierarchy - -- [VerifiedRequest](index.verifiedrequest.md) - - ↳ **EnvoyBaseRequest** - -## Table of contents - -### Properties - -- [[VERIFIED]](index.envoybaserequest.md#[verified]) -- [envoy](index.envoybaserequest.md#envoy) - -## Properties - -### [VERIFIED] - -• **[VERIFIED]**: `boolean` - -#### Inherited from - -[VerifiedRequest](index.verifiedrequest.md).[[VERIFIED]](index.verifiedrequest.md#[verified]) - -#### Defined in - -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L10) - -___ - -### envoy - -• **envoy**: [EnvoyPluginSDK](../classes/index.envoypluginsdk.md) - -#### Defined in - -[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L14) diff --git a/docs/interfaces/index.envoyeventmeta.md b/docs/interfaces/index.envoyeventmeta.md deleted file mode 100644 index 27226c5..0000000 --- a/docs/interfaces/index.envoyeventmeta.md +++ /dev/null @@ -1,100 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoyEventMeta - -# Interface: EnvoyEventMeta - -[index](../modules/index.md).EnvoyEventMeta - -Metadata that will be included in the request body for events. - -## Table of contents - -### Properties - -- [auth](index.envoyeventmeta.md#auth) -- [company](index.envoyeventmeta.md#company) -- [config](index.envoyeventmeta.md#config) -- [event](index.envoyeventmeta.md#event) -- [install\_id](index.envoyeventmeta.md#install_id) -- [job](index.envoyeventmeta.md#job) -- [location](index.envoyeventmeta.md#location) -- [plugin\_id](index.envoyeventmeta.md#plugin_id) - -## Properties - -### auth - -• **auth**: ``null`` \| [EnvoyMetaAuth](../modules/index.md#envoymetaauth) - -#### Defined in - -[EnvoyMeta.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L62) - -___ - -### company - -• **company**: [EnvoyMetaCompany](index.envoymetacompany.md) - -#### Defined in - -[EnvoyMeta.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L61) - -___ - -### config - -• **config**: `Record` - -#### Defined in - -[EnvoyMeta.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L58) - -___ - -### event - -• **event**: `string` - -#### Defined in - -[EnvoyMeta.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L55) - -___ - -### install\_id - -• **install\_id**: `string` - -#### Defined in - -[EnvoyMeta.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L57) - -___ - -### job - -• **job**: [EnvoyMetaJob](index.envoymetajob.md) - -#### Defined in - -[EnvoyMeta.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L59) - -___ - -### location - -• **location**: [EnvoyMetaLocation](index.envoymetalocation.md) - -#### Defined in - -[EnvoyMeta.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L60) - -___ - -### plugin\_id - -• **plugin\_id**: `string` - -#### Defined in - -[EnvoyMeta.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L56) diff --git a/docs/interfaces/index.envoysignatureverifieroptions.md b/docs/interfaces/index.envoysignatureverifieroptions.md deleted file mode 100644 index 5731371..0000000 --- a/docs/interfaces/index.envoysignatureverifieroptions.md +++ /dev/null @@ -1,54 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / EnvoySignatureVerifierOptions - -# Interface: EnvoySignatureVerifierOptions - -[index](../modules/index.md).EnvoySignatureVerifierOptions - -## Table of contents - -### Properties - -- [algorithm](index.envoysignatureverifieroptions.md#algorithm) -- [encoding](index.envoysignatureverifieroptions.md#encoding) -- [header](index.envoysignatureverifieroptions.md#header) -- [secret](index.envoysignatureverifieroptions.md#secret) - -## Properties - -### algorithm - -• **algorithm**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L6) - -___ - -### encoding - -• **encoding**: `BinaryToTextEncoding` - -#### Defined in - -[EnvoySignatureVerifier.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L7) - -___ - -### header - -• **header**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L9) - -___ - -### secret - -• **secret**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoySignatureVerifier.ts#L8) diff --git a/docs/interfaces/index.verifiedrequest.md b/docs/interfaces/index.verifiedrequest.md deleted file mode 100644 index e796071..0000000 --- a/docs/interfaces/index.verifiedrequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [index](../modules/index.md) / VerifiedRequest - -# Interface: VerifiedRequest - -[index](../modules/index.md).VerifiedRequest - -## Hierarchy - -- `Request` - - ↳ **VerifiedRequest** - - ↳↳ [EnvoyBaseRequest](index.envoybaserequest.md) - -## Table of contents - -### Properties - -- [[VERIFIED]](index.verifiedrequest.md#[verified]) - -## Properties - -### [VERIFIED] - -• **[VERIFIED]**: `boolean` - -#### Defined in - -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L10) diff --git a/docs/interfaces/payloads_entrypayload.default.md b/docs/interfaces/payloads_entrypayload.default.md deleted file mode 100644 index e8b51dd..0000000 --- a/docs/interfaces/payloads_entrypayload.default.md +++ /dev/null @@ -1,95 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [payloads/EntryPayload](../modules/payloads_entrypayload.md) / default - -# Interface: default - -[payloads/EntryPayload](../modules/payloads_entrypayload.md).default - -## Table of contents - -### Properties - -- [attributes](payloads_entrypayload.default.md#attributes) -- [id](payloads_entrypayload.default.md#id) -- [relationships](payloads_entrypayload.default.md#relationships) -- [type](payloads_entrypayload.default.md#type) - -## Properties - -### attributes - -• **attributes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | ``null`` \| `string` | -| `employee-screening-flow` | `boolean` | -| `flow-name` | `string` | -| `full-name` | `string` | -| `host` | ``null`` \| `string` | -| `host-email` | ``null`` \| `string` | -| `legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | -| `nda?` | `string` | -| `phone-number?` | `string` | -| `private-notes` | ``null`` \| `string` | -| `signed-in-at` | `string` | -| `signed-out-at?` | `string` | -| `thumbnails` | `Object` | -| `thumbnails.large` | ``null`` \| `string` | -| `thumbnails.original` | ``null`` \| `string` | -| `thumbnails.small` | ``null`` \| `string` | -| `user-data` | { `field`: `string` ; `value`: ``null`` \| `string` }[] | - -#### Defined in - -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L6) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[payloads/EntryPayload.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L4) - -___ - -### relationships - -• **relationships**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `agreeable-ndas?` | `Object` | -| `agreeable-ndas.data` | `default`<``"agreeable-ndas"``, string\>[] | -| `device?` | `Object` | -| `device.data` | `default`<``"devices"``, string\> | -| `employee?` | `Object` | -| `employee.data` | `default`<``"employees"``, string\> | -| `flow?` | `Object` | -| `flow.data` | `default`<``"flows"``, string\> | -| `invite?` | `Object` | -| `invite.data` | `default`<``"invites"``, string\> | -| `location` | `Object` | -| `location.data` | `default`<``"locations"``, string\> | -| `visitor-entrance?` | `Object` | -| `visitor-entrance.data` | `default`<``"visitor-entrances"``, string\> | - -#### Defined in - -[payloads/EntryPayload.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L36) - -___ - -### type - -• **type**: ``"entries"`` - -#### Defined in - -[payloads/EntryPayload.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/EntryPayload.ts#L5) diff --git a/docs/interfaces/payloads_invitepayload.default.md b/docs/interfaces/payloads_invitepayload.default.md deleted file mode 100644 index d34c770..0000000 --- a/docs/interfaces/payloads_invitepayload.default.md +++ /dev/null @@ -1,97 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / [payloads/InvitePayload](../modules/payloads_invitepayload.md) / default - -# Interface: default - -[payloads/InvitePayload](../modules/payloads_invitepayload.md).default - -## Table of contents - -### Properties - -- [attributes](payloads_invitepayload.default.md#attributes) -- [id](payloads_invitepayload.default.md#id) -- [relationships](payloads_invitepayload.default.md#relationships) -- [type](payloads_invitepayload.default.md#type) - -## Properties - -### attributes - -• **attributes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `arrived` | `boolean` | -| `been-here-before` | `boolean` | -| `edit-token` | `string` | -| `email` | ``null`` \| `string` | -| `employee-screening-flow` | `boolean` | -| `expected-arrival-time` | `string` | -| `flow-id` | `string` | -| `flow-name` | `string` | -| `full-name` | `string` | -| `inviter-email` | ``null`` \| `string` | -| `inviter-name` | ``null`` \| `string` | -| `legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | -| `nda?` | `string` | -| `photo-url` | ``null`` \| `string` | -| `preregistration-complete` | `boolean` | -| `private-notes` | ``null`` \| `string` | -| `qr-code` | ``null`` \| `string` | -| `qr-code-sent-at` | ``null`` \| `string` | -| `reminder-sent-at` | ``null`` \| `string` | -| `secret-token` | `string` | -| `signed-in-at?` | `string` | -| `signed-out-at?` | `string` | -| `user-data` | { `field`: `string` ; `value`: ``null`` \| `string` }[] | - -#### Defined in - -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L6) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[payloads/InvitePayload.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L4) - -___ - -### relationships - -• **relationships**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `agreeable-ndas?` | `Object` | -| `agreeable-ndas.data` | `default`<``"agreeable-ndas"``, string\>[] | -| `employee?` | `Object` | -| `employee.data` | `default`<``"employees"``, string\> | -| `entry?` | `Object` | -| `entry.data` | `default`<``"entries"``, string\> | -| `flow?` | `Object` | -| `flow.data` | `default`<``"flows"``, string\> | -| `location` | `Object` | -| `location.data` | `default`<``"locations"``, string\> | - -#### Defined in - -[payloads/InvitePayload.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L41) - -___ - -### type - -• **type**: ``"invites"`` - -#### Defined in - -[payloads/InvitePayload.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/payloads/InvitePayload.ts#L5) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md new file mode 100644 index 0000000..9a810be --- /dev/null +++ b/docs/interfaces/verifiedrequest.md @@ -0,0 +1,27 @@ +[@envoy/envoy-integrations-sdk](../README.md) / VerifiedRequest + +# Interface: VerifiedRequest + +## Hierarchy + +- `Request` + + ↳ **VerifiedRequest** + + ↳↳ [EnvoyBaseRequest](envoybaserequest.md) + +## Table of contents + +### Properties + +- [[VERIFIED]](verifiedrequest.md#[verified]) + +## Properties + +### [VERIFIED] + +• **[VERIFIED]**: `boolean` + +#### Defined in + +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L10) diff --git a/docs/modules/index.md b/docs/modules/index.md deleted file mode 100644 index 5106f4c..0000000 --- a/docs/modules/index.md +++ /dev/null @@ -1,309 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / index - -# Module: index - -## Table of contents - -### Enumerations - -- [HttpStatus](../enums/index.httpstatus.md) - -### Classes - -- [EnvoyJWT](../classes/index.envoyjwt.md) -- [EnvoyPluginAPI](../classes/index.envoypluginapi.md) -- [EnvoyPluginJob](../classes/index.envoypluginjob.md) -- [EnvoyPluginSDK](../classes/index.envoypluginsdk.md) -- [EnvoyPluginStorage](../classes/index.envoypluginstorage.md) -- [EnvoyPluginStoragePipeline](../classes/index.envoypluginstoragepipeline.md) -- [EnvoySignatureVerifier](../classes/index.envoysignatureverifier.md) -- [EnvoyUserAPI](../classes/index.envoyuserapi.md) - -### Interfaces - -- [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md) -- [EnvoyEventMeta](../interfaces/index.envoyeventmeta.md) -- [EnvoyMetaCompany](../interfaces/index.envoymetacompany.md) -- [EnvoyMetaJob](../interfaces/index.envoymetajob.md) -- [EnvoyMetaLocation](../interfaces/index.envoymetalocation.md) -- [EnvoyResponse](../interfaces/index.envoyresponse.md) -- [EnvoyRouteMeta](../interfaces/index.envoyroutemeta.md) -- [EnvoySignatureVerifierOptions](../interfaces/index.envoysignatureverifieroptions.md) -- [VerifiedRequest](../interfaces/index.verifiedrequest.md) - -### Type aliases - -- [EnvoyEntryEventRequest](index.md#envoyentryeventrequest) -- [EnvoyEventRequest](index.md#envoyeventrequest) -- [EnvoyInviteEventRequest](index.md#envoyinviteeventrequest) -- [EnvoyMetaAuth](index.md#envoymetaauth) -- [EnvoyMiddleware](index.md#envoymiddleware) -- [EnvoyRequest](index.md#envoyrequest) -- [EnvoyRouteRequest](index.md#envoyrouterequest) -- [EnvoyStorageItem](index.md#envoystorageitem) - -### Variables - -- [VERIFIED](index.md#verified) - -### Functions - -- [asyncHandler](index.md#asynchandler) -- [errorMiddleware](index.md#errormiddleware) -- [middleware](index.md#middleware) - -## Type aliases - -### EnvoyEntryEventRequest - -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](index.md#envoyeventrequest)<[default](../interfaces/payloads_entrypayload.default.md)\> - -Use to type your `req` object in entry event handlers, -such as handlers for `entry_sign_in`. - -#### Defined in - -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L33) - -___ - -### EnvoyEventRequest - -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md)<[EnvoyEventMeta](../interfaces/index.envoyeventmeta.md), Payload\> - -Use to type your `req` object in route handlers, -such as validation URLS or options URLs. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Payload` | `Payload` = `unknown` | - -#### Defined in - -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L27) - -___ - -### EnvoyInviteEventRequest - -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](index.md#envoyeventrequest)<[default](../interfaces/payloads_invitepayload.default.md)\> - -Use to type your `req` object in invite event handlers, -such as handlers for `invite_created` or `upcoming_visit`. - -#### Defined in - -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L39) - -___ - -### EnvoyMetaAuth - -Ƭ **EnvoyMetaAuth**: `Object` - -A short-lived userAPI token. -Will be used to construct the userAPI property -found in req.envoy.userAPI. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `access_token` | `string` | -| `expires_in` | `number` | -| `refresh_token` | `string` \| ``null`` | -| `refresh_token_expires_in` | `number` \| ``null`` | -| `token_type` | ``"Bearer"`` | - -#### Defined in - -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyMeta.ts#L43) - -___ - -### EnvoyMiddleware - -Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](index.md#envoyrequest), `res`: [EnvoyResponse](../interfaces/index.envoyresponse.md), `next`: `NextFunction`) => `void` - -#### Type declaration - -▸ (`req`, `res`, `next`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | [EnvoyRequest](index.md#envoyrequest) | -| `res` | [EnvoyResponse](../interfaces/index.envoyresponse.md) | -| `next` | `NextFunction` | - -##### Returns - -`void` - -#### Defined in - -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/middleware.ts#L12) - -___ - -### EnvoyRequest - -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md)<[EnvoyRouteMeta](../interfaces/index.envoyroutemeta.md) \| [EnvoyEventMeta](../interfaces/index.envoyeventmeta.md), Payload\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Payload` | `Payload` = `unknown` | - -#### Defined in - -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L41) - -___ - -### EnvoyRouteRequest - -Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](../interfaces/index.envoybaserequest.md)<[EnvoyRouteMeta](../interfaces/index.envoyroutemeta.md), Payload\> - -Use to type your `req` object in route handlers, -such as validation URLS or options URLs. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Payload` | `Payload` = `unknown` | - -#### Defined in - -[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L21) - -___ - -### EnvoyStorageItem - -Ƭ **EnvoyStorageItem**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `unknown` | - -#### Defined in - -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyStorageItem.ts#L1) - -## Variables - -### VERIFIED - -• `Const` **VERIFIED**: typeof [VERIFIED](index.md#verified) - -#### Defined in - -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/EnvoyRequest.ts#L7) - -## Functions - -### asyncHandler - -▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](index.md#envoyrequest), `res`: [EnvoyResponse](../interfaces/index.envoyresponse.md), `next`: `NextFunction`) => `Promise` - -Catches Promise-based errors. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `handler` | `RequestHandler` \| `EnvoyHandler` | - -#### Returns - -`fn` - -▸ (`req`, `res`, `next`): `Promise` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | [EnvoyRequest](index.md#envoyrequest) | -| `res` | [EnvoyResponse](../interfaces/index.envoyresponse.md) | -| `next` | `NextFunction` | - -##### Returns - -`Promise` - -#### Defined in - -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/asyncHandler.ts#L10) - -___ - -### errorMiddleware - -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](index.md#envoyrequest), `res`: [EnvoyResponse](../interfaces/index.envoyresponse.md), `next`: `NextFunction`) => `void` - -Catches errors and sets the proper status code. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onError` | (`err`: `Error`) => `void` | - -#### Returns - -`fn` - -▸ (`err`, `req`, `res`, `next`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `req` | [EnvoyRequest](index.md#envoyrequest) | -| `res` | [EnvoyResponse](../interfaces/index.envoyresponse.md) | -| `next` | `NextFunction` | - -##### Returns - -`void` - -#### Defined in - -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/errorMiddleware.ts#L9) - -___ - -### middleware - -▸ **middleware**(`options?`): [EnvoyMiddleware](index.md#envoymiddleware) - -Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. -Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. - -Also verifies that the request is coming from Envoy, -as well as managing the plugin access token lifecycle. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [EnvoySignatureVerifierOptions](../interfaces/index.envoysignatureverifieroptions.md) | - -#### Returns - -[EnvoyMiddleware](index.md#envoymiddleware) - -#### Defined in - -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d8fa581/src/middleware.ts#L21) diff --git a/docs/modules/payloads_entrypayload.md b/docs/modules/payloads_entrypayload.md deleted file mode 100644 index 3deb400..0000000 --- a/docs/modules/payloads_entrypayload.md +++ /dev/null @@ -1,9 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / payloads/EntryPayload - -# Module: payloads/EntryPayload - -## Table of contents - -### Interfaces - -- [default](../interfaces/payloads_entrypayload.default.md) diff --git a/docs/modules/payloads_invitepayload.md b/docs/modules/payloads_invitepayload.md deleted file mode 100644 index ef9d87c..0000000 --- a/docs/modules/payloads_invitepayload.md +++ /dev/null @@ -1,9 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / payloads/InvitePayload - -# Module: payloads/InvitePayload - -## Table of contents - -### Interfaces - -- [default](../interfaces/payloads_invitepayload.default.md) diff --git a/src/index.ts b/src/index.ts index 5d3bbf8..8b98051 100644 --- a/src/index.ts +++ b/src/index.ts @@ -13,12 +13,16 @@ import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; import HttpStatus from './HttpStatus'; import middleware, { EnvoyMiddleware } from './middleware'; +import EntryPayload from './payloads/EntryPayload'; +import InvitePayload from './payloads/InvitePayload'; export * from './EnvoyMeta'; export * from './EnvoyRequest'; export { asyncHandler, errorMiddleware, + EntryPayload, + InvitePayload, EnvoyJWT, EnvoyMiddleware, EnvoyPluginJob, diff --git a/src/payloads/EntryPayload.ts b/src/payloads/EntryPayload.ts index 31f2b44..757d222 100644 --- a/src/payloads/EntryPayload.ts +++ b/src/payloads/EntryPayload.ts @@ -1,6 +1,6 @@ import JSONAPIData from '../util/json-api/JSONAPIData'; -export default interface EntryPayload { +type EntryPayload = { id: string, type: 'entries', attributes: { @@ -56,4 +56,6 @@ export default interface EntryPayload { data: Array>, } } -} +}; + +export default EntryPayload; diff --git a/src/payloads/InvitePayload.ts b/src/payloads/InvitePayload.ts index a40c223..c3d5a9f 100644 --- a/src/payloads/InvitePayload.ts +++ b/src/payloads/InvitePayload.ts @@ -1,6 +1,6 @@ import JSONAPIData from '../util/json-api/JSONAPIData'; -export default interface InvitePayload { +type InvitePayload = { id: string, type: 'invites', attributes: { @@ -55,4 +55,6 @@ export default interface InvitePayload { data: Array>, } } -} +}; + +export default InvitePayload; diff --git a/typedoc.json b/typedoc.json index fa36893..e2bc5f8 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,5 @@ { - "entryPoints": ["./src/index.ts", "./src/payloads"], + "entryPoints": ["./src/index.ts"], "out": "docs", "excludePrivate": true, "excludeProtected": true, From af53dd282458a3a119bf128e4f00cadc70b67dbf Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:07:51 -0400 Subject: [PATCH 16/91] fixing docs --- src/index.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/index.ts b/src/index.ts index 8b98051..7bca1e0 100644 --- a/src/index.ts +++ b/src/index.ts @@ -13,16 +13,16 @@ import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; import HttpStatus from './HttpStatus'; import middleware, { EnvoyMiddleware } from './middleware'; -import EntryPayload from './payloads/EntryPayload'; -import InvitePayload from './payloads/InvitePayload'; +// import EntryPayload from './payloads/EntryPayload'; +// import InvitePayload from './payloads/InvitePayload'; export * from './EnvoyMeta'; export * from './EnvoyRequest'; export { asyncHandler, errorMiddleware, - EntryPayload, - InvitePayload, + // EntryPayload, + // InvitePayload, EnvoyJWT, EnvoyMiddleware, EnvoyPluginJob, From fbf2ead2c4c13cace8f3de2c0f6e77b8c9c76fe2 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:12:03 -0400 Subject: [PATCH 17/91] fixing docs --- docs/README.md | 268 ++++++++++++--------- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 18 +- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 18 +- docs/classes/envoypluginstoragepipeline.md | 22 +- docs/classes/envoysignatureverifier.md | 6 +- docs/classes/envoyuserapi.md | 46 ++-- docs/enums/httpstatus.md | 8 +- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/verifiedrequest.md | 2 +- src/EnvoyMeta.ts | 20 +- src/EnvoySignatureVerifier.ts | 4 +- src/errorMiddleware.ts | 4 +- src/index.ts | 4 - 17 files changed, 255 insertions(+), 221 deletions(-) diff --git a/docs/README.md b/docs/README.md index ee02653..a6f0f44 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,27 +22,25 @@ ### Interfaces - [EnvoyBaseRequest](interfaces/envoybaserequest.md) -- [EnvoyEventMeta](interfaces/envoyeventmeta.md) -- [EnvoyMetaCompany](interfaces/envoymetacompany.md) -- [EnvoyMetaJob](interfaces/envoymetajob.md) -- [EnvoyMetaLocation](interfaces/envoymetalocation.md) - [EnvoyResponse](interfaces/envoyresponse.md) -- [EnvoyRouteMeta](interfaces/envoyroutemeta.md) -- [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) - [VerifiedRequest](interfaces/verifiedrequest.md) ### Type aliases -- [EntryPayload](README.md#entrypayload) - [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) +- [EnvoyEventMeta](README.md#envoyeventmeta) - [EnvoyEventRequest](README.md#envoyeventrequest) - [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) - [EnvoyMetaAuth](README.md#envoymetaauth) +- [EnvoyMetaCompany](README.md#envoymetacompany) +- [EnvoyMetaJob](README.md#envoymetajob) +- [EnvoyMetaLocation](README.md#envoymetalocation) - [EnvoyMiddleware](README.md#envoymiddleware) - [EnvoyRequest](README.md#envoyrequest) +- [EnvoyRouteMeta](README.md#envoyroutemeta) - [EnvoyRouteRequest](README.md#envoyrouterequest) +- [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) - [EnvoyStorageItem](README.md#envoystorageitem) -- [InvitePayload](README.md#invitepayload) ### Variables @@ -56,72 +54,47 @@ ## Type aliases -### EntryPayload - -Ƭ **EntryPayload**: `Object` +### EnvoyEntryEventRequest -#### Type declaration +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) -| Name | Type | -| :------ | :------ | -| `attributes` | `Object` | -| `attributes.email` | `string` \| ``null`` | -| `attributes.employee-screening-flow` | `boolean` | -| `attributes.flow-name` | `string` | -| `attributes.full-name` | `string` | -| `attributes.host` | `string` \| ``null`` | -| `attributes.host-email` | `string` \| ``null`` | -| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | -| `attributes.nda?` | `string` | -| `attributes.phone-number?` | `string` | -| `attributes.private-notes` | `string` \| ``null`` | -| `attributes.signed-in-at` | `string` | -| `attributes.signed-out-at?` | `string` | -| `attributes.thumbnails` | `Object` | -| `attributes.thumbnails.large` | `string` \| ``null`` | -| `attributes.thumbnails.original` | `string` \| ``null`` | -| `attributes.thumbnails.small` | `string` \| ``null`` | -| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | -| `id` | `string` | -| `relationships` | `Object` | -| `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | -| `relationships.device?` | `Object` | -| `relationships.device.data` | `JSONAPIData`<``"devices"``\> | -| `relationships.employee?` | `Object` | -| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | -| `relationships.flow?` | `Object` | -| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | -| `relationships.invite?` | `Object` | -| `relationships.invite.data` | `JSONAPIData`<``"invites"``\> | -| `relationships.location` | `Object` | -| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | -| `relationships.visitor-entrance?` | `Object` | -| `relationships.visitor-entrance.data` | `JSONAPIData`<``"visitor-entrances"``\> | -| `type` | ``"entries"`` | +Use to type your `req` object in entry event handlers, +such as handlers for `entry_sign_in`. #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/payloads/EntryPayload.ts#L3) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L33) ___ -### EnvoyEntryEventRequest +### EnvoyEventMeta -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> +Ƭ **EnvoyEventMeta**: `Object` -Use to type your `req` object in entry event handlers, -such as handlers for `entry_sign_in`. +Metadata that will be included in the request body for events. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | +| `config` | `Record` | +| `event` | `string` | +| `install_id` | `string` | +| `job` | [EnvoyMetaJob](README.md#envoymetajob) | +| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `plugin_id` | `string` | #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L33) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L54) ___ ### EnvoyEventRequest -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](interfaces/envoyeventmeta.md), Payload\> +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> Use to type your `req` object in route handlers, such as validation URLS or options URLs. @@ -134,20 +107,20 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L27) ___ ### EnvoyInviteEventRequest -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) Use to type your `req` object in invite event handlers, such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L39) ___ @@ -171,7 +144,78 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L43) + +___ + +### EnvoyMetaCompany + +Ƭ **EnvoyMetaCompany**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.active` | `boolean` | +| `attributes.created-at` | `string` | +| `attributes.name` | `string` | +| `id` | `string` | +| `type` | ``"companies"`` | + +#### Defined in + +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L28) + +___ + +### EnvoyMetaJob + +Ƭ **EnvoyMetaJob**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `identifier` | `string` | +| `name` | `string` | + +#### Defined in + +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L1) + +___ + +### EnvoyMetaLocation + +Ƭ **EnvoyMetaLocation**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.address` | `string` | +| `attributes.address-line-one` | `string` \| ``null`` | +| `attributes.address-line-two` | `string` \| ``null`` | +| `attributes.city` | `string` \| ``null`` | +| `attributes.company-name-override` | `string` \| ``null`` | +| `attributes.country` | `string` \| ``null`` | +| `attributes.created-at` | `string` | +| `attributes.latitude` | `number` \| ``null`` | +| `attributes.locale` | `string` \| ``null`` | +| `attributes.longitude` | `number` \| ``null`` | +| `attributes.name` | `string` | +| `attributes.state` | `string` \| ``null`` | +| `attributes.timezone` | `string` | +| `attributes.zip` | `string` \| ``null`` | +| `id` | `string` | +| `type` | ``"locations"`` | + +#### Defined in + +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L7) ___ @@ -197,13 +241,13 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/middleware.ts#L12) ___ ### EnvoyRequest -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](interfaces/envoyroutemeta.md) \| [EnvoyEventMeta](interfaces/envoyeventmeta.md), Payload\> +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> #### Type parameters @@ -213,13 +257,40 @@ ___ #### Defined in -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L41) + +___ + +### EnvoyRouteMeta + +Ƭ **EnvoyRouteMeta**: `Object` + +Metadata that will be included in the request body for setup routes, +like validation URLs or options URLs. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | +| `config` | `Record` | +| `forwarded_bearer_token?` | `string` | +| `install_id` | `string` | +| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `params` | `Record` | +| `plugin_id` | `string` | +| `route` | `string` | + +#### Defined in + +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L69) ___ ### EnvoyRouteRequest -Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](interfaces/envoyroutemeta.md), Payload\> +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> Use to type your `req` object in route handlers, such as validation URLS or options URLs. @@ -232,76 +303,43 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L21) +[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L21) ___ -### EnvoyStorageItem +### EnvoySignatureVerifierOptions -Ƭ **EnvoyStorageItem**: `Object` +Ƭ **EnvoySignatureVerifierOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `key` | `string` | -| `value` | `unknown` | +| `algorithm` | ``"sha256"`` \| `string` | +| `encoding` | `BinaryToTextEncoding` | +| `header` | ``"x-envoy-signature"`` \| `string` | +| `secret` | `string` | #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyStorageItem.ts#L1) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoySignatureVerifier.ts#L5) ___ -### InvitePayload +### EnvoyStorageItem -Ƭ **InvitePayload**: `Object` +Ƭ **EnvoyStorageItem**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `attributes` | `Object` | -| `attributes.arrived` | `boolean` | -| `attributes.been-here-before` | `boolean` | -| `attributes.edit-token` | `string` | -| `attributes.email` | `string` \| ``null`` | -| `attributes.employee-screening-flow` | `boolean` | -| `attributes.expected-arrival-time` | `string` | -| `attributes.flow-id` | `string` | -| `attributes.flow-name` | `string` | -| `attributes.full-name` | `string` | -| `attributes.inviter-email` | `string` \| ``null`` | -| `attributes.inviter-name` | `string` \| ``null`` | -| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | -| `attributes.nda?` | `string` | -| `attributes.photo-url` | `string` \| ``null`` | -| `attributes.preregistration-complete` | `boolean` | -| `attributes.private-notes` | `string` \| ``null`` | -| `attributes.qr-code` | `string` \| ``null`` | -| `attributes.qr-code-sent-at` | `string` \| ``null`` | -| `attributes.reminder-sent-at` | `string` \| ``null`` | -| `attributes.secret-token` | `string` | -| `attributes.signed-in-at?` | `string` | -| `attributes.signed-out-at?` | `string` | -| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | -| `id` | `string` | -| `relationships` | `Object` | -| `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | -| `relationships.employee?` | `Object` | -| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | -| `relationships.entry?` | `Object` | -| `relationships.entry.data` | `JSONAPIData`<``"entries"``\> | -| `relationships.flow?` | `Object` | -| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | -| `relationships.location` | `Object` | -| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | -| `type` | ``"invites"`` | +| `key` | `string` | +| `value` | `unknown` | #### Defined in -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/payloads/InvitePayload.ts#L3) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyStorageItem.ts#L1) ## Variables @@ -311,7 +349,7 @@ ___ #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L7) ## Functions @@ -347,7 +385,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/asyncHandler.ts#L10) ___ @@ -384,7 +422,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/errorMiddleware.ts#L9) ___ @@ -402,7 +440,7 @@ as well as managing the plugin access token lifecycle. | Name | Type | | :------ | :------ | -| `options?` | [EnvoySignatureVerifierOptions](interfaces/envoysignatureverifieroptions.md) | +| `options?` | [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) | #### Returns @@ -410,4 +448,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index bd32fd7..359e2c8 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 1dc23c7..3127cfe 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index ffaa0f9..d1e67c7 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 7b56b1d..1446df6 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index a9fdcf8..a65d67d 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 716c482..d6b2e03 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index b4c3052..a7b1af7 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -24,11 +24,11 @@ Verifies that a request is coming from Envoy. | Name | Type | | :------ | :------ | -| `options` | [EnvoySignatureVerifierOptions](../interfaces/envoysignatureverifieroptions.md) | +| `options` | [EnvoySignatureVerifierOptions](../README.md#envoysignatureverifieroptions) | #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index d4f7f66..5b14fd9 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 23fbda1..5a4ccee 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 185401a..9fbe7ae 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -34,7 +34,7 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L10) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L14) +[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L14) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 41b3ab9..69b728e 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md index 9a810be..0ff1798 100644 --- a/docs/interfaces/verifiedrequest.md +++ b/docs/interfaces/verifiedrequest.md @@ -24,4 +24,4 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L10) diff --git a/src/EnvoyMeta.ts b/src/EnvoyMeta.ts index b6b34e7..4aa8450 100644 --- a/src/EnvoyMeta.ts +++ b/src/EnvoyMeta.ts @@ -1,10 +1,10 @@ -export interface EnvoyMetaJob { +export type EnvoyMetaJob = { id: string, name: string, identifier: string, -} +}; -export interface EnvoyMetaLocation { +export type EnvoyMetaLocation = { id: string, type: 'locations', attributes: { @@ -23,9 +23,9 @@ export interface EnvoyMetaLocation { latitude: number | null, 'created-at': string, } -} +}; -export interface EnvoyMetaCompany { +export type EnvoyMetaCompany = { id: string, type: 'companies', attributes: { @@ -33,7 +33,7 @@ export interface EnvoyMetaCompany { active: boolean, 'created-at': string, } -} +}; /** * A short-lived userAPI token. @@ -51,7 +51,7 @@ export type EnvoyMetaAuth = { /** * Metadata that will be included in the request body for events. */ -export interface EnvoyEventMeta { +export type EnvoyEventMeta = { event: string, plugin_id: string, install_id: string, @@ -60,13 +60,13 @@ export interface EnvoyEventMeta { location: EnvoyMetaLocation, company: EnvoyMetaCompany, auth: EnvoyMetaAuth | null, -} +}; /** * Metadata that will be included in the request body for setup routes, * like validation URLs or options URLs. */ -export interface EnvoyRouteMeta { +export type EnvoyRouteMeta = { route: string, plugin_id: string, install_id: string, @@ -76,7 +76,7 @@ export interface EnvoyRouteMeta { company: EnvoyMetaCompany, auth: EnvoyMetaAuth | null, forwarded_bearer_token?: string, -} +}; /** * Metadata that will be included in every request Envoy sends to your plugin. diff --git a/src/EnvoySignatureVerifier.ts b/src/EnvoySignatureVerifier.ts index 13b3957..02be0e8 100644 --- a/src/EnvoySignatureVerifier.ts +++ b/src/EnvoySignatureVerifier.ts @@ -2,12 +2,12 @@ import crypto, { BinaryToTextEncoding } from 'crypto'; import { Request } from 'express'; import { envoyClientSecret } from './constants'; -export interface EnvoySignatureVerifierOptions { +export type EnvoySignatureVerifierOptions = { algorithm: 'sha256' | string, encoding: BinaryToTextEncoding, secret: string, header: 'x-envoy-signature' | string, -} +}; const defaultOptions: EnvoySignatureVerifierOptions = { algorithm: 'sha256', diff --git a/src/errorMiddleware.ts b/src/errorMiddleware.ts index 94c256e..bb7e33c 100644 --- a/src/errorMiddleware.ts +++ b/src/errorMiddleware.ts @@ -1,13 +1,13 @@ import { NextFunction } from 'express'; import HttpStatus from './HttpStatus'; -import EnvoyBaseRequest from './EnvoyRequest'; +import EnvoyRequest from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; /** * Catches errors and sets the proper status code. */ export default function errorMiddleware(onError: (err: Error) => void = () => {}) { - return (err: Error, req: EnvoyBaseRequest, res: EnvoyResponse, next: NextFunction): void => { + return (err: Error, req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): void => { onError(err); if (res.headersSent) { return next(err); diff --git a/src/index.ts b/src/index.ts index 7bca1e0..5d3bbf8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -13,16 +13,12 @@ import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; import HttpStatus from './HttpStatus'; import middleware, { EnvoyMiddleware } from './middleware'; -// import EntryPayload from './payloads/EntryPayload'; -// import InvitePayload from './payloads/InvitePayload'; export * from './EnvoyMeta'; export * from './EnvoyRequest'; export { asyncHandler, errorMiddleware, - // EntryPayload, - // InvitePayload, EnvoyJWT, EnvoyMiddleware, EnvoyPluginJob, From 981d571664f48d609c3972ba905b854b23632cd2 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:13:45 -0400 Subject: [PATCH 18/91] fixing docs --- docs/README.md | 144 +++++++++++++++--- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 18 +-- docs/classes/envoypluginsdk.md | 22 +-- docs/classes/envoypluginstorage.md | 18 +-- docs/classes/envoypluginstoragepipeline.md | 22 +-- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 46 +++--- docs/enums/httpstatus.md | 8 +- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyeventmeta.md | 98 ------------ docs/interfaces/envoymetacompany.md | 49 ------ docs/interfaces/envoymetajob.md | 41 ----- docs/interfaces/envoymetalocation.md | 60 -------- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/envoyroutemeta.md | 110 ------------- .../envoysignatureverifieroptions.md | 52 ------- docs/interfaces/verifiedrequest.md | 2 +- src/index.ts | 4 + 20 files changed, 215 insertions(+), 517 deletions(-) delete mode 100644 docs/interfaces/envoyeventmeta.md delete mode 100644 docs/interfaces/envoymetacompany.md delete mode 100644 docs/interfaces/envoymetajob.md delete mode 100644 docs/interfaces/envoymetalocation.md delete mode 100644 docs/interfaces/envoyroutemeta.md delete mode 100644 docs/interfaces/envoysignatureverifieroptions.md diff --git a/docs/README.md b/docs/README.md index a6f0f44..f1d78ef 100644 --- a/docs/README.md +++ b/docs/README.md @@ -27,6 +27,7 @@ ### Type aliases +- [EntryPayload](README.md#entrypayload) - [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) - [EnvoyEventMeta](README.md#envoyeventmeta) - [EnvoyEventRequest](README.md#envoyeventrequest) @@ -41,6 +42,7 @@ - [EnvoyRouteRequest](README.md#envoyrouterequest) - [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) - [EnvoyStorageItem](README.md#envoystorageitem) +- [InvitePayload](README.md#invitepayload) ### Variables @@ -54,16 +56,66 @@ ## Type aliases +### EntryPayload + +Ƭ **EntryPayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.email` | `string` \| ``null`` | +| `attributes.employee-screening-flow` | `boolean` | +| `attributes.flow-name` | `string` | +| `attributes.full-name` | `string` | +| `attributes.host` | `string` \| ``null`` | +| `attributes.host-email` | `string` \| ``null`` | +| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `attributes.nda?` | `string` | +| `attributes.phone-number?` | `string` | +| `attributes.private-notes` | `string` \| ``null`` | +| `attributes.signed-in-at` | `string` | +| `attributes.signed-out-at?` | `string` | +| `attributes.thumbnails` | `Object` | +| `attributes.thumbnails.large` | `string` \| ``null`` | +| `attributes.thumbnails.original` | `string` \| ``null`` | +| `attributes.thumbnails.small` | `string` \| ``null`` | +| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | +| `id` | `string` | +| `relationships` | `Object` | +| `relationships.agreeable-ndas?` | `Object` | +| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | +| `relationships.device?` | `Object` | +| `relationships.device.data` | `JSONAPIData`<``"devices"``\> | +| `relationships.employee?` | `Object` | +| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | +| `relationships.flow?` | `Object` | +| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | +| `relationships.invite?` | `Object` | +| `relationships.invite.data` | `JSONAPIData`<``"invites"``\> | +| `relationships.location` | `Object` | +| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | +| `relationships.visitor-entrance?` | `Object` | +| `relationships.visitor-entrance.data` | `JSONAPIData`<``"visitor-entrances"``\> | +| `type` | ``"entries"`` | + +#### Defined in + +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/payloads/EntryPayload.ts#L3) + +___ + ### EnvoyEntryEventRequest -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> Use to type your `req` object in entry event handlers, such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L33) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L33) ___ @@ -88,7 +140,7 @@ Metadata that will be included in the request body for events. #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L54) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L54) ___ @@ -107,20 +159,20 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L27) ___ ### EnvoyInviteEventRequest -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> Use to type your `req` object in invite event handlers, such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L39) ___ @@ -144,7 +196,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L43) ___ @@ -165,7 +217,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L28) ___ @@ -183,7 +235,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L1) ___ @@ -215,7 +267,7 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L7) ___ @@ -241,7 +293,7 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/middleware.ts#L12) ___ @@ -257,7 +309,7 @@ ___ #### Defined in -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L41) ___ @@ -284,7 +336,7 @@ like validation URLs or options URLs. #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyMeta.ts#L69) +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L69) ___ @@ -303,7 +355,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L21) +[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L21) ___ @@ -322,7 +374,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoySignatureVerifier.ts#L5) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoySignatureVerifier.ts#L5) ___ @@ -339,7 +391,59 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyStorageItem.ts#L1) + +___ + +### InvitePayload + +Ƭ **InvitePayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.arrived` | `boolean` | +| `attributes.been-here-before` | `boolean` | +| `attributes.edit-token` | `string` | +| `attributes.email` | `string` \| ``null`` | +| `attributes.employee-screening-flow` | `boolean` | +| `attributes.expected-arrival-time` | `string` | +| `attributes.flow-id` | `string` | +| `attributes.flow-name` | `string` | +| `attributes.full-name` | `string` | +| `attributes.inviter-email` | `string` \| ``null`` | +| `attributes.inviter-name` | `string` \| ``null`` | +| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `attributes.nda?` | `string` | +| `attributes.photo-url` | `string` \| ``null`` | +| `attributes.preregistration-complete` | `boolean` | +| `attributes.private-notes` | `string` \| ``null`` | +| `attributes.qr-code` | `string` \| ``null`` | +| `attributes.qr-code-sent-at` | `string` \| ``null`` | +| `attributes.reminder-sent-at` | `string` \| ``null`` | +| `attributes.secret-token` | `string` | +| `attributes.signed-in-at?` | `string` | +| `attributes.signed-out-at?` | `string` | +| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | +| `id` | `string` | +| `relationships` | `Object` | +| `relationships.agreeable-ndas?` | `Object` | +| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | +| `relationships.employee?` | `Object` | +| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | +| `relationships.entry?` | `Object` | +| `relationships.entry.data` | `JSONAPIData`<``"entries"``\> | +| `relationships.flow?` | `Object` | +| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | +| `relationships.location` | `Object` | +| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | +| `type` | ``"invites"`` | + +#### Defined in + +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/payloads/InvitePayload.ts#L3) ## Variables @@ -349,7 +453,7 @@ ___ #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L7) ## Functions @@ -385,7 +489,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/asyncHandler.ts#L10) ___ @@ -422,7 +526,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/errorMiddleware.ts#L9) ___ @@ -448,4 +552,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 359e2c8..06b4ffc 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 3127cfe..112eb36 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index d1e67c7..ecff041 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 1446df6..31ca77c 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index a65d67d..ff3529b 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index d6b2e03..2d7ecb7 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index a7b1af7..1589d3c 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 5b14fd9..b14056b 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 5a4ccee..77c6608 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 9fbe7ae..60a84d9 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -34,7 +34,7 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L10) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L14) +[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L14) diff --git a/docs/interfaces/envoyeventmeta.md b/docs/interfaces/envoyeventmeta.md deleted file mode 100644 index 1cd887c..0000000 --- a/docs/interfaces/envoyeventmeta.md +++ /dev/null @@ -1,98 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyEventMeta - -# Interface: EnvoyEventMeta - -Metadata that will be included in the request body for events. - -## Table of contents - -### Properties - -- [auth](envoyeventmeta.md#auth) -- [company](envoyeventmeta.md#company) -- [config](envoyeventmeta.md#config) -- [event](envoyeventmeta.md#event) -- [install\_id](envoyeventmeta.md#install_id) -- [job](envoyeventmeta.md#job) -- [location](envoyeventmeta.md#location) -- [plugin\_id](envoyeventmeta.md#plugin_id) - -## Properties - -### auth - -• **auth**: ``null`` \| [EnvoyMetaAuth](../README.md#envoymetaauth) - -#### Defined in - -[EnvoyMeta.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L62) - -___ - -### company - -• **company**: [EnvoyMetaCompany](envoymetacompany.md) - -#### Defined in - -[EnvoyMeta.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L61) - -___ - -### config - -• **config**: `Record` - -#### Defined in - -[EnvoyMeta.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L58) - -___ - -### event - -• **event**: `string` - -#### Defined in - -[EnvoyMeta.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L55) - -___ - -### install\_id - -• **install\_id**: `string` - -#### Defined in - -[EnvoyMeta.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L57) - -___ - -### job - -• **job**: [EnvoyMetaJob](envoymetajob.md) - -#### Defined in - -[EnvoyMeta.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L59) - -___ - -### location - -• **location**: [EnvoyMetaLocation](envoymetalocation.md) - -#### Defined in - -[EnvoyMeta.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L60) - -___ - -### plugin\_id - -• **plugin\_id**: `string` - -#### Defined in - -[EnvoyMeta.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L56) diff --git a/docs/interfaces/envoymetacompany.md b/docs/interfaces/envoymetacompany.md deleted file mode 100644 index 96e791b..0000000 --- a/docs/interfaces/envoymetacompany.md +++ /dev/null @@ -1,49 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyMetaCompany - -# Interface: EnvoyMetaCompany - -## Table of contents - -### Properties - -- [attributes](envoymetacompany.md#attributes) -- [id](envoymetacompany.md#id) -- [type](envoymetacompany.md#type) - -## Properties - -### attributes - -• **attributes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `active` | `boolean` | -| `created-at` | `string` | -| `name` | `string` | - -#### Defined in - -[EnvoyMeta.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L31) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[EnvoyMeta.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L29) - -___ - -### type - -• **type**: ``"companies"`` - -#### Defined in - -[EnvoyMeta.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L30) diff --git a/docs/interfaces/envoymetajob.md b/docs/interfaces/envoymetajob.md deleted file mode 100644 index 94ba1ab..0000000 --- a/docs/interfaces/envoymetajob.md +++ /dev/null @@ -1,41 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyMetaJob - -# Interface: EnvoyMetaJob - -## Table of contents - -### Properties - -- [id](envoymetajob.md#id) -- [identifier](envoymetajob.md#identifier) -- [name](envoymetajob.md#name) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[EnvoyMeta.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L2) - -___ - -### identifier - -• **identifier**: `string` - -#### Defined in - -[EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L4) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[EnvoyMeta.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L3) diff --git a/docs/interfaces/envoymetalocation.md b/docs/interfaces/envoymetalocation.md deleted file mode 100644 index e7ae182..0000000 --- a/docs/interfaces/envoymetalocation.md +++ /dev/null @@ -1,60 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyMetaLocation - -# Interface: EnvoyMetaLocation - -## Table of contents - -### Properties - -- [attributes](envoymetalocation.md#attributes) -- [id](envoymetalocation.md#id) -- [type](envoymetalocation.md#type) - -## Properties - -### attributes - -• **attributes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address` | `string` | -| `address-line-one` | ``null`` \| `string` | -| `address-line-two` | ``null`` \| `string` | -| `city` | ``null`` \| `string` | -| `company-name-override` | ``null`` \| `string` | -| `country` | ``null`` \| `string` | -| `created-at` | `string` | -| `latitude` | ``null`` \| `number` | -| `locale` | ``null`` \| `string` | -| `longitude` | ``null`` \| `number` | -| `name` | `string` | -| `state` | ``null`` \| `string` | -| `timezone` | `string` | -| `zip` | ``null`` \| `string` | - -#### Defined in - -[EnvoyMeta.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L10) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[EnvoyMeta.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L8) - -___ - -### type - -• **type**: ``"locations"`` - -#### Defined in - -[EnvoyMeta.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L9) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 69b728e..b443427 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/envoyroutemeta.md b/docs/interfaces/envoyroutemeta.md deleted file mode 100644 index 2c5f232..0000000 --- a/docs/interfaces/envoyroutemeta.md +++ /dev/null @@ -1,110 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyRouteMeta - -# Interface: EnvoyRouteMeta - -Metadata that will be included in the request body for setup routes, -like validation URLs or options URLs. - -## Table of contents - -### Properties - -- [auth](envoyroutemeta.md#auth) -- [company](envoyroutemeta.md#company) -- [config](envoyroutemeta.md#config) -- [forwarded\_bearer\_token](envoyroutemeta.md#forwarded_bearer_token) -- [install\_id](envoyroutemeta.md#install_id) -- [location](envoyroutemeta.md#location) -- [params](envoyroutemeta.md#params) -- [plugin\_id](envoyroutemeta.md#plugin_id) -- [route](envoyroutemeta.md#route) - -## Properties - -### auth - -• **auth**: ``null`` \| [EnvoyMetaAuth](../README.md#envoymetaauth) - -#### Defined in - -[EnvoyMeta.ts:77](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L77) - -___ - -### company - -• **company**: [EnvoyMetaCompany](envoymetacompany.md) - -#### Defined in - -[EnvoyMeta.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L76) - -___ - -### config - -• **config**: `Record` - -#### Defined in - -[EnvoyMeta.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L73) - -___ - -### forwarded\_bearer\_token - -• `Optional` **forwarded\_bearer\_token**: `string` - -#### Defined in - -[EnvoyMeta.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L78) - -___ - -### install\_id - -• **install\_id**: `string` - -#### Defined in - -[EnvoyMeta.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L72) - -___ - -### location - -• **location**: [EnvoyMetaLocation](envoymetalocation.md) - -#### Defined in - -[EnvoyMeta.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L75) - -___ - -### params - -• **params**: `Record` - -#### Defined in - -[EnvoyMeta.ts:74](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L74) - -___ - -### plugin\_id - -• **plugin\_id**: `string` - -#### Defined in - -[EnvoyMeta.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L71) - -___ - -### route - -• **route**: `string` - -#### Defined in - -[EnvoyMeta.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoyMeta.ts#L70) diff --git a/docs/interfaces/envoysignatureverifieroptions.md b/docs/interfaces/envoysignatureverifieroptions.md deleted file mode 100644 index 16a9ddb..0000000 --- a/docs/interfaces/envoysignatureverifieroptions.md +++ /dev/null @@ -1,52 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifierOptions - -# Interface: EnvoySignatureVerifierOptions - -## Table of contents - -### Properties - -- [algorithm](envoysignatureverifieroptions.md#algorithm) -- [encoding](envoysignatureverifieroptions.md#encoding) -- [header](envoysignatureverifieroptions.md#header) -- [secret](envoysignatureverifieroptions.md#secret) - -## Properties - -### algorithm - -• **algorithm**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L6) - -___ - -### encoding - -• **encoding**: `BinaryToTextEncoding` - -#### Defined in - -[EnvoySignatureVerifier.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L7) - -___ - -### header - -• **header**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L9) - -___ - -### secret - -• **secret**: `string` - -#### Defined in - -[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7d8339/src/EnvoySignatureVerifier.ts#L8) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md index 0ff1798..dfa318d 100644 --- a/docs/interfaces/verifiedrequest.md +++ b/docs/interfaces/verifiedrequest.md @@ -24,4 +24,4 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/af53dd2/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L10) diff --git a/src/index.ts b/src/index.ts index 5d3bbf8..8b98051 100644 --- a/src/index.ts +++ b/src/index.ts @@ -13,12 +13,16 @@ import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; import HttpStatus from './HttpStatus'; import middleware, { EnvoyMiddleware } from './middleware'; +import EntryPayload from './payloads/EntryPayload'; +import InvitePayload from './payloads/InvitePayload'; export * from './EnvoyMeta'; export * from './EnvoyRequest'; export { asyncHandler, errorMiddleware, + EntryPayload, + InvitePayload, EnvoyJWT, EnvoyMiddleware, EnvoyPluginJob, From 84b46673fe56736690a53de169b56e27254535dc Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:24:06 -0400 Subject: [PATCH 19/91] fixing docs --- docs/README.md | 65 +++++++++++----------- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +++--- docs/classes/envoypluginjob.md | 18 +++--- docs/classes/envoypluginsdk.md | 22 ++++---- docs/classes/envoypluginstorage.md | 18 +++--- docs/classes/envoypluginstoragepipeline.md | 22 ++++---- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 46 +++++++-------- docs/enums/httpstatus.md | 8 +-- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 +-- docs/interfaces/jsonapidata.md | 37 ++++++++++++ docs/interfaces/verifiedrequest.md | 2 +- src/index.ts | 2 + 15 files changed, 159 insertions(+), 119 deletions(-) create mode 100644 docs/interfaces/jsonapidata.md diff --git a/docs/README.md b/docs/README.md index f1d78ef..535922a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,6 +23,7 @@ - [EnvoyBaseRequest](interfaces/envoybaserequest.md) - [EnvoyResponse](interfaces/envoyresponse.md) +- [JSONAPIData](interfaces/jsonapidata.md) - [VerifiedRequest](interfaces/verifiedrequest.md) ### Type aliases @@ -85,24 +86,24 @@ | `id` | `string` | | `relationships` | `Object` | | `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | +| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | | `relationships.device?` | `Object` | -| `relationships.device.data` | `JSONAPIData`<``"devices"``\> | +| `relationships.device.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"devices"``\> | | `relationships.employee?` | `Object` | -| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | +| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | | `relationships.flow?` | `Object` | -| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | +| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | | `relationships.invite?` | `Object` | -| `relationships.invite.data` | `JSONAPIData`<``"invites"``\> | +| `relationships.invite.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"invites"``\> | | `relationships.location` | `Object` | -| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | +| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | | `relationships.visitor-entrance?` | `Object` | -| `relationships.visitor-entrance.data` | `JSONAPIData`<``"visitor-entrances"``\> | +| `relationships.visitor-entrance.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"visitor-entrances"``\> | | `type` | ``"entries"`` | #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/payloads/EntryPayload.ts#L3) +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/payloads/EntryPayload.ts#L3) ___ @@ -115,7 +116,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L33) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L33) ___ @@ -140,7 +141,7 @@ Metadata that will be included in the request body for events. #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L54) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L54) ___ @@ -159,7 +160,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L27) ___ @@ -172,7 +173,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L39) ___ @@ -196,7 +197,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L43) ___ @@ -217,7 +218,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L28) ___ @@ -235,7 +236,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L1) ___ @@ -267,7 +268,7 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L7) ___ @@ -293,7 +294,7 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/middleware.ts#L12) ___ @@ -309,7 +310,7 @@ ___ #### Defined in -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L41) ___ @@ -336,7 +337,7 @@ like validation URLs or options URLs. #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyMeta.ts#L69) +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L69) ___ @@ -355,7 +356,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L21) +[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L21) ___ @@ -374,7 +375,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoySignatureVerifier.ts#L5) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoySignatureVerifier.ts#L5) ___ @@ -391,7 +392,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyStorageItem.ts#L1) ___ @@ -430,20 +431,20 @@ ___ | `id` | `string` | | `relationships` | `Object` | | `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | `JSONAPIData`<``"agreeable-ndas"``\>[] | +| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | | `relationships.employee?` | `Object` | -| `relationships.employee.data` | `JSONAPIData`<``"employees"``\> | +| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | | `relationships.entry?` | `Object` | -| `relationships.entry.data` | `JSONAPIData`<``"entries"``\> | +| `relationships.entry.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"entries"``\> | | `relationships.flow?` | `Object` | -| `relationships.flow.data` | `JSONAPIData`<``"flows"``\> | +| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | | `relationships.location` | `Object` | -| `relationships.location.data` | `JSONAPIData`<``"locations"``\> | +| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | | `type` | ``"invites"`` | #### Defined in -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/payloads/InvitePayload.ts#L3) +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/payloads/InvitePayload.ts#L3) ## Variables @@ -453,7 +454,7 @@ ___ #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L7) ## Functions @@ -489,7 +490,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/asyncHandler.ts#L10) ___ @@ -526,7 +527,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/errorMiddleware.ts#L9) ___ @@ -552,4 +553,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 06b4ffc..79bc2d7 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 112eb36..fa0e8d8 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index ecff041..7e74fdd 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 31ca77c..90e89c3 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index ff3529b..a2742f6 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 2d7ecb7..4c02670 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index 1589d3c..b94c0aa 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index b14056b..a229787 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 77c6608..072f991 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 60a84d9..1984ee0 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -34,7 +34,7 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L10) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L14) +[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L14) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index b443427..c8df3f1 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md new file mode 100644 index 0000000..ea13972 --- /dev/null +++ b/docs/interfaces/jsonapidata.md @@ -0,0 +1,37 @@ +[@envoy/envoy-integrations-sdk](../README.md) / JSONAPIData + +# Interface: JSONAPIData + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Type` | `Type` = `string` | +| `ID` | `ID` = `string` | + +## Table of contents + +### Properties + +- [id](jsonapidata.md#id) +- [type](jsonapidata.md#type) + +## Properties + +### id + +• **id**: `ID` + +#### Defined in + +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/util/json-api/JSONAPIData.ts#L2) + +___ + +### type + +• **type**: `Type` + +#### Defined in + +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md index dfa318d..9050fcc 100644 --- a/docs/interfaces/verifiedrequest.md +++ b/docs/interfaces/verifiedrequest.md @@ -24,4 +24,4 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/fbf2ead/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L10) diff --git a/src/index.ts b/src/index.ts index 8b98051..a3a0668 100644 --- a/src/index.ts +++ b/src/index.ts @@ -15,6 +15,7 @@ import HttpStatus from './HttpStatus'; import middleware, { EnvoyMiddleware } from './middleware'; import EntryPayload from './payloads/EntryPayload'; import InvitePayload from './payloads/InvitePayload'; +import JSONAPIData from './util/json-api/JSONAPIData'; export * from './EnvoyMeta'; export * from './EnvoyRequest'; @@ -37,5 +38,6 @@ export { EnvoyPluginAPI, EnvoyUserAPI, HttpStatus, + JSONAPIData, middleware, }; From d2a4136ad8554ccea4818c9ff2ae5a7d720d5852 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:34:48 -0400 Subject: [PATCH 20/91] fixing docs --- src/EnvoyRequest.ts | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/src/EnvoyRequest.ts b/src/EnvoyRequest.ts index e8d22c6..9444710 100644 --- a/src/EnvoyRequest.ts +++ b/src/EnvoyRequest.ts @@ -10,6 +10,12 @@ export interface VerifiedRequest extends Request { [VERIFIED]: boolean } +/** + * Base type for Envoy requests. + * You probably won't need to use this type directly. + * For routes, use `EnvoyRouteRequest`, + * and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + */ export interface EnvoyBaseRequest extends VerifiedRequest { envoy: EnvoyPluginSDK } @@ -21,8 +27,8 @@ export interface EnvoyBaseRequest = EnvoyBaseRequest; /** - * Use to type your `req` object in route handlers, - * such as validation URLS or options URLs. + * Base type for event requests. + * You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. */ export type EnvoyEventRequest = EnvoyBaseRequest; @@ -38,5 +44,10 @@ export type EnvoyEntryEventRequest = EnvoyEventRequest; */ export type EnvoyInviteEventRequest = EnvoyEventRequest; +/** + * You probably won't need to use this type directly. + * For routes, use `EnvoyRouteRequest`, + * and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + */ type EnvoyRequest = EnvoyBaseRequest; export default EnvoyRequest; From a7acad5432bb52fa6ef523bdb418f042d7e57ae0 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:35:07 -0400 Subject: [PATCH 21/91] fixing docs --- docs/README.md | 48 ++++++++++++---------- docs/classes/envoyjwt.md | 6 +-- docs/classes/envoypluginapi.md | 16 ++++---- docs/classes/envoypluginjob.md | 18 ++++---- docs/classes/envoypluginsdk.md | 22 +++++----- docs/classes/envoypluginstorage.md | 18 ++++---- docs/classes/envoypluginstoragepipeline.md | 22 +++++----- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 46 ++++++++++----------- docs/enums/httpstatus.md | 8 ++-- docs/interfaces/envoybaserequest.md | 9 +++- docs/interfaces/envoyresponse.md | 8 ++-- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/verifiedrequest.md | 2 +- 14 files changed, 120 insertions(+), 111 deletions(-) diff --git a/docs/README.md b/docs/README.md index 535922a..d197b31 100644 --- a/docs/README.md +++ b/docs/README.md @@ -103,7 +103,7 @@ #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/payloads/EntryPayload.ts#L3) +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/payloads/EntryPayload.ts#L3) ___ @@ -116,7 +116,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L33) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L39) ___ @@ -141,7 +141,7 @@ Metadata that will be included in the request body for events. #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L54) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L54) ___ @@ -149,8 +149,8 @@ ___ Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> -Use to type your `req` object in route handlers, -such as validation URLS or options URLs. +Base type for event requests. +You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Type parameters @@ -160,7 +160,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L33) ___ @@ -173,7 +173,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L45) ___ @@ -197,7 +197,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L43) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L28) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L1) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L7) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/middleware.ts#L12) ___ @@ -302,6 +302,10 @@ ___ Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +You probably won't need to use this type directly. +For routes, use `EnvoyRouteRequest`, +and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + #### Type parameters | Name | Type | @@ -310,7 +314,7 @@ ___ #### Defined in -[EnvoyRequest.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L41) +[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L52) ___ @@ -337,7 +341,7 @@ like validation URLs or options URLs. #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyMeta.ts#L69) +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L69) ___ @@ -356,7 +360,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L21) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L27) ___ @@ -375,7 +379,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoySignatureVerifier.ts#L5) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoySignatureVerifier.ts#L5) ___ @@ -392,7 +396,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyStorageItem.ts#L1) ___ @@ -444,7 +448,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/payloads/InvitePayload.ts#L3) +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/payloads/InvitePayload.ts#L3) ## Variables @@ -454,7 +458,7 @@ ___ #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L7) ## Functions @@ -490,7 +494,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/asyncHandler.ts#L10) ___ @@ -527,7 +531,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/errorMiddleware.ts#L9) ___ @@ -553,4 +557,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 79bc2d7..b2bc590 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index fa0e8d8..0c0a183 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 7e74fdd..e573c1a 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 90e89c3..bf2218c 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index a2742f6..176aa9a 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 4c02670..cdd74d0 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index b94c0aa..0bc03f8 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index a229787..d2e811d 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index 072f991..e3775b9 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 1984ee0..dcc3865 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -2,6 +2,11 @@ # Interface: EnvoyBaseRequest +Base type for Envoy requests. +You probably won't need to use this type directly. +For routes, use `EnvoyRouteRequest`, +and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + ## Type parameters | Name | Type | @@ -34,7 +39,7 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L10) ___ @@ -44,4 +49,4 @@ ___ #### Defined in -[EnvoyRequest.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L14) +[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L20) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index c8df3f1..b5fe704 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index ea13972..611772c 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md index 9050fcc..e5927e9 100644 --- a/docs/interfaces/verifiedrequest.md +++ b/docs/interfaces/verifiedrequest.md @@ -24,4 +24,4 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/981d571/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L10) From f50d6c55554779ed003bee5c9597ddb5ebb94018 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:38:34 -0400 Subject: [PATCH 22/91] fixing docs --- docs/README.md | 40 +++++++++---------- docs/classes/envoyjwt.md | 6 +-- docs/classes/envoypluginapi.md | 16 ++++---- docs/classes/envoypluginjob.md | 18 ++++----- docs/classes/envoypluginsdk.md | 22 +++++------ docs/classes/envoypluginstorage.md | 18 ++++----- docs/classes/envoypluginstoragepipeline.md | 22 +++++------ docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 46 +++++++++++----------- docs/enums/httpstatus.md | 8 ++-- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 ++-- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/verifiedrequest.md | 2 +- package-lock.json | 6 +++ package.json | 1 + typedoc.json | 3 +- 17 files changed, 118 insertions(+), 110 deletions(-) diff --git a/docs/README.md b/docs/README.md index d197b31..d3f2d28 100644 --- a/docs/README.md +++ b/docs/README.md @@ -103,7 +103,7 @@ #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/payloads/EntryPayload.ts#L3) +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/payloads/EntryPayload.ts#L3) ___ @@ -116,7 +116,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L39) ___ @@ -141,7 +141,7 @@ Metadata that will be included in the request body for events. #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L54) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L54) ___ @@ -160,7 +160,7 @@ You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L33) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L33) ___ @@ -173,7 +173,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L45) +[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L45) ___ @@ -197,7 +197,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L43) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L28) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L1) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L7) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/middleware.ts#L12) ___ @@ -314,7 +314,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L52) +[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L52) ___ @@ -341,7 +341,7 @@ like validation URLs or options URLs. #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyMeta.ts#L69) +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L69) ___ @@ -360,7 +360,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L27) ___ @@ -379,7 +379,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoySignatureVerifier.ts#L5) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoySignatureVerifier.ts#L5) ___ @@ -396,7 +396,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyStorageItem.ts#L1) ___ @@ -448,7 +448,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/payloads/InvitePayload.ts#L3) +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/payloads/InvitePayload.ts#L3) ## Variables @@ -458,7 +458,7 @@ ___ #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L7) ## Functions @@ -494,7 +494,7 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/asyncHandler.ts#L10) ___ @@ -531,7 +531,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/errorMiddleware.ts#L9) ___ @@ -557,4 +557,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/middleware.ts#L21) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index b2bc590..6d93550 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 0c0a183..d83a502 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L26) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L13) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index e573c1a..c42307f 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L15) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index bf2218c..9ae444c 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L38) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L129) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L122) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L111) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L136) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L62) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L90) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index 176aa9a..9392bc1 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L13) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L13) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L30) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L23) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L37) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L44) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L51) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index cdd74d0..8ef7086 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L39) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L27) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L34) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L47) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L55) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L63) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L71) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index 0bc03f8..b36c29a 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index d2e811d..1632cb6 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -63,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L140) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L120) ___ @@ -488,7 +488,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L177) ___ @@ -513,4 +513,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md index e3775b9..42f20d8 100644 --- a/docs/enums/httpstatus.md +++ b/docs/enums/httpstatus.md @@ -21,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L7) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L6) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L5) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index dcc3865..45e2415 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -39,7 +39,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L10) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L20) +[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L20) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index b5fe704..0bac5c8 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index 611772c..b3ea6a9 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md index e5927e9..4f63ac8 100644 --- a/docs/interfaces/verifiedrequest.md +++ b/docs/interfaces/verifiedrequest.md @@ -24,4 +24,4 @@ #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/d2a4136/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L10) diff --git a/package-lock.json b/package-lock.json index 8c02e03..1763679 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4295,6 +4295,12 @@ "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", "dev": true }, + "typedoc-github-wiki-theme": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/typedoc-github-wiki-theme/-/typedoc-github-wiki-theme-0.3.0.tgz", + "integrity": "sha512-YMnpahBvsk0FlmHM3Djq+U25YZgiXSXdNzPRqu/mQY9QXHHzIKJmLm6r3Qz2U2NfD7xWyfoODpX/UY5Zz9434g==", + "dev": true + }, "typedoc-plugin-markdown": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.9.0.tgz", diff --git a/package.json b/package.json index 0f4146c..845de7c 100644 --- a/package.json +++ b/package.json @@ -52,6 +52,7 @@ "proxyquire": "^2.1.0", "sinon": "^7.3.2", "typedoc": "^0.20.36", + "typedoc-github-wiki-theme": "^0.3.0", "typedoc-plugin-markdown": "^3.9.0", "typescript": "4.2" } diff --git a/typedoc.json b/typedoc.json index e2bc5f8..3016739 100644 --- a/typedoc.json +++ b/typedoc.json @@ -4,5 +4,6 @@ "excludePrivate": true, "excludeProtected": true, "excludeExternals": true, - "readme": "none" + "readme": "none", + "theme": "typedoc-github-wiki-theme/dist" } From db5b9583bd0b207b8528e1875f70f970eb8cc674 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:39:38 -0400 Subject: [PATCH 23/91] fixing docs --- .../envoyjwt.md => Class: EnvoyJWT.md} | 16 +- ...ypluginapi.md => Class: EnvoyPluginAPI.md} | 44 ++--- ...ypluginjob.md => Class: EnvoyPluginJob.md} | 44 ++--- ...ypluginsdk.md => Class: EnvoyPluginSDK.md} | 78 ++++---- ...torage.md => Class: EnvoyPluginStorage.md} | 68 +++---- ...d => Class: EnvoyPluginStoragePipeline.md} | 84 ++++---- ...er.md => Class: EnvoySignatureVerifier.md} | 14 +- ...envoyuserapi.md => Class: EnvoyUserAPI.md} | 104 +++++----- ...tpstatus.md => Enumeration: HttpStatus.md} | 20 +- docs/{README.md => Home.md} | 184 +++++++++--------- ...uest.md => Interface: EnvoyBaseRequest.md} | 18 +- ...esponse.md => Interface: EnvoyResponse.md} | 26 ++- ...onapidata.md => Interface: JSONAPIData.md} | 12 +- docs/Interface: VerifiedRequest.md | 23 +++ docs/_Sidebar.md | 25 +++ docs/interfaces/verifiedrequest.md | 27 --- typedoc.json | 2 +- 17 files changed, 379 insertions(+), 410 deletions(-) rename docs/{classes/envoyjwt.md => Class: EnvoyJWT.md} (78%) rename docs/{classes/envoypluginapi.md => Class: EnvoyPluginAPI.md} (69%) rename docs/{classes/envoypluginjob.md => Class: EnvoyPluginJob.md} (72%) rename docs/{classes/envoypluginsdk.md => Class: EnvoyPluginSDK.md} (59%) rename docs/{classes/envoypluginstorage.md => Class: EnvoyPluginStorage.md} (57%) rename docs/{classes/envoypluginstoragepipeline.md => Class: EnvoyPluginStoragePipeline.md} (52%) rename docs/{classes/envoysignatureverifier.md => Class: EnvoySignatureVerifier.md} (65%) rename docs/{classes/envoyuserapi.md => Class: EnvoyUserAPI.md} (72%) rename docs/{enums/httpstatus.md => Enumeration: HttpStatus.md} (60%) rename docs/{README.md => Home.md} (61%) rename docs/{interfaces/envoybaserequest.md => Interface: EnvoyBaseRequest.md} (57%) rename docs/{interfaces/envoyresponse.md => Interface: EnvoyResponse.md} (72%) rename docs/{interfaces/jsonapidata.md => Interface: JSONAPIData.md} (59%) create mode 100644 docs/Interface: VerifiedRequest.md create mode 100644 docs/_Sidebar.md delete mode 100644 docs/interfaces/verifiedrequest.md diff --git a/docs/classes/envoyjwt.md b/docs/Class: EnvoyJWT.md similarity index 78% rename from docs/classes/envoyjwt.md rename to docs/Class: EnvoyJWT.md index 6d93550..f284688 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/Class: EnvoyJWT.md @@ -1,19 +1,15 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyJWT - -# Class: EnvoyJWT - Helper to encode and decode JWTs. ## Table of contents ### Constructors -- [constructor](envoyjwt.md#constructor) +- [constructor](../wiki/Class:%20EnvoyJWT#constructor) ### Methods -- [decode](envoyjwt.md#decode) -- [encode](envoyjwt.md#encode) +- [decode](../wiki/Class:%20EnvoyJWT#decode) +- [encode](../wiki/Class:%20EnvoyJWT#encode) ## Constructors @@ -30,7 +26,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyJWT.ts#L12) ## Methods @@ -51,7 +47,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyJWT.ts#L39) ___ @@ -73,4 +69,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyJWT.ts#L22) diff --git a/docs/classes/envoypluginapi.md b/docs/Class: EnvoyPluginAPI.md similarity index 69% rename from docs/classes/envoypluginapi.md rename to docs/Class: EnvoyPluginAPI.md index d83a502..c70723d 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/Class: EnvoyPluginAPI.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginAPI - -# Class: EnvoyPluginAPI - API endpoints for *plugin-scoped* tokens. ## Hierarchy @@ -14,20 +10,20 @@ API endpoints for *plugin-scoped* tokens. ### Constructors -- [constructor](envoypluginapi.md#constructor) +- [constructor](../wiki/Class:%20EnvoyPluginAPI#constructor) ### Properties -- [axios](envoypluginapi.md#axios) +- [axios](../wiki/Class:%20EnvoyPluginAPI#axios) ### Methods -- [createNotification](envoypluginapi.md#createnotification) -- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) -- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) -- [storagePipeline](envoypluginapi.md#storagepipeline) -- [updateJob](envoypluginapi.md#updatejob) -- [login](envoypluginapi.md#login) +- [createNotification](../wiki/Class:%20EnvoyPluginAPI#createnotification) +- [getPluginInstallConfig](../wiki/Class:%20EnvoyPluginAPI#getplugininstallconfig) +- [setPluginInstallConfig](../wiki/Class:%20EnvoyPluginAPI#setplugininstallconfig) +- [storagePipeline](../wiki/Class:%20EnvoyPluginAPI#storagepipeline) +- [updateJob](../wiki/Class:%20EnvoyPluginAPI#updatejob) +- [login](../wiki/Class:%20EnvoyPluginAPI#login) ## Constructors @@ -47,7 +43,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L58) ## Properties @@ -63,7 +59,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L31) ## Methods @@ -84,7 +80,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L50) ___ @@ -104,7 +100,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L21) ___ @@ -125,13 +121,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L26) ___ ### storagePipeline -▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> #### Parameters @@ -142,11 +138,11 @@ ___ #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L34) ___ @@ -167,13 +163,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L13) ___ ### login -▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> Gets a plugin access token using `client_credentials` as the grant type. @@ -186,8 +182,8 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Returns -`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/classes/envoypluginjob.md b/docs/Class: EnvoyPluginJob.md similarity index 72% rename from docs/classes/envoypluginjob.md rename to docs/Class: EnvoyPluginJob.md index c42307f..2a16590 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/Class: EnvoyPluginJob.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginJob - -# Class: EnvoyPluginJob - A "job" is an event, like `entry_sign_in`. When your plugin handles the event, you can use this job concept to update the status (e.g. complete, failed, ignored) @@ -12,21 +8,21 @@ as well as attach extra data to the event's subject ### Constructors -- [constructor](envoypluginjob.md#constructor) +- [constructor](../wiki/Class:%20EnvoyPluginJob#constructor) ### Properties -- [api](envoypluginjob.md#api) -- [id](envoypluginjob.md#id) +- [api](../wiki/Class:%20EnvoyPluginJob#api) +- [id](../wiki/Class:%20EnvoyPluginJob#id) ### Methods -- [attach](envoypluginjob.md#attach) -- [complete](envoypluginjob.md#complete) -- [execute](envoypluginjob.md#execute) -- [fail](envoypluginjob.md#fail) -- [ignore](envoypluginjob.md#ignore) -- [update](envoypluginjob.md#update) +- [attach](../wiki/Class:%20EnvoyPluginJob#attach) +- [complete](../wiki/Class:%20EnvoyPluginJob#complete) +- [execute](../wiki/Class:%20EnvoyPluginJob#execute) +- [fail](../wiki/Class:%20EnvoyPluginJob#fail) +- [ignore](../wiki/Class:%20EnvoyPluginJob#ignore) +- [update](../wiki/Class:%20EnvoyPluginJob#update) ## Constructors @@ -38,22 +34,22 @@ as well as attach extra data to the event's subject | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) | | `jobId` | `string` | #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L15) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L13) ___ @@ -63,7 +59,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L15) ## Methods @@ -83,7 +79,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L43) ___ @@ -104,7 +100,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L47) ___ @@ -127,7 +123,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L22) ___ @@ -148,7 +144,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L55) ___ @@ -169,7 +165,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L51) ___ @@ -190,4 +186,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L59) diff --git a/docs/classes/envoypluginsdk.md b/docs/Class: EnvoyPluginSDK.md similarity index 59% rename from docs/classes/envoypluginsdk.md rename to docs/Class: EnvoyPluginSDK.md index 9ae444c..1265242 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/Class: EnvoyPluginSDK.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginSDK - -# Class: EnvoyPluginSDK - Sets up all relevant Envoy functions. Attaches itself to every request object using our `middleware`, to allow for easy access to Envoy functions. @@ -17,20 +13,20 @@ to allow for easy access to Envoy functions. ### Constructors -- [constructor](envoypluginsdk.md#constructor) +- [constructor](../wiki/Class:%20EnvoyPluginSDK#constructor) ### Accessors -- [getJob](envoypluginsdk.md#getjob) -- [globalStorage](envoypluginsdk.md#globalstorage) -- [installStorage](envoypluginsdk.md#installstorage) -- [job](envoypluginsdk.md#job) -- [jobId](envoypluginsdk.md#jobid) -- [jwt](envoypluginsdk.md#jwt) -- [meta](envoypluginsdk.md#meta) -- [payload](envoypluginsdk.md#payload) -- [pluginAPI](envoypluginsdk.md#pluginapi) -- [userAPI](envoypluginsdk.md#userapi) +- [getJob](../wiki/Class:%20EnvoyPluginSDK#getjob) +- [globalStorage](../wiki/Class:%20EnvoyPluginSDK#globalstorage) +- [installStorage](../wiki/Class:%20EnvoyPluginSDK#installstorage) +- [job](../wiki/Class:%20EnvoyPluginSDK#job) +- [jobId](../wiki/Class:%20EnvoyPluginSDK#jobid) +- [jwt](../wiki/Class:%20EnvoyPluginSDK#jwt) +- [meta](../wiki/Class:%20EnvoyPluginSDK#meta) +- [payload](../wiki/Class:%20EnvoyPluginSDK#payload) +- [pluginAPI](../wiki/Class:%20EnvoyPluginSDK#pluginapi) +- [userAPI](../wiki/Class:%20EnvoyPluginSDK#userapi) ## Constructors @@ -55,13 +51,13 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L38) ## Accessors ### getJob -• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](envoypluginjob.md) +• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) Returns a job based on an ID. @@ -69,7 +65,7 @@ Returns a job based on an ID. `fn` -▸ (`jobId`): [EnvoyPluginJob](envoypluginjob.md) +▸ (`jobId`): [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) ##### Parameters @@ -79,59 +75,59 @@ Returns a job based on an ID. ##### Returns -[EnvoyPluginJob](envoypluginjob.md) +[EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L129) ___ ### globalStorage -• `get` **globalStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) +• `get` **globalStorage**(): [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) Storage scoped globally (across installs). #### Returns -[EnvoyPluginStorage](envoypluginstorage.md) +[EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L122) ___ ### installStorage -• `get` **installStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) +• `get` **installStorage**(): [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) Storage scoped to the install. #### Returns -[EnvoyPluginStorage](envoypluginstorage.md) +[EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L111) ___ ### job -• `get` **job**(): [EnvoyPluginJob](envoypluginjob.md) +• `get` **job**(): [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) Perform operations on the current job. #### Returns -[EnvoyPluginJob](envoypluginjob.md) +[EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L147) ___ @@ -147,24 +143,24 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L136) ___ ### jwt -• `get` **jwt**(): [EnvoyJWT](envoyjwt.md) +• `get` **jwt**(): [EnvoyJWT](../wiki/Class:%20EnvoyJWT) A utility to encode and decode JWTs. Useful for verifiable communications between plugin endpoints. #### Returns -[EnvoyJWT](envoyjwt.md) +[EnvoyJWT](../wiki/Class:%20EnvoyJWT) #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L160) ___ @@ -181,7 +177,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L50) ___ @@ -199,38 +195,38 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L62) ___ ### pluginAPI -• `get` **pluginAPI**(): [EnvoyPluginAPI](envoypluginapi.md) +• `get` **pluginAPI**(): [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) Envoy API scoped to the plugin. Used to perform storage or job operations. #### Returns -[EnvoyPluginAPI](envoypluginapi.md) +[EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L90) ___ ### userAPI -• `get` **userAPI**(): [EnvoyUserAPI](envoyuserapi.md) +• `get` **userAPI**(): [EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) Envoy API scoped to the user. Used only in routes. #### Returns -[EnvoyUserAPI](envoyuserapi.md) +[EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/classes/envoypluginstorage.md b/docs/Class: EnvoyPluginStorage.md similarity index 57% rename from docs/classes/envoypluginstorage.md rename to docs/Class: EnvoyPluginStorage.md index 9392bc1..c877032 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/Class: EnvoyPluginStorage.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStorage - -# Class: EnvoyPluginStorage - A key-value storage that can be scoped to a specific install, or to the plugin itself. @@ -9,21 +5,21 @@ or to the plugin itself. ### Constructors -- [constructor](envoypluginstorage.md#constructor) +- [constructor](../wiki/Class:%20EnvoyPluginStorage#constructor) ### Properties -- [api](envoypluginstorage.md#api) -- [installId](envoypluginstorage.md#installid) +- [api](../wiki/Class:%20EnvoyPluginStorage#api) +- [installId](../wiki/Class:%20EnvoyPluginStorage#installid) ### Methods -- [get](envoypluginstorage.md#get) -- [pipeline](envoypluginstorage.md#pipeline) -- [set](envoypluginstorage.md#set) -- [setUnique](envoypluginstorage.md#setunique) -- [setUniqueNum](envoypluginstorage.md#setuniquenum) -- [unset](envoypluginstorage.md#unset) +- [get](../wiki/Class:%20EnvoyPluginStorage#get) +- [pipeline](../wiki/Class:%20EnvoyPluginStorage#pipeline) +- [set](../wiki/Class:%20EnvoyPluginStorage#set) +- [setUnique](../wiki/Class:%20EnvoyPluginStorage#setunique) +- [setUniqueNum](../wiki/Class:%20EnvoyPluginStorage#setuniquenum) +- [unset](../wiki/Class:%20EnvoyPluginStorage#unset) ## Constructors @@ -35,22 +31,22 @@ or to the plugin itself. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L13) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L11) ___ @@ -60,13 +56,13 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L13) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> Wrapper for single pipeline get. @@ -78,33 +74,33 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L30) ___ ### pipeline -▸ **pipeline**(): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **pipeline**(): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) Creates a new pipeline instance. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L23) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> Wrapper for single pipeline set. @@ -117,17 +113,17 @@ Wrapper for single pipeline set. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L37) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -140,17 +136,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L44) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -163,17 +159,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L51) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> Wrapper for single pipeline unset. Returns null if the item did not previously exist. @@ -186,8 +182,8 @@ Returns null if the item did not previously exist. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/Class: EnvoyPluginStoragePipeline.md similarity index 52% rename from docs/classes/envoypluginstoragepipeline.md rename to docs/Class: EnvoyPluginStoragePipeline.md index 8ef7086..2100bae 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/Class: EnvoyPluginStoragePipeline.md @@ -1,30 +1,26 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStoragePipeline - -# Class: EnvoyPluginStoragePipeline - Builds up a request pipeline for submitting storage commands. ## Table of contents ### Constructors -- [constructor](envoypluginstoragepipeline.md#constructor) +- [constructor](../wiki/Class:%20EnvoyPluginStoragePipeline#constructor) ### Properties -- [api](envoypluginstoragepipeline.md#api) -- [installId](envoypluginstoragepipeline.md#installid) +- [api](../wiki/Class:%20EnvoyPluginStoragePipeline#api) +- [installId](../wiki/Class:%20EnvoyPluginStoragePipeline#installid) ### Methods -- [addCommand](envoypluginstoragepipeline.md#addcommand) -- [execute](envoypluginstoragepipeline.md#execute) -- [executeSingle](envoypluginstoragepipeline.md#executesingle) -- [get](envoypluginstoragepipeline.md#get) -- [set](envoypluginstoragepipeline.md#set) -- [setUnique](envoypluginstoragepipeline.md#setunique) -- [setUniqueNum](envoypluginstoragepipeline.md#setuniquenum) -- [unset](envoypluginstoragepipeline.md#unset) +- [addCommand](../wiki/Class:%20EnvoyPluginStoragePipeline#addcommand) +- [execute](../wiki/Class:%20EnvoyPluginStoragePipeline#execute) +- [executeSingle](../wiki/Class:%20EnvoyPluginStoragePipeline#executesingle) +- [get](../wiki/Class:%20EnvoyPluginStoragePipeline#get) +- [set](../wiki/Class:%20EnvoyPluginStoragePipeline#set) +- [setUnique](../wiki/Class:%20EnvoyPluginStoragePipeline#setunique) +- [setUniqueNum](../wiki/Class:%20EnvoyPluginStoragePipeline#setuniquenum) +- [unset](../wiki/Class:%20EnvoyPluginStoragePipeline#unset) ## Constructors @@ -36,22 +32,22 @@ Builds up a request pipeline for submitting storage commands. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | +| `pluginAPI` | [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) +• `Readonly` **api**: [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -61,13 +57,13 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods ### addCommand -▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Parameters @@ -77,49 +73,49 @@ ___ #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L39) ___ ### execute -▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> Executes all the commands in the pipeline. #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L27) ___ ### executeSingle -▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> Executes the pipeline and returns the first result. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L34) ___ ### get -▸ **get**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **get**(`key`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) Gets a storage item. @@ -131,17 +127,17 @@ Gets a storage item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L47) ___ ### set -▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) Sets a value for a storage item, and returns that item. @@ -155,17 +151,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L55) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) Sets a unique value for a storage item, and returns that item. @@ -179,17 +175,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L63) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) Sets a unique number value for a storage item, and returns that item. @@ -203,17 +199,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L71) ___ ### unset -▸ **unset**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **unset**(`key`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) Unsets a storage item. @@ -225,8 +221,8 @@ Unsets a storage item. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/classes/envoysignatureverifier.md b/docs/Class: EnvoySignatureVerifier.md similarity index 65% rename from docs/classes/envoysignatureverifier.md rename to docs/Class: EnvoySignatureVerifier.md index b36c29a..aa54267 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/Class: EnvoySignatureVerifier.md @@ -1,18 +1,14 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifier - -# Class: EnvoySignatureVerifier - Verifies that a request is coming from Envoy. ## Table of contents ### Constructors -- [constructor](envoysignatureverifier.md#constructor) +- [constructor](../wiki/Class:%20EnvoySignatureVerifier#constructor) ### Methods -- [verify](envoysignatureverifier.md#verify) +- [verify](../wiki/Class:%20EnvoySignatureVerifier#verify) ## Constructors @@ -24,11 +20,11 @@ Verifies that a request is coming from Envoy. | Name | Type | | :------ | :------ | -| `options` | [EnvoySignatureVerifierOptions](../README.md#envoysignatureverifieroptions) | +| `options` | [EnvoySignatureVerifierOptions](../wiki/Home#envoysignatureverifieroptions) | #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -51,4 +47,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/classes/envoyuserapi.md b/docs/Class: EnvoyUserAPI.md similarity index 72% rename from docs/classes/envoyuserapi.md rename to docs/Class: EnvoyUserAPI.md index 1632cb6..6d895d0 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/Class: EnvoyUserAPI.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyUserAPI - -# Class: EnvoyUserAPI - API endpoints for *user-scoped* tokens. To access Envoy resources, this is the API you'd want. @@ -15,35 +11,35 @@ To access Envoy resources, this is the API you'd want. ### Constructors -- [constructor](envoyuserapi.md#constructor) +- [constructor](../wiki/Class:%20EnvoyUserAPI#constructor) ### Properties -- [axios](envoyuserapi.md#axios) +- [axios](../wiki/Class:%20EnvoyUserAPI#axios) ### Methods -- [createInvite](envoyuserapi.md#createinvite) -- [getAgreement](envoyuserapi.md#getagreement) -- [getAgreementPage](envoyuserapi.md#getagreementpage) -- [getCompany](envoyuserapi.md#getcompany) -- [getEmployee](envoyuserapi.md#getemployee) -- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) -- [getEmployees](envoyuserapi.md#getemployees) -- [getFlow](envoyuserapi.md#getflow) -- [getFlows](envoyuserapi.md#getflows) -- [getInvites](envoyuserapi.md#getinvites) -- [getLocation](envoyuserapi.md#getlocation) -- [getLocations](envoyuserapi.md#getlocations) -- [getSignInField](envoyuserapi.md#getsigninfield) -- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) -- [getSignInFields](envoyuserapi.md#getsigninfields) -- [me](envoyuserapi.md#me) -- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) -- [removeInvite](envoyuserapi.md#removeinvite) -- [updateInvite](envoyuserapi.md#updateinvite) -- [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) -- [loginAsUser](envoyuserapi.md#loginasuser) +- [createInvite](../wiki/Class:%20EnvoyUserAPI#createinvite) +- [getAgreement](../wiki/Class:%20EnvoyUserAPI#getagreement) +- [getAgreementPage](../wiki/Class:%20EnvoyUserAPI#getagreementpage) +- [getCompany](../wiki/Class:%20EnvoyUserAPI#getcompany) +- [getEmployee](../wiki/Class:%20EnvoyUserAPI#getemployee) +- [getEmployeeByEmail](../wiki/Class:%20EnvoyUserAPI#getemployeebyemail) +- [getEmployees](../wiki/Class:%20EnvoyUserAPI#getemployees) +- [getFlow](../wiki/Class:%20EnvoyUserAPI#getflow) +- [getFlows](../wiki/Class:%20EnvoyUserAPI#getflows) +- [getInvites](../wiki/Class:%20EnvoyUserAPI#getinvites) +- [getLocation](../wiki/Class:%20EnvoyUserAPI#getlocation) +- [getLocations](../wiki/Class:%20EnvoyUserAPI#getlocations) +- [getSignInField](../wiki/Class:%20EnvoyUserAPI#getsigninfield) +- [getSignInFieldPage](../wiki/Class:%20EnvoyUserAPI#getsigninfieldpage) +- [getSignInFields](../wiki/Class:%20EnvoyUserAPI#getsigninfields) +- [me](../wiki/Class:%20EnvoyUserAPI#me) +- [partialUpdateInvite](../wiki/Class:%20EnvoyUserAPI#partialupdateinvite) +- [removeInvite](../wiki/Class:%20EnvoyUserAPI#removeinvite) +- [updateInvite](../wiki/Class:%20EnvoyUserAPI#updateinvite) +- [loginAsPluginInstaller](../wiki/Class:%20EnvoyUserAPI#loginasplugininstaller) +- [loginAsUser](../wiki/Class:%20EnvoyUserAPI#loginasuser) ## Constructors @@ -63,7 +59,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L58) ## Properties @@ -79,7 +75,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L31) ## Methods @@ -99,7 +95,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L111) ___ @@ -120,7 +116,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L28) ___ @@ -141,7 +137,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L24) ___ @@ -162,7 +158,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L32) ___ @@ -183,7 +179,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L36) ___ @@ -204,7 +200,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L56) ___ @@ -224,7 +220,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L75) ___ @@ -245,7 +241,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L40) ___ @@ -265,7 +261,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L82) ___ @@ -285,7 +281,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L99) ___ @@ -306,7 +302,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L44) ___ @@ -326,7 +322,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L87) ___ @@ -347,7 +343,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L52) ___ @@ -368,7 +364,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L48) ___ @@ -388,7 +384,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L94) ___ @@ -402,7 +398,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L106) ___ @@ -423,7 +419,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L130) ___ @@ -443,7 +439,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L140) ___ @@ -464,13 +460,13 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L120) ___ ### loginAsPluginInstaller -▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> Gets a user access token using `plugin_install` as the grant type. @@ -484,17 +480,17 @@ Gets a user access token using `plugin_install` as the grant type. #### Returns -`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L177) ___ ### loginAsUser -▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> Gets a user access token using `password` as the grant type (discouraged). @@ -509,8 +505,8 @@ Gets a user access token using `password` as the grant type (discouraged). #### Returns -`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L150) diff --git a/docs/enums/httpstatus.md b/docs/Enumeration: HttpStatus.md similarity index 60% rename from docs/enums/httpstatus.md rename to docs/Enumeration: HttpStatus.md index 42f20d8..2770754 100644 --- a/docs/enums/httpstatus.md +++ b/docs/Enumeration: HttpStatus.md @@ -1,17 +1,13 @@ -[@envoy/envoy-integrations-sdk](../README.md) / HttpStatus - -# Enumeration: HttpStatus - Use these status codes to inform Envoy of a job's or route's status. ## Table of contents ### Enumeration members -- [FAILED](httpstatus.md#failed) -- [IGNORED](httpstatus.md#ignored) -- [ONGOING](httpstatus.md#ongoing) -- [UNEXPECTED\_FAILURE](httpstatus.md#unexpected_failure) +- [FAILED](../wiki/Enumeration:%20HttpStatus#failed) +- [IGNORED](../wiki/Enumeration:%20HttpStatus#ignored) +- [ONGOING](../wiki/Enumeration:%20HttpStatus#ongoing) +- [UNEXPECTED\_FAILURE](../wiki/Enumeration:%20HttpStatus#unexpected_failure) ## Enumeration members @@ -21,7 +17,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L7) ___ @@ -31,7 +27,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L6) ___ @@ -41,7 +37,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L5) ___ @@ -51,4 +47,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L8) diff --git a/docs/README.md b/docs/Home.md similarity index 61% rename from docs/README.md rename to docs/Home.md index d3f2d28..bce9558 100644 --- a/docs/README.md +++ b/docs/Home.md @@ -1,59 +1,55 @@ -@envoy/envoy-integrations-sdk - -# @envoy/envoy-integrations-sdk - ## Table of contents ### Enumerations -- [HttpStatus](enums/httpstatus.md) +- [HttpStatus](../wiki/Enumeration:%20HttpStatus) ### Classes -- [EnvoyJWT](classes/envoyjwt.md) -- [EnvoyPluginAPI](classes/envoypluginapi.md) -- [EnvoyPluginJob](classes/envoypluginjob.md) -- [EnvoyPluginSDK](classes/envoypluginsdk.md) -- [EnvoyPluginStorage](classes/envoypluginstorage.md) -- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) -- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) -- [EnvoyUserAPI](classes/envoyuserapi.md) +- [EnvoyJWT](../wiki/Class:%20EnvoyJWT) +- [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +- [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +- [EnvoyPluginSDK](../wiki/Class:%20EnvoyPluginSDK) +- [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) +- [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +- [EnvoySignatureVerifier](../wiki/Class:%20EnvoySignatureVerifier) +- [EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) ### Interfaces -- [EnvoyBaseRequest](interfaces/envoybaserequest.md) -- [EnvoyResponse](interfaces/envoyresponse.md) -- [JSONAPIData](interfaces/jsonapidata.md) -- [VerifiedRequest](interfaces/verifiedrequest.md) +- [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest) +- [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) +- [JSONAPIData](../wiki/Interface:%20JSONAPIData) +- [VerifiedRequest](../wiki/Interface:%20VerifiedRequest) ### Type aliases -- [EntryPayload](README.md#entrypayload) -- [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) -- [EnvoyEventMeta](README.md#envoyeventmeta) -- [EnvoyEventRequest](README.md#envoyeventrequest) -- [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) -- [EnvoyMetaAuth](README.md#envoymetaauth) -- [EnvoyMetaCompany](README.md#envoymetacompany) -- [EnvoyMetaJob](README.md#envoymetajob) -- [EnvoyMetaLocation](README.md#envoymetalocation) -- [EnvoyMiddleware](README.md#envoymiddleware) -- [EnvoyRequest](README.md#envoyrequest) -- [EnvoyRouteMeta](README.md#envoyroutemeta) -- [EnvoyRouteRequest](README.md#envoyrouterequest) -- [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) -- [EnvoyStorageItem](README.md#envoystorageitem) -- [InvitePayload](README.md#invitepayload) +- [EntryPayload](../wiki/Home#entrypayload) +- [EnvoyEntryEventRequest](../wiki/Home#envoyentryeventrequest) +- [EnvoyEventMeta](../wiki/Home#envoyeventmeta) +- [EnvoyEventRequest](../wiki/Home#envoyeventrequest) +- [EnvoyInviteEventRequest](../wiki/Home#envoyinviteeventrequest) +- [EnvoyMetaAuth](../wiki/Home#envoymetaauth) +- [EnvoyMetaCompany](../wiki/Home#envoymetacompany) +- [EnvoyMetaJob](../wiki/Home#envoymetajob) +- [EnvoyMetaLocation](../wiki/Home#envoymetalocation) +- [EnvoyMiddleware](../wiki/Home#envoymiddleware) +- [EnvoyRequest](../wiki/Home#envoyrequest) +- [EnvoyRouteMeta](../wiki/Home#envoyroutemeta) +- [EnvoyRouteRequest](../wiki/Home#envoyrouterequest) +- [EnvoySignatureVerifierOptions](../wiki/Home#envoysignatureverifieroptions) +- [EnvoyStorageItem](../wiki/Home#envoystorageitem) +- [InvitePayload](../wiki/Home#invitepayload) ### Variables -- [VERIFIED](README.md#verified) +- [VERIFIED](../wiki/Home#verified) ### Functions -- [asyncHandler](README.md#asynchandler) -- [errorMiddleware](README.md#errormiddleware) -- [middleware](README.md#middleware) +- [asyncHandler](../wiki/Home#asynchandler) +- [errorMiddleware](../wiki/Home#errormiddleware) +- [middleware](../wiki/Home#middleware) ## Type aliases @@ -86,37 +82,37 @@ | `id` | `string` | | `relationships` | `Object` | | `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | +| `relationships.agreeable-ndas.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"agreeable-ndas"``\>[] | | `relationships.device?` | `Object` | -| `relationships.device.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"devices"``\> | +| `relationships.device.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"devices"``\> | | `relationships.employee?` | `Object` | -| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | +| `relationships.employee.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"employees"``\> | | `relationships.flow?` | `Object` | -| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | +| `relationships.flow.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"flows"``\> | | `relationships.invite?` | `Object` | -| `relationships.invite.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"invites"``\> | +| `relationships.invite.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"invites"``\> | | `relationships.location` | `Object` | -| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | +| `relationships.location.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"locations"``\> | | `relationships.visitor-entrance?` | `Object` | -| `relationships.visitor-entrance.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"visitor-entrances"``\> | +| `relationships.visitor-entrance.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"visitor-entrances"``\> | | `type` | ``"entries"`` | #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/payloads/EntryPayload.ts#L3) +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/payloads/EntryPayload.ts#L3) ___ ### EnvoyEntryEventRequest -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](../wiki/Home#envoyeventrequest)<[EntryPayload](../wiki/Home#entrypayload)\> Use to type your `req` object in entry event handlers, such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L39) ___ @@ -130,24 +126,24 @@ Metadata that will be included in the request body for events. | Name | Type | | :------ | :------ | -| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | -| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | +| `auth` | [EnvoyMetaAuth](../wiki/Home#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](../wiki/Home#envoymetacompany) | | `config` | `Record` | | `event` | `string` | | `install_id` | `string` | -| `job` | [EnvoyMetaJob](README.md#envoymetajob) | -| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `job` | [EnvoyMetaJob](../wiki/Home#envoymetajob) | +| `location` | [EnvoyMetaLocation](../wiki/Home#envoymetalocation) | | `plugin_id` | `string` | #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L54) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L54) ___ ### EnvoyEventRequest -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest)<[EnvoyEventMeta](../wiki/Home#envoyeventmeta), Payload\> Base type for event requests. You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. @@ -160,20 +156,20 @@ You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L33) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L33) ___ ### EnvoyInviteEventRequest -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](../wiki/Home#envoyeventrequest)<[InvitePayload](../wiki/Home#invitepayload)\> Use to type your `req` object in invite event handlers, such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L45) +[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L45) ___ @@ -197,7 +193,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L43) ___ @@ -218,7 +214,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L28) ___ @@ -236,7 +232,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L1) ___ @@ -268,13 +264,13 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L7) ___ ### EnvoyMiddleware -Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](../wiki/Home#envoyrequest), `res`: [EnvoyResponse](../wiki/Interface:%20EnvoyResponse), `next`: `NextFunction`) => `void` #### Type declaration @@ -284,8 +280,8 @@ ___ | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `req` | [EnvoyRequest](../wiki/Home#envoyrequest) | +| `res` | [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) | | `next` | `NextFunction` | ##### Returns @@ -294,13 +290,13 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/middleware.ts#L12) ___ ### EnvoyRequest -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest)<[EnvoyRouteMeta](../wiki/Home#envoyroutemeta) \| [EnvoyEventMeta](../wiki/Home#envoyeventmeta), Payload\> You probably won't need to use this type directly. For routes, use `EnvoyRouteRequest`, @@ -314,7 +310,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L52) +[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L52) ___ @@ -329,25 +325,25 @@ like validation URLs or options URLs. | Name | Type | | :------ | :------ | -| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | -| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | +| `auth` | [EnvoyMetaAuth](../wiki/Home#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](../wiki/Home#envoymetacompany) | | `config` | `Record` | | `forwarded_bearer_token?` | `string` | | `install_id` | `string` | -| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `location` | [EnvoyMetaLocation](../wiki/Home#envoymetalocation) | | `params` | `Record` | | `plugin_id` | `string` | | `route` | `string` | #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyMeta.ts#L69) +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L69) ___ ### EnvoyRouteRequest -Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest)<[EnvoyRouteMeta](../wiki/Home#envoyroutemeta), Payload\> Use to type your `req` object in route handlers, such as validation URLS or options URLs. @@ -360,7 +356,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L27) ___ @@ -379,7 +375,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoySignatureVerifier.ts#L5) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoySignatureVerifier.ts#L5) ___ @@ -396,7 +392,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyStorageItem.ts#L1) ___ @@ -435,36 +431,36 @@ ___ | `id` | `string` | | `relationships` | `Object` | | `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | +| `relationships.agreeable-ndas.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"agreeable-ndas"``\>[] | | `relationships.employee?` | `Object` | -| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | +| `relationships.employee.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"employees"``\> | | `relationships.entry?` | `Object` | -| `relationships.entry.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"entries"``\> | +| `relationships.entry.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"entries"``\> | | `relationships.flow?` | `Object` | -| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | +| `relationships.flow.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"flows"``\> | | `relationships.location` | `Object` | -| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | +| `relationships.location.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"locations"``\> | | `type` | ``"invites"`` | #### Defined in -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/payloads/InvitePayload.ts#L3) +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/payloads/InvitePayload.ts#L3) ## Variables ### VERIFIED -• `Const` **VERIFIED**: typeof [VERIFIED](README.md#verified) +• `Const` **VERIFIED**: typeof [VERIFIED](../wiki/Home#verified) #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L7) ## Functions ### asyncHandler -▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` +▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](../wiki/Home#envoyrequest), `res`: [EnvoyResponse](../wiki/Interface:%20EnvoyResponse), `next`: `NextFunction`) => `Promise` Catches Promise-based errors. @@ -484,8 +480,8 @@ Catches Promise-based errors. | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `req` | [EnvoyRequest](../wiki/Home#envoyrequest) | +| `res` | [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) | | `next` | `NextFunction` | ##### Returns @@ -494,13 +490,13 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/asyncHandler.ts#L10) ___ ### errorMiddleware -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](../wiki/Home#envoyrequest), `res`: [EnvoyResponse](../wiki/Interface:%20EnvoyResponse), `next`: `NextFunction`) => `void` Catches errors and sets the proper status code. @@ -521,8 +517,8 @@ Catches errors and sets the proper status code. | Name | Type | | :------ | :------ | | `err` | `Error` | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `req` | [EnvoyRequest](../wiki/Home#envoyrequest) | +| `res` | [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) | | `next` | `NextFunction` | ##### Returns @@ -531,13 +527,13 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/errorMiddleware.ts#L9) ___ ### middleware -▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) +▸ **middleware**(`options?`): [EnvoyMiddleware](../wiki/Home#envoymiddleware) Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. @@ -549,12 +545,12 @@ as well as managing the plugin access token lifecycle. | Name | Type | | :------ | :------ | -| `options?` | [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) | +| `options?` | [EnvoySignatureVerifierOptions](../wiki/Home#envoysignatureverifieroptions) | #### Returns -[EnvoyMiddleware](README.md#envoymiddleware) +[EnvoyMiddleware](../wiki/Home#envoymiddleware) #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/middleware.ts#L21) diff --git a/docs/interfaces/envoybaserequest.md b/docs/Interface: EnvoyBaseRequest.md similarity index 57% rename from docs/interfaces/envoybaserequest.md rename to docs/Interface: EnvoyBaseRequest.md index 45e2415..d2e223f 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/Interface: EnvoyBaseRequest.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyBaseRequest - -# Interface: EnvoyBaseRequest - Base type for Envoy requests. You probably won't need to use this type directly. For routes, use `EnvoyRouteRequest`, @@ -16,7 +12,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. ## Hierarchy -- [VerifiedRequest](verifiedrequest.md) +- [VerifiedRequest](../wiki/Interface:%20VerifiedRequest) ↳ **EnvoyBaseRequest** @@ -24,8 +20,8 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. ### Properties -- [[VERIFIED]](envoybaserequest.md#[verified]) -- [envoy](envoybaserequest.md#envoy) +- [[VERIFIED]](../wiki/Interface:%20EnvoyBaseRequest#%5Bverified%5D) +- [envoy](../wiki/Interface:%20EnvoyBaseRequest#envoy) ## Properties @@ -35,18 +31,18 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Inherited from -[VerifiedRequest](verifiedrequest.md).[[VERIFIED]](verifiedrequest.md#[verified]) +[VerifiedRequest](../wiki/Interface:%20VerifiedRequest).[[VERIFIED]](../wiki/Interface:%20VerifiedRequest#%5Bverified%5D) #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L10) ___ ### envoy -• **envoy**: [EnvoyPluginSDK](../classes/envoypluginsdk.md) +• **envoy**: [EnvoyPluginSDK](../wiki/Class:%20EnvoyPluginSDK) #### Defined in -[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L20) +[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L20) diff --git a/docs/interfaces/envoyresponse.md b/docs/Interface: EnvoyResponse.md similarity index 72% rename from docs/interfaces/envoyresponse.md rename to docs/Interface: EnvoyResponse.md index 0bac5c8..c626386 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/Interface: EnvoyResponse.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyResponse - -# Interface: EnvoyResponse - Use to type your `res` object in Envoy request handlers. ## Hierarchy @@ -14,20 +10,20 @@ Use to type your `res` object in Envoy request handlers. ### Properties -- [send](envoyresponse.md#send) -- [sendFailed](envoyresponse.md#sendfailed) -- [sendIgnored](envoyresponse.md#sendignored) -- [sendOngoing](envoyresponse.md#sendongoing) +- [send](../wiki/Interface:%20EnvoyResponse#send) +- [sendFailed](../wiki/Interface:%20EnvoyResponse#sendfailed) +- [sendIgnored](../wiki/Interface:%20EnvoyResponse#sendignored) +- [sendOngoing](../wiki/Interface:%20EnvoyResponse#sendongoing) ## Properties ### send -• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](envoyresponse.md) +• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) #### Type declaration -▸ (`debugInfo?`): [EnvoyResponse](envoyresponse.md) +▸ (`debugInfo?`): [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) ##### Parameters @@ -37,7 +33,7 @@ Use to type your `res` object in Envoy request handlers. ##### Returns -[EnvoyResponse](envoyresponse.md) +[EnvoyResponse](../wiki/Interface:%20EnvoyResponse) #### Overrides @@ -45,7 +41,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L8) ___ @@ -71,7 +67,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L11) ___ @@ -97,7 +93,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L10) ___ @@ -121,4 +117,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L9) diff --git a/docs/interfaces/jsonapidata.md b/docs/Interface: JSONAPIData.md similarity index 59% rename from docs/interfaces/jsonapidata.md rename to docs/Interface: JSONAPIData.md index b3ea6a9..0cd9d0b 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/Interface: JSONAPIData.md @@ -1,7 +1,3 @@ -[@envoy/envoy-integrations-sdk](../README.md) / JSONAPIData - -# Interface: JSONAPIData - ## Type parameters | Name | Type | @@ -13,8 +9,8 @@ ### Properties -- [id](jsonapidata.md#id) -- [type](jsonapidata.md#type) +- [id](../wiki/Interface:%20JSONAPIData#id) +- [type](../wiki/Interface:%20JSONAPIData#type) ## Properties @@ -24,7 +20,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +30,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/Interface: VerifiedRequest.md b/docs/Interface: VerifiedRequest.md new file mode 100644 index 0000000..ea7a665 --- /dev/null +++ b/docs/Interface: VerifiedRequest.md @@ -0,0 +1,23 @@ +## Hierarchy + +- `Request` + + ↳ **VerifiedRequest** + + ↳↳ [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest) + +## Table of contents + +### Properties + +- [[VERIFIED]](../wiki/Interface:%20VerifiedRequest#%5Bverified%5D) + +## Properties + +### [VERIFIED] + +• **[VERIFIED]**: `boolean` + +#### Defined in + +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L10) diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md new file mode 100644 index 0000000..35dafc5 --- /dev/null +++ b/docs/_Sidebar.md @@ -0,0 +1,25 @@ +## @envoy/envoy-integrations-sdk + +- [Home](../wiki/Home) + +### Enumerations + +- [HttpStatus](../wiki/Enumeration:%20HttpStatus) + +### Classes + +- [EnvoyJWT](../wiki/Class:%20EnvoyJWT) +- [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +- [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +- [EnvoyPluginSDK](../wiki/Class:%20EnvoyPluginSDK) +- [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) +- [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +- [EnvoySignatureVerifier](../wiki/Class:%20EnvoySignatureVerifier) +- [EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) + +### Interfaces + +- [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest) +- [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) +- [JSONAPIData](../wiki/Interface:%20JSONAPIData) +- [VerifiedRequest](../wiki/Interface:%20VerifiedRequest) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md deleted file mode 100644 index 4f63ac8..0000000 --- a/docs/interfaces/verifiedrequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / VerifiedRequest - -# Interface: VerifiedRequest - -## Hierarchy - -- `Request` - - ↳ **VerifiedRequest** - - ↳↳ [EnvoyBaseRequest](envoybaserequest.md) - -## Table of contents - -### Properties - -- [[VERIFIED]](verifiedrequest.md#[verified]) - -## Properties - -### [VERIFIED] - -• **[VERIFIED]**: `boolean` - -#### Defined in - -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/a7acad5/src/EnvoyRequest.ts#L10) diff --git a/typedoc.json b/typedoc.json index 3016739..b3c22df 100644 --- a/typedoc.json +++ b/typedoc.json @@ -5,5 +5,5 @@ "excludeProtected": true, "excludeExternals": true, "readme": "none", - "theme": "typedoc-github-wiki-theme/dist" + "theme": "./node_modules/typedoc-github-wiki-theme/dist" } From cd208f9184994230cc7266b3f6bfe991c9006450 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 4 Jun 2021 18:52:33 -0400 Subject: [PATCH 24/91] fixing docs --- docs/Interface: VerifiedRequest.md | 23 --- docs/{Home.md => README.md} | 184 +++++++++--------- docs/_Sidebar.md | 25 --- .../envoyjwt.md} | 16 +- .../envoypluginapi.md} | 44 +++-- .../envoypluginjob.md} | 44 +++-- .../envoypluginsdk.md} | 78 ++++---- .../envoypluginstorage.md} | 68 ++++--- .../envoypluginstoragepipeline.md} | 84 ++++---- .../envoysignatureverifier.md} | 14 +- .../envoyuserapi.md} | 104 +++++----- .../httpstatus.md} | 20 +- .../envoybaserequest.md} | 18 +- .../envoyresponse.md} | 26 +-- .../jsonapidata.md} | 12 +- docs/interfaces/verifiedrequest.md | 27 +++ typedoc.json | 3 +- 17 files changed, 410 insertions(+), 380 deletions(-) delete mode 100644 docs/Interface: VerifiedRequest.md rename docs/{Home.md => README.md} (61%) delete mode 100644 docs/_Sidebar.md rename docs/{Class: EnvoyJWT.md => classes/envoyjwt.md} (78%) rename docs/{Class: EnvoyPluginAPI.md => classes/envoypluginapi.md} (69%) rename docs/{Class: EnvoyPluginJob.md => classes/envoypluginjob.md} (72%) rename docs/{Class: EnvoyPluginSDK.md => classes/envoypluginsdk.md} (59%) rename docs/{Class: EnvoyPluginStorage.md => classes/envoypluginstorage.md} (57%) rename docs/{Class: EnvoyPluginStoragePipeline.md => classes/envoypluginstoragepipeline.md} (52%) rename docs/{Class: EnvoySignatureVerifier.md => classes/envoysignatureverifier.md} (65%) rename docs/{Class: EnvoyUserAPI.md => classes/envoyuserapi.md} (72%) rename docs/{Enumeration: HttpStatus.md => enums/httpstatus.md} (60%) rename docs/{Interface: EnvoyBaseRequest.md => interfaces/envoybaserequest.md} (57%) rename docs/{Interface: EnvoyResponse.md => interfaces/envoyresponse.md} (72%) rename docs/{Interface: JSONAPIData.md => interfaces/jsonapidata.md} (59%) create mode 100644 docs/interfaces/verifiedrequest.md diff --git a/docs/Interface: VerifiedRequest.md b/docs/Interface: VerifiedRequest.md deleted file mode 100644 index ea7a665..0000000 --- a/docs/Interface: VerifiedRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -## Hierarchy - -- `Request` - - ↳ **VerifiedRequest** - - ↳↳ [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest) - -## Table of contents - -### Properties - -- [[VERIFIED]](../wiki/Interface:%20VerifiedRequest#%5Bverified%5D) - -## Properties - -### [VERIFIED] - -• **[VERIFIED]**: `boolean` - -#### Defined in - -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L10) diff --git a/docs/Home.md b/docs/README.md similarity index 61% rename from docs/Home.md rename to docs/README.md index bce9558..ca7ad75 100644 --- a/docs/Home.md +++ b/docs/README.md @@ -1,55 +1,59 @@ +@envoy/envoy-integrations-sdk + +# @envoy/envoy-integrations-sdk + ## Table of contents ### Enumerations -- [HttpStatus](../wiki/Enumeration:%20HttpStatus) +- [HttpStatus](enums/httpstatus.md) ### Classes -- [EnvoyJWT](../wiki/Class:%20EnvoyJWT) -- [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) -- [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) -- [EnvoyPluginSDK](../wiki/Class:%20EnvoyPluginSDK) -- [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) -- [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) -- [EnvoySignatureVerifier](../wiki/Class:%20EnvoySignatureVerifier) -- [EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) +- [EnvoyJWT](classes/envoyjwt.md) +- [EnvoyPluginAPI](classes/envoypluginapi.md) +- [EnvoyPluginJob](classes/envoypluginjob.md) +- [EnvoyPluginSDK](classes/envoypluginsdk.md) +- [EnvoyPluginStorage](classes/envoypluginstorage.md) +- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) +- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) +- [EnvoyUserAPI](classes/envoyuserapi.md) ### Interfaces -- [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest) -- [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) -- [JSONAPIData](../wiki/Interface:%20JSONAPIData) -- [VerifiedRequest](../wiki/Interface:%20VerifiedRequest) +- [EnvoyBaseRequest](interfaces/envoybaserequest.md) +- [EnvoyResponse](interfaces/envoyresponse.md) +- [JSONAPIData](interfaces/jsonapidata.md) +- [VerifiedRequest](interfaces/verifiedrequest.md) ### Type aliases -- [EntryPayload](../wiki/Home#entrypayload) -- [EnvoyEntryEventRequest](../wiki/Home#envoyentryeventrequest) -- [EnvoyEventMeta](../wiki/Home#envoyeventmeta) -- [EnvoyEventRequest](../wiki/Home#envoyeventrequest) -- [EnvoyInviteEventRequest](../wiki/Home#envoyinviteeventrequest) -- [EnvoyMetaAuth](../wiki/Home#envoymetaauth) -- [EnvoyMetaCompany](../wiki/Home#envoymetacompany) -- [EnvoyMetaJob](../wiki/Home#envoymetajob) -- [EnvoyMetaLocation](../wiki/Home#envoymetalocation) -- [EnvoyMiddleware](../wiki/Home#envoymiddleware) -- [EnvoyRequest](../wiki/Home#envoyrequest) -- [EnvoyRouteMeta](../wiki/Home#envoyroutemeta) -- [EnvoyRouteRequest](../wiki/Home#envoyrouterequest) -- [EnvoySignatureVerifierOptions](../wiki/Home#envoysignatureverifieroptions) -- [EnvoyStorageItem](../wiki/Home#envoystorageitem) -- [InvitePayload](../wiki/Home#invitepayload) +- [EntryPayload](README.md#entrypayload) +- [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) +- [EnvoyEventMeta](README.md#envoyeventmeta) +- [EnvoyEventRequest](README.md#envoyeventrequest) +- [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) +- [EnvoyMetaAuth](README.md#envoymetaauth) +- [EnvoyMetaCompany](README.md#envoymetacompany) +- [EnvoyMetaJob](README.md#envoymetajob) +- [EnvoyMetaLocation](README.md#envoymetalocation) +- [EnvoyMiddleware](README.md#envoymiddleware) +- [EnvoyRequest](README.md#envoyrequest) +- [EnvoyRouteMeta](README.md#envoyroutemeta) +- [EnvoyRouteRequest](README.md#envoyrouterequest) +- [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) +- [EnvoyStorageItem](README.md#envoystorageitem) +- [InvitePayload](README.md#invitepayload) ### Variables -- [VERIFIED](../wiki/Home#verified) +- [VERIFIED](README.md#verified) ### Functions -- [asyncHandler](../wiki/Home#asynchandler) -- [errorMiddleware](../wiki/Home#errormiddleware) -- [middleware](../wiki/Home#middleware) +- [asyncHandler](README.md#asynchandler) +- [errorMiddleware](README.md#errormiddleware) +- [middleware](README.md#middleware) ## Type aliases @@ -82,37 +86,37 @@ | `id` | `string` | | `relationships` | `Object` | | `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"agreeable-ndas"``\>[] | +| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | | `relationships.device?` | `Object` | -| `relationships.device.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"devices"``\> | +| `relationships.device.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"devices"``\> | | `relationships.employee?` | `Object` | -| `relationships.employee.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"employees"``\> | +| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | | `relationships.flow?` | `Object` | -| `relationships.flow.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"flows"``\> | +| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | | `relationships.invite?` | `Object` | -| `relationships.invite.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"invites"``\> | +| `relationships.invite.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"invites"``\> | | `relationships.location` | `Object` | -| `relationships.location.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"locations"``\> | +| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | | `relationships.visitor-entrance?` | `Object` | -| `relationships.visitor-entrance.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"visitor-entrances"``\> | +| `relationships.visitor-entrance.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"visitor-entrances"``\> | | `type` | ``"entries"`` | #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/payloads/EntryPayload.ts#L3) +[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/payloads/EntryPayload.ts#L3) ___ ### EnvoyEntryEventRequest -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](../wiki/Home#envoyeventrequest)<[EntryPayload](../wiki/Home#entrypayload)\> +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> Use to type your `req` object in entry event handlers, such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L39) +[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L39) ___ @@ -126,24 +130,24 @@ Metadata that will be included in the request body for events. | Name | Type | | :------ | :------ | -| `auth` | [EnvoyMetaAuth](../wiki/Home#envoymetaauth) \| ``null`` | -| `company` | [EnvoyMetaCompany](../wiki/Home#envoymetacompany) | +| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | | `config` | `Record` | | `event` | `string` | | `install_id` | `string` | -| `job` | [EnvoyMetaJob](../wiki/Home#envoymetajob) | -| `location` | [EnvoyMetaLocation](../wiki/Home#envoymetalocation) | +| `job` | [EnvoyMetaJob](README.md#envoymetajob) | +| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | | `plugin_id` | `string` | #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L54) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L54) ___ ### EnvoyEventRequest -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest)<[EnvoyEventMeta](../wiki/Home#envoyeventmeta), Payload\> +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> Base type for event requests. You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. @@ -156,20 +160,20 @@ You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L33) +[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L33) ___ ### EnvoyInviteEventRequest -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](../wiki/Home#envoyeventrequest)<[InvitePayload](../wiki/Home#invitepayload)\> +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> Use to type your `req` object in invite event handlers, such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L45) +[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L45) ___ @@ -193,7 +197,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L43) ___ @@ -214,7 +218,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L28) ___ @@ -232,7 +236,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L1) ___ @@ -264,13 +268,13 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L7) ___ ### EnvoyMiddleware -Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](../wiki/Home#envoyrequest), `res`: [EnvoyResponse](../wiki/Interface:%20EnvoyResponse), `next`: `NextFunction`) => `void` +Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` #### Type declaration @@ -280,8 +284,8 @@ ___ | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](../wiki/Home#envoyrequest) | -| `res` | [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -290,13 +294,13 @@ ___ #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/middleware.ts#L12) +[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/middleware.ts#L12) ___ ### EnvoyRequest -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest)<[EnvoyRouteMeta](../wiki/Home#envoyroutemeta) \| [EnvoyEventMeta](../wiki/Home#envoyeventmeta), Payload\> +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> You probably won't need to use this type directly. For routes, use `EnvoyRouteRequest`, @@ -310,7 +314,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L52) +[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L52) ___ @@ -325,25 +329,25 @@ like validation URLs or options URLs. | Name | Type | | :------ | :------ | -| `auth` | [EnvoyMetaAuth](../wiki/Home#envoymetaauth) \| ``null`` | -| `company` | [EnvoyMetaCompany](../wiki/Home#envoymetacompany) | +| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | | `config` | `Record` | | `forwarded_bearer_token?` | `string` | | `install_id` | `string` | -| `location` | [EnvoyMetaLocation](../wiki/Home#envoymetalocation) | +| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | | `params` | `Record` | | `plugin_id` | `string` | | `route` | `string` | #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyMeta.ts#L69) +[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L69) ___ ### EnvoyRouteRequest -Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest)<[EnvoyRouteMeta](../wiki/Home#envoyroutemeta), Payload\> +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> Use to type your `req` object in route handlers, such as validation URLS or options URLs. @@ -356,7 +360,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L27) ___ @@ -375,7 +379,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoySignatureVerifier.ts#L5) +[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoySignatureVerifier.ts#L5) ___ @@ -392,7 +396,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyStorageItem.ts#L1) +[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyStorageItem.ts#L1) ___ @@ -431,36 +435,36 @@ ___ | `id` | `string` | | `relationships` | `Object` | | `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"agreeable-ndas"``\>[] | +| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | | `relationships.employee?` | `Object` | -| `relationships.employee.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"employees"``\> | +| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | | `relationships.entry?` | `Object` | -| `relationships.entry.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"entries"``\> | +| `relationships.entry.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"entries"``\> | | `relationships.flow?` | `Object` | -| `relationships.flow.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"flows"``\> | +| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | | `relationships.location` | `Object` | -| `relationships.location.data` | [JSONAPIData](../wiki/Interface:%20JSONAPIData)<``"locations"``\> | +| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | | `type` | ``"invites"`` | #### Defined in -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/payloads/InvitePayload.ts#L3) +[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/payloads/InvitePayload.ts#L3) ## Variables ### VERIFIED -• `Const` **VERIFIED**: typeof [VERIFIED](../wiki/Home#verified) +• `Const` **VERIFIED**: typeof [VERIFIED](README.md#verified) #### Defined in -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L7) +[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L7) ## Functions ### asyncHandler -▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](../wiki/Home#envoyrequest), `res`: [EnvoyResponse](../wiki/Interface:%20EnvoyResponse), `next`: `NextFunction`) => `Promise` +▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` Catches Promise-based errors. @@ -480,8 +484,8 @@ Catches Promise-based errors. | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](../wiki/Home#envoyrequest) | -| `res` | [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -490,13 +494,13 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/asyncHandler.ts#L10) +[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/asyncHandler.ts#L10) ___ ### errorMiddleware -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](../wiki/Home#envoyrequest), `res`: [EnvoyResponse](../wiki/Interface:%20EnvoyResponse), `next`: `NextFunction`) => `void` +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` Catches errors and sets the proper status code. @@ -517,8 +521,8 @@ Catches errors and sets the proper status code. | Name | Type | | :------ | :------ | | `err` | `Error` | -| `req` | [EnvoyRequest](../wiki/Home#envoyrequest) | -| `res` | [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -527,13 +531,13 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/errorMiddleware.ts#L9) ___ ### middleware -▸ **middleware**(`options?`): [EnvoyMiddleware](../wiki/Home#envoymiddleware) +▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. @@ -545,12 +549,12 @@ as well as managing the plugin access token lifecycle. | Name | Type | | :------ | :------ | -| `options?` | [EnvoySignatureVerifierOptions](../wiki/Home#envoysignatureverifieroptions) | +| `options?` | [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) | #### Returns -[EnvoyMiddleware](../wiki/Home#envoymiddleware) +[EnvoyMiddleware](README.md#envoymiddleware) #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/middleware.ts#L21) +[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/middleware.ts#L21) diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md deleted file mode 100644 index 35dafc5..0000000 --- a/docs/_Sidebar.md +++ /dev/null @@ -1,25 +0,0 @@ -## @envoy/envoy-integrations-sdk - -- [Home](../wiki/Home) - -### Enumerations - -- [HttpStatus](../wiki/Enumeration:%20HttpStatus) - -### Classes - -- [EnvoyJWT](../wiki/Class:%20EnvoyJWT) -- [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) -- [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) -- [EnvoyPluginSDK](../wiki/Class:%20EnvoyPluginSDK) -- [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) -- [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) -- [EnvoySignatureVerifier](../wiki/Class:%20EnvoySignatureVerifier) -- [EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) - -### Interfaces - -- [EnvoyBaseRequest](../wiki/Interface:%20EnvoyBaseRequest) -- [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) -- [JSONAPIData](../wiki/Interface:%20JSONAPIData) -- [VerifiedRequest](../wiki/Interface:%20VerifiedRequest) diff --git a/docs/Class: EnvoyJWT.md b/docs/classes/envoyjwt.md similarity index 78% rename from docs/Class: EnvoyJWT.md rename to docs/classes/envoyjwt.md index f284688..236f1ff 100644 --- a/docs/Class: EnvoyJWT.md +++ b/docs/classes/envoyjwt.md @@ -1,15 +1,19 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyJWT + +# Class: EnvoyJWT + Helper to encode and decode JWTs. ## Table of contents ### Constructors -- [constructor](../wiki/Class:%20EnvoyJWT#constructor) +- [constructor](envoyjwt.md#constructor) ### Methods -- [decode](../wiki/Class:%20EnvoyJWT#decode) -- [encode](../wiki/Class:%20EnvoyJWT#encode) +- [decode](envoyjwt.md#decode) +- [encode](envoyjwt.md#encode) ## Constructors @@ -26,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyJWT.ts#L12) ## Methods @@ -47,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyJWT.ts#L39) ___ @@ -69,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyJWT.ts#L22) diff --git a/docs/Class: EnvoyPluginAPI.md b/docs/classes/envoypluginapi.md similarity index 69% rename from docs/Class: EnvoyPluginAPI.md rename to docs/classes/envoypluginapi.md index c70723d..54ede45 100644 --- a/docs/Class: EnvoyPluginAPI.md +++ b/docs/classes/envoypluginapi.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginAPI + +# Class: EnvoyPluginAPI + API endpoints for *plugin-scoped* tokens. ## Hierarchy @@ -10,20 +14,20 @@ API endpoints for *plugin-scoped* tokens. ### Constructors -- [constructor](../wiki/Class:%20EnvoyPluginAPI#constructor) +- [constructor](envoypluginapi.md#constructor) ### Properties -- [axios](../wiki/Class:%20EnvoyPluginAPI#axios) +- [axios](envoypluginapi.md#axios) ### Methods -- [createNotification](../wiki/Class:%20EnvoyPluginAPI#createnotification) -- [getPluginInstallConfig](../wiki/Class:%20EnvoyPluginAPI#getplugininstallconfig) -- [setPluginInstallConfig](../wiki/Class:%20EnvoyPluginAPI#setplugininstallconfig) -- [storagePipeline](../wiki/Class:%20EnvoyPluginAPI#storagepipeline) -- [updateJob](../wiki/Class:%20EnvoyPluginAPI#updatejob) -- [login](../wiki/Class:%20EnvoyPluginAPI#login) +- [createNotification](envoypluginapi.md#createnotification) +- [getPluginInstallConfig](envoypluginapi.md#getplugininstallconfig) +- [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) +- [storagePipeline](envoypluginapi.md#storagepipeline) +- [updateJob](envoypluginapi.md#updatejob) +- [login](envoypluginapi.md#login) ## Constructors @@ -43,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L58) ## Properties @@ -59,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L31) ## Methods @@ -80,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L50) ___ @@ -100,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L21) ___ @@ -121,13 +125,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L26) ___ ### storagePipeline -▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Parameters @@ -138,11 +142,11 @@ ___ #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L34) ___ @@ -163,13 +167,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L13) ___ ### login -▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> +▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a plugin access token using `client_credentials` as the grant type. @@ -182,8 +186,8 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Returns -`Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L61) diff --git a/docs/Class: EnvoyPluginJob.md b/docs/classes/envoypluginjob.md similarity index 72% rename from docs/Class: EnvoyPluginJob.md rename to docs/classes/envoypluginjob.md index 2a16590..acc7d70 100644 --- a/docs/Class: EnvoyPluginJob.md +++ b/docs/classes/envoypluginjob.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginJob + +# Class: EnvoyPluginJob + A "job" is an event, like `entry_sign_in`. When your plugin handles the event, you can use this job concept to update the status (e.g. complete, failed, ignored) @@ -8,21 +12,21 @@ as well as attach extra data to the event's subject ### Constructors -- [constructor](../wiki/Class:%20EnvoyPluginJob#constructor) +- [constructor](envoypluginjob.md#constructor) ### Properties -- [api](../wiki/Class:%20EnvoyPluginJob#api) -- [id](../wiki/Class:%20EnvoyPluginJob#id) +- [api](envoypluginjob.md#api) +- [id](envoypluginjob.md#id) ### Methods -- [attach](../wiki/Class:%20EnvoyPluginJob#attach) -- [complete](../wiki/Class:%20EnvoyPluginJob#complete) -- [execute](../wiki/Class:%20EnvoyPluginJob#execute) -- [fail](../wiki/Class:%20EnvoyPluginJob#fail) -- [ignore](../wiki/Class:%20EnvoyPluginJob#ignore) -- [update](../wiki/Class:%20EnvoyPluginJob#update) +- [attach](envoypluginjob.md#attach) +- [complete](envoypluginjob.md#complete) +- [execute](envoypluginjob.md#execute) +- [fail](envoypluginjob.md#fail) +- [ignore](envoypluginjob.md#ignore) +- [update](envoypluginjob.md#update) ## Constructors @@ -34,22 +38,22 @@ as well as attach extra data to the event's subject | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | | `jobId` | `string` | #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L15) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L13) ___ @@ -59,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L15) ## Methods @@ -79,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L43) ___ @@ -100,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L47) ___ @@ -123,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L22) ___ @@ -144,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L55) ___ @@ -165,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L51) ___ @@ -186,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L59) diff --git a/docs/Class: EnvoyPluginSDK.md b/docs/classes/envoypluginsdk.md similarity index 59% rename from docs/Class: EnvoyPluginSDK.md rename to docs/classes/envoypluginsdk.md index 1265242..1737369 100644 --- a/docs/Class: EnvoyPluginSDK.md +++ b/docs/classes/envoypluginsdk.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginSDK + +# Class: EnvoyPluginSDK + Sets up all relevant Envoy functions. Attaches itself to every request object using our `middleware`, to allow for easy access to Envoy functions. @@ -13,20 +17,20 @@ to allow for easy access to Envoy functions. ### Constructors -- [constructor](../wiki/Class:%20EnvoyPluginSDK#constructor) +- [constructor](envoypluginsdk.md#constructor) ### Accessors -- [getJob](../wiki/Class:%20EnvoyPluginSDK#getjob) -- [globalStorage](../wiki/Class:%20EnvoyPluginSDK#globalstorage) -- [installStorage](../wiki/Class:%20EnvoyPluginSDK#installstorage) -- [job](../wiki/Class:%20EnvoyPluginSDK#job) -- [jobId](../wiki/Class:%20EnvoyPluginSDK#jobid) -- [jwt](../wiki/Class:%20EnvoyPluginSDK#jwt) -- [meta](../wiki/Class:%20EnvoyPluginSDK#meta) -- [payload](../wiki/Class:%20EnvoyPluginSDK#payload) -- [pluginAPI](../wiki/Class:%20EnvoyPluginSDK#pluginapi) -- [userAPI](../wiki/Class:%20EnvoyPluginSDK#userapi) +- [getJob](envoypluginsdk.md#getjob) +- [globalStorage](envoypluginsdk.md#globalstorage) +- [installStorage](envoypluginsdk.md#installstorage) +- [job](envoypluginsdk.md#job) +- [jobId](envoypluginsdk.md#jobid) +- [jwt](envoypluginsdk.md#jwt) +- [meta](envoypluginsdk.md#meta) +- [payload](envoypluginsdk.md#payload) +- [pluginAPI](envoypluginsdk.md#pluginapi) +- [userAPI](envoypluginsdk.md#userapi) ## Constructors @@ -51,13 +55,13 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L38) ## Accessors ### getJob -• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +• `get` **getJob**(): (`jobId`: `string`) => [EnvoyPluginJob](envoypluginjob.md) Returns a job based on an ID. @@ -65,7 +69,7 @@ Returns a job based on an ID. `fn` -▸ (`jobId`): [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +▸ (`jobId`): [EnvoyPluginJob](envoypluginjob.md) ##### Parameters @@ -75,59 +79,59 @@ Returns a job based on an ID. ##### Returns -[EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +[EnvoyPluginJob](envoypluginjob.md) #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L129) ___ ### globalStorage -• `get` **globalStorage**(): [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) +• `get` **globalStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) Storage scoped globally (across installs). #### Returns -[EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) +[EnvoyPluginStorage](envoypluginstorage.md) #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L122) ___ ### installStorage -• `get` **installStorage**(): [EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) +• `get` **installStorage**(): [EnvoyPluginStorage](envoypluginstorage.md) Storage scoped to the install. #### Returns -[EnvoyPluginStorage](../wiki/Class:%20EnvoyPluginStorage) +[EnvoyPluginStorage](envoypluginstorage.md) #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L111) ___ ### job -• `get` **job**(): [EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +• `get` **job**(): [EnvoyPluginJob](envoypluginjob.md) Perform operations on the current job. #### Returns -[EnvoyPluginJob](../wiki/Class:%20EnvoyPluginJob) +[EnvoyPluginJob](envoypluginjob.md) #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L147) ___ @@ -143,24 +147,24 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L136) ___ ### jwt -• `get` **jwt**(): [EnvoyJWT](../wiki/Class:%20EnvoyJWT) +• `get` **jwt**(): [EnvoyJWT](envoyjwt.md) A utility to encode and decode JWTs. Useful for verifiable communications between plugin endpoints. #### Returns -[EnvoyJWT](../wiki/Class:%20EnvoyJWT) +[EnvoyJWT](envoyjwt.md) #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L160) ___ @@ -177,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L50) ___ @@ -195,38 +199,38 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L62) ___ ### pluginAPI -• `get` **pluginAPI**(): [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +• `get` **pluginAPI**(): [EnvoyPluginAPI](envoypluginapi.md) Envoy API scoped to the plugin. Used to perform storage or job operations. #### Returns -[EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +[EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L90) ___ ### userAPI -• `get` **userAPI**(): [EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) +• `get` **userAPI**(): [EnvoyUserAPI](envoyuserapi.md) Envoy API scoped to the user. Used only in routes. #### Returns -[EnvoyUserAPI](../wiki/Class:%20EnvoyUserAPI) +[EnvoyUserAPI](envoyuserapi.md) #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L73) diff --git a/docs/Class: EnvoyPluginStorage.md b/docs/classes/envoypluginstorage.md similarity index 57% rename from docs/Class: EnvoyPluginStorage.md rename to docs/classes/envoypluginstorage.md index c877032..ed4c830 100644 --- a/docs/Class: EnvoyPluginStorage.md +++ b/docs/classes/envoypluginstorage.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStorage + +# Class: EnvoyPluginStorage + A key-value storage that can be scoped to a specific install, or to the plugin itself. @@ -5,21 +9,21 @@ or to the plugin itself. ### Constructors -- [constructor](../wiki/Class:%20EnvoyPluginStorage#constructor) +- [constructor](envoypluginstorage.md#constructor) ### Properties -- [api](../wiki/Class:%20EnvoyPluginStorage#api) -- [installId](../wiki/Class:%20EnvoyPluginStorage#installid) +- [api](envoypluginstorage.md#api) +- [installId](envoypluginstorage.md#installid) ### Methods -- [get](../wiki/Class:%20EnvoyPluginStorage#get) -- [pipeline](../wiki/Class:%20EnvoyPluginStorage#pipeline) -- [set](../wiki/Class:%20EnvoyPluginStorage#set) -- [setUnique](../wiki/Class:%20EnvoyPluginStorage#setunique) -- [setUniqueNum](../wiki/Class:%20EnvoyPluginStorage#setuniquenum) -- [unset](../wiki/Class:%20EnvoyPluginStorage#unset) +- [get](envoypluginstorage.md#get) +- [pipeline](envoypluginstorage.md#pipeline) +- [set](envoypluginstorage.md#set) +- [setUnique](envoypluginstorage.md#setunique) +- [setUniqueNum](envoypluginstorage.md#setuniquenum) +- [unset](envoypluginstorage.md#unset) ## Constructors @@ -31,22 +35,22 @@ or to the plugin itself. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L13) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L11) ___ @@ -56,13 +60,13 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L13) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline get. @@ -74,33 +78,33 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L30) ___ ### pipeline -▸ **pipeline**(): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **pipeline**(): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Creates a new pipeline instance. #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L23) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline set. @@ -113,17 +117,17 @@ Wrapper for single pipeline set. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L37) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -136,17 +140,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L44) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline setUnique. @@ -159,17 +163,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L51) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Wrapper for single pipeline unset. Returns null if the item did not previously exist. @@ -182,8 +186,8 @@ Returns null if the item did not previously exist. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L59) diff --git a/docs/Class: EnvoyPluginStoragePipeline.md b/docs/classes/envoypluginstoragepipeline.md similarity index 52% rename from docs/Class: EnvoyPluginStoragePipeline.md rename to docs/classes/envoypluginstoragepipeline.md index 2100bae..6fc645a 100644 --- a/docs/Class: EnvoyPluginStoragePipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -1,26 +1,30 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStoragePipeline + +# Class: EnvoyPluginStoragePipeline + Builds up a request pipeline for submitting storage commands. ## Table of contents ### Constructors -- [constructor](../wiki/Class:%20EnvoyPluginStoragePipeline#constructor) +- [constructor](envoypluginstoragepipeline.md#constructor) ### Properties -- [api](../wiki/Class:%20EnvoyPluginStoragePipeline#api) -- [installId](../wiki/Class:%20EnvoyPluginStoragePipeline#installid) +- [api](envoypluginstoragepipeline.md#api) +- [installId](envoypluginstoragepipeline.md#installid) ### Methods -- [addCommand](../wiki/Class:%20EnvoyPluginStoragePipeline#addcommand) -- [execute](../wiki/Class:%20EnvoyPluginStoragePipeline#execute) -- [executeSingle](../wiki/Class:%20EnvoyPluginStoragePipeline#executesingle) -- [get](../wiki/Class:%20EnvoyPluginStoragePipeline#get) -- [set](../wiki/Class:%20EnvoyPluginStoragePipeline#set) -- [setUnique](../wiki/Class:%20EnvoyPluginStoragePipeline#setunique) -- [setUniqueNum](../wiki/Class:%20EnvoyPluginStoragePipeline#setuniquenum) -- [unset](../wiki/Class:%20EnvoyPluginStoragePipeline#unset) +- [addCommand](envoypluginstoragepipeline.md#addcommand) +- [execute](envoypluginstoragepipeline.md#execute) +- [executeSingle](envoypluginstoragepipeline.md#executesingle) +- [get](envoypluginstoragepipeline.md#get) +- [set](envoypluginstoragepipeline.md#set) +- [setUnique](envoypluginstoragepipeline.md#setunique) +- [setUniqueNum](envoypluginstoragepipeline.md#setuniquenum) +- [unset](envoypluginstoragepipeline.md#unset) ## Constructors @@ -32,22 +36,22 @@ Builds up a request pipeline for submitting storage commands. | Name | Type | | :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) | +| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | | `installId?` | `string` | #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L16) ## Properties ### api -• `Readonly` **api**: [EnvoyPluginAPI](../wiki/Class:%20EnvoyPluginAPI) +• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L12) ___ @@ -57,13 +61,13 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L14) ## Methods ### addCommand -▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Parameters @@ -73,49 +77,49 @@ ___ #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L39) ___ ### execute -▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> +▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> Executes all the commands in the pipeline. #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L27) ___ ### executeSingle -▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Executes the pipeline and returns the first result. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../wiki/Home#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L34) ___ ### get -▸ **get**(`key`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **get**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Gets a storage item. @@ -127,17 +131,17 @@ Gets a storage item. #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L47) ___ ### set -▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Sets a value for a storage item, and returns that item. @@ -151,17 +155,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L55) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Sets a unique value for a storage item, and returns that item. @@ -175,17 +179,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L63) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Sets a unique number value for a storage item, and returns that item. @@ -199,17 +203,17 @@ and returns that item. #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L71) ___ ### unset -▸ **unset**(`key`): [EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +▸ **unset**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) Unsets a storage item. @@ -221,8 +225,8 @@ Unsets a storage item. #### Returns -[EnvoyPluginStoragePipeline](../wiki/Class:%20EnvoyPluginStoragePipeline) +[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L78) diff --git a/docs/Class: EnvoySignatureVerifier.md b/docs/classes/envoysignatureverifier.md similarity index 65% rename from docs/Class: EnvoySignatureVerifier.md rename to docs/classes/envoysignatureverifier.md index aa54267..aa07add 100644 --- a/docs/Class: EnvoySignatureVerifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -1,14 +1,18 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifier + +# Class: EnvoySignatureVerifier + Verifies that a request is coming from Envoy. ## Table of contents ### Constructors -- [constructor](../wiki/Class:%20EnvoySignatureVerifier#constructor) +- [constructor](envoysignatureverifier.md#constructor) ### Methods -- [verify](../wiki/Class:%20EnvoySignatureVerifier#verify) +- [verify](envoysignatureverifier.md#verify) ## Constructors @@ -20,11 +24,11 @@ Verifies that a request is coming from Envoy. | Name | Type | | :------ | :------ | -| `options` | [EnvoySignatureVerifierOptions](../wiki/Home#envoysignatureverifieroptions) | +| `options` | [EnvoySignatureVerifierOptions](../README.md#envoysignatureverifieroptions) | #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoySignatureVerifier.ts#L23) ## Methods @@ -47,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoySignatureVerifier.ts#L36) diff --git a/docs/Class: EnvoyUserAPI.md b/docs/classes/envoyuserapi.md similarity index 72% rename from docs/Class: EnvoyUserAPI.md rename to docs/classes/envoyuserapi.md index 6d895d0..bf24b1f 100644 --- a/docs/Class: EnvoyUserAPI.md +++ b/docs/classes/envoyuserapi.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyUserAPI + +# Class: EnvoyUserAPI + API endpoints for *user-scoped* tokens. To access Envoy resources, this is the API you'd want. @@ -11,35 +15,35 @@ To access Envoy resources, this is the API you'd want. ### Constructors -- [constructor](../wiki/Class:%20EnvoyUserAPI#constructor) +- [constructor](envoyuserapi.md#constructor) ### Properties -- [axios](../wiki/Class:%20EnvoyUserAPI#axios) +- [axios](envoyuserapi.md#axios) ### Methods -- [createInvite](../wiki/Class:%20EnvoyUserAPI#createinvite) -- [getAgreement](../wiki/Class:%20EnvoyUserAPI#getagreement) -- [getAgreementPage](../wiki/Class:%20EnvoyUserAPI#getagreementpage) -- [getCompany](../wiki/Class:%20EnvoyUserAPI#getcompany) -- [getEmployee](../wiki/Class:%20EnvoyUserAPI#getemployee) -- [getEmployeeByEmail](../wiki/Class:%20EnvoyUserAPI#getemployeebyemail) -- [getEmployees](../wiki/Class:%20EnvoyUserAPI#getemployees) -- [getFlow](../wiki/Class:%20EnvoyUserAPI#getflow) -- [getFlows](../wiki/Class:%20EnvoyUserAPI#getflows) -- [getInvites](../wiki/Class:%20EnvoyUserAPI#getinvites) -- [getLocation](../wiki/Class:%20EnvoyUserAPI#getlocation) -- [getLocations](../wiki/Class:%20EnvoyUserAPI#getlocations) -- [getSignInField](../wiki/Class:%20EnvoyUserAPI#getsigninfield) -- [getSignInFieldPage](../wiki/Class:%20EnvoyUserAPI#getsigninfieldpage) -- [getSignInFields](../wiki/Class:%20EnvoyUserAPI#getsigninfields) -- [me](../wiki/Class:%20EnvoyUserAPI#me) -- [partialUpdateInvite](../wiki/Class:%20EnvoyUserAPI#partialupdateinvite) -- [removeInvite](../wiki/Class:%20EnvoyUserAPI#removeinvite) -- [updateInvite](../wiki/Class:%20EnvoyUserAPI#updateinvite) -- [loginAsPluginInstaller](../wiki/Class:%20EnvoyUserAPI#loginasplugininstaller) -- [loginAsUser](../wiki/Class:%20EnvoyUserAPI#loginasuser) +- [createInvite](envoyuserapi.md#createinvite) +- [getAgreement](envoyuserapi.md#getagreement) +- [getAgreementPage](envoyuserapi.md#getagreementpage) +- [getCompany](envoyuserapi.md#getcompany) +- [getEmployee](envoyuserapi.md#getemployee) +- [getEmployeeByEmail](envoyuserapi.md#getemployeebyemail) +- [getEmployees](envoyuserapi.md#getemployees) +- [getFlow](envoyuserapi.md#getflow) +- [getFlows](envoyuserapi.md#getflows) +- [getInvites](envoyuserapi.md#getinvites) +- [getLocation](envoyuserapi.md#getlocation) +- [getLocations](envoyuserapi.md#getlocations) +- [getSignInField](envoyuserapi.md#getsigninfield) +- [getSignInFieldPage](envoyuserapi.md#getsigninfieldpage) +- [getSignInFields](envoyuserapi.md#getsigninfields) +- [me](envoyuserapi.md#me) +- [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) +- [removeInvite](envoyuserapi.md#removeinvite) +- [updateInvite](envoyuserapi.md#updateinvite) +- [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) +- [loginAsUser](envoyuserapi.md#loginasuser) ## Constructors @@ -59,7 +63,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L58) ## Properties @@ -75,7 +79,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L31) ## Methods @@ -95,7 +99,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L111) ___ @@ -116,7 +120,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L28) ___ @@ -137,7 +141,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L24) ___ @@ -158,7 +162,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L32) ___ @@ -179,7 +183,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L36) ___ @@ -200,7 +204,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L56) ___ @@ -220,7 +224,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L75) ___ @@ -241,7 +245,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L40) ___ @@ -261,7 +265,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L82) ___ @@ -281,7 +285,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L99) ___ @@ -302,7 +306,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L44) ___ @@ -322,7 +326,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L87) ___ @@ -343,7 +347,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L52) ___ @@ -364,7 +368,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L48) ___ @@ -384,7 +388,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L94) ___ @@ -398,7 +402,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L106) ___ @@ -419,7 +423,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L130) ___ @@ -439,7 +443,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L140) ___ @@ -460,13 +464,13 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L120) ___ ### loginAsPluginInstaller -▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> +▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `plugin_install` as the grant type. @@ -480,17 +484,17 @@ Gets a user access token using `plugin_install` as the grant type. #### Returns -`Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L177) ___ ### loginAsUser -▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> +▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `password` as the grant type (discouraged). @@ -505,8 +509,8 @@ Gets a user access token using `password` as the grant type (discouraged). #### Returns -`Promise`<[EnvoyMetaAuth](../wiki/Home#envoymetaauth)\> +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L150) diff --git a/docs/Enumeration: HttpStatus.md b/docs/enums/httpstatus.md similarity index 60% rename from docs/Enumeration: HttpStatus.md rename to docs/enums/httpstatus.md index 2770754..b81598e 100644 --- a/docs/Enumeration: HttpStatus.md +++ b/docs/enums/httpstatus.md @@ -1,13 +1,17 @@ +[@envoy/envoy-integrations-sdk](../README.md) / HttpStatus + +# Enumeration: HttpStatus + Use these status codes to inform Envoy of a job's or route's status. ## Table of contents ### Enumeration members -- [FAILED](../wiki/Enumeration:%20HttpStatus#failed) -- [IGNORED](../wiki/Enumeration:%20HttpStatus#ignored) -- [ONGOING](../wiki/Enumeration:%20HttpStatus#ongoing) -- [UNEXPECTED\_FAILURE](../wiki/Enumeration:%20HttpStatus#unexpected_failure) +- [FAILED](httpstatus.md#failed) +- [IGNORED](httpstatus.md#ignored) +- [ONGOING](httpstatus.md#ongoing) +- [UNEXPECTED\_FAILURE](httpstatus.md#unexpected_failure) ## Enumeration members @@ -17,7 +21,7 @@ Use these status codes to inform Envoy of a job's or route's status. #### Defined in -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L7) +[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L7) ___ @@ -27,7 +31,7 @@ ___ #### Defined in -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L6) +[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L6) ___ @@ -37,7 +41,7 @@ ___ #### Defined in -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L5) +[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L5) ___ @@ -47,4 +51,4 @@ ___ #### Defined in -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/HttpStatus.ts#L8) +[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L8) diff --git a/docs/Interface: EnvoyBaseRequest.md b/docs/interfaces/envoybaserequest.md similarity index 57% rename from docs/Interface: EnvoyBaseRequest.md rename to docs/interfaces/envoybaserequest.md index d2e223f..0f7a12e 100644 --- a/docs/Interface: EnvoyBaseRequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyBaseRequest + +# Interface: EnvoyBaseRequest + Base type for Envoy requests. You probably won't need to use this type directly. For routes, use `EnvoyRouteRequest`, @@ -12,7 +16,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. ## Hierarchy -- [VerifiedRequest](../wiki/Interface:%20VerifiedRequest) +- [VerifiedRequest](verifiedrequest.md) ↳ **EnvoyBaseRequest** @@ -20,8 +24,8 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. ### Properties -- [[VERIFIED]](../wiki/Interface:%20EnvoyBaseRequest#%5Bverified%5D) -- [envoy](../wiki/Interface:%20EnvoyBaseRequest#envoy) +- [[VERIFIED]](envoybaserequest.md#[verified]) +- [envoy](envoybaserequest.md#envoy) ## Properties @@ -31,18 +35,18 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Inherited from -[VerifiedRequest](../wiki/Interface:%20VerifiedRequest).[[VERIFIED]](../wiki/Interface:%20VerifiedRequest#%5Bverified%5D) +[VerifiedRequest](verifiedrequest.md).[[VERIFIED]](verifiedrequest.md#[verified]) #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L10) ___ ### envoy -• **envoy**: [EnvoyPluginSDK](../wiki/Class:%20EnvoyPluginSDK) +• **envoy**: [EnvoyPluginSDK](../classes/envoypluginsdk.md) #### Defined in -[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyRequest.ts#L20) +[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L20) diff --git a/docs/Interface: EnvoyResponse.md b/docs/interfaces/envoyresponse.md similarity index 72% rename from docs/Interface: EnvoyResponse.md rename to docs/interfaces/envoyresponse.md index c626386..dd1e077 100644 --- a/docs/Interface: EnvoyResponse.md +++ b/docs/interfaces/envoyresponse.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EnvoyResponse + +# Interface: EnvoyResponse + Use to type your `res` object in Envoy request handlers. ## Hierarchy @@ -10,20 +14,20 @@ Use to type your `res` object in Envoy request handlers. ### Properties -- [send](../wiki/Interface:%20EnvoyResponse#send) -- [sendFailed](../wiki/Interface:%20EnvoyResponse#sendfailed) -- [sendIgnored](../wiki/Interface:%20EnvoyResponse#sendignored) -- [sendOngoing](../wiki/Interface:%20EnvoyResponse#sendongoing) +- [send](envoyresponse.md#send) +- [sendFailed](envoyresponse.md#sendfailed) +- [sendIgnored](envoyresponse.md#sendignored) +- [sendOngoing](envoyresponse.md#sendongoing) ## Properties ### send -• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) +• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](envoyresponse.md) #### Type declaration -▸ (`debugInfo?`): [EnvoyResponse](../wiki/Interface:%20EnvoyResponse) +▸ (`debugInfo?`): [EnvoyResponse](envoyresponse.md) ##### Parameters @@ -33,7 +37,7 @@ Use to type your `res` object in Envoy request handlers. ##### Returns -[EnvoyResponse](../wiki/Interface:%20EnvoyResponse) +[EnvoyResponse](envoyresponse.md) #### Overrides @@ -41,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L8) ___ @@ -67,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L11) ___ @@ -93,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L10) ___ @@ -117,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L9) diff --git a/docs/Interface: JSONAPIData.md b/docs/interfaces/jsonapidata.md similarity index 59% rename from docs/Interface: JSONAPIData.md rename to docs/interfaces/jsonapidata.md index 0cd9d0b..2969b9a 100644 --- a/docs/Interface: JSONAPIData.md +++ b/docs/interfaces/jsonapidata.md @@ -1,3 +1,7 @@ +[@envoy/envoy-integrations-sdk](../README.md) / JSONAPIData + +# Interface: JSONAPIData + ## Type parameters | Name | Type | @@ -9,8 +13,8 @@ ### Properties -- [id](../wiki/Interface:%20JSONAPIData#id) -- [type](../wiki/Interface:%20JSONAPIData#type) +- [id](jsonapidata.md#id) +- [type](jsonapidata.md#type) ## Properties @@ -20,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -30,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/f50d6c5/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md new file mode 100644 index 0000000..da168c6 --- /dev/null +++ b/docs/interfaces/verifiedrequest.md @@ -0,0 +1,27 @@ +[@envoy/envoy-integrations-sdk](../README.md) / VerifiedRequest + +# Interface: VerifiedRequest + +## Hierarchy + +- `Request` + + ↳ **VerifiedRequest** + + ↳↳ [EnvoyBaseRequest](envoybaserequest.md) + +## Table of contents + +### Properties + +- [[VERIFIED]](verifiedrequest.md#[verified]) + +## Properties + +### [VERIFIED] + +• **[VERIFIED]**: `boolean` + +#### Defined in + +[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L10) diff --git a/typedoc.json b/typedoc.json index b3c22df..e2bc5f8 100644 --- a/typedoc.json +++ b/typedoc.json @@ -4,6 +4,5 @@ "excludePrivate": true, "excludeProtected": true, "excludeExternals": true, - "readme": "none", - "theme": "./node_modules/typedoc-github-wiki-theme/dist" + "readme": "none" } From 11f594b5e50b8ac0242852a17380e6b6ed1deee5 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 11 Jun 2021 12:24:18 -0400 Subject: [PATCH 25/91] added categories --- docs/README.md | 385 +++++++++++---------- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 22 +- docs/classes/envoypluginjob.md | 18 +- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 18 +- docs/classes/envoypluginstoragepipeline.md | 22 +- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 91 +++-- docs/enums/httpstatus.md | 54 --- docs/interfaces/envoybaserequest.md | 8 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/verifiedrequest.md | 27 -- package.json | 3 +- src/EnvoyAPI.ts | 5 +- src/EnvoyJWT.ts | 3 + src/EnvoyMeta.ts | 23 +- src/EnvoyPluginAPI.ts | 5 +- src/EnvoyPluginJob.ts | 2 + src/EnvoyPluginJobAttachment.ts | 8 + src/EnvoyPluginJobUpdate.ts | 3 + src/EnvoyPluginSDK.ts | 5 +- src/EnvoyPluginStorage.ts | 3 + src/EnvoyPluginStoragePipeline.ts | 2 + src/EnvoyRequest.ts | 18 + src/EnvoyResponse.ts | 1 + src/EnvoySignatureVerifier.ts | 5 + src/EnvoyStorageCommand.ts | 3 + src/EnvoyStorageItem.ts | 3 + src/EnvoyUserAPI.ts | 34 +- src/HttpStatus.ts | 2 + src/asyncHandler.ts | 5 +- src/errorMiddleware.ts | 2 + src/middleware.ts | 7 +- src/payloads/EntryPayload.ts | 3 + src/payloads/InvitePayload.ts | 3 + src/resources/AgreementPageResource.ts | 9 + src/resources/AgreementResource.ts | 9 + src/resources/CompanyResource.ts | 9 + src/resources/EmployeeResource.ts | 15 + src/resources/FlowResource.ts | 15 + src/resources/InviteResource.ts | 21 ++ src/resources/LocationResource.ts | 15 + src/resources/SignInFieldPageResource.ts | 9 + src/resources/SignInFieldResource.ts | 9 + src/resources/UserResource.ts | 6 + typedoc.json | 2 + 48 files changed, 587 insertions(+), 369 deletions(-) delete mode 100644 docs/enums/httpstatus.md delete mode 100644 docs/interfaces/verifiedrequest.md diff --git a/docs/README.md b/docs/README.md index ca7ad75..aeba98c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,58 +4,86 @@ ## Table of contents -### Enumerations +### API Classes -- [HttpStatus](enums/httpstatus.md) +- [EnvoyPluginAPI](classes/envoypluginapi.md) +- [EnvoyUserAPI](classes/envoyuserapi.md) + +### Base Classes + +- [EnvoyPluginSDK](classes/envoypluginsdk.md) +- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) + +### Helper Classes + +- [EnvoyJWT](classes/envoyjwt.md) +- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) -### Classes +### Request Object Classes - [EnvoyJWT](classes/envoyjwt.md) - [EnvoyPluginAPI](classes/envoypluginapi.md) - [EnvoyPluginJob](classes/envoypluginjob.md) -- [EnvoyPluginSDK](classes/envoypluginsdk.md) - [EnvoyPluginStorage](classes/envoypluginstorage.md) -- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) -- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) - [EnvoyUserAPI](classes/envoyuserapi.md) -### Interfaces +### Storage Classes + +- [EnvoyPluginStorage](classes/envoypluginstorage.md) + +### Other Interfaces + +- [JSONAPIData](interfaces/jsonapidata.md) + +### Request Interfaces - [EnvoyBaseRequest](interfaces/envoybaserequest.md) + +### Response Interfaces + - [EnvoyResponse](interfaces/envoyresponse.md) -- [JSONAPIData](interfaces/jsonapidata.md) -- [VerifiedRequest](interfaces/verifiedrequest.md) -### Type aliases +### Event Type aliases - [EntryPayload](README.md#entrypayload) -- [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) +- [InvitePayload](README.md#invitepayload) + +### Helper Type aliases + +- [EnvoyMiddleware](README.md#envoymiddleware) +- [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) + +### Meta Type aliases + - [EnvoyEventMeta](README.md#envoyeventmeta) -- [EnvoyEventRequest](README.md#envoyeventrequest) -- [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) - [EnvoyMetaAuth](README.md#envoymetaauth) - [EnvoyMetaCompany](README.md#envoymetacompany) - [EnvoyMetaJob](README.md#envoymetajob) - [EnvoyMetaLocation](README.md#envoymetalocation) -- [EnvoyMiddleware](README.md#envoymiddleware) -- [EnvoyRequest](README.md#envoyrequest) - [EnvoyRouteMeta](README.md#envoyroutemeta) + +### Request Type aliases + +- [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) +- [EnvoyEventRequest](README.md#envoyeventrequest) +- [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) +- [EnvoyRequest](README.md#envoyrequest) - [EnvoyRouteRequest](README.md#envoyrouterequest) -- [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) -- [EnvoyStorageItem](README.md#envoystorageitem) -- [InvitePayload](README.md#invitepayload) -### Variables +### Storage Type aliases -- [VERIFIED](README.md#verified) +- [EnvoyStorageItem](README.md#envoystorageitem) -### Functions +### Helper Functions - [asyncHandler](README.md#asynchandler) + +### SDK Functions + - [errorMiddleware](README.md#errormiddleware) - [middleware](README.md#middleware) -## Type aliases +## Event Type aliases ### EntryPayload @@ -103,77 +131,133 @@ #### Defined in -[payloads/EntryPayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/payloads/EntryPayload.ts#L3) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/payloads/EntryPayload.ts#L6) ___ -### EnvoyEntryEventRequest +### InvitePayload -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> +Ƭ **InvitePayload**: `Object` -Use to type your `req` object in entry event handlers, -such as handlers for `entry_sign_in`. +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.arrived` | `boolean` | +| `attributes.been-here-before` | `boolean` | +| `attributes.edit-token` | `string` | +| `attributes.email` | `string` \| ``null`` | +| `attributes.employee-screening-flow` | `boolean` | +| `attributes.expected-arrival-time` | `string` | +| `attributes.flow-id` | `string` | +| `attributes.flow-name` | `string` | +| `attributes.full-name` | `string` | +| `attributes.inviter-email` | `string` \| ``null`` | +| `attributes.inviter-name` | `string` \| ``null`` | +| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | +| `attributes.nda?` | `string` | +| `attributes.photo-url` | `string` \| ``null`` | +| `attributes.preregistration-complete` | `boolean` | +| `attributes.private-notes` | `string` \| ``null`` | +| `attributes.qr-code` | `string` \| ``null`` | +| `attributes.qr-code-sent-at` | `string` \| ``null`` | +| `attributes.reminder-sent-at` | `string` \| ``null`` | +| `attributes.secret-token` | `string` | +| `attributes.signed-in-at?` | `string` | +| `attributes.signed-out-at?` | `string` | +| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | +| `id` | `string` | +| `relationships` | `Object` | +| `relationships.agreeable-ndas?` | `Object` | +| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | +| `relationships.employee?` | `Object` | +| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | +| `relationships.entry?` | `Object` | +| `relationships.entry.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"entries"``\> | +| `relationships.flow?` | `Object` | +| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | +| `relationships.location` | `Object` | +| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | +| `type` | ``"invites"`` | #### Defined in -[EnvoyRequest.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L39) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/payloads/InvitePayload.ts#L6) ___ -### EnvoyEventMeta +## Helper Type aliases -Ƭ **EnvoyEventMeta**: `Object` +### EnvoyMiddleware -Metadata that will be included in the request body for events. +Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` #### Type declaration +▸ (`req`, `res`, `next`): `void` + +##### Parameters + | Name | Type | | :------ | :------ | -| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | -| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | -| `config` | `Record` | -| `event` | `string` | -| `install_id` | `string` | -| `job` | [EnvoyMetaJob](README.md#envoymetajob) | -| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | -| `plugin_id` | `string` | +| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `next` | `NextFunction` | + +##### Returns + +`void` #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L54) +[middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/middleware.ts#L15) ___ -### EnvoyEventRequest - -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +### EnvoySignatureVerifierOptions -Base type for event requests. -You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. +Ƭ **EnvoySignatureVerifierOptions**: `Object` -#### Type parameters +#### Type declaration | Name | Type | | :------ | :------ | -| `Payload` | `Payload` = `unknown` | +| `algorithm` | ``"sha256"`` \| `string` | +| `encoding` | `BinaryToTextEncoding` | +| `header` | ``"x-envoy-signature"`` \| `string` | +| `secret` | `string` | #### Defined in -[EnvoyRequest.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L33) +[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoySignatureVerifier.ts#L8) ___ -### EnvoyInviteEventRequest +## Meta Type aliases -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> +### EnvoyEventMeta -Use to type your `req` object in invite event handlers, -such as handlers for `invite_created` or `upcoming_visit`. +Ƭ **EnvoyEventMeta**: `Object` + +Metadata that will be included in the request body for events. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | +| `config` | `Record` | +| `event` | `string` | +| `install_id` | `string` | +| `job` | [EnvoyMetaJob](README.md#envoymetajob) | +| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `plugin_id` | `string` | #### Defined in -[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L45) +[EnvoyMeta.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L67) ___ @@ -181,9 +265,9 @@ ___ Ƭ **EnvoyMetaAuth**: `Object` -A short-lived userAPI token. -Will be used to construct the userAPI property -found in req.envoy.userAPI. +A short-lived `userAPI` token. +Will be used to construct the `userAPI` property +found in `req.envoy.userAPI`. #### Type declaration @@ -197,7 +281,7 @@ found in req.envoy.userAPI. #### Defined in -[EnvoyMeta.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L43) +[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L54) ___ @@ -218,7 +302,7 @@ ___ #### Defined in -[EnvoyMeta.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L28) +[EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L37) ___ @@ -236,7 +320,7 @@ ___ #### Defined in -[EnvoyMeta.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L1) +[EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L4) ___ @@ -268,43 +352,58 @@ ___ #### Defined in -[EnvoyMeta.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L7) +[EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L13) ___ -### EnvoyMiddleware - -Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +### EnvoyRouteMeta -#### Type declaration +Ƭ **EnvoyRouteMeta**: `Object` -▸ (`req`, `res`, `next`): `void` +Metadata that will be included in the request body for setup routes, +like validation URLs or options URLs. -##### Parameters +#### Type declaration | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | +| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | +| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | +| `config` | `Record` | +| `forwarded_bearer_token?` | `string` | +| `install_id` | `string` | +| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `params` | `Record` | +| `plugin_id` | `string` | +| `route` | `string` | -##### Returns +#### Defined in -`void` +[EnvoyMeta.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L84) + +___ + +## Request Type aliases + +### EnvoyEntryEventRequest + +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> + +Use to type your `req` object in entry event handlers, +such as handlers for `entry_sign_in`. #### Defined in -[middleware.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/middleware.ts#L12) +[EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L53) ___ -### EnvoyRequest +### EnvoyEventRequest -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> -You probably won't need to use this type directly. -For routes, use `EnvoyRouteRequest`, -and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. +Base type for event requests. +You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Type parameters @@ -314,43 +413,30 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L52) +[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L45) ___ -### EnvoyRouteMeta - -Ƭ **EnvoyRouteMeta**: `Object` - -Metadata that will be included in the request body for setup routes, -like validation URLs or options URLs. +### EnvoyInviteEventRequest -#### Type declaration +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> -| Name | Type | -| :------ | :------ | -| `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | -| `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | -| `config` | `Record` | -| `forwarded_bearer_token?` | `string` | -| `install_id` | `string` | -| `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | -| `params` | `Record` | -| `plugin_id` | `string` | -| `route` | `string` | +Use to type your `req` object in invite event handlers, +such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyMeta.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyMeta.ts#L69) +[EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L61) ___ -### EnvoyRouteRequest +### EnvoyRequest -Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> -Use to type your `req` object in route handlers, -such as validation URLS or options URLs. +You probably won't need to use this type directly. +For routes, use `EnvoyRouteRequest`, +and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Type parameters @@ -360,29 +446,31 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L27) +[EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L70) ___ -### EnvoySignatureVerifierOptions +### EnvoyRouteRequest -Ƭ **EnvoySignatureVerifierOptions**: `Object` +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> -#### Type declaration +Use to type your `req` object in route handlers, +such as validation URLS or options URLs. + +#### Type parameters | Name | Type | | :------ | :------ | -| `algorithm` | ``"sha256"`` \| `string` | -| `encoding` | `BinaryToTextEncoding` | -| `header` | ``"x-envoy-signature"`` \| `string` | -| `secret` | `string` | +| `Payload` | `Payload` = `unknown` | #### Defined in -[EnvoySignatureVerifier.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoySignatureVerifier.ts#L5) +[EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L37) ___ +## Storage Type aliases + ### EnvoyStorageItem Ƭ **EnvoyStorageItem**: `Object` @@ -396,77 +484,16 @@ ___ #### Defined in -[EnvoyStorageItem.ts:1](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyStorageItem.ts#L1) - -___ - -### InvitePayload +[EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyStorageItem.ts#L4) -Ƭ **InvitePayload**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `attributes` | `Object` | -| `attributes.arrived` | `boolean` | -| `attributes.been-here-before` | `boolean` | -| `attributes.edit-token` | `string` | -| `attributes.email` | `string` \| ``null`` | -| `attributes.employee-screening-flow` | `boolean` | -| `attributes.expected-arrival-time` | `string` | -| `attributes.flow-id` | `string` | -| `attributes.flow-name` | `string` | -| `attributes.full-name` | `string` | -| `attributes.inviter-email` | `string` \| ``null`` | -| `attributes.inviter-name` | `string` \| ``null`` | -| `attributes.legal-docs?` | { `agreement`: { `id`: `string` } ; `id`: `string` ; `signed-at`: `string` ; `url`: `string` }[] | -| `attributes.nda?` | `string` | -| `attributes.photo-url` | `string` \| ``null`` | -| `attributes.preregistration-complete` | `boolean` | -| `attributes.private-notes` | `string` \| ``null`` | -| `attributes.qr-code` | `string` \| ``null`` | -| `attributes.qr-code-sent-at` | `string` \| ``null`` | -| `attributes.reminder-sent-at` | `string` \| ``null`` | -| `attributes.secret-token` | `string` | -| `attributes.signed-in-at?` | `string` | -| `attributes.signed-out-at?` | `string` | -| `attributes.user-data` | { `field`: `string` ; `value`: `string` \| ``null`` }[] | -| `id` | `string` | -| `relationships` | `Object` | -| `relationships.agreeable-ndas?` | `Object` | -| `relationships.agreeable-ndas.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"agreeable-ndas"``\>[] | -| `relationships.employee?` | `Object` | -| `relationships.employee.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"employees"``\> | -| `relationships.entry?` | `Object` | -| `relationships.entry.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"entries"``\> | -| `relationships.flow?` | `Object` | -| `relationships.flow.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"flows"``\> | -| `relationships.location` | `Object` | -| `relationships.location.data` | [JSONAPIData](interfaces/jsonapidata.md)<``"locations"``\> | -| `type` | ``"invites"`` | - -#### Defined in - -[payloads/InvitePayload.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/payloads/InvitePayload.ts#L3) - -## Variables - -### VERIFIED - -• `Const` **VERIFIED**: typeof [VERIFIED](README.md#verified) - -#### Defined in - -[EnvoyRequest.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L7) - -## Functions +## Helper Functions ### asyncHandler ▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` -Catches Promise-based errors. +Wraps any express.js-based handlers +to catch Promise-based errors. #### Parameters @@ -494,10 +521,12 @@ Catches Promise-based errors. #### Defined in -[asyncHandler.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/asyncHandler.ts#L10) +[asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/asyncHandler.ts#L13) ___ +## SDK Functions + ### errorMiddleware ▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` @@ -531,7 +560,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/errorMiddleware.ts#L9) +[errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/errorMiddleware.ts#L11) ___ @@ -557,4 +586,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/middleware.ts#L21) +[middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/middleware.ts#L26) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 236f1ff..7e83278 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyJWT.ts#L12) +[EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyJWT.ts#L39) +[EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyJWT.ts#L22) +[EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 54ede45..da70ec4 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -27,7 +27,7 @@ API endpoints for *plugin-scoped* tokens. - [setPluginInstallConfig](envoypluginapi.md#setplugininstallconfig) - [storagePipeline](envoypluginapi.md#storagepipeline) - [updateJob](envoypluginapi.md#updatejob) -- [login](envoypluginapi.md#login) +- [loginAsPlugin](envoypluginapi.md#loginasplugin) ## Constructors @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L50) +[EnvoyPluginAPI.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L53) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L21) +[EnvoyPluginAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L24) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L26) +[EnvoyPluginAPI.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L29) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L34) +[EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L37) ___ @@ -167,13 +167,13 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L13) +[EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L16) ___ -### login +### loginAsPlugin -▸ `Static` **login**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsPlugin**(`id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a plugin access token using `client_credentials` as the grant type. @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginAPI.ts#L61) +[EnvoyPluginAPI.ts:64](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L64) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index acc7d70..d7203d1 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L17) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L13) +[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L15) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L15) +[EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L17) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L43) +[EnvoyPluginJob.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L45) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L47) +[EnvoyPluginJob.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L49) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L22) +[EnvoyPluginJob.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L24) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L55) +[EnvoyPluginJob.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L57) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L51) +[EnvoyPluginJob.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L53) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginJob.ts#L59) +[EnvoyPluginJob.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L61) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 1737369..6010ee0 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L38) +[EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L41) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:129](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L129) +[EnvoyPluginSDK.ts:132](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L132) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L122) +[EnvoyPluginSDK.ts:125](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L125) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L111) +[EnvoyPluginSDK.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L114) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L147) +[EnvoyPluginSDK.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L150) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L136) +[EnvoyPluginSDK.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L139) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:160](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L160) +[EnvoyPluginSDK.ts:163](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L163) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L50) +[EnvoyPluginSDK.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L53) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L62) +[EnvoyPluginSDK.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L65) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L90) +[EnvoyPluginSDK.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L93) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginSDK.ts#L73) +[EnvoyPluginSDK.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L76) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index ed4c830..a8a9a2a 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L11) +[EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L13) +[EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L16) ## Methods @@ -82,7 +82,7 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L30) +[EnvoyPluginStorage.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L33) ___ @@ -98,7 +98,7 @@ Creates a new pipeline instance. #### Defined in -[EnvoyPluginStorage.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L23) +[EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L26) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L37) +[EnvoyPluginStorage.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L40) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L44) +[EnvoyPluginStorage.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L47) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L51) +[EnvoyPluginStorage.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L54) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStorage.ts#L59) +[EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L62) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md index 6fc645a..d1fe476 100644 --- a/docs/classes/envoypluginstoragepipeline.md +++ b/docs/classes/envoypluginstoragepipeline.md @@ -41,7 +41,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L16) +[EnvoyPluginStoragePipeline.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L18) ## Properties @@ -51,7 +51,7 @@ Builds up a request pipeline for submitting storage commands. #### Defined in -[EnvoyPluginStoragePipeline.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L12) +[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L14) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L14) +[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L16) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[EnvoyPluginStoragePipeline.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L39) +[EnvoyPluginStoragePipeline.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L41) ___ @@ -97,7 +97,7 @@ Executes all the commands in the pipeline. #### Defined in -[EnvoyPluginStoragePipeline.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L27) +[EnvoyPluginStoragePipeline.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L29) ___ @@ -113,7 +113,7 @@ Executes the pipeline and returns the first result. #### Defined in -[EnvoyPluginStoragePipeline.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L34) +[EnvoyPluginStoragePipeline.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L36) ___ @@ -135,7 +135,7 @@ Gets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L47) +[EnvoyPluginStoragePipeline.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L49) ___ @@ -159,7 +159,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L55) +[EnvoyPluginStoragePipeline.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L57) ___ @@ -183,7 +183,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:63](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L63) +[EnvoyPluginStoragePipeline.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L65) ___ @@ -207,7 +207,7 @@ and returns that item. #### Defined in -[EnvoyPluginStoragePipeline.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L71) +[EnvoyPluginStoragePipeline.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L73) ___ @@ -229,4 +229,4 @@ Unsets a storage item. #### Defined in -[EnvoyPluginStoragePipeline.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyPluginStoragePipeline.ts#L78) +[EnvoyPluginStoragePipeline.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L80) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index aa07add..e710ff1 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoySignatureVerifier.ts#L23) +[EnvoySignatureVerifier.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoySignatureVerifier.ts#L28) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoySignatureVerifier.ts#L36) +[EnvoySignatureVerifier.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoySignatureVerifier.ts#L41) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index bf24b1f..d99d4c4 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -43,7 +43,8 @@ To access Envoy resources, this is the API you'd want. - [removeInvite](envoyuserapi.md#removeinvite) - [updateInvite](envoyuserapi.md#updateinvite) - [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) -- [loginAsUser](envoyuserapi.md#loginasuser) +- [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) +- [loginAsUserWithPassword](envoyuserapi.md#loginasuserwithpassword) ## Constructors @@ -63,7 +64,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L58) +[EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L59) ## Properties @@ -79,7 +80,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyAPI.ts#L31) +[EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L32) ## Methods @@ -99,7 +100,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:111](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L111) +[EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L114) ___ @@ -120,7 +121,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L28) +[EnvoyUserAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L31) ___ @@ -141,7 +142,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L24) +[EnvoyUserAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L27) ___ @@ -162,7 +163,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L32) +[EnvoyUserAPI.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L35) ___ @@ -183,7 +184,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L36) +[EnvoyUserAPI.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L39) ___ @@ -204,7 +205,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L56) +[EnvoyUserAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L59) ___ @@ -224,7 +225,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L75) +[EnvoyUserAPI.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L78) ___ @@ -245,7 +246,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L40) +[EnvoyUserAPI.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L43) ___ @@ -265,7 +266,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L82) +[EnvoyUserAPI.ts:85](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L85) ___ @@ -285,7 +286,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:99](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L99) +[EnvoyUserAPI.ts:102](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L102) ___ @@ -306,7 +307,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L44) +[EnvoyUserAPI.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L47) ___ @@ -326,7 +327,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L87) +[EnvoyUserAPI.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L90) ___ @@ -347,7 +348,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L52) +[EnvoyUserAPI.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L55) ___ @@ -368,7 +369,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L48) +[EnvoyUserAPI.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L51) ___ @@ -388,7 +389,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:94](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L94) +[EnvoyUserAPI.ts:97](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L97) ___ @@ -402,7 +403,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:106](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L106) +[EnvoyUserAPI.ts:109](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L109) ___ @@ -423,7 +424,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:130](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L130) +[EnvoyUserAPI.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L133) ___ @@ -443,7 +444,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L140) +[EnvoyUserAPI.ts:143](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L143) ___ @@ -464,7 +465,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:120](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L120) +[EnvoyUserAPI.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L123) ___ @@ -488,24 +489,50 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:177](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L177) +[EnvoyUserAPI.ts:207](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L207) ___ -### loginAsUser +### loginAsUserWithCode -▸ `Static` **loginAsUser**(`username`, `password`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsUserWithCode**(`code`, `scope?`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> + +Gets a user access token using `code` as the grant type. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `code` | `string` | `undefined` | +| `scope` | `string`[] | [] | +| `id` | `string` | `undefined` | +| `secret` | `string` | `undefined` | + +#### Returns + +`Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> + +#### Defined in + +[EnvoyUserAPI.ts:181](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L181) + +___ + +### loginAsUserWithPassword + +▸ `Static` **loginAsUserWithPassword**(`username`, `password`, `scope?`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `password` as the grant type (discouraged). #### Parameters -| Name | Type | -| :------ | :------ | -| `username` | `string` | -| `password` | `string` | -| `id` | `string` | -| `secret` | `string` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `username` | `string` | `undefined` | +| `password` | `string` | `undefined` | +| `scope` | `string`[] | [] | +| `id` | `string` | `undefined` | +| `secret` | `string` | `undefined` | #### Returns @@ -513,4 +540,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyUserAPI.ts#L150) +[EnvoyUserAPI.ts:153](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L153) diff --git a/docs/enums/httpstatus.md b/docs/enums/httpstatus.md deleted file mode 100644 index b81598e..0000000 --- a/docs/enums/httpstatus.md +++ /dev/null @@ -1,54 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / HttpStatus - -# Enumeration: HttpStatus - -Use these status codes to inform Envoy of a job's or route's status. - -## Table of contents - -### Enumeration members - -- [FAILED](httpstatus.md#failed) -- [IGNORED](httpstatus.md#ignored) -- [ONGOING](httpstatus.md#ongoing) -- [UNEXPECTED\_FAILURE](httpstatus.md#unexpected_failure) - -## Enumeration members - -### FAILED - -• **FAILED** = 412 - -#### Defined in - -[HttpStatus.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L7) - -___ - -### IGNORED - -• **IGNORED** = 400 - -#### Defined in - -[HttpStatus.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L6) - -___ - -### ONGOING - -• **ONGOING** = 202 - -#### Defined in - -[HttpStatus.ts:5](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L5) - -___ - -### UNEXPECTED\_FAILURE - -• **UNEXPECTED\_FAILURE** = 500 - -#### Defined in - -[HttpStatus.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/HttpStatus.ts#L8) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 0f7a12e..6a592b5 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -16,7 +16,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. ## Hierarchy -- [VerifiedRequest](verifiedrequest.md) +- `VerifiedRequest` ↳ **EnvoyBaseRequest** @@ -35,11 +35,11 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Inherited from -[VerifiedRequest](verifiedrequest.md).[[VERIFIED]](verifiedrequest.md#[verified]) +VerifiedRequest.\_\_@VERIFIED@1237 #### Defined in -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L10) +[EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L16) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[EnvoyRequest.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L20) +[EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L28) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index dd1e077..5b87beb 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L8) +[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L9) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L11) +[EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L12) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L10) +[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L11) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyResponse.ts#L9) +[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L10) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index 2969b9a..aafcc30 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/verifiedrequest.md b/docs/interfaces/verifiedrequest.md deleted file mode 100644 index da168c6..0000000 --- a/docs/interfaces/verifiedrequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / VerifiedRequest - -# Interface: VerifiedRequest - -## Hierarchy - -- `Request` - - ↳ **VerifiedRequest** - - ↳↳ [EnvoyBaseRequest](envoybaserequest.md) - -## Table of contents - -### Properties - -- [[VERIFIED]](verifiedrequest.md#[verified]) - -## Properties - -### [VERIFIED] - -• **[VERIFIED]**: `boolean` - -#### Defined in - -[EnvoyRequest.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/db5b958/src/EnvoyRequest.ts#L10) diff --git a/package.json b/package.json index 845de7c..6fcfcaf 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,8 @@ "src" ], "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "docs:generate": "typedoc" }, "repository": { "type": "git", diff --git a/src/EnvoyAPI.ts b/src/EnvoyAPI.ts index 1295b57..df9ddad 100644 --- a/src/EnvoyAPI.ts +++ b/src/EnvoyAPI.ts @@ -2,8 +2,7 @@ import axios from 'axios'; import qs from 'qs'; import DataLoader from 'dataloader'; import JSONAPIData from './util/json-api/JSONAPIData'; -import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; -import { EnvoyMetaAuth } from './EnvoyMeta'; +import { envoyBaseURL } from './constants'; interface EnvoyWebDataLoaderKey extends JSONAPIData { include?: string; @@ -23,6 +22,8 @@ const TYPE_ALIASES = new Map([ * Uses a data loader to leverage JSONAPI's "include" functionality. * This allows us to save everything that was included in the initial response * to be used later without re-fetching from the API. + * + * @category Base */ export default class EnvoyAPI { /** diff --git a/src/EnvoyJWT.ts b/src/EnvoyJWT.ts index 881c7f4..c58c48c 100644 --- a/src/EnvoyJWT.ts +++ b/src/EnvoyJWT.ts @@ -5,6 +5,9 @@ export type EnvoyJWTAlgorithm = Algorithm; export type EnvoyJWTDecodeOptions = VerifyOptions; /** * Helper to encode and decode JWTs. + * + * @category Helper + * @category Request Object */ export default class EnvoyJWT { private secret: string; diff --git a/src/EnvoyMeta.ts b/src/EnvoyMeta.ts index 4aa8450..dcc5826 100644 --- a/src/EnvoyMeta.ts +++ b/src/EnvoyMeta.ts @@ -1,9 +1,15 @@ +/** + * @category Meta + */ export type EnvoyMetaJob = { id: string, name: string, identifier: string, }; +/** + * @category Meta + */ export type EnvoyMetaLocation = { id: string, type: 'locations', @@ -25,6 +31,9 @@ export type EnvoyMetaLocation = { } }; +/** + * @category Meta + */ export type EnvoyMetaCompany = { id: string, type: 'companies', @@ -36,9 +45,11 @@ export type EnvoyMetaCompany = { }; /** - * A short-lived userAPI token. - * Will be used to construct the userAPI property - * found in req.envoy.userAPI. + * A short-lived `userAPI` token. + * Will be used to construct the `userAPI` property + * found in `req.envoy.userAPI`. + * + * @category Meta */ export type EnvoyMetaAuth = { token_type: 'Bearer', @@ -50,6 +61,8 @@ export type EnvoyMetaAuth = { /** * Metadata that will be included in the request body for events. + * + * @category Meta */ export type EnvoyEventMeta = { event: string, @@ -65,6 +78,8 @@ export type EnvoyEventMeta = { /** * Metadata that will be included in the request body for setup routes, * like validation URLs or options URLs. + * + * @category Meta */ export type EnvoyRouteMeta = { route: string, @@ -80,6 +95,8 @@ export type EnvoyRouteMeta = { /** * Metadata that will be included in every request Envoy sends to your plugin. + * + * @category Meta */ type EnvoyMeta = EnvoyEventMeta | EnvoyRouteMeta; export default EnvoyMeta; diff --git a/src/EnvoyPluginAPI.ts b/src/EnvoyPluginAPI.ts index d2e5f36..fe0f418 100644 --- a/src/EnvoyPluginAPI.ts +++ b/src/EnvoyPluginAPI.ts @@ -8,6 +8,9 @@ import { EnvoyMetaAuth } from './EnvoyMeta'; /** * API endpoints for *plugin-scoped* tokens. + * + * @category API + * @category Request Object */ export default class EnvoyPluginAPI extends EnvoyAPI { async updateJob(jobId: string, update: EnvoyPluginJobUpdate): Promise { @@ -58,7 +61,7 @@ export default class EnvoyPluginAPI extends EnvoyAPI { /** * Gets a plugin access token using `client_credentials` as the grant type. */ - static async login(id = envoyClientId, secret = envoyClientSecret): Promise { + static async loginAsPlugin(id = envoyClientId, secret = envoyClientSecret): Promise { const { data } = await axios({ auth: { username: id, diff --git a/src/EnvoyPluginJob.ts b/src/EnvoyPluginJob.ts index 5781b95..ce1085c 100644 --- a/src/EnvoyPluginJob.ts +++ b/src/EnvoyPluginJob.ts @@ -8,6 +8,8 @@ import EnvoyPluginAPI from './EnvoyPluginAPI'; * to update the status (e.g. complete, failed, ignored) * as well as attach extra data to the event's subject * (e.g. showing a generated card number in the dashboard for a visitor on `entry_sign_in`). + * + * @category Request Object */ export default class EnvoyPluginJob { readonly api: EnvoyPluginAPI; diff --git a/src/EnvoyPluginJobAttachment.ts b/src/EnvoyPluginJobAttachment.ts index 93c95cc..9fe490f 100644 --- a/src/EnvoyPluginJobAttachment.ts +++ b/src/EnvoyPluginJobAttachment.ts @@ -1,5 +1,7 @@ /** * Display some text in Envoy's dashboard. + * + * @category Attachment */ export interface EnvoyPluginTextJobAttachment { type?: 'text' | 'password' | 'link' | 'credential_image', @@ -9,6 +11,8 @@ export interface EnvoyPluginTextJobAttachment { /** * Display a link in Envoy's dashboard. + * + * @category Attachment */ export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachment { type: 'link', @@ -18,6 +22,8 @@ export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachme /** * Display a credential in Envoy's dashboard, * and include the credential's image in the invitee's welcome email. + * + * @category Attachment */ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAttachment { type: 'credential_image', @@ -32,6 +38,8 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt * Attachments to jobs, which will be displayed in the Envoy dashboard. * Some attachments like `credential_image` can show up in other places, * like an invitee's welcome email. + * + * @category Attachment */ type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment | EnvoyPluginLinkJobAttachment diff --git a/src/EnvoyPluginJobUpdate.ts b/src/EnvoyPluginJobUpdate.ts index d028721..226e8bb 100644 --- a/src/EnvoyPluginJobUpdate.ts +++ b/src/EnvoyPluginJobUpdate.ts @@ -1,5 +1,8 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; +/** + * @internal + */ export default interface EnvoyPluginJobUpdate { status?: string, status_message?: string, diff --git a/src/EnvoyPluginSDK.ts b/src/EnvoyPluginSDK.ts index 9cb3601..3916b72 100644 --- a/src/EnvoyPluginSDK.ts +++ b/src/EnvoyPluginSDK.ts @@ -7,6 +7,7 @@ import EnvoyPluginAPI from './EnvoyPluginAPI'; /** * Every Envoy request has a `meta` and `payload`. + * @category Request */ export interface EnvoyRequestBody { meta: Meta, @@ -17,6 +18,8 @@ export interface EnvoyRequestBody { * Sets up all relevant Envoy functions. * Attaches itself to every request object using our `middleware`, * to allow for easy access to Envoy functions. + * + * @category Base */ export default class EnvoyPluginSDK { /** @@ -78,7 +81,7 @@ export default class EnvoyPluginSDK extends VerifiedRequest { envoy: EnvoyPluginSDK @@ -23,24 +31,32 @@ export interface EnvoyBaseRequest = EnvoyBaseRequest; /** * Base type for event requests. * You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + * + * @category Request */ export type EnvoyEventRequest = EnvoyBaseRequest; /** * Use to type your `req` object in entry event handlers, * such as handlers for `entry_sign_in`. + * + * @category Request */ export type EnvoyEntryEventRequest = EnvoyEventRequest; /** * Use to type your `req` object in invite event handlers, * such as handlers for `invite_created` or `upcoming_visit`. + * + * @category Request */ export type EnvoyInviteEventRequest = EnvoyEventRequest; @@ -48,6 +64,8 @@ export type EnvoyInviteEventRequest = EnvoyEventRequest; * You probably won't need to use this type directly. * For routes, use `EnvoyRouteRequest`, * and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + * + * @category Request */ type EnvoyRequest = EnvoyBaseRequest; export default EnvoyRequest; diff --git a/src/EnvoyResponse.ts b/src/EnvoyResponse.ts index 2d2d104..67db258 100644 --- a/src/EnvoyResponse.ts +++ b/src/EnvoyResponse.ts @@ -3,6 +3,7 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; /** * Use to type your `res` object in Envoy request handlers. + * @category Response */ export default interface EnvoyResponse extends Response { send: (debugInfo?: unknown) => this; diff --git a/src/EnvoySignatureVerifier.ts b/src/EnvoySignatureVerifier.ts index 02be0e8..7315752 100644 --- a/src/EnvoySignatureVerifier.ts +++ b/src/EnvoySignatureVerifier.ts @@ -2,6 +2,9 @@ import crypto, { BinaryToTextEncoding } from 'crypto'; import { Request } from 'express'; import { envoyClientSecret } from './constants'; +/** + * @category Helper + */ export type EnvoySignatureVerifierOptions = { algorithm: 'sha256' | string, encoding: BinaryToTextEncoding, @@ -18,6 +21,8 @@ const defaultOptions: EnvoySignatureVerifierOptions = { /** * Verifies that a request is coming from Envoy. + * + * @category Helper */ export default class EnvoySignatureVerifier { private readonly options: EnvoySignatureVerifierOptions; diff --git a/src/EnvoyStorageCommand.ts b/src/EnvoyStorageCommand.ts index 359d486..b927416 100644 --- a/src/EnvoyStorageCommand.ts +++ b/src/EnvoyStorageCommand.ts @@ -34,6 +34,9 @@ export interface EnvoyUnsetStorageCommand extends EnvoyBaseStorageCommand { action: 'unset', } +/** + * @internal + */ type EnvoyStorageCommand = EnvoyGetStorageCommand | EnvoySetStorageCommand | EnvoySetUniqueStorageCommand diff --git a/src/EnvoyStorageItem.ts b/src/EnvoyStorageItem.ts index 0308305..6524252 100644 --- a/src/EnvoyStorageItem.ts +++ b/src/EnvoyStorageItem.ts @@ -1,3 +1,6 @@ +/** + * @category Storage + */ type EnvoyStorageItem = { key: string, value: unknown, diff --git a/src/EnvoyUserAPI.ts b/src/EnvoyUserAPI.ts index d7307de..676b01f 100644 --- a/src/EnvoyUserAPI.ts +++ b/src/EnvoyUserAPI.ts @@ -19,6 +19,9 @@ import { EnvoyMetaAuth } from './EnvoyMeta'; /** * API endpoints for *user-scoped* tokens. * To access Envoy resources, this is the API you'd want. + * + * @category API + * @category Request Object */ export default class EnvoyUserAPI extends EnvoyAPI { async getAgreementPage(id: string, include?: string): Promise { @@ -147,9 +150,10 @@ export default class EnvoyUserAPI extends EnvoyAPI { /** * Gets a user access token using `password` as the grant type (discouraged). */ - static async loginAsUser( + static async loginAsUserWithPassword( username: string, password: string, + scope: Array = [], id = envoyClientId, secret = envoyClientSecret, ): Promise { @@ -161,9 +165,35 @@ export default class EnvoyUserAPI extends EnvoyAPI { method: 'POST', data: { grant_type: 'password', + scope, username, password, - scope: 'plugin,token.refresh', + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } + + /** + * Gets a user access token using `code` as the grant type. + */ + static async loginAsUserWithCode( + code: string, + scope: Array = [], + id = envoyClientId, + secret = envoyClientSecret, + ): Promise { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'authorization_code', + scope, + code, }, url: '/a/auth/v0/token', baseURL: envoyBaseURL, diff --git a/src/HttpStatus.ts b/src/HttpStatus.ts index 37bf8a0..feba2b0 100644 --- a/src/HttpStatus.ts +++ b/src/HttpStatus.ts @@ -1,5 +1,7 @@ /** * Use these status codes to inform Envoy of a job's or route's status. + * + * @internal */ enum HttpStatus { ONGOING = 202, diff --git a/src/asyncHandler.ts b/src/asyncHandler.ts index 0410c36..5a45e89 100644 --- a/src/asyncHandler.ts +++ b/src/asyncHandler.ts @@ -5,7 +5,10 @@ import EnvoyResponse from './EnvoyResponse'; export type EnvoyHandler = (req: EnvoyRequest, res: EnvoyResponse) => void | Promise; /** - * Catches Promise-based errors. + * Wraps any express.js-based handlers + * to catch Promise-based errors. + * + * @category Helper */ export default function asyncHandler(handler: RequestHandler | EnvoyHandler) { return async (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): Promise => { diff --git a/src/errorMiddleware.ts b/src/errorMiddleware.ts index bb7e33c..f4f78f4 100644 --- a/src/errorMiddleware.ts +++ b/src/errorMiddleware.ts @@ -5,6 +5,8 @@ import EnvoyResponse from './EnvoyResponse'; /** * Catches errors and sets the proper status code. + * + * @category SDK */ export default function errorMiddleware(onError: (err: Error) => void = () => {}) { return (err: Error, req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): void => { diff --git a/src/middleware.ts b/src/middleware.ts index db18729..732b4ad 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -9,6 +9,9 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; import EnvoyPluginSDK from './EnvoyPluginSDK'; import EnvoyPluginAPI from './EnvoyPluginAPI'; +/** + * @category Helper + */ export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => void; /** @@ -17,6 +20,8 @@ export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: Next * * Also verifies that the request is coming from Envoy, * as well as managing the plugin access token lifecycle. + * + * @category SDK */ export default function middleware(options?: EnvoySignatureVerifierOptions): EnvoyMiddleware { const signatureVerifier = new EnvoySignatureVerifier(options); @@ -35,7 +40,7 @@ export default function middleware(options?: EnvoySignatureVerifierOptions): Env try { const now = Date.now(); if (now > threshold) { - const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyPluginAPI.login(); + const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyPluginAPI.loginAsPlugin(); accessToken = rawAccessToken; threshold = now + (expiresIn * 1000) - (1000 * 60 * 10); } diff --git a/src/payloads/EntryPayload.ts b/src/payloads/EntryPayload.ts index 757d222..c38bb3c 100644 --- a/src/payloads/EntryPayload.ts +++ b/src/payloads/EntryPayload.ts @@ -1,5 +1,8 @@ import JSONAPIData from '../util/json-api/JSONAPIData'; +/** + * @category Event + */ type EntryPayload = { id: string, type: 'entries', diff --git a/src/payloads/InvitePayload.ts b/src/payloads/InvitePayload.ts index c3d5a9f..08e6b04 100644 --- a/src/payloads/InvitePayload.ts +++ b/src/payloads/InvitePayload.ts @@ -1,5 +1,8 @@ import JSONAPIData from '../util/json-api/JSONAPIData'; +/** + * @category Event + */ type InvitePayload = { id: string, type: 'invites', diff --git a/src/resources/AgreementPageResource.ts b/src/resources/AgreementPageResource.ts index eb15ca3..17cf608 100644 --- a/src/resources/AgreementPageResource.ts +++ b/src/resources/AgreementPageResource.ts @@ -1,10 +1,19 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type SignInFieldPageAttributes = { enabled?: boolean; position?: number; }; +/** + * @category API Resource + */ export type AgreementPageRelationships = 'flow' | 'agreements'; +/** + * @category API Resource + */ export type AgreementPageModel = JSONAPIModel; diff --git a/src/resources/AgreementResource.ts b/src/resources/AgreementResource.ts index c1dedff..ce0a77f 100644 --- a/src/resources/AgreementResource.ts +++ b/src/resources/AgreementResource.ts @@ -1,5 +1,8 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export interface AgreementAttributes { name: string; optional: boolean; @@ -12,6 +15,12 @@ export interface AgreementAttributes { 'updated-at'?: string; } +/** + * @category API Resource + */ export type AgreementRelationships = 'agreement-page'; +/** + * @category API Resource + */ export type AgreementModel = JSONAPIModel; diff --git a/src/resources/CompanyResource.ts b/src/resources/CompanyResource.ts index 305e2c5..acf38a4 100644 --- a/src/resources/CompanyResource.ts +++ b/src/resources/CompanyResource.ts @@ -1,5 +1,8 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export interface CompanyAttributes { name: string; active: boolean; @@ -7,6 +10,12 @@ export interface CompanyAttributes { 'updated-at': string; } +/** + * @category API Resource + */ export type CompanyRelationships = 'locations'; +/** + * @category API Resource + */ export type CompanyModel = JSONAPIModel; diff --git a/src/resources/EmployeeResource.ts b/src/resources/EmployeeResource.ts index a665104..172b281 100644 --- a/src/resources/EmployeeResource.ts +++ b/src/resources/EmployeeResource.ts @@ -1,7 +1,13 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type EmployeeSortFields = 'name' | 'created_at' | '-name' | '-created_at'; +/** + * @category API Resource + */ export interface EmployeeFilterFields { deleted?: boolean; company?: string; @@ -15,6 +21,9 @@ export interface EmployeeFilterFields { query?: string; } +/** + * @category API Resource + */ export interface EmployeeAttributes { name: string; email: string; @@ -27,6 +36,12 @@ export interface EmployeeAttributes { 'deleted-at'?: string; } +/** + * @category API Resource + */ export type EmployeeRelationships = 'locations' | 'company'; +/** + * @category API Resource + */ export type EmployeeModel = JSONAPIModel; diff --git a/src/resources/FlowResource.ts b/src/resources/FlowResource.ts index fd81cb7..4f64cc9 100644 --- a/src/resources/FlowResource.ts +++ b/src/resources/FlowResource.ts @@ -1,12 +1,21 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type FlowSortFields = 'name' | 'created_at' | '-name' | '-created_at'; +/** + * @category API Resource + */ export interface FlowFilterFields { 'employee-centric'?: boolean; location?: string; } +/** + * @category API Resource + */ export interface FlowAttributes { name: string; 'employee-centric'?: boolean; @@ -15,6 +24,12 @@ export interface FlowAttributes { 'updated-at'?: string; } +/** + * @category API Resource + */ export type FlowRelationships = 'location' | 'sign-in-field-page' | 'agreement-page'; +/** + * @category API Resource + */ export type FlowModel = JSONAPIModel; diff --git a/src/resources/InviteResource.ts b/src/resources/InviteResource.ts index 4262b54..a044617 100644 --- a/src/resources/InviteResource.ts +++ b/src/resources/InviteResource.ts @@ -1,7 +1,13 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type InviteSortFields = 'name' | 'created_at' | '-name' | '-created_at'; +/** + * @category API Resource + */ export interface InviteFilterFields { email?: string; employee?: string; @@ -16,6 +22,9 @@ export interface InviteFilterFields { scope?: 'hosted' | 'mine' | 'include_execs'; } +/** + * @category API Resource + */ export interface InviteAttributes { 'additional-guests'?: number; 'approval-status'?: { @@ -52,6 +61,9 @@ export interface InviteAttributes { 'updated-at'?: string; } +/** + * @category API Resource + */ export interface InviteCreationAttributes { email?: string; 'expected-arrival-time'?: string; @@ -64,8 +76,17 @@ export interface InviteCreationAttributes { phone?: string; } +/** + * @category API Resource + */ export type InviteRelationships = 'attendee' | 'creator' | 'employee' | 'entry' | 'flow' | 'location'; +/** + * @category API Resource + */ export type InviteModel = JSONAPIModel; +/** + * @category API Resource + */ export type InviteCreationModel = JSONAPIModel; diff --git a/src/resources/LocationResource.ts b/src/resources/LocationResource.ts index 6838d0a..51528e6 100644 --- a/src/resources/LocationResource.ts +++ b/src/resources/LocationResource.ts @@ -1,12 +1,21 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type LocationSortFields = 'name' | 'created_at' | '-name' | '-created_at'; +/** + * @category API Resource + */ export interface LocationFilterFields { disabled?: boolean; company?: string; } +/** + * @category API Resource + */ export interface LocationAttributes { name: string; address: string; @@ -47,6 +56,12 @@ export interface LocationAttributes { 'updated-at'?: string; } +/** + * @category API Resource + */ export type LocationRelationships = 'company' | 'employees' | 'flows' | 'employee-screening-flow'; +/** + * @category API Resource + */ export type LocationModel = JSONAPIModel; diff --git a/src/resources/SignInFieldPageResource.ts b/src/resources/SignInFieldPageResource.ts index e3af783..943101e 100644 --- a/src/resources/SignInFieldPageResource.ts +++ b/src/resources/SignInFieldPageResource.ts @@ -1,14 +1,23 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type SignInFieldPageAttributes = { enabled?: boolean; position?: number; }; +/** + * @category API Resource + */ export type SignInFieldPageRelationships = 'flow' | 'actionable-sign-in-field-actions' | 'actionable-sign-in-fields' | 'sign-in-field-actions' | 'sign-in-fields'; +/** + * @category API Resource + */ export type SignInFieldPageModel = JSONAPIModel; diff --git a/src/resources/SignInFieldResource.ts b/src/resources/SignInFieldResource.ts index ce16aff..eca5728 100644 --- a/src/resources/SignInFieldResource.ts +++ b/src/resources/SignInFieldResource.ts @@ -1,5 +1,8 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export interface SignInFieldAttributes { name: string; kind: string; @@ -17,6 +20,12 @@ export interface SignInFieldAttributes { 'updated-at'?: string; } +/** + * @category API Resource + */ export type SignInFieldRelationships = 'sign-in-field-page'; +/** + * @category API Resource + */ export type SignInFieldModel = JSONAPIModel; diff --git a/src/resources/UserResource.ts b/src/resources/UserResource.ts index 0f3c2e8..492cc2c 100644 --- a/src/resources/UserResource.ts +++ b/src/resources/UserResource.ts @@ -1,8 +1,14 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; +/** + * @category API Resource + */ export type UserAttributes = { name: string; email: string; }; +/** + * @category API Resource + */ export type UserModel = JSONAPIModel; diff --git a/typedoc.json b/typedoc.json index e2bc5f8..1dda9f4 100644 --- a/typedoc.json +++ b/typedoc.json @@ -4,5 +4,7 @@ "excludePrivate": true, "excludeProtected": true, "excludeExternals": true, + "excludeInternal": true, + "categorizeByGroup": true, "readme": "none" } From 7f5367784f7362c4040b0facafdd02851925dfde Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Fri, 11 Jun 2021 12:52:57 -0400 Subject: [PATCH 26/91] reorganizing --- docs/README.md | 47 ++-- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 18 +- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 22 +- docs/classes/envoypluginstoragepipeline.md | 232 ------------------- docs/classes/envoysignatureverifier.md | 4 +- docs/classes/envoyuserapi.md | 48 ++-- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/jsonapidata.md | 4 +- src/{ => base}/EnvoyAPI.ts | 4 +- src/{ => base}/EnvoyPluginStoragePipeline.ts | 6 +- src/index.ts | 36 ++- src/{ => internal}/EnvoyPluginJobUpdate.ts | 2 +- src/{ => internal}/EnvoyStorageCommand.ts | 0 src/{ => internal}/HttpStatus.ts | 0 src/{ => sdk}/EnvoyMeta.ts | 0 src/{ => sdk}/EnvoyPluginAPI.ts | 8 +- src/{ => sdk}/EnvoyPluginJob.ts | 2 +- src/{ => sdk}/EnvoyPluginJobAttachment.ts | 0 src/{ => sdk}/EnvoyPluginSDK.ts | 4 +- src/{ => sdk}/EnvoyPluginStorage.ts | 4 +- src/{ => sdk}/EnvoyRequest.ts | 4 +- src/{ => sdk}/EnvoyResponse.ts | 0 src/{ => sdk}/EnvoyStorageItem.ts | 0 src/{ => sdk}/EnvoyUserAPI.ts | 26 +-- src/{ => sdk}/asyncHandler.ts | 0 src/{ => sdk}/errorMiddleware.ts | 2 +- src/{ => sdk}/middleware.ts | 4 +- src/{ => util}/EnvoyJWT.ts | 2 +- src/{ => util}/EnvoySignatureVerifier.ts | 2 +- 33 files changed, 151 insertions(+), 386 deletions(-) delete mode 100644 docs/classes/envoypluginstoragepipeline.md rename src/{ => base}/EnvoyAPI.ts (96%) rename src/{ => base}/EnvoyPluginStoragePipeline.ts (93%) rename src/{ => internal}/EnvoyPluginJobUpdate.ts (72%) rename src/{ => internal}/EnvoyStorageCommand.ts (100%) rename src/{ => internal}/HttpStatus.ts (100%) rename src/{ => sdk}/EnvoyMeta.ts (100%) rename src/{ => sdk}/EnvoyPluginAPI.ts (92%) rename src/{ => sdk}/EnvoyPluginJob.ts (96%) rename src/{ => sdk}/EnvoyPluginJobAttachment.ts (100%) rename src/{ => sdk}/EnvoyPluginSDK.ts (98%) rename src/{ => sdk}/EnvoyPluginStorage.ts (93%) rename src/{ => sdk}/EnvoyRequest.ts (94%) rename src/{ => sdk}/EnvoyResponse.ts (100%) rename src/{ => sdk}/EnvoyStorageItem.ts (100%) rename src/{ => sdk}/EnvoyUserAPI.ts (89%) rename src/{ => sdk}/asyncHandler.ts (100%) rename src/{ => sdk}/errorMiddleware.ts (92%) rename src/{ => sdk}/middleware.ts (97%) rename src/{ => util}/EnvoyJWT.ts (96%) rename src/{ => util}/EnvoySignatureVerifier.ts (96%) diff --git a/docs/README.md b/docs/README.md index aeba98c..008bafc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,11 +9,6 @@ - [EnvoyPluginAPI](classes/envoypluginapi.md) - [EnvoyUserAPI](classes/envoyuserapi.md) -### Base Classes - -- [EnvoyPluginSDK](classes/envoypluginsdk.md) -- [EnvoyPluginStoragePipeline](classes/envoypluginstoragepipeline.md) - ### Helper Classes - [EnvoyJWT](classes/envoyjwt.md) @@ -27,6 +22,10 @@ - [EnvoyPluginStorage](classes/envoypluginstorage.md) - [EnvoyUserAPI](classes/envoyuserapi.md) +### SDK Classes + +- [EnvoyPluginSDK](classes/envoypluginsdk.md) + ### Storage Classes - [EnvoyPluginStorage](classes/envoypluginstorage.md) @@ -131,7 +130,7 @@ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/payloads/EntryPayload.ts#L6) ___ @@ -183,7 +182,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/payloads/InvitePayload.ts#L6) ___ @@ -211,7 +210,7 @@ ___ #### Defined in -[middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/middleware.ts#L15) +[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/middleware.ts#L15) ___ @@ -230,7 +229,7 @@ ___ #### Defined in -[EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -257,7 +256,7 @@ Metadata that will be included in the request body for events. #### Defined in -[EnvoyMeta.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L67) +[sdk/EnvoyMeta.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L67) ___ @@ -281,7 +280,7 @@ found in `req.envoy.userAPI`. #### Defined in -[EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L54) +[sdk/EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L54) ___ @@ -302,7 +301,7 @@ ___ #### Defined in -[EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L37) ___ @@ -320,7 +319,7 @@ ___ #### Defined in -[EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L4) ___ @@ -352,7 +351,7 @@ ___ #### Defined in -[EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L13) ___ @@ -379,7 +378,7 @@ like validation URLs or options URLs. #### Defined in -[EnvoyMeta.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyMeta.ts#L84) +[sdk/EnvoyMeta.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L84) ___ @@ -394,7 +393,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L53) +[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L53) ___ @@ -413,7 +412,7 @@ You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L45) +[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L45) ___ @@ -426,7 +425,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L61) +[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L61) ___ @@ -446,7 +445,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L70) ___ @@ -465,7 +464,7 @@ such as validation URLS or options URLs. #### Defined in -[EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L37) +[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L37) ___ @@ -484,7 +483,7 @@ ___ #### Defined in -[EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyStorageItem.ts#L4) ## Helper Functions @@ -521,7 +520,7 @@ to catch Promise-based errors. #### Defined in -[asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/asyncHandler.ts#L13) +[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/asyncHandler.ts#L13) ___ @@ -560,7 +559,7 @@ Catches errors and sets the proper status code. #### Defined in -[errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/errorMiddleware.ts#L11) +[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/errorMiddleware.ts#L11) ___ @@ -586,4 +585,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/middleware.ts#L26) +[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/middleware.ts#L26) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 7e83278..bc3f281 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index da70ec4..99879fc 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyPluginAPI.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L53) +[sdk/EnvoyPluginAPI.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L53) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L24) +[sdk/EnvoyPluginAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L24) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L29) +[sdk/EnvoyPluginAPI.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L29) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -190,4 +190,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[EnvoyPluginAPI.ts:64](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginAPI.ts#L64) +[sdk/EnvoyPluginAPI.ts:64](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L64) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index d7203d1..44c22dc 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -43,7 +43,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -53,7 +53,7 @@ as well as attach extra data to the event's subject #### Defined in -[EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -83,7 +83,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L45) +[sdk/EnvoyPluginJob.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L45) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L49) +[sdk/EnvoyPluginJob.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L49) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L24) +[sdk/EnvoyPluginJob.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L24) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L57) +[sdk/EnvoyPluginJob.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L57) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[EnvoyPluginJob.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L53) +[sdk/EnvoyPluginJob.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L53) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[EnvoyPluginJob.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginJob.ts#L61) +[sdk/EnvoyPluginJob.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L61) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 6010ee0..548ed32 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -55,7 +55,7 @@ to allow for easy access to Envoy functions. #### Defined in -[EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -83,7 +83,7 @@ Returns a job based on an ID. #### Defined in -[EnvoyPluginSDK.ts:132](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L132) +[sdk/EnvoyPluginSDK.ts:132](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L132) ___ @@ -99,7 +99,7 @@ Storage scoped globally (across installs). #### Defined in -[EnvoyPluginSDK.ts:125](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L125) +[sdk/EnvoyPluginSDK.ts:125](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L125) ___ @@ -115,7 +115,7 @@ Storage scoped to the install. #### Defined in -[EnvoyPluginSDK.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L114) +[sdk/EnvoyPluginSDK.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L114) ___ @@ -131,7 +131,7 @@ Perform operations on the current job. #### Defined in -[EnvoyPluginSDK.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L150) +[sdk/EnvoyPluginSDK.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L150) ___ @@ -147,7 +147,7 @@ Returns the current job's ID. #### Defined in -[EnvoyPluginSDK.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L139) +[sdk/EnvoyPluginSDK.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L139) ___ @@ -164,7 +164,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[EnvoyPluginSDK.ts:163](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L163) +[sdk/EnvoyPluginSDK.ts:163](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L163) ___ @@ -181,7 +181,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[EnvoyPluginSDK.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L53) +[sdk/EnvoyPluginSDK.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L53) ___ @@ -199,7 +199,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[EnvoyPluginSDK.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L65) +[sdk/EnvoyPluginSDK.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L65) ___ @@ -216,7 +216,7 @@ Used to perform storage or job operations. #### Defined in -[EnvoyPluginSDK.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L93) +[sdk/EnvoyPluginSDK.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L93) ___ @@ -233,4 +233,4 @@ Used only in routes. #### Defined in -[EnvoyPluginSDK.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginSDK.ts#L76) +[sdk/EnvoyPluginSDK.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L76) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index a8a9a2a..7f23c1c 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -82,23 +82,23 @@ Wrapper for single pipeline get. #### Defined in -[EnvoyPluginStorage.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L33) +[sdk/EnvoyPluginStorage.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L33) ___ ### pipeline -▸ **pipeline**(): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +▸ **pipeline**(): `default` Creates a new pipeline instance. #### Returns -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) +`default` #### Defined in -[EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -121,7 +121,7 @@ Wrapper for single pipeline set. #### Defined in -[EnvoyPluginStorage.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L40) +[sdk/EnvoyPluginStorage.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L40) ___ @@ -144,7 +144,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L47) +[sdk/EnvoyPluginStorage.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L47) ___ @@ -167,7 +167,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[EnvoyPluginStorage.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L54) +[sdk/EnvoyPluginStorage.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L54) ___ @@ -190,4 +190,4 @@ Returns null if the item did not previously exist. #### Defined in -[EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L62) diff --git a/docs/classes/envoypluginstoragepipeline.md b/docs/classes/envoypluginstoragepipeline.md deleted file mode 100644 index d1fe476..0000000 --- a/docs/classes/envoypluginstoragepipeline.md +++ /dev/null @@ -1,232 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoyPluginStoragePipeline - -# Class: EnvoyPluginStoragePipeline - -Builds up a request pipeline for submitting storage commands. - -## Table of contents - -### Constructors - -- [constructor](envoypluginstoragepipeline.md#constructor) - -### Properties - -- [api](envoypluginstoragepipeline.md#api) -- [installId](envoypluginstoragepipeline.md#installid) - -### Methods - -- [addCommand](envoypluginstoragepipeline.md#addcommand) -- [execute](envoypluginstoragepipeline.md#execute) -- [executeSingle](envoypluginstoragepipeline.md#executesingle) -- [get](envoypluginstoragepipeline.md#get) -- [set](envoypluginstoragepipeline.md#set) -- [setUnique](envoypluginstoragepipeline.md#setunique) -- [setUniqueNum](envoypluginstoragepipeline.md#setuniquenum) -- [unset](envoypluginstoragepipeline.md#unset) - -## Constructors - -### constructor - -• **new EnvoyPluginStoragePipeline**(`pluginAPI`, `installId?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pluginAPI` | [EnvoyPluginAPI](envoypluginapi.md) | -| `installId?` | `string` | - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L18) - -## Properties - -### api - -• `Readonly` **api**: [EnvoyPluginAPI](envoypluginapi.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L14) - -___ - -### installId - -• `Readonly` **installId**: `undefined` \| `string` - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L16) - -## Methods - -### addCommand - -▸ **addCommand**(`command`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `EnvoyStorageCommand` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L41) - -___ - -### execute - -▸ **execute**(): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> - -Executes all the commands in the pipeline. - -#### Returns - -`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L29) - -___ - -### executeSingle - -▸ **executeSingle**(): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> - -Executes the pipeline and returns the first result. - -#### Returns - -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L36) - -___ - -### get - -▸ **get**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -Gets a storage item. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L49) - -___ - -### set - -▸ **set**(`key`, `value`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -Sets a value for a storage item, -and returns that item. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `unknown` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L57) - -___ - -### setUnique - -▸ **setUnique**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -Sets a unique value for a storage item, -and returns that item. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `EnvoyStorageSetUniqueOptions` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L65) - -___ - -### setUniqueNum - -▸ **setUniqueNum**(`key`, `options?`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -Sets a unique number value for a storage item, -and returns that item. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `EnvoyStorageSetUniqueNumOptions` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L73) - -___ - -### unset - -▸ **unset**(`key`): [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -Unsets a storage item. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -[EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) - -#### Defined in - -[EnvoyPluginStoragePipeline.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyPluginStoragePipeline.ts#L80) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md index e710ff1..5028f74 100644 --- a/docs/classes/envoysignatureverifier.md +++ b/docs/classes/envoysignatureverifier.md @@ -28,7 +28,7 @@ Verifies that a request is coming from Envoy. #### Defined in -[EnvoySignatureVerifier.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoySignatureVerifier.ts#L28) +[util/EnvoySignatureVerifier.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoySignatureVerifier.ts#L28) ## Methods @@ -51,4 +51,4 @@ Verifies that the signature provided matches the request body. #### Defined in -[EnvoySignatureVerifier.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoySignatureVerifier.ts#L41) +[util/EnvoySignatureVerifier.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoySignatureVerifier.ts#L41) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index d99d4c4..1849718 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -64,7 +64,7 @@ EnvoyAPI.constructor #### Defined in -[EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L59) ## Properties @@ -80,7 +80,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L32) ## Methods @@ -100,7 +100,7 @@ EnvoyAPI.axios #### Defined in -[EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L31) +[sdk/EnvoyUserAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L31) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L27) +[sdk/EnvoyUserAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L27) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L35) +[sdk/EnvoyUserAPI.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L35) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L39) +[sdk/EnvoyUserAPI.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L39) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L59) +[sdk/EnvoyUserAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L59) ___ @@ -225,7 +225,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L78) +[sdk/EnvoyUserAPI.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L78) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L43) +[sdk/EnvoyUserAPI.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L43) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:85](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L85) +[sdk/EnvoyUserAPI.ts:85](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L85) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:102](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L102) +[sdk/EnvoyUserAPI.ts:102](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L102) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L47) +[sdk/EnvoyUserAPI.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L47) ___ @@ -327,7 +327,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L90) +[sdk/EnvoyUserAPI.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L90) ___ @@ -348,7 +348,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L55) +[sdk/EnvoyUserAPI.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L55) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L51) +[sdk/EnvoyUserAPI.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L51) ___ @@ -389,7 +389,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:97](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L97) +[sdk/EnvoyUserAPI.ts:97](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L97) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:109](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L109) +[sdk/EnvoyUserAPI.ts:109](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L109) ___ @@ -424,7 +424,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L133) +[sdk/EnvoyUserAPI.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L133) ___ @@ -444,7 +444,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:143](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L143) +[sdk/EnvoyUserAPI.ts:143](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L143) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[EnvoyUserAPI.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L123) +[sdk/EnvoyUserAPI.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L123) ___ @@ -489,7 +489,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[EnvoyUserAPI.ts:207](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L207) +[sdk/EnvoyUserAPI.ts:207](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L207) ___ @@ -514,7 +514,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[EnvoyUserAPI.ts:181](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L181) +[sdk/EnvoyUserAPI.ts:181](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L181) ___ @@ -540,4 +540,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[EnvoyUserAPI.ts:153](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyUserAPI.ts#L153) +[sdk/EnvoyUserAPI.ts:153](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L153) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 6a592b5..082a296 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -39,7 +39,7 @@ VerifiedRequest.\_\_@VERIFIED@1237 #### Defined in -[EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L16) +[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L16) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyRequest.ts#L28) +[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L28) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 5b87beb..8cea0c8 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L9) +[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L9) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L12) +[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L12) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L11) +[sdk/EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L11) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -[EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/EnvoyResponse.ts#L10) +[sdk/EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L10) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index aafcc30..d79bc0f 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/cd208f9/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/json-api/JSONAPIData.ts#L3) diff --git a/src/EnvoyAPI.ts b/src/base/EnvoyAPI.ts similarity index 96% rename from src/EnvoyAPI.ts rename to src/base/EnvoyAPI.ts index df9ddad..d8e8991 100644 --- a/src/EnvoyAPI.ts +++ b/src/base/EnvoyAPI.ts @@ -1,8 +1,8 @@ import axios from 'axios'; import qs from 'qs'; import DataLoader from 'dataloader'; -import JSONAPIData from './util/json-api/JSONAPIData'; -import { envoyBaseURL } from './constants'; +import JSONAPIData from '../util/json-api/JSONAPIData'; +import { envoyBaseURL } from '../constants'; interface EnvoyWebDataLoaderKey extends JSONAPIData { include?: string; diff --git a/src/EnvoyPluginStoragePipeline.ts b/src/base/EnvoyPluginStoragePipeline.ts similarity index 93% rename from src/EnvoyPluginStoragePipeline.ts rename to src/base/EnvoyPluginStoragePipeline.ts index 8d715c4..189d9e6 100644 --- a/src/EnvoyPluginStoragePipeline.ts +++ b/src/base/EnvoyPluginStoragePipeline.ts @@ -1,9 +1,9 @@ import EnvoyStorageCommand, { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions, -} from './EnvoyStorageCommand'; -import EnvoyStorageItem from './EnvoyStorageItem'; -import EnvoyPluginAPI from './EnvoyPluginAPI'; +} from '../internal/EnvoyStorageCommand'; +import EnvoyStorageItem from '../sdk/EnvoyStorageItem'; +import EnvoyPluginAPI from '../sdk/EnvoyPluginAPI'; /** * Builds up a request pipeline for submitting storage commands. diff --git a/src/index.ts b/src/index.ts index a3a0668..c4f2ac1 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,24 +1,24 @@ -import asyncHandler from './asyncHandler'; -import errorMiddleware from './errorMiddleware'; -import EnvoyJWT from './EnvoyJWT'; -import EnvoyPluginJob from './EnvoyPluginJob'; -import EnvoyPluginSDK from './EnvoyPluginSDK'; -import EnvoyPluginStorage from './EnvoyPluginStorage'; -import EnvoyPluginStoragePipeline from './EnvoyPluginStoragePipeline'; -import EnvoyRequest from './EnvoyRequest'; -import EnvoyResponse from './EnvoyResponse'; -import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './EnvoySignatureVerifier'; -import EnvoyStorageItem from './EnvoyStorageItem'; -import EnvoyUserAPI from './EnvoyUserAPI'; -import EnvoyPluginAPI from './EnvoyPluginAPI'; -import HttpStatus from './HttpStatus'; -import middleware, { EnvoyMiddleware } from './middleware'; import EntryPayload from './payloads/EntryPayload'; import InvitePayload from './payloads/InvitePayload'; + +import asyncHandler from './sdk/asyncHandler'; +import errorMiddleware from './sdk/errorMiddleware'; +import EnvoyPluginJob from './sdk/EnvoyPluginJob'; +import EnvoyPluginSDK from './sdk/EnvoyPluginSDK'; +import EnvoyPluginStorage from './sdk/EnvoyPluginStorage'; +import EnvoyRequest from './sdk/EnvoyRequest'; +import EnvoyResponse from './sdk/EnvoyResponse'; +import EnvoyStorageItem from './sdk/EnvoyStorageItem'; +import EnvoyUserAPI from './sdk/EnvoyUserAPI'; +import EnvoyPluginAPI from './sdk/EnvoyPluginAPI'; +import middleware, { EnvoyMiddleware } from './sdk/middleware'; + +import EnvoyJWT from './util/EnvoyJWT'; +import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './util/EnvoySignatureVerifier'; import JSONAPIData from './util/json-api/JSONAPIData'; -export * from './EnvoyMeta'; -export * from './EnvoyRequest'; +export * from './sdk/EnvoyMeta'; +export * from './sdk/EnvoyRequest'; export { asyncHandler, errorMiddleware, @@ -29,7 +29,6 @@ export { EnvoyPluginJob, EnvoyPluginSDK, EnvoyPluginStorage, - EnvoyPluginStoragePipeline, EnvoyRequest, EnvoyResponse, EnvoySignatureVerifier, @@ -37,7 +36,6 @@ export { EnvoyStorageItem, EnvoyPluginAPI, EnvoyUserAPI, - HttpStatus, JSONAPIData, middleware, }; diff --git a/src/EnvoyPluginJobUpdate.ts b/src/internal/EnvoyPluginJobUpdate.ts similarity index 72% rename from src/EnvoyPluginJobUpdate.ts rename to src/internal/EnvoyPluginJobUpdate.ts index 226e8bb..c4f05d3 100644 --- a/src/EnvoyPluginJobUpdate.ts +++ b/src/internal/EnvoyPluginJobUpdate.ts @@ -1,4 +1,4 @@ -import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; +import EnvoyPluginJobAttachment from '../sdk/EnvoyPluginJobAttachment'; /** * @internal diff --git a/src/EnvoyStorageCommand.ts b/src/internal/EnvoyStorageCommand.ts similarity index 100% rename from src/EnvoyStorageCommand.ts rename to src/internal/EnvoyStorageCommand.ts diff --git a/src/HttpStatus.ts b/src/internal/HttpStatus.ts similarity index 100% rename from src/HttpStatus.ts rename to src/internal/HttpStatus.ts diff --git a/src/EnvoyMeta.ts b/src/sdk/EnvoyMeta.ts similarity index 100% rename from src/EnvoyMeta.ts rename to src/sdk/EnvoyMeta.ts diff --git a/src/EnvoyPluginAPI.ts b/src/sdk/EnvoyPluginAPI.ts similarity index 92% rename from src/EnvoyPluginAPI.ts rename to src/sdk/EnvoyPluginAPI.ts index fe0f418..692a453 100644 --- a/src/EnvoyPluginAPI.ts +++ b/src/sdk/EnvoyPluginAPI.ts @@ -1,9 +1,9 @@ import axios from 'axios'; -import EnvoyAPI from './EnvoyAPI'; -import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; -import EnvoyStorageCommand from './EnvoyStorageCommand'; +import EnvoyAPI from '../base/EnvoyAPI'; +import EnvoyPluginJobUpdate from '../internal/EnvoyPluginJobUpdate'; +import EnvoyStorageCommand from '../internal/EnvoyStorageCommand'; import EnvoyStorageItem from './EnvoyStorageItem'; -import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; +import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; /** diff --git a/src/EnvoyPluginJob.ts b/src/sdk/EnvoyPluginJob.ts similarity index 96% rename from src/EnvoyPluginJob.ts rename to src/sdk/EnvoyPluginJob.ts index ce1085c..7d13b93 100644 --- a/src/EnvoyPluginJob.ts +++ b/src/sdk/EnvoyPluginJob.ts @@ -1,5 +1,5 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; -import EnvoyPluginJobUpdate from './EnvoyPluginJobUpdate'; +import EnvoyPluginJobUpdate from '../internal/EnvoyPluginJobUpdate'; import EnvoyPluginAPI from './EnvoyPluginAPI'; /** diff --git a/src/EnvoyPluginJobAttachment.ts b/src/sdk/EnvoyPluginJobAttachment.ts similarity index 100% rename from src/EnvoyPluginJobAttachment.ts rename to src/sdk/EnvoyPluginJobAttachment.ts diff --git a/src/EnvoyPluginSDK.ts b/src/sdk/EnvoyPluginSDK.ts similarity index 98% rename from src/EnvoyPluginSDK.ts rename to src/sdk/EnvoyPluginSDK.ts index 3916b72..12bebb9 100644 --- a/src/EnvoyPluginSDK.ts +++ b/src/sdk/EnvoyPluginSDK.ts @@ -1,7 +1,7 @@ import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta'; import EnvoyPluginStorage from './EnvoyPluginStorage'; import EnvoyPluginJob from './EnvoyPluginJob'; -import EnvoyJWT from './EnvoyJWT'; +import EnvoyJWT from '../util/EnvoyJWT'; import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; @@ -19,7 +19,7 @@ export interface EnvoyRequestBody { * Attaches itself to every request object using our `middleware`, * to allow for easy access to Envoy functions. * - * @category Base + * @category SDK */ export default class EnvoyPluginSDK { /** diff --git a/src/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts similarity index 93% rename from src/EnvoyPluginStorage.ts rename to src/sdk/EnvoyPluginStorage.ts index e744d09..43ade0c 100644 --- a/src/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -1,5 +1,5 @@ -import EnvoyPluginStoragePipeline from './EnvoyPluginStoragePipeline'; -import { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions } from './EnvoyStorageCommand'; +import EnvoyPluginStoragePipeline from '../base/EnvoyPluginStoragePipeline'; +import { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions } from '../internal/EnvoyStorageCommand'; import EnvoyStorageItem from './EnvoyStorageItem'; import EnvoyPluginAPI from './EnvoyPluginAPI'; diff --git a/src/EnvoyRequest.ts b/src/sdk/EnvoyRequest.ts similarity index 94% rename from src/EnvoyRequest.ts rename to src/sdk/EnvoyRequest.ts index bed75e4..38eb936 100644 --- a/src/EnvoyRequest.ts +++ b/src/sdk/EnvoyRequest.ts @@ -1,8 +1,8 @@ import { Request } from 'express'; import EnvoyPluginSDK from './EnvoyPluginSDK'; import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta'; -import EntryPayload from './payloads/EntryPayload'; -import InvitePayload from './payloads/InvitePayload'; +import EntryPayload from '../payloads/EntryPayload'; +import InvitePayload from '../payloads/InvitePayload'; /** * @internal diff --git a/src/EnvoyResponse.ts b/src/sdk/EnvoyResponse.ts similarity index 100% rename from src/EnvoyResponse.ts rename to src/sdk/EnvoyResponse.ts diff --git a/src/EnvoyStorageItem.ts b/src/sdk/EnvoyStorageItem.ts similarity index 100% rename from src/EnvoyStorageItem.ts rename to src/sdk/EnvoyStorageItem.ts diff --git a/src/EnvoyUserAPI.ts b/src/sdk/EnvoyUserAPI.ts similarity index 89% rename from src/EnvoyUserAPI.ts rename to src/sdk/EnvoyUserAPI.ts index 676b01f..fda57ab 100644 --- a/src/EnvoyUserAPI.ts +++ b/src/sdk/EnvoyUserAPI.ts @@ -1,19 +1,19 @@ import axios from 'axios'; -import EnvoyAPI from './EnvoyAPI'; -import { AgreementPageModel } from './resources/AgreementPageResource'; -import { AgreementModel } from './resources/AgreementResource'; -import { CompanyModel } from './resources/CompanyResource'; -import { EmployeeFilterFields, EmployeeModel, EmployeeSortFields } from './resources/EmployeeResource'; -import { FlowFilterFields, FlowModel, FlowSortFields } from './resources/FlowResource'; -import { LocationFilterFields, LocationModel, LocationSortFields } from './resources/LocationResource'; -import { SignInFieldPageModel } from './resources/SignInFieldPageResource'; -import { SignInFieldModel } from './resources/SignInFieldResource'; -import JSONAPIPaginationParams from './util/json-api/JSONAPIPaginationParams'; +import EnvoyAPI from '../base/EnvoyAPI'; +import { AgreementPageModel } from '../resources/AgreementPageResource'; +import { AgreementModel } from '../resources/AgreementResource'; +import { CompanyModel } from '../resources/CompanyResource'; +import { EmployeeFilterFields, EmployeeModel, EmployeeSortFields } from '../resources/EmployeeResource'; +import { FlowFilterFields, FlowModel, FlowSortFields } from '../resources/FlowResource'; +import { LocationFilterFields, LocationModel, LocationSortFields } from '../resources/LocationResource'; +import { SignInFieldPageModel } from '../resources/SignInFieldPageResource'; +import { SignInFieldModel } from '../resources/SignInFieldResource'; +import JSONAPIPaginationParams from '../util/json-api/JSONAPIPaginationParams'; import { InviteCreationModel, InviteFilterFields, InviteModel, InviteSortFields, -} from './resources/InviteResource'; -import { UserModel } from './resources/UserResource'; -import { envoyBaseURL, envoyClientId, envoyClientSecret } from './constants'; +} from '../resources/InviteResource'; +import { UserModel } from '../resources/UserResource'; +import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; /** diff --git a/src/asyncHandler.ts b/src/sdk/asyncHandler.ts similarity index 100% rename from src/asyncHandler.ts rename to src/sdk/asyncHandler.ts diff --git a/src/errorMiddleware.ts b/src/sdk/errorMiddleware.ts similarity index 92% rename from src/errorMiddleware.ts rename to src/sdk/errorMiddleware.ts index f4f78f4..d384661 100644 --- a/src/errorMiddleware.ts +++ b/src/sdk/errorMiddleware.ts @@ -1,5 +1,5 @@ import { NextFunction } from 'express'; -import HttpStatus from './HttpStatus'; +import HttpStatus from '../internal/HttpStatus'; import EnvoyRequest from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; diff --git a/src/middleware.ts b/src/sdk/middleware.ts similarity index 97% rename from src/middleware.ts rename to src/sdk/middleware.ts index 732b4ad..76f7287 100644 --- a/src/middleware.ts +++ b/src/sdk/middleware.ts @@ -1,8 +1,8 @@ import bodyParser from 'body-parser'; import { Response, NextFunction } from 'express'; -import HttpStatus from './HttpStatus'; -import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './EnvoySignatureVerifier'; +import HttpStatus from '../internal/HttpStatus'; +import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from '../util/EnvoySignatureVerifier'; import EnvoyRequest, { VERIFIED, VerifiedRequest } from './EnvoyRequest'; import EnvoyResponse from './EnvoyResponse'; import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; diff --git a/src/EnvoyJWT.ts b/src/util/EnvoyJWT.ts similarity index 96% rename from src/EnvoyJWT.ts rename to src/util/EnvoyJWT.ts index c58c48c..34ad7d1 100644 --- a/src/EnvoyJWT.ts +++ b/src/util/EnvoyJWT.ts @@ -1,5 +1,5 @@ import jwt, { SignOptions, Algorithm, VerifyOptions } from 'jsonwebtoken'; -import { jwtSecret } from './constants'; +import { jwtSecret } from '../constants'; export type EnvoyJWTAlgorithm = Algorithm; export type EnvoyJWTDecodeOptions = VerifyOptions; diff --git a/src/EnvoySignatureVerifier.ts b/src/util/EnvoySignatureVerifier.ts similarity index 96% rename from src/EnvoySignatureVerifier.ts rename to src/util/EnvoySignatureVerifier.ts index 7315752..a61c9ff 100644 --- a/src/EnvoySignatureVerifier.ts +++ b/src/util/EnvoySignatureVerifier.ts @@ -1,6 +1,6 @@ import crypto, { BinaryToTextEncoding } from 'crypto'; import { Request } from 'express'; -import { envoyClientSecret } from './constants'; +import { envoyClientSecret } from '../constants'; /** * @category Helper From 48073ada44d2bb279bfa50516f8984abc6a52463 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 12 Jun 2021 12:40:07 -0400 Subject: [PATCH 27/91] adding links --- docs/README.md | 52 ++++----- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 22 ++-- docs/classes/envoypluginjob.md | 61 +++++----- docs/classes/envoypluginsdk.md | 40 ++++--- docs/classes/envoypluginstorage.md | 29 +++-- docs/classes/envoysignatureverifier.md | 54 --------- docs/classes/envoyuserapi.md | 152 ++++++++++++++++++------- docs/interfaces/envoybaserequest.md | 10 +- docs/interfaces/envoyresponse.md | 16 ++- docs/interfaces/jsonapidata.md | 4 +- src/index.ts | 17 ++- src/resources/AgreementPageResource.ts | 4 +- src/sdk/EnvoyMeta.ts | 3 +- src/sdk/EnvoyPluginAPI.ts | 8 ++ src/sdk/EnvoyPluginJob.ts | 28 ++++- src/sdk/EnvoyPluginSDK.ts | 14 ++- src/sdk/EnvoyPluginStorage.ts | 11 +- src/sdk/EnvoyRequest.ts | 10 +- src/sdk/EnvoyResponse.ts | 12 ++ src/sdk/EnvoyUserAPI.ts | 129 ++++++++++++++++++--- src/sdk/middleware.ts | 8 +- src/util/EnvoyJWT.ts | 2 +- 23 files changed, 449 insertions(+), 243 deletions(-) delete mode 100644 docs/classes/envoysignatureverifier.md diff --git a/docs/README.md b/docs/README.md index 008bafc..daeaf45 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,6 @@ ### Helper Classes - [EnvoyJWT](classes/envoyjwt.md) -- [EnvoySignatureVerifier](classes/envoysignatureverifier.md) ### Request Object Classes @@ -130,7 +129,7 @@ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/payloads/EntryPayload.ts#L6) ___ @@ -182,7 +181,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/payloads/InvitePayload.ts#L6) ___ @@ -210,7 +209,7 @@ ___ #### Defined in -[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/middleware.ts#L15) +[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/middleware.ts#L15) ___ @@ -229,7 +228,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -256,7 +255,7 @@ Metadata that will be included in the request body for events. #### Defined in -[sdk/EnvoyMeta.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L67) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L66) ___ @@ -265,8 +264,7 @@ ___ Ƭ **EnvoyMetaAuth**: `Object` A short-lived `userAPI` token. -Will be used to construct the `userAPI` property -found in `req.envoy.userAPI`. +Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Type declaration @@ -280,7 +278,7 @@ found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L54) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L53) ___ @@ -301,7 +299,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L37) ___ @@ -319,7 +317,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L4) ___ @@ -351,7 +349,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L13) ___ @@ -378,7 +376,7 @@ like validation URLs or options URLs. #### Defined in -[sdk/EnvoyMeta.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyMeta.ts#L84) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L83) ___ @@ -393,7 +391,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L53) +[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L53) ___ @@ -402,7 +400,7 @@ ___ Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> Base type for event requests. -You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. +You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest). #### Type parameters @@ -412,7 +410,7 @@ You should use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L45) +[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L45) ___ @@ -425,7 +423,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L61) +[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L61) ___ @@ -434,8 +432,8 @@ ___ Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> You probably won't need to use this type directly. -For routes, use `EnvoyRouteRequest`, -and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. +For routes, use [EnvoyRouteRequest](README.md#envoyrouterequest), +and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest). #### Type parameters @@ -445,7 +443,7 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L70) ___ @@ -464,7 +462,7 @@ such as validation URLS or options URLs. #### Defined in -[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L37) +[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L37) ___ @@ -483,7 +481,7 @@ ___ #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyStorageItem.ts#L4) ## Helper Functions @@ -520,7 +518,7 @@ to catch Promise-based errors. #### Defined in -[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/asyncHandler.ts#L13) +[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/asyncHandler.ts#L13) ___ @@ -559,7 +557,7 @@ Catches errors and sets the proper status code. #### Defined in -[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/errorMiddleware.ts#L11) +[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/errorMiddleware.ts#L11) ___ @@ -567,8 +565,8 @@ ___ ▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) -Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. -Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. +Sets up an [EnvoyPluginSDK](classes/envoypluginsdk.md) object in the path `req.envoy`. +Modifies the `res` object to include Envoy's helpers, per [EnvoyResponse](interfaces/envoyresponse.md). Also verifies that the request is coming from Envoy, as well as managing the plugin access token lifecycle. @@ -585,4 +583,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/middleware.ts#L26) +[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/middleware.ts#L26) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index bc3f281..bebea58 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 99879fc..7369d5b 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L53) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -92,6 +92,8 @@ ___ ▸ **getPluginInstallConfig**(`installId`): `Promise`\> +Fetches the current `config` saved for this install during setup by the customer. + #### Parameters | Name | Type | @@ -104,7 +106,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L24) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -112,6 +114,10 @@ ___ ▸ **setPluginInstallConfig**(`installId`, `config`): `Promise` +Merges changes with the current `config` saved for this install during setup by the customer. + +To remove an item from the saved `config`, set the item's key to `null`. + #### Parameters | Name | Type | @@ -125,7 +131,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L29) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -146,7 +152,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -167,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -190,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:64](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginAPI.ts#L64) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 44c22dc..6c0a85d 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -23,7 +23,6 @@ as well as attach extra data to the event's subject - [attach](envoypluginjob.md#attach) - [complete](envoypluginjob.md#complete) -- [execute](envoypluginjob.md#execute) - [fail](envoypluginjob.md#fail) - [ignore](envoypluginjob.md#ignore) - [update](envoypluginjob.md#update) @@ -43,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -53,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -63,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -71,6 +70,8 @@ ___ ▸ **attach**(...`attachments`): `Promise` +Add attachments to this job. + #### Parameters | Name | Type | @@ -83,7 +84,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L45) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -91,6 +92,11 @@ ___ ▸ **complete**(`message`, ...`attachments`): `Promise` +Reports that the job is complete. + +Instead of calling this directly, you can return a 200 response from the job's event handler, +using {@link EnvoyRequest.send}. + #### Parameters | Name | Type | @@ -104,30 +110,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L49) - -___ - -### execute - -▸ **execute**(`status`, `message`, `reason`, `attachments?`): `Promise` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `status` | ``null`` \| `string` | `undefined` | -| `message` | ``null`` \| `string` | `undefined` | -| `reason` | ``null`` \| `string` | `undefined` | -| `attachments` | `EnvoyPluginJobAttachment`[] | [] | - -#### Returns - -`Promise` - -#### Defined in - -[sdk/EnvoyPluginJob.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L24) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -135,6 +118,11 @@ ___ ▸ **fail**(`message`, `reason`): `Promise` +Reports that the job is ignored. + +Instead of calling this directly, you can return a 400 response from the job's event handler, +using {@link EnvoyRequest.sendFailed}. + #### Parameters | Name | Type | @@ -148,7 +136,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L57) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -156,6 +144,11 @@ ___ ▸ **ignore**(`message`, `reason`): `Promise` +Reports that the job is ignored. + +Instead of calling this directly, you can return a 400 response from the job's event handler, +using {@link EnvoyRequest.sendIgnored}. + #### Parameters | Name | Type | @@ -169,7 +162,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L53) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -177,6 +170,10 @@ ___ ▸ **update**(`message`, ...`attachments`): `Promise` +Updates the job with a new message and attachments. + +Can be used to periodically update long-running jobs. + #### Parameters | Name | Type | @@ -190,4 +187,4 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginJob.ts#L61) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 548ed32..4fd1163 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -38,6 +38,10 @@ to allow for easy access to Envoy functions. • **new EnvoyPluginSDK**(`body`, `isVerified?`, `pluginAccessToken?`) +Don't create an instance of this class directly. + +Instead, use [middleware](../README.md#middleware) to automatically attach an instance to `req` on every request. + #### Type parameters | Name | Type | @@ -47,15 +51,15 @@ to allow for easy access to Envoy functions. #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `body` | `EnvoyRequestBody` | `undefined` | -| `isVerified` | `boolean` | false | -| `pluginAccessToken` | ``null`` \| `string` | null | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `body` | `EnvoyRequestBody` | `undefined` | Request body | +| `isVerified` | `boolean` | false | If the request has been verified via {@link EnvoySignatureVerifier} | +| `pluginAccessToken` | ``null`` \| `string` | null | An access token from [EnvoyPluginAPI.loginAsPlugin](envoypluginapi.md#loginasplugin) | #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -83,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:132](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L132) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -99,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:125](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L125) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -115,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L114) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -131,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:150](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L150) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -147,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L139) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -164,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:163](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L163) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -173,7 +177,7 @@ ___ • `get` **meta**(): `Meta` The metadata for the request. -Either an EnvoyEventMeta or EnvoyRouteMeta. +Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../README.md#envoyroutemeta). #### Returns @@ -181,7 +185,7 @@ Either an EnvoyEventMeta or EnvoyRouteMeta. #### Defined in -[sdk/EnvoyPluginSDK.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L53) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -190,7 +194,7 @@ ___ • `get` **payload**(): `Payload` The payload for the request. -For events, it's some Envoy resource, like an Entry or Invite. +For events, it's some Envoy event payload, like an [EntryPayload](../README.md#entrypayload) or [InvitePayload](../README.md#invitepayload). For setup step validation URLs, it's the form submitted values for a validation URL. #### Returns @@ -199,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L65) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -216,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L93) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -233,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginSDK.ts#L76) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index 7f23c1c..a31f6a6 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -68,6 +68,8 @@ ___ ▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +Gets a single [EnvoyStorageItem](../README.md#envoystorageitem) from storage. + Wrapper for single pipeline get. #### Parameters @@ -82,7 +84,7 @@ Wrapper for single pipeline get. #### Defined in -[sdk/EnvoyPluginStorage.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L33) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -98,7 +100,7 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -106,6 +108,8 @@ ___ ▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +Sets a single [EnvoyStorageItem](../README.md#envoystorageitem) from storage. + Wrapper for single pipeline set. #### Parameters @@ -121,7 +125,7 @@ Wrapper for single pipeline set. #### Defined in -[sdk/EnvoyPluginStorage.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L40) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L44) ___ @@ -129,6 +133,8 @@ ___ ▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +Sets a single unique string [EnvoyStorageItem](../README.md#envoystorageitem) from storage. + Wrapper for single pipeline setUnique. #### Parameters @@ -144,7 +150,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L47) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L53) ___ @@ -152,6 +158,8 @@ ___ ▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +Sets a single unique number [EnvoyStorageItem](../README.md#envoystorageitem) from storage. + Wrapper for single pipeline setUnique. #### Parameters @@ -167,7 +175,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L54) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L62) ___ @@ -175,8 +183,9 @@ ___ ▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +Unsets an [EnvoyStorageItem](../README.md#envoystorageitem) from storage. Returns null if the item did not previously exist. + Wrapper for single pipeline unset. -Returns null if the item did not previously exist. #### Parameters @@ -190,4 +199,4 @@ Returns null if the item did not previously exist. #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoysignatureverifier.md b/docs/classes/envoysignatureverifier.md deleted file mode 100644 index 5028f74..0000000 --- a/docs/classes/envoysignatureverifier.md +++ /dev/null @@ -1,54 +0,0 @@ -[@envoy/envoy-integrations-sdk](../README.md) / EnvoySignatureVerifier - -# Class: EnvoySignatureVerifier - -Verifies that a request is coming from Envoy. - -## Table of contents - -### Constructors - -- [constructor](envoysignatureverifier.md#constructor) - -### Methods - -- [verify](envoysignatureverifier.md#verify) - -## Constructors - -### constructor - -• **new EnvoySignatureVerifier**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [EnvoySignatureVerifierOptions](../README.md#envoysignatureverifieroptions) | - -#### Defined in - -[util/EnvoySignatureVerifier.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoySignatureVerifier.ts#L28) - -## Methods - -### verify - -▸ **verify**(`req`, `rawBody`): `boolean` - -Verifies that the signature provided matches the request body. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | `Request`\> | -| `rawBody` | `Buffer` | - -#### Returns - -`boolean` - -#### Defined in - -[util/EnvoySignatureVerifier.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/EnvoySignatureVerifier.ts#L41) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 1849718..ca06e78 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -42,6 +42,7 @@ To access Envoy resources, this is the API you'd want. - [partialUpdateInvite](envoyuserapi.md#partialupdateinvite) - [removeInvite](envoyuserapi.md#removeinvite) - [updateInvite](envoyuserapi.md#updateinvite) +- [getAuthorizeURL](envoyuserapi.md#getauthorizeurl) - [loginAsPluginInstaller](envoyuserapi.md#loginasplugininstaller) - [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) - [loginAsUserWithPassword](envoyuserapi.md#loginasuserwithpassword) @@ -64,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L59) ## Properties @@ -80,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L32) ## Methods @@ -88,6 +89,9 @@ EnvoyAPI.axios ▸ **createInvite**(`invite`): `Promise` +Requires `invites.write` scope. +May also require `invites.attest` scope if setting `attested: true`. + #### Parameters | Name | Type | @@ -100,7 +104,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L188) ___ @@ -108,6 +112,8 @@ ___ ▸ **getAgreement**(`id`, `include?`): `Promise` +Requires `agreements.read` scope. + #### Parameters | Name | Type | @@ -121,7 +127,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L31) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L65) ___ @@ -129,6 +135,8 @@ ___ ▸ **getAgreementPage**(`id`, `include?`): `Promise` +{@link AgreementPageModel} + #### Parameters | Name | Type | @@ -142,7 +150,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L27) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L58) ___ @@ -150,6 +158,8 @@ ___ ▸ **getCompany**(`id`, `include?`): `Promise` +Requires `companies.read` scope. + #### Parameters | Name | Type | @@ -163,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L35) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L72) ___ @@ -171,6 +181,8 @@ ___ ▸ **getEmployee**(`id`, `include?`): `Promise` +Requires `employees.read` scope. + #### Parameters | Name | Type | @@ -184,7 +196,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L39) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L79) ___ @@ -192,6 +204,8 @@ ___ ▸ **getEmployeeByEmail**(`email`, `include?`): `Promise` +Requires `employees.read` scope. + #### Parameters | Name | Type | @@ -205,7 +219,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L59) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -213,6 +227,8 @@ ___ ▸ **getEmployees**(`params?`): `Promise` +Requires `employees.read` scope. + #### Parameters | Name | Type | @@ -225,7 +241,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L78) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L136) ___ @@ -233,6 +249,8 @@ ___ ▸ **getFlow**(`id`, `include?`): `Promise` +Requires `flows.read` scope. + #### Parameters | Name | Type | @@ -246,7 +264,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L43) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L86) ___ @@ -254,6 +272,8 @@ ___ ▸ **getFlows**(`params?`): `Promise` +Requires `flows.read` scope. + #### Parameters | Name | Type | @@ -266,7 +286,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:85](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L85) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L146) ___ @@ -274,6 +294,8 @@ ___ ▸ **getInvites**(`params?`): `Promise` +Requires `invites.read` scope. + #### Parameters | Name | Type | @@ -286,7 +308,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:102](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L102) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L172) ___ @@ -294,6 +316,8 @@ ___ ▸ **getLocation**(`id`, `include?`): `Promise` +Requires `locations.read` scope. + #### Parameters | Name | Type | @@ -307,7 +331,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L47) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L93) ___ @@ -315,6 +339,8 @@ ___ ▸ **getLocations**(`params?`): `Promise` +Requires `locations.read` scope. + #### Parameters | Name | Type | @@ -327,7 +353,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L90) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L154) ___ @@ -335,6 +361,8 @@ ___ ▸ **getSignInField**(`id`, `include?`): `Promise` +Requires `sign-in-fields.read` scope. + #### Parameters | Name | Type | @@ -348,7 +376,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L55) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L107) ___ @@ -356,6 +384,8 @@ ___ ▸ **getSignInFieldPage**(`id`, `include?`): `Promise` +Requires `sign-in-field-pages.read` scope. + #### Parameters | Name | Type | @@ -369,7 +399,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L51) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L100) ___ @@ -377,6 +407,8 @@ ___ ▸ **getSignInFields**(`signInFieldPageId`): `Promise` +Requires `sign-in-fields.read` scope. + #### Parameters | Name | Type | @@ -389,7 +421,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:97](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L97) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L164) ___ @@ -403,7 +435,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:109](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L109) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L179) ___ @@ -411,6 +443,8 @@ ___ ▸ **partialUpdateInvite**(`inviteId`, `invite`): `Promise` +Requires `invites.write` scope. + #### Parameters | Name | Type | @@ -424,7 +458,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L133) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -432,6 +466,8 @@ ___ ▸ **removeInvite**(`inviteId`): `Promise` +Requires `invites.write` scope. + #### Parameters | Name | Type | @@ -444,7 +480,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:143](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L143) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L226) ___ @@ -452,6 +488,8 @@ ___ ▸ **updateInvite**(`inviteId`, `invite`): `Promise` +Requires `invites.write` scope. + #### Parameters | Name | Type | @@ -465,13 +503,41 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L123) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L200) + +___ + +### getAuthorizeURL + +▸ `Static` **getAuthorizeURL**(`redirectURL`, `scope`, `clientId?`): `string` + +Builds the authorize URL to redirect a user to initiate the auth code oauth2 flow. + +Upon completion, they will be redirected to `redirectURL`, with a `code` query param in the url. + +Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exchange that code for an access token. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `redirectURL` | `string` | +| `scope` | `string`[] | +| `clientId` | `string` | + +#### Returns + +`string` + +#### Defined in + +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L240) ___ ### loginAsPluginInstaller -▸ `Static` **loginAsPluginInstaller**(`installId`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsPluginInstaller**(`installId`, `clientId?`, `clientSecret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `plugin_install` as the grant type. @@ -480,8 +546,8 @@ Gets a user access token using `plugin_install` as the grant type. | Name | Type | | :------ | :------ | | `installId` | `string` | -| `id` | `string` | -| `secret` | `string` | +| `clientId` | `string` | +| `clientSecret` | `string` | #### Returns @@ -489,24 +555,24 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:207](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L207) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L306) ___ ### loginAsUserWithCode -▸ `Static` **loginAsUserWithCode**(`code`, `scope?`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsUserWithCode**(`code`, `scope`, `clientId?`, `clientSecret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> Gets a user access token using `code` as the grant type. #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `code` | `string` | `undefined` | -| `scope` | `string`[] | [] | -| `id` | `string` | `undefined` | -| `secret` | `string` | `undefined` | +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `scope` | `string`[] | +| `clientId` | `string` | +| `clientSecret` | `string` | #### Returns @@ -514,25 +580,25 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:181](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L181) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L280) ___ ### loginAsUserWithPassword -▸ `Static` **loginAsUserWithPassword**(`username`, `password`, `scope?`, `id?`, `secret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> +▸ `Static` **loginAsUserWithPassword**(`username`, `password`, `scope`, `clientId?`, `clientSecret?`): `Promise`<[EnvoyMetaAuth](../README.md#envoymetaauth)\> -Gets a user access token using `password` as the grant type (discouraged). +Gets a user access token using `password` as the grant type (discouraged - use [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) below). #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `username` | `string` | `undefined` | -| `password` | `string` | `undefined` | -| `scope` | `string`[] | [] | -| `id` | `string` | `undefined` | -| `secret` | `string` | `undefined` | +| Name | Type | +| :------ | :------ | +| `username` | `string` | +| `password` | `string` | +| `scope` | `string`[] | +| `clientId` | `string` | +| `clientSecret` | `string` | #### Returns @@ -540,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged). #### Defined in -[sdk/EnvoyUserAPI.ts:153](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyUserAPI.ts#L153) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 082a296..c74e25e 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -4,8 +4,8 @@ Base type for Envoy requests. You probably won't need to use this type directly. -For routes, use `EnvoyRouteRequest`, -and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. +For routes, use [EnvoyRouteRequest](../README.md#envoyrouterequest), +and for events, use [EnvoyEntryEventRequest](../README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](../README.md#envoyinviteeventrequest). ## Type parameters @@ -35,11 +35,11 @@ and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. #### Inherited from -VerifiedRequest.\_\_@VERIFIED@1237 +VerifiedRequest.\_\_@VERIFIED@1256 #### Defined in -[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L16) +[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L16) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyRequest.ts#L28) +[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L28) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 8cea0c8..2283607 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L9) +[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L9) ___ @@ -53,6 +53,8 @@ ___ • **sendFailed**: (`message`: `string`, `debugInfo?`: `unknown`, ...`attachments`: `EnvoyPluginJobAttachment`[]) => `void` +Marks the job as "failed". The message will be communicated to the Envoy Dashboard user. + #### Type declaration ▸ (`message`, `debugInfo?`, ...`attachments`): `void` @@ -71,7 +73,7 @@ ___ #### Defined in -[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L12) +[sdk/EnvoyResponse.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L24) ___ @@ -79,6 +81,8 @@ ___ • **sendIgnored**: (`message`: `string`, `debugInfo?`: `unknown`, ...`attachments`: `EnvoyPluginJobAttachment`[]) => `void` +Marks the job as "ignored". Useful when you explicitly do not want to handle the event. + #### Type declaration ▸ (`message`, `debugInfo?`, ...`attachments`): `void` @@ -97,7 +101,7 @@ ___ #### Defined in -[sdk/EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L11) +[sdk/EnvoyResponse.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L19) ___ @@ -105,6 +109,10 @@ ___ • **sendOngoing**: (`debugInfo?`: `unknown`) => `void` +Marks the job as "ongoing". This is useful for long-running event handling. +Later on, you should update the job using +[EnvoyPluginJob.complete](../classes/envoypluginjob.md#complete), [EnvoyPluginJob.fail](../classes/envoypluginjob.md#fail), or [EnvoyPluginJob.ignore](../classes/envoypluginjob.md#ignore). + #### Type declaration ▸ (`debugInfo?`): `void` @@ -121,4 +129,4 @@ ___ #### Defined in -[sdk/EnvoyResponse.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/sdk/EnvoyResponse.ts#L10) +[sdk/EnvoyResponse.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L15) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index d79bc0f..50d718e 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/11f594b/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/json-api/JSONAPIData.ts#L3) diff --git a/src/index.ts b/src/index.ts index c4f2ac1..31acd99 100644 --- a/src/index.ts +++ b/src/index.ts @@ -14,11 +14,24 @@ import EnvoyPluginAPI from './sdk/EnvoyPluginAPI'; import middleware, { EnvoyMiddleware } from './sdk/middleware'; import EnvoyJWT from './util/EnvoyJWT'; -import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from './util/EnvoySignatureVerifier'; import JSONAPIData from './util/json-api/JSONAPIData'; +// export * from './resources/AgreementPageResource'; +// export * from './resources/AgreementResource'; +// export * from './resources/CompanyResource'; +// export * from './resources/EmployeeResource'; +// export * from './resources/FlowResource'; +// export * from './resources/InviteResource'; +// export * from './resources/LocationResource'; +// export * from './resources/SignInFieldPageResource'; +// export * from './resources/SignInFieldResource'; +// export * from './resources/UserResource'; + export * from './sdk/EnvoyMeta'; export * from './sdk/EnvoyRequest'; + +export * from './util/EnvoySignatureVerifier'; + export { asyncHandler, errorMiddleware, @@ -31,8 +44,6 @@ export { EnvoyPluginStorage, EnvoyRequest, EnvoyResponse, - EnvoySignatureVerifier, - EnvoySignatureVerifierOptions, EnvoyStorageItem, EnvoyPluginAPI, EnvoyUserAPI, diff --git a/src/resources/AgreementPageResource.ts b/src/resources/AgreementPageResource.ts index 17cf608..199553b 100644 --- a/src/resources/AgreementPageResource.ts +++ b/src/resources/AgreementPageResource.ts @@ -3,7 +3,7 @@ import JSONAPIModel from '../util/json-api/JSONAPIModel'; /** * @category API Resource */ -export type SignInFieldPageAttributes = { +export type AgreementPageAttributes = { enabled?: boolean; position?: number; }; @@ -16,4 +16,4 @@ export type AgreementPageRelationships = 'flow' | 'agreements'; /** * @category API Resource */ -export type AgreementPageModel = JSONAPIModel; +export type AgreementPageModel = JSONAPIModel; diff --git a/src/sdk/EnvoyMeta.ts b/src/sdk/EnvoyMeta.ts index dcc5826..e8b8030 100644 --- a/src/sdk/EnvoyMeta.ts +++ b/src/sdk/EnvoyMeta.ts @@ -46,8 +46,7 @@ export type EnvoyMetaCompany = { /** * A short-lived `userAPI` token. - * Will be used to construct the `userAPI` property - * found in `req.envoy.userAPI`. + * Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. * * @category Meta */ diff --git a/src/sdk/EnvoyPluginAPI.ts b/src/sdk/EnvoyPluginAPI.ts index 692a453..c2ff81d 100644 --- a/src/sdk/EnvoyPluginAPI.ts +++ b/src/sdk/EnvoyPluginAPI.ts @@ -21,11 +21,19 @@ export default class EnvoyPluginAPI extends EnvoyAPI { }); } + /** + * Fetches the current `config` saved for this install during setup by the customer. + */ async getPluginInstallConfig(installId: string): Promise> { const { data } = await this.axios.get(`/api/v2/plugin-services/installs/${installId}/config`); return data.data; } + /** + * Merges changes with the current `config` saved for this install during setup by the customer. + * + * To remove an item from the saved `config`, set the item's key to `null`. + */ async setPluginInstallConfig(installId: string, config: Record): Promise { await this.axios({ method: 'PUT', diff --git a/src/sdk/EnvoyPluginJob.ts b/src/sdk/EnvoyPluginJob.ts index 7d13b93..eff721d 100644 --- a/src/sdk/EnvoyPluginJob.ts +++ b/src/sdk/EnvoyPluginJob.ts @@ -21,7 +21,7 @@ export default class EnvoyPluginJob { this.id = jobId; } - execute( + private execute( status: string | null, message: string | null, reason: string | null, @@ -42,22 +42,48 @@ export default class EnvoyPluginJob { return this.api.updateJob(this.id, updates); } + /** + * Add attachments to this job. + */ attach(...attachments: Array): Promise { return this.execute(null, null, null, attachments); } + /** + * Reports that the job is complete. + * + * Instead of calling this directly, you can return a 200 response from the job's event handler, + * using {@link EnvoyRequest.send}. + */ complete(message: string, ...attachments: Array): Promise { return this.execute('done', message, null, attachments); } + /** + * Reports that the job is ignored. + * + * Instead of calling this directly, you can return a 400 response from the job's event handler, + * using {@link EnvoyRequest.sendIgnored}. + */ ignore(message: string, reason: string): Promise { return this.execute('ignored', message, reason); } + /** + * Reports that the job is ignored. + * + * Instead of calling this directly, you can return a 400 response from the job's event handler, + * using {@link EnvoyRequest.sendFailed}. + */ fail(message: string, reason: string): Promise { return this.execute('failed', message, reason); } + /** + * Updates the job with a new message and attachments. + * + * Can be used to periodically update long-running jobs. + */ update(message: string, ...attachments: Array): Promise { return this.execute(null, message, null, attachments); } diff --git a/src/sdk/EnvoyPluginSDK.ts b/src/sdk/EnvoyPluginSDK.ts index 12bebb9..43fdb30 100644 --- a/src/sdk/EnvoyPluginSDK.ts +++ b/src/sdk/EnvoyPluginSDK.ts @@ -40,6 +40,14 @@ export default class EnvoyPluginSDK, isVerified = false, pluginAccessToken: string | null = null) { this.body = body; this.isVerified = isVerified; @@ -48,7 +56,7 @@ export default class EnvoyPluginSDK EnvoyPluginStorage { return (installId?) => new EnvoyPluginStorage(this.pluginAPI, installId); diff --git a/src/sdk/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts index 43ade0c..6723b3b 100644 --- a/src/sdk/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -28,6 +28,8 @@ export default class EnvoyPluginStorage { } /** + * Gets a single {@link EnvoyStorageItem} from storage. + * * Wrapper for single pipeline get. */ get(key: string): Promise { @@ -35,6 +37,8 @@ export default class EnvoyPluginStorage { } /** + * Sets a single {@link EnvoyStorageItem} from storage. + * * Wrapper for single pipeline set. */ set(key: string, value: unknown): Promise { @@ -42,6 +46,8 @@ export default class EnvoyPluginStorage { } /** + * Sets a single unique string {@link EnvoyStorageItem} from storage. + * * Wrapper for single pipeline setUnique. */ setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): Promise { @@ -49,6 +55,8 @@ export default class EnvoyPluginStorage { } /** + * Sets a single unique number {@link EnvoyStorageItem} from storage. + * * Wrapper for single pipeline setUnique. */ setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): Promise { @@ -56,8 +64,9 @@ export default class EnvoyPluginStorage { } /** + * Unsets an {@link EnvoyStorageItem} from storage. Returns null if the item did not previously exist. + * * Wrapper for single pipeline unset. - * Returns null if the item did not previously exist. */ unset(key: string): Promise { return this.pipeline().unset(key).executeSingle(); diff --git a/src/sdk/EnvoyRequest.ts b/src/sdk/EnvoyRequest.ts index 38eb936..6467efe 100644 --- a/src/sdk/EnvoyRequest.ts +++ b/src/sdk/EnvoyRequest.ts @@ -19,8 +19,8 @@ export interface VerifiedRequest extends Request { /** * Base type for Envoy requests. * You probably won't need to use this type directly. - * For routes, use `EnvoyRouteRequest`, - * and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + * For routes, use {@link EnvoyRouteRequest}, + * and for events, use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}. * * @category Request */ @@ -38,7 +38,7 @@ export type EnvoyRouteRequest = EnvoyBaseRequest; /** * You probably won't need to use this type directly. - * For routes, use `EnvoyRouteRequest`, - * and for events, use `EnvoyEntryEventRequest` or `EnvoyInviteEventRequest`. + * For routes, use {@link EnvoyRouteRequest}, + * and for events, use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}. * * @category Request */ diff --git a/src/sdk/EnvoyResponse.ts b/src/sdk/EnvoyResponse.ts index 67db258..81eb872 100644 --- a/src/sdk/EnvoyResponse.ts +++ b/src/sdk/EnvoyResponse.ts @@ -7,7 +7,19 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; */ export default interface EnvoyResponse extends Response { send: (debugInfo?: unknown) => this; + /** + * Marks the job as "ongoing". This is useful for long-running event handling. + * Later on, you should update the job using + * {@link EnvoyPluginJob.complete}, {@link EnvoyPluginJob.fail}, or {@link EnvoyPluginJob.ignore}. + */ sendOngoing: (debugInfo?: unknown) => void; + /** + * Marks the job as "ignored". Useful when you explicitly do not want to handle the event. + */ sendIgnored: (message: string, debugInfo?: unknown, ...attachments: Array) => void; + + /** + * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user. + */ sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array) => void; } diff --git a/src/sdk/EnvoyUserAPI.ts b/src/sdk/EnvoyUserAPI.ts index fda57ab..2fb770f 100644 --- a/src/sdk/EnvoyUserAPI.ts +++ b/src/sdk/EnvoyUserAPI.ts @@ -1,3 +1,4 @@ +import { Url } from 'url'; import axios from 'axios'; import EnvoyAPI from '../base/EnvoyAPI'; import { AgreementPageModel } from '../resources/AgreementPageResource'; @@ -16,6 +17,32 @@ import { UserModel } from '../resources/UserResource'; import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; +type EnvoyUserAPIScope = + 'flows.read' | + 'entries.read' | + 'entries.write' | + 'invites.read' | + 'invites.write' | + 'invites.attest' | + 'locations.read' | + 'companies.read' | + 'agreements.read' | + 'agreements.write' | + 'sign-in-field-pages.read' | + 'sign-in-fields.read' | + 'sign-in-fields.write' | + 'employees.read' | + 'employees.write' | + 'badges.read' | + 'blacklist-filters.read' | + 'blacklist-filters.write' | + 'tickets.read' | + 'tickets.write' | + 'spaces.read' | + 'reservations.read' | + 'reservations.write' | + string; + /** * API endpoints for *user-scoped* tokens. * To access Envoy resources, this is the API you'd want. @@ -24,38 +51,66 @@ import { EnvoyMetaAuth } from './EnvoyMeta'; * @category Request Object */ export default class EnvoyUserAPI extends EnvoyAPI { + /** + * + * {@link AgreementPageModel} + */ async getAgreementPage(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'agreement-pages', id, include }); } + /** + * Requires `agreements.read` scope. + */ async getAgreement(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'agreements', id, include }); } + /** + * Requires `companies.read` scope. + */ async getCompany(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'companies', id, include }); } + /** + * Requires `employees.read` scope. + */ async getEmployee(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'employees', id, include }); } + /** + * Requires `flows.read` scope. + */ async getFlow(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'flows', id, include }); } + /** + * Requires `locations.read` scope. + */ async getLocation(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'locations', id, include }); } + /** + * Requires `sign-in-field-pages.read` scope. + */ async getSignInFieldPage(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'sign-in-field-pages', id, include }); } + /** + * Requires `sign-in-fields.read` scope. + */ async getSignInField(id: string, include?: string): Promise { return this.dataLoader.load({ type: 'sign-in-fields', id, include }); } + /** + * Requires `employees.read` scope. + */ async getEmployeeByEmail(email: string, include?: string): Promise { const paginationParams: JSONAPIPaginationParams = { filter: { @@ -75,6 +130,9 @@ export default class EnvoyUserAPI extends EnvoyAPI { return employee; } + /** + * Requires `employees.read` scope. + */ async getEmployees( params?: JSONAPIPaginationParams, ): Promise> { @@ -82,11 +140,17 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + /** + * Requires `flows.read` scope. + */ async getFlows(params?: JSONAPIPaginationParams): Promise> { const { data } = await this.axios.get('/api/v3/flows', { params }); return data.data; } + /** + * Requires `locations.read` scope. + */ async getLocations( params?: JSONAPIPaginationParams, ): Promise> { @@ -94,11 +158,17 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + /** + * Requires `sign-in-fields.read` scope. + */ async getSignInFields(signInFieldPageId: string): Promise> { const { data } = await this.axios.get(`/api/v3/sign-in-field-pages/${signInFieldPageId}/sign-in-fields`); return data.data; } + /** + * Requires `invites.read` scope. + */ async getInvites( params?: JSONAPIPaginationParams, ): Promise> { @@ -111,6 +181,10 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + /** + * Requires `invites.write` scope. + * May also require `invites.attest` scope if setting `attested: true`. + */ async createInvite(invite: InviteCreationModel): Promise { const { data } = await this.axios({ method: 'POST', @@ -120,6 +194,9 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + /** + * Requires `invites.write` scope. + */ async updateInvite(inviteId: string, invite: InviteCreationModel): Promise { const { data } = await this.axios({ method: 'PUT', @@ -130,6 +207,9 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + /** + * Requires `invites.write` scope. + */ async partialUpdateInvite(inviteId: string, invite: InviteCreationModel): Promise { const { data } = await this.axios({ method: 'PATCH', @@ -140,6 +220,9 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + /** + * Requires `invites.write` scope. + */ async removeInvite(inviteId: string): Promise { await this.axios({ method: 'DELETE', @@ -148,19 +231,35 @@ export default class EnvoyUserAPI extends EnvoyAPI { } /** - * Gets a user access token using `password` as the grant type (discouraged). + * Builds the authorize URL to redirect a user to initiate the auth code oauth2 flow. + * + * Upon completion, they will be redirected to `redirectURL`, with a `code` query param in the url. + * + * Use the {@link loginAsUserWithCode} method to exchange that code for an access token. + */ + static getAuthorizeURL(redirectURL: string, scope: Array, clientId = envoyClientId): string { + const url = new URL(envoyBaseURL); + url.pathname = '/a/auth/v0/authorize'; + url.searchParams.append('response_type', 'code'); + url.searchParams.append('client_id', clientId); + url.searchParams.append('redirect_uri', redirectURL); + return `${url.href}&scope=${scope.join('+')}`; + } + + /** + * Gets a user access token using `password` as the grant type (discouraged - use {@link loginAsUserWithCode} below). */ static async loginAsUserWithPassword( username: string, password: string, - scope: Array = [], - id = envoyClientId, - secret = envoyClientSecret, + scope: Array, + clientId = envoyClientId, + clientSecret = envoyClientSecret, ): Promise { const { data } = await axios({ auth: { - username: id, - password: secret, + username: clientId, + password: clientSecret, }, method: 'POST', data: { @@ -180,14 +279,14 @@ export default class EnvoyUserAPI extends EnvoyAPI { */ static async loginAsUserWithCode( code: string, - scope: Array = [], - id = envoyClientId, - secret = envoyClientSecret, + scope: Array, + clientId = envoyClientId, + clientSecret = envoyClientSecret, ): Promise { const { data } = await axios({ auth: { - username: id, - password: secret, + username: clientId, + password: clientSecret, }, method: 'POST', data: { @@ -206,13 +305,13 @@ export default class EnvoyUserAPI extends EnvoyAPI { */ static async loginAsPluginInstaller( installId: string, - id = envoyClientId, - secret = envoyClientSecret, + clientId = envoyClientId, + clientSecret = envoyClientSecret, ): Promise { const { data } = await axios({ auth: { - username: id, - password: secret, + username: clientId, + password: clientSecret, }, method: 'POST', data: { diff --git a/src/sdk/middleware.ts b/src/sdk/middleware.ts index 76f7287..6e43cac 100644 --- a/src/sdk/middleware.ts +++ b/src/sdk/middleware.ts @@ -15,8 +15,8 @@ import EnvoyPluginAPI from './EnvoyPluginAPI'; export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => void; /** - * Sets up an `EnvoyPluginSDK` object in the path `req.envoy`. - * Modifies the `res` object to include Envoy's helpers, per `EnvoyResponse`. + * Sets up an {@link EnvoyPluginSDK} object in the path `req.envoy`. + * Modifies the `res` object to include Envoy's helpers, per {@link EnvoyResponse}. * * Also verifies that the request is coming from Envoy, * as well as managing the plugin access token lifecycle. @@ -50,10 +50,10 @@ export default function middleware(options?: EnvoySignatureVerifierOptions): Env /** * Respond with "ongoing" for long jobs. */ - res.sendOngoing = (debugInfo: unknown = {}) => { + res.sendOngoing = (message = '', debugInfo: unknown = {}) => { res.statusCode = HttpStatus.ONGOING; res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ debugInfo })); + res.end(JSON.stringify({ message, debugInfo })); }; /** diff --git a/src/util/EnvoyJWT.ts b/src/util/EnvoyJWT.ts index 34ad7d1..22eee55 100644 --- a/src/util/EnvoyJWT.ts +++ b/src/util/EnvoyJWT.ts @@ -16,7 +16,7 @@ export default class EnvoyJWT { constructor(secret = jwtSecret, algorithm: EnvoyJWTAlgorithm = 'HS256') { if (!secret) { - throw new Error('JWT secret missing.'); + throw new Error('JWT secret missing. Have you set the `JWT_SECRET` environment variable?'); } this.secret = secret; this.algorithm = algorithm; From 4506a1fd33d66915ae29fe5d267af0bc9c8000f3 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 12 Jun 2021 12:41:47 -0400 Subject: [PATCH 28/91] adding links --- docs/README.md | 38 +++++++++++----------- docs/classes/envoyjwt.md | 6 ++-- docs/classes/envoypluginapi.md | 16 ++++----- docs/classes/envoypluginjob.md | 16 ++++----- docs/classes/envoypluginsdk.md | 24 +++++++------- docs/classes/envoypluginstorage.md | 18 +++++------ docs/classes/envoyuserapi.md | 50 ++++++++++++++--------------- docs/interfaces/envoybaserequest.md | 4 +-- docs/interfaces/envoyresponse.md | 8 ++--- docs/interfaces/jsonapidata.md | 4 +-- src/sdk/EnvoyPluginSDK.ts | 2 +- 11 files changed, 93 insertions(+), 93 deletions(-) diff --git a/docs/README.md b/docs/README.md index daeaf45..3580fd2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -129,7 +129,7 @@ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/payloads/EntryPayload.ts#L6) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/payloads/InvitePayload.ts#L6) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/middleware.ts#L15) +[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/middleware.ts#L15) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -255,7 +255,7 @@ Metadata that will be included in the request body for events. #### Defined in -[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L66) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L66) ___ @@ -278,7 +278,7 @@ Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L53) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L53) ___ @@ -299,7 +299,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L37) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L4) ___ @@ -349,7 +349,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L13) ___ @@ -376,7 +376,7 @@ like validation URLs or options URLs. #### Defined in -[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyMeta.ts#L83) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L83) ___ @@ -391,7 +391,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L53) +[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L53) ___ @@ -410,7 +410,7 @@ You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [En #### Defined in -[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L45) +[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L45) ___ @@ -423,7 +423,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L61) +[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L61) ___ @@ -443,7 +443,7 @@ and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) o #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L70) ___ @@ -462,7 +462,7 @@ such as validation URLS or options URLs. #### Defined in -[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L37) +[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L37) ___ @@ -481,7 +481,7 @@ ___ #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyStorageItem.ts#L4) ## Helper Functions @@ -518,7 +518,7 @@ to catch Promise-based errors. #### Defined in -[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/asyncHandler.ts#L13) +[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/asyncHandler.ts#L13) ___ @@ -557,7 +557,7 @@ Catches errors and sets the proper status code. #### Defined in -[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/errorMiddleware.ts#L11) +[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/errorMiddleware.ts#L11) ___ @@ -583,4 +583,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/middleware.ts#L26) +[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/middleware.ts#L26) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index bebea58..40fd529 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 7369d5b..a8ca022 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L61) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -106,7 +106,7 @@ Fetches the current `config` saved for this install during setup by the customer #### Defined in -[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L27) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -131,7 +131,7 @@ To remove an item from the saved `config`, set the item's key to `null`. #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L45) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -196,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginAPI.ts#L72) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 6c0a85d..2c1d417 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -42,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -52,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -84,7 +84,7 @@ Add attachments to this job. #### Defined in -[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L48) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -110,7 +110,7 @@ using {@link EnvoyRequest.send}. #### Defined in -[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L58) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -136,7 +136,7 @@ using {@link EnvoyRequest.sendFailed}. #### Defined in -[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L78) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -162,7 +162,7 @@ using {@link EnvoyRequest.sendIgnored}. #### Defined in -[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L68) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -187,4 +187,4 @@ Can be used to periodically update long-running jobs. #### Defined in -[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginJob.ts#L87) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 4fd1163..d6cee25 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -3,7 +3,7 @@ # Class: EnvoyPluginSDK Sets up all relevant Envoy functions. -Attaches itself to every request object using our `middleware`, +Attaches itself to every request object using our [middleware](../README.md#middleware), to allow for easy access to Envoy functions. ## Type parameters @@ -59,7 +59,7 @@ Instead, use [middleware](../README.md#middleware) to automatically attach an in #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -87,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L140) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -103,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L133) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -119,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L122) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -135,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L158) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -151,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L147) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -168,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L171) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -185,7 +185,7 @@ Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../ #### Defined in -[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L61) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -203,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L73) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -220,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L101) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -237,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginSDK.ts#L84) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index a31f6a6..c0eb589 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -84,7 +84,7 @@ Wrapper for single pipeline get. #### Defined in -[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L35) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -100,7 +100,7 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -125,7 +125,7 @@ Wrapper for single pipeline set. #### Defined in -[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L44) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L44) ___ @@ -150,7 +150,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L53) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L53) ___ @@ -175,7 +175,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L62) ___ @@ -199,4 +199,4 @@ Wrapper for single pipeline unset. #### Defined in -[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyPluginStorage.ts#L71) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index ca06e78..4792c59 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -65,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L59) ## Properties @@ -81,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L32) ## Methods @@ -104,7 +104,7 @@ May also require `invites.attest` scope if setting `attested: true`. #### Defined in -[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L188) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L188) ___ @@ -127,7 +127,7 @@ Requires `agreements.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L65) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L65) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L58) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L58) ___ @@ -173,7 +173,7 @@ Requires `companies.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L72) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L72) ___ @@ -196,7 +196,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L79) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L79) ___ @@ -219,7 +219,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -241,7 +241,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L136) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L136) ___ @@ -264,7 +264,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L86) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L86) ___ @@ -286,7 +286,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L146) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L146) ___ @@ -308,7 +308,7 @@ Requires `invites.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L172) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L172) ___ @@ -331,7 +331,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L93) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L93) ___ @@ -353,7 +353,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L154) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L154) ___ @@ -376,7 +376,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L107) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L107) ___ @@ -399,7 +399,7 @@ Requires `sign-in-field-pages.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L100) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L100) ___ @@ -421,7 +421,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L164) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L164) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L179) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L179) ___ @@ -458,7 +458,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L213) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -480,7 +480,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L226) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L226) ___ @@ -503,7 +503,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L200) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L200) ___ @@ -531,7 +531,7 @@ Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exc #### Defined in -[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L240) +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L240) ___ @@ -555,7 +555,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L306) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L306) ___ @@ -580,7 +580,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L280) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L280) ___ @@ -606,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged - use [ #### Defined in -[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyUserAPI.ts#L252) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index c74e25e..6e9fc95 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -39,7 +39,7 @@ VerifiedRequest.\_\_@VERIFIED@1256 #### Defined in -[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L16) +[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L16) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyRequest.ts#L28) +[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L28) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 2283607..67a4365 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L9) +[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L9) ___ @@ -73,7 +73,7 @@ Marks the job as "failed". The message will be communicated to the Envoy Dashboa #### Defined in -[sdk/EnvoyResponse.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L24) +[sdk/EnvoyResponse.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L24) ___ @@ -101,7 +101,7 @@ Marks the job as "ignored". Useful when you explicitly do not want to handle the #### Defined in -[sdk/EnvoyResponse.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L19) +[sdk/EnvoyResponse.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L19) ___ @@ -129,4 +129,4 @@ Later on, you should update the job using #### Defined in -[sdk/EnvoyResponse.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/sdk/EnvoyResponse.ts#L15) +[sdk/EnvoyResponse.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L15) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index 50d718e..a428b93 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/7f53677/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/json-api/JSONAPIData.ts#L3) diff --git a/src/sdk/EnvoyPluginSDK.ts b/src/sdk/EnvoyPluginSDK.ts index 43fdb30..1bad59a 100644 --- a/src/sdk/EnvoyPluginSDK.ts +++ b/src/sdk/EnvoyPluginSDK.ts @@ -16,7 +16,7 @@ export interface EnvoyRequestBody { /** * Sets up all relevant Envoy functions. - * Attaches itself to every request object using our `middleware`, + * Attaches itself to every request object using our {@link middleware}, * to allow for easy access to Envoy functions. * * @category SDK From b26deae87f285402dfad593a201b9641a603f0fe Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 12 Jun 2021 13:07:51 -0400 Subject: [PATCH 29/91] added API resources back --- .../EnvoyEntryEventRequestFactory.ts | 0 src/index.ts | 20 +++++++++---------- 2 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 src/factories/EnvoyEntryEventRequestFactory.ts diff --git a/src/factories/EnvoyEntryEventRequestFactory.ts b/src/factories/EnvoyEntryEventRequestFactory.ts new file mode 100644 index 0000000..e69de29 diff --git a/src/index.ts b/src/index.ts index 31acd99..a3c7434 100644 --- a/src/index.ts +++ b/src/index.ts @@ -16,16 +16,16 @@ import middleware, { EnvoyMiddleware } from './sdk/middleware'; import EnvoyJWT from './util/EnvoyJWT'; import JSONAPIData from './util/json-api/JSONAPIData'; -// export * from './resources/AgreementPageResource'; -// export * from './resources/AgreementResource'; -// export * from './resources/CompanyResource'; -// export * from './resources/EmployeeResource'; -// export * from './resources/FlowResource'; -// export * from './resources/InviteResource'; -// export * from './resources/LocationResource'; -// export * from './resources/SignInFieldPageResource'; -// export * from './resources/SignInFieldResource'; -// export * from './resources/UserResource'; +export * from './resources/AgreementPageResource'; +export * from './resources/AgreementResource'; +export * from './resources/CompanyResource'; +export * from './resources/EmployeeResource'; +export * from './resources/FlowResource'; +export * from './resources/InviteResource'; +export * from './resources/LocationResource'; +export * from './resources/SignInFieldPageResource'; +export * from './resources/SignInFieldResource'; +export * from './resources/UserResource'; export * from './sdk/EnvoyMeta'; export * from './sdk/EnvoyRequest'; From c0e2fd5b292f81d10ca763aa7182cd8a10306776 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 12 Jun 2021 13:08:34 -0400 Subject: [PATCH 30/91] added API resources back --- docs/README.md | 376 +++++++++++++++++- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 16 +- docs/classes/envoypluginsdk.md | 22 +- docs/classes/envoypluginstorage.md | 18 +- docs/classes/envoyuserapi.md | 138 +++---- docs/interfaces/agreementattributes.md | 107 +++++ docs/interfaces/companyattributes.md | 52 +++ docs/interfaces/employeeattributes.md | 107 +++++ docs/interfaces/employeefilterfields.md | 118 ++++++ docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/flowattributes.md | 63 +++ docs/interfaces/flowfilterfields.md | 30 ++ docs/interfaces/inviteattributes.md | 225 +++++++++++ docs/interfaces/invitecreationattributes.md | 107 +++++ docs/interfaces/invitefilterfields.md | 129 ++++++ docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/locationattributes.md | 415 ++++++++++++++++++++ docs/interfaces/locationfilterfields.md | 30 ++ docs/interfaces/signinfieldattributes.md | 118 ++++++ 22 files changed, 1974 insertions(+), 135 deletions(-) create mode 100644 docs/interfaces/agreementattributes.md create mode 100644 docs/interfaces/companyattributes.md create mode 100644 docs/interfaces/employeeattributes.md create mode 100644 docs/interfaces/employeefilterfields.md create mode 100644 docs/interfaces/flowattributes.md create mode 100644 docs/interfaces/flowfilterfields.md create mode 100644 docs/interfaces/inviteattributes.md create mode 100644 docs/interfaces/invitecreationattributes.md create mode 100644 docs/interfaces/invitefilterfields.md create mode 100644 docs/interfaces/locationattributes.md create mode 100644 docs/interfaces/locationfilterfields.md create mode 100644 docs/interfaces/signinfieldattributes.md diff --git a/docs/README.md b/docs/README.md index 3580fd2..0556a04 100644 --- a/docs/README.md +++ b/docs/README.md @@ -29,6 +29,21 @@ - [EnvoyPluginStorage](classes/envoypluginstorage.md) +### API Resource Interfaces + +- [AgreementAttributes](interfaces/agreementattributes.md) +- [CompanyAttributes](interfaces/companyattributes.md) +- [EmployeeAttributes](interfaces/employeeattributes.md) +- [EmployeeFilterFields](interfaces/employeefilterfields.md) +- [FlowAttributes](interfaces/flowattributes.md) +- [FlowFilterFields](interfaces/flowfilterfields.md) +- [InviteAttributes](interfaces/inviteattributes.md) +- [InviteCreationAttributes](interfaces/invitecreationattributes.md) +- [InviteFilterFields](interfaces/invitefilterfields.md) +- [LocationAttributes](interfaces/locationattributes.md) +- [LocationFilterFields](interfaces/locationfilterfields.md) +- [SignInFieldAttributes](interfaces/signinfieldattributes.md) + ### Other Interfaces - [JSONAPIData](interfaces/jsonapidata.md) @@ -41,6 +56,36 @@ - [EnvoyResponse](interfaces/envoyresponse.md) +### API Resource Type aliases + +- [AgreementModel](README.md#agreementmodel) +- [AgreementPageAttributes](README.md#agreementpageattributes) +- [AgreementPageModel](README.md#agreementpagemodel) +- [AgreementPageRelationships](README.md#agreementpagerelationships) +- [AgreementRelationships](README.md#agreementrelationships) +- [CompanyModel](README.md#companymodel) +- [CompanyRelationships](README.md#companyrelationships) +- [EmployeeModel](README.md#employeemodel) +- [EmployeeRelationships](README.md#employeerelationships) +- [EmployeeSortFields](README.md#employeesortfields) +- [FlowModel](README.md#flowmodel) +- [FlowRelationships](README.md#flowrelationships) +- [FlowSortFields](README.md#flowsortfields) +- [InviteCreationModel](README.md#invitecreationmodel) +- [InviteModel](README.md#invitemodel) +- [InviteRelationships](README.md#inviterelationships) +- [InviteSortFields](README.md#invitesortfields) +- [LocationModel](README.md#locationmodel) +- [LocationRelationships](README.md#locationrelationships) +- [LocationSortFields](README.md#locationsortfields) +- [SignInFieldModel](README.md#signinfieldmodel) +- [SignInFieldPageAttributes](README.md#signinfieldpageattributes) +- [SignInFieldPageModel](README.md#signinfieldpagemodel) +- [SignInFieldPageRelationships](README.md#signinfieldpagerelationships) +- [SignInFieldRelationships](README.md#signinfieldrelationships) +- [UserAttributes](README.md#userattributes) +- [UserModel](README.md#usermodel) + ### Event Type aliases - [EntryPayload](README.md#entrypayload) @@ -81,6 +126,299 @@ - [errorMiddleware](README.md#errormiddleware) - [middleware](README.md#middleware) +## API Resource Type aliases + +### AgreementModel + +Ƭ **AgreementModel**: `JSONAPIModel`<[AgreementAttributes](interfaces/agreementattributes.md), [AgreementRelationships](README.md#agreementrelationships)\> + +#### Defined in + +[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L26) + +___ + +### AgreementPageAttributes + +Ƭ **AgreementPageAttributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `enabled?` | `boolean` | +| `position?` | `number` | + +#### Defined in + +[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementPageResource.ts#L6) + +___ + +### AgreementPageModel + +Ƭ **AgreementPageModel**: `JSONAPIModel`<[AgreementPageAttributes](README.md#agreementpageattributes), [AgreementPageRelationships](README.md#agreementpagerelationships)\> + +#### Defined in + +[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementPageResource.ts#L19) + +___ + +### AgreementPageRelationships + +Ƭ **AgreementPageRelationships**: ``"flow"`` \| ``"agreements"`` + +#### Defined in + +[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementPageResource.ts#L14) + +___ + +### AgreementRelationships + +Ƭ **AgreementRelationships**: ``"agreement-page"`` + +#### Defined in + +[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L21) + +___ + +### CompanyModel + +Ƭ **CompanyModel**: `JSONAPIModel`<[CompanyAttributes](interfaces/companyattributes.md), [CompanyRelationships](README.md#companyrelationships)\> + +#### Defined in + +[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L21) + +___ + +### CompanyRelationships + +Ƭ **CompanyRelationships**: ``"locations"`` + +#### Defined in + +[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L16) + +___ + +### EmployeeModel + +Ƭ **EmployeeModel**: `JSONAPIModel`<[EmployeeAttributes](interfaces/employeeattributes.md), [EmployeeRelationships](README.md#employeerelationships)\> + +#### Defined in + +[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L47) + +___ + +### EmployeeRelationships + +Ƭ **EmployeeRelationships**: ``"locations"`` \| ``"company"`` + +#### Defined in + +[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L42) + +___ + +### EmployeeSortFields + +Ƭ **EmployeeSortFields**: ``"name"`` \| ``"created_at"`` \| ``"-name"`` \| ``"-created_at"`` + +#### Defined in + +[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L6) + +___ + +### FlowModel + +Ƭ **FlowModel**: `JSONAPIModel`<[FlowAttributes](interfaces/flowattributes.md), [FlowRelationships](README.md#flowrelationships)\> + +#### Defined in + +[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L35) + +___ + +### FlowRelationships + +Ƭ **FlowRelationships**: ``"location"`` \| ``"sign-in-field-page"`` \| ``"agreement-page"`` + +#### Defined in + +[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L30) + +___ + +### FlowSortFields + +Ƭ **FlowSortFields**: ``"name"`` \| ``"created_at"`` \| ``"-name"`` \| ``"-created_at"`` + +#### Defined in + +[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L6) + +___ + +### InviteCreationModel + +Ƭ **InviteCreationModel**: `JSONAPIModel`<[InviteCreationAttributes](interfaces/invitecreationattributes.md), [InviteRelationships](README.md#inviterelationships), ``"invites"``, undefined\> + +#### Defined in + +[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L92) + +___ + +### InviteModel + +Ƭ **InviteModel**: `JSONAPIModel`<[InviteAttributes](interfaces/inviteattributes.md), [InviteRelationships](README.md#inviterelationships), ``"invites"``\> + +#### Defined in + +[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L87) + +___ + +### InviteRelationships + +Ƭ **InviteRelationships**: ``"attendee"`` \| ``"creator"`` \| ``"employee"`` \| ``"entry"`` \| ``"flow"`` \| ``"location"`` + +#### Defined in + +[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L82) + +___ + +### InviteSortFields + +Ƭ **InviteSortFields**: ``"name"`` \| ``"created_at"`` \| ``"-name"`` \| ``"-created_at"`` + +#### Defined in + +[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L6) + +___ + +### LocationModel + +Ƭ **LocationModel**: `JSONAPIModel`<[LocationAttributes](interfaces/locationattributes.md), [LocationRelationships](README.md#locationrelationships)\> + +#### Defined in + +[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L67) + +___ + +### LocationRelationships + +Ƭ **LocationRelationships**: ``"company"`` \| ``"employees"`` \| ``"flows"`` \| ``"employee-screening-flow"`` + +#### Defined in + +[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L62) + +___ + +### LocationSortFields + +Ƭ **LocationSortFields**: ``"name"`` \| ``"created_at"`` \| ``"-name"`` \| ``"-created_at"`` + +#### Defined in + +[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L6) + +___ + +### SignInFieldModel + +Ƭ **SignInFieldModel**: `JSONAPIModel`<[SignInFieldAttributes](interfaces/signinfieldattributes.md), [SignInFieldRelationships](README.md#signinfieldrelationships)\> + +#### Defined in + +[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L31) + +___ + +### SignInFieldPageAttributes + +Ƭ **SignInFieldPageAttributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `enabled?` | `boolean` | +| `position?` | `number` | + +#### Defined in + +[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldPageResource.ts#L6) + +___ + +### SignInFieldPageModel + +Ƭ **SignInFieldPageModel**: `JSONAPIModel`<[SignInFieldPageAttributes](README.md#signinfieldpageattributes), [SignInFieldPageRelationships](README.md#signinfieldpagerelationships)\> + +#### Defined in + +[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldPageResource.ts#L23) + +___ + +### SignInFieldPageRelationships + +Ƭ **SignInFieldPageRelationships**: ``"flow"`` \| ``"actionable-sign-in-field-actions"`` \| ``"actionable-sign-in-fields"`` \| ``"sign-in-field-actions"`` \| ``"sign-in-fields"`` + +#### Defined in + +[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldPageResource.ts#L14) + +___ + +### SignInFieldRelationships + +Ƭ **SignInFieldRelationships**: ``"sign-in-field-page"`` + +#### Defined in + +[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L26) + +___ + +### UserAttributes + +Ƭ **UserAttributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `name` | `string` | + +#### Defined in + +[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/UserResource.ts#L6) + +___ + +### UserModel + +Ƭ **UserModel**: `JSONAPIModel`<[UserAttributes](README.md#userattributes), ``""``\> + +#### Defined in + +[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/UserResource.ts#L14) + +___ + ## Event Type aliases ### EntryPayload @@ -129,7 +467,7 @@ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/payloads/EntryPayload.ts#L6) ___ @@ -181,7 +519,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/payloads/InvitePayload.ts#L6) ___ @@ -209,7 +547,7 @@ ___ #### Defined in -[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/middleware.ts#L15) +[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/middleware.ts#L15) ___ @@ -228,7 +566,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -255,7 +593,7 @@ Metadata that will be included in the request body for events. #### Defined in -[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L66) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L66) ___ @@ -278,7 +616,7 @@ Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L53) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L53) ___ @@ -299,7 +637,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L37) ___ @@ -317,7 +655,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L4) ___ @@ -349,7 +687,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L13) ___ @@ -376,7 +714,7 @@ like validation URLs or options URLs. #### Defined in -[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyMeta.ts#L83) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L83) ___ @@ -391,7 +729,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L53) +[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L53) ___ @@ -410,7 +748,7 @@ You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [En #### Defined in -[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L45) +[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L45) ___ @@ -423,7 +761,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L61) +[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L61) ___ @@ -443,7 +781,7 @@ and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) o #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L70) ___ @@ -462,7 +800,7 @@ such as validation URLS or options URLs. #### Defined in -[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L37) +[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L37) ___ @@ -481,7 +819,7 @@ ___ #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyStorageItem.ts#L4) ## Helper Functions @@ -518,7 +856,7 @@ to catch Promise-based errors. #### Defined in -[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/asyncHandler.ts#L13) +[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/asyncHandler.ts#L13) ___ @@ -557,7 +895,7 @@ Catches errors and sets the proper status code. #### Defined in -[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/errorMiddleware.ts#L11) +[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/errorMiddleware.ts#L11) ___ @@ -583,4 +921,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/middleware.ts#L26) +[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/middleware.ts#L26) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 40fd529..2cba781 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index a8ca022..21e1ec0 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L61) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -106,7 +106,7 @@ Fetches the current `config` saved for this install during setup by the customer #### Defined in -[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L27) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -131,7 +131,7 @@ To remove an item from the saved `config`, set the item's key to `null`. #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L45) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -196,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginAPI.ts#L72) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 2c1d417..c4b7a56 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -42,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -52,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -84,7 +84,7 @@ Add attachments to this job. #### Defined in -[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L48) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -110,7 +110,7 @@ using {@link EnvoyRequest.send}. #### Defined in -[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L58) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -136,7 +136,7 @@ using {@link EnvoyRequest.sendFailed}. #### Defined in -[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L78) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -162,7 +162,7 @@ using {@link EnvoyRequest.sendIgnored}. #### Defined in -[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L68) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -187,4 +187,4 @@ Can be used to periodically update long-running jobs. #### Defined in -[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginJob.ts#L87) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index d6cee25..925f079 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -59,7 +59,7 @@ Instead, use [middleware](../README.md#middleware) to automatically attach an in #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -87,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L140) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -103,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L133) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -119,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L122) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -135,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L158) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -151,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L147) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -168,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L171) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -185,7 +185,7 @@ Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../ #### Defined in -[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L61) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -203,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L73) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -220,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L101) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -237,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginSDK.ts#L84) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index c0eb589..4e810d2 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -84,7 +84,7 @@ Wrapper for single pipeline get. #### Defined in -[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L35) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -100,7 +100,7 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -125,7 +125,7 @@ Wrapper for single pipeline set. #### Defined in -[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L44) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L44) ___ @@ -150,7 +150,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L53) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L53) ___ @@ -175,7 +175,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L62) ___ @@ -199,4 +199,4 @@ Wrapper for single pipeline unset. #### Defined in -[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyPluginStorage.ts#L71) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 4792c59..f9a3a6b 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -65,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L59) ## Properties @@ -81,13 +81,13 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L32) ## Methods ### createInvite -▸ **createInvite**(`invite`): `Promise` +▸ **createInvite**(`invite`): `Promise`<[InviteModel](../README.md#invitemodel)\> Requires `invites.write` scope. May also require `invites.attest` scope if setting `attested: true`. @@ -96,21 +96,21 @@ May also require `invites.attest` scope if setting `attested: true`. | Name | Type | | :------ | :------ | -| `invite` | `InviteCreationModel` | +| `invite` | [InviteCreationModel](../README.md#invitecreationmodel) | #### Returns -`Promise` +`Promise`<[InviteModel](../README.md#invitemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L188) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L188) ___ ### getAgreement -▸ **getAgreement**(`id`, `include?`): `Promise` +▸ **getAgreement**(`id`, `include?`): `Promise`<[AgreementModel](../README.md#agreementmodel)\> Requires `agreements.read` scope. @@ -123,19 +123,19 @@ Requires `agreements.read` scope. #### Returns -`Promise` +`Promise`<[AgreementModel](../README.md#agreementmodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L65) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L65) ___ ### getAgreementPage -▸ **getAgreementPage**(`id`, `include?`): `Promise` +▸ **getAgreementPage**(`id`, `include?`): `Promise`<[AgreementPageModel](../README.md#agreementpagemodel)\> -{@link AgreementPageModel} +[AgreementPageModel](../README.md#agreementpagemodel) #### Parameters @@ -146,17 +146,17 @@ ___ #### Returns -`Promise` +`Promise`<[AgreementPageModel](../README.md#agreementpagemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L58) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L58) ___ ### getCompany -▸ **getCompany**(`id`, `include?`): `Promise` +▸ **getCompany**(`id`, `include?`): `Promise`<[CompanyModel](../README.md#companymodel)\> Requires `companies.read` scope. @@ -169,17 +169,17 @@ Requires `companies.read` scope. #### Returns -`Promise` +`Promise`<[CompanyModel](../README.md#companymodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L72) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L72) ___ ### getEmployee -▸ **getEmployee**(`id`, `include?`): `Promise` +▸ **getEmployee**(`id`, `include?`): `Promise`<[EmployeeModel](../README.md#employeemodel)\> Requires `employees.read` scope. @@ -192,17 +192,17 @@ Requires `employees.read` scope. #### Returns -`Promise` +`Promise`<[EmployeeModel](../README.md#employeemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L79) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L79) ___ ### getEmployeeByEmail -▸ **getEmployeeByEmail**(`email`, `include?`): `Promise` +▸ **getEmployeeByEmail**(`email`, `include?`): `Promise`<[EmployeeModel](../README.md#employeemodel)\> Requires `employees.read` scope. @@ -215,17 +215,17 @@ Requires `employees.read` scope. #### Returns -`Promise` +`Promise`<[EmployeeModel](../README.md#employeemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L114) ___ ### getEmployees -▸ **getEmployees**(`params?`): `Promise` +▸ **getEmployees**(`params?`): `Promise`<[EmployeeModel](../README.md#employeemodel)[]\> Requires `employees.read` scope. @@ -233,21 +233,21 @@ Requires `employees.read` scope. | Name | Type | | :------ | :------ | -| `params?` | `default` | +| `params?` | `default`<[EmployeeFilterFields](../interfaces/employeefilterfields.md), [EmployeeSortFields](../README.md#employeesortfields)\> | #### Returns -`Promise` +`Promise`<[EmployeeModel](../README.md#employeemodel)[]\> #### Defined in -[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L136) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L136) ___ ### getFlow -▸ **getFlow**(`id`, `include?`): `Promise` +▸ **getFlow**(`id`, `include?`): `Promise`<[FlowModel](../README.md#flowmodel)\> Requires `flows.read` scope. @@ -260,17 +260,17 @@ Requires `flows.read` scope. #### Returns -`Promise` +`Promise`<[FlowModel](../README.md#flowmodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L86) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L86) ___ ### getFlows -▸ **getFlows**(`params?`): `Promise` +▸ **getFlows**(`params?`): `Promise`<[FlowModel](../README.md#flowmodel)[]\> Requires `flows.read` scope. @@ -278,21 +278,21 @@ Requires `flows.read` scope. | Name | Type | | :------ | :------ | -| `params?` | `default` | +| `params?` | `default`<[FlowFilterFields](../interfaces/flowfilterfields.md), [FlowSortFields](../README.md#flowsortfields)\> | #### Returns -`Promise` +`Promise`<[FlowModel](../README.md#flowmodel)[]\> #### Defined in -[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L146) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L146) ___ ### getInvites -▸ **getInvites**(`params?`): `Promise` +▸ **getInvites**(`params?`): `Promise`<[InviteModel](../README.md#invitemodel)[]\> Requires `invites.read` scope. @@ -300,21 +300,21 @@ Requires `invites.read` scope. | Name | Type | | :------ | :------ | -| `params?` | `default` | +| `params?` | `default`<[InviteFilterFields](../interfaces/invitefilterfields.md), [InviteSortFields](../README.md#invitesortfields)\> | #### Returns -`Promise` +`Promise`<[InviteModel](../README.md#invitemodel)[]\> #### Defined in -[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L172) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L172) ___ ### getLocation -▸ **getLocation**(`id`, `include?`): `Promise` +▸ **getLocation**(`id`, `include?`): `Promise`<[LocationModel](../README.md#locationmodel)\> Requires `locations.read` scope. @@ -327,17 +327,17 @@ Requires `locations.read` scope. #### Returns -`Promise` +`Promise`<[LocationModel](../README.md#locationmodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L93) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L93) ___ ### getLocations -▸ **getLocations**(`params?`): `Promise` +▸ **getLocations**(`params?`): `Promise`<[LocationModel](../README.md#locationmodel)[]\> Requires `locations.read` scope. @@ -345,21 +345,21 @@ Requires `locations.read` scope. | Name | Type | | :------ | :------ | -| `params?` | `default` | +| `params?` | `default`<[LocationFilterFields](../interfaces/locationfilterfields.md), [LocationSortFields](../README.md#locationsortfields)\> | #### Returns -`Promise` +`Promise`<[LocationModel](../README.md#locationmodel)[]\> #### Defined in -[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L154) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L154) ___ ### getSignInField -▸ **getSignInField**(`id`, `include?`): `Promise` +▸ **getSignInField**(`id`, `include?`): `Promise`<[SignInFieldModel](../README.md#signinfieldmodel)\> Requires `sign-in-fields.read` scope. @@ -372,17 +372,17 @@ Requires `sign-in-fields.read` scope. #### Returns -`Promise` +`Promise`<[SignInFieldModel](../README.md#signinfieldmodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L107) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L107) ___ ### getSignInFieldPage -▸ **getSignInFieldPage**(`id`, `include?`): `Promise` +▸ **getSignInFieldPage**(`id`, `include?`): `Promise`<[SignInFieldPageModel](../README.md#signinfieldpagemodel)\> Requires `sign-in-field-pages.read` scope. @@ -395,17 +395,17 @@ Requires `sign-in-field-pages.read` scope. #### Returns -`Promise` +`Promise`<[SignInFieldPageModel](../README.md#signinfieldpagemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L100) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L100) ___ ### getSignInFields -▸ **getSignInFields**(`signInFieldPageId`): `Promise` +▸ **getSignInFields**(`signInFieldPageId`): `Promise`<[SignInFieldModel](../README.md#signinfieldmodel)[]\> Requires `sign-in-fields.read` scope. @@ -417,31 +417,31 @@ Requires `sign-in-fields.read` scope. #### Returns -`Promise` +`Promise`<[SignInFieldModel](../README.md#signinfieldmodel)[]\> #### Defined in -[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L164) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L164) ___ ### me -▸ **me**(): `Promise` +▸ **me**(): `Promise`<[UserModel](../README.md#usermodel)\> #### Returns -`Promise` +`Promise`<[UserModel](../README.md#usermodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L179) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L179) ___ ### partialUpdateInvite -▸ **partialUpdateInvite**(`inviteId`, `invite`): `Promise` +▸ **partialUpdateInvite**(`inviteId`, `invite`): `Promise`<[InviteModel](../README.md#invitemodel)\> Requires `invites.write` scope. @@ -450,15 +450,15 @@ Requires `invites.write` scope. | Name | Type | | :------ | :------ | | `inviteId` | `string` | -| `invite` | `InviteCreationModel` | +| `invite` | [InviteCreationModel](../README.md#invitecreationmodel) | #### Returns -`Promise` +`Promise`<[InviteModel](../README.md#invitemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L213) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -480,13 +480,13 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L226) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L226) ___ ### updateInvite -▸ **updateInvite**(`inviteId`, `invite`): `Promise` +▸ **updateInvite**(`inviteId`, `invite`): `Promise`<[InviteModel](../README.md#invitemodel)\> Requires `invites.write` scope. @@ -495,15 +495,15 @@ Requires `invites.write` scope. | Name | Type | | :------ | :------ | | `inviteId` | `string` | -| `invite` | `InviteCreationModel` | +| `invite` | [InviteCreationModel](../README.md#invitecreationmodel) | #### Returns -`Promise` +`Promise`<[InviteModel](../README.md#invitemodel)\> #### Defined in -[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L200) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L200) ___ @@ -531,7 +531,7 @@ Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exc #### Defined in -[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L240) +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L240) ___ @@ -555,7 +555,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L306) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L306) ___ @@ -580,7 +580,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L280) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L280) ___ @@ -606,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged - use [ #### Defined in -[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyUserAPI.ts#L252) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/agreementattributes.md b/docs/interfaces/agreementattributes.md new file mode 100644 index 0000000..efdd0fc --- /dev/null +++ b/docs/interfaces/agreementattributes.md @@ -0,0 +1,107 @@ +[@envoy/envoy-integrations-sdk](../README.md) / AgreementAttributes + +# Interface: AgreementAttributes + +## Table of contents + +### Properties + +- [body](agreementattributes.md#body) +- [created-at](agreementattributes.md#created-at) +- [enabled](agreementattributes.md#enabled) +- [name](agreementattributes.md#name) +- [optional](agreementattributes.md#optional) +- [position](agreementattributes.md#position) +- [require-resign](agreementattributes.md#require-resign) +- [updated-at](agreementattributes.md#updated-at) +- [video-url](agreementattributes.md#video-url) + +## Properties + +### body + +• `Optional` **body**: `string` + +#### Defined in + +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L10) + +___ + +### created-at + +• `Optional` **created-at**: `string` + +#### Defined in + +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L13) + +___ + +### enabled + +• `Optional` **enabled**: `boolean` + +#### Defined in + +[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L12) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L7) + +___ + +### optional + +• **optional**: `boolean` + +#### Defined in + +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L8) + +___ + +### position + +• `Optional` **position**: `number` + +#### Defined in + +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L13) + +___ + +### require-resign + +• **require-resign**: `boolean` + +#### Defined in + +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L8) + +___ + +### updated-at + +• `Optional` **updated-at**: `string` + +#### Defined in + +[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L14) + +___ + +### video-url + +• `Optional` **video-url**: `string` + +#### Defined in + +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L10) diff --git a/docs/interfaces/companyattributes.md b/docs/interfaces/companyattributes.md new file mode 100644 index 0000000..3304ed3 --- /dev/null +++ b/docs/interfaces/companyattributes.md @@ -0,0 +1,52 @@ +[@envoy/envoy-integrations-sdk](../README.md) / CompanyAttributes + +# Interface: CompanyAttributes + +## Table of contents + +### Properties + +- [active](companyattributes.md#active) +- [created-at](companyattributes.md#created-at) +- [name](companyattributes.md#name) +- [updated-at](companyattributes.md#updated-at) + +## Properties + +### active + +• **active**: `boolean` + +#### Defined in + +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L8) + +___ + +### created-at + +• **created-at**: `string` + +#### Defined in + +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L8) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L7) + +___ + +### updated-at + +• **updated-at**: `string` + +#### Defined in + +[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L9) diff --git a/docs/interfaces/employeeattributes.md b/docs/interfaces/employeeattributes.md new file mode 100644 index 0000000..d1b8e32 --- /dev/null +++ b/docs/interfaces/employeeattributes.md @@ -0,0 +1,107 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EmployeeAttributes + +# Interface: EmployeeAttributes + +## Table of contents + +### Properties + +- [company-id](employeeattributes.md#company-id) +- [created-at](employeeattributes.md#created-at) +- [deleted](employeeattributes.md#deleted) +- [deleted-at](employeeattributes.md#deleted-at) +- [email](employeeattributes.md#email) +- [name](employeeattributes.md#name) +- [phone-number](employeeattributes.md#phone-number) +- [profile-picture-url](employeeattributes.md#profile-picture-url) +- [updated-at](employeeattributes.md#updated-at) + +## Properties + +### company-id + +• `Optional` **company-id**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L32) + +___ + +### created-at + +• `Optional` **created-at**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L33) + +___ + +### deleted + +• `Optional` **deleted**: `boolean` + +#### Defined in + +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L32) + +___ + +### deleted-at + +• `Optional` **deleted-at**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L35) + +___ + +### email + +• **email**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L29) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L28) + +___ + +### phone-number + +• `Optional` **phone-number**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L29) + +___ + +### profile-picture-url + +• `Optional` **profile-picture-url**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L30) + +___ + +### updated-at + +• `Optional` **updated-at**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L34) diff --git a/docs/interfaces/employeefilterfields.md b/docs/interfaces/employeefilterfields.md new file mode 100644 index 0000000..cc0f97a --- /dev/null +++ b/docs/interfaces/employeefilterfields.md @@ -0,0 +1,118 @@ +[@envoy/envoy-integrations-sdk](../README.md) / EmployeeFilterFields + +# Interface: EmployeeFilterFields + +## Table of contents + +### Properties + +- [company](employeefilterfields.md#company) +- [deleted](employeefilterfields.md#deleted) +- [email](employeefilterfields.md#email) +- [except](employeefilterfields.md#except) +- [exclude-hidden](employeefilterfields.md#exclude-hidden) +- [exclude-locations](employeefilterfields.md#exclude-locations) +- [locations](employeefilterfields.md#locations) +- [manually-added](employeefilterfields.md#manually-added) +- [name](employeefilterfields.md#name) +- [query](employeefilterfields.md#query) + +## Properties + +### company + +• `Optional` **company**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L13) + +___ + +### deleted + +• `Optional` **deleted**: `boolean` + +#### Defined in + +[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L12) + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L15) + +___ + +### except + +• `Optional` **except**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L16) + +___ + +### exclude-hidden + +• `Optional` **exclude-hidden**: `boolean` + +#### Defined in + +[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L17) + +___ + +### exclude-locations + +• `Optional` **exclude-locations**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L16) + +___ + +### locations + +• `Optional` **locations**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L14) + +___ + +### manually-added + +• `Optional` **manually-added**: `boolean` + +#### Defined in + +[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L18) + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L20) + +___ + +### query + +• `Optional` **query**: `string` + +#### Defined in + +[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L21) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 6e9fc95..25919d5 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -39,7 +39,7 @@ VerifiedRequest.\_\_@VERIFIED@1256 #### Defined in -[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L16) +[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L16) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyRequest.ts#L28) +[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L28) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 67a4365..f8def89 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -45,7 +45,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L9) +[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L9) ___ @@ -73,7 +73,7 @@ Marks the job as "failed". The message will be communicated to the Envoy Dashboa #### Defined in -[sdk/EnvoyResponse.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L24) +[sdk/EnvoyResponse.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L24) ___ @@ -101,7 +101,7 @@ Marks the job as "ignored". Useful when you explicitly do not want to handle the #### Defined in -[sdk/EnvoyResponse.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L19) +[sdk/EnvoyResponse.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L19) ___ @@ -129,4 +129,4 @@ Later on, you should update the job using #### Defined in -[sdk/EnvoyResponse.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/sdk/EnvoyResponse.ts#L15) +[sdk/EnvoyResponse.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L15) diff --git a/docs/interfaces/flowattributes.md b/docs/interfaces/flowattributes.md new file mode 100644 index 0000000..09a2203 --- /dev/null +++ b/docs/interfaces/flowattributes.md @@ -0,0 +1,63 @@ +[@envoy/envoy-integrations-sdk](../README.md) / FlowAttributes + +# Interface: FlowAttributes + +## Table of contents + +### Properties + +- [created-at](flowattributes.md#created-at) +- [employee-centric](flowattributes.md#employee-centric) +- [enabled](flowattributes.md#enabled) +- [name](flowattributes.md#name) +- [updated-at](flowattributes.md#updated-at) + +## Properties + +### created-at + +• `Optional` **created-at**: `string` + +#### Defined in + +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L22) + +___ + +### employee-centric + +• `Optional` **employee-centric**: `boolean` + +#### Defined in + +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L20) + +___ + +### enabled + +• `Optional` **enabled**: `boolean` + +#### Defined in + +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L22) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L20) + +___ + +### updated-at + +• `Optional` **updated-at**: `string` + +#### Defined in + +[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L23) diff --git a/docs/interfaces/flowfilterfields.md b/docs/interfaces/flowfilterfields.md new file mode 100644 index 0000000..3177add --- /dev/null +++ b/docs/interfaces/flowfilterfields.md @@ -0,0 +1,30 @@ +[@envoy/envoy-integrations-sdk](../README.md) / FlowFilterFields + +# Interface: FlowFilterFields + +## Table of contents + +### Properties + +- [employee-centric](flowfilterfields.md#employee-centric) +- [location](flowfilterfields.md#location) + +## Properties + +### employee-centric + +• `Optional` **employee-centric**: `boolean` + +#### Defined in + +[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L11) + +___ + +### location + +• `Optional` **location**: `string` + +#### Defined in + +[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L13) diff --git a/docs/interfaces/inviteattributes.md b/docs/interfaces/inviteattributes.md new file mode 100644 index 0000000..7bd78e3 --- /dev/null +++ b/docs/interfaces/inviteattributes.md @@ -0,0 +1,225 @@ +[@envoy/envoy-integrations-sdk](../README.md) / InviteAttributes + +# Interface: InviteAttributes + +## Table of contents + +### Properties + +- [additional-guests](inviteattributes.md#additional-guests) +- [approval-status](inviteattributes.md#approval-status) +- [arrived](inviteattributes.md#arrived) +- [attested](inviteattributes.md#attested) +- [created-at](inviteattributes.md#created-at) +- [created-from](inviteattributes.md#created-from) +- [email](inviteattributes.md#email) +- [entry-signed-out-at](inviteattributes.md#entry-signed-out-at) +- [expected-arrival-time](inviteattributes.md#expected-arrival-time) +- [expected-departure-time](inviteattributes.md#expected-departure-time) +- [full-name](inviteattributes.md#full-name) +- [guest-updated-at](inviteattributes.md#guest-updated-at) +- [is-presigned](inviteattributes.md#is-presigned) +- [notify-visitor](inviteattributes.md#notify-visitor) +- [phone](inviteattributes.md#phone) +- [private-notes](inviteattributes.md#private-notes) +- [reminder-sent-at](inviteattributes.md#reminder-sent-at) +- [updated-at](inviteattributes.md#updated-at) +- [user-data](inviteattributes.md#user-data) + +## Properties + +### additional-guests + +• `Optional` **additional-guests**: `number` + +#### Defined in + +[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L28) + +___ + +### approval-status + +• `Optional` **approval-status**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `auto_approved` | `boolean` | +| `report` | { `messages`: { `failure?`: { `header`: `string` ; `text`: `string` } } ; `reason`: `string` ; `result`: ``"pending"`` \| ``"pass"`` \| ``"fail"`` ; `source`: `string` }[] | +| `status` | ``"approved"`` \| ``"review"`` \| ``"pending"`` \| ``"denied"`` | + +#### Defined in + +[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L29) + +___ + +### arrived + +• `Optional` **arrived**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L55) + +___ + +### attested + +• `Optional` **attested**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L56) + +___ + +### created-at + +• `Optional` **created-at**: `string` + +#### Defined in + +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L59) + +___ + +### created-from + +• `Optional` **created-from**: `string` + +#### Defined in + +[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L53) + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L45) + +___ + +### entry-signed-out-at + +• `Optional` **entry-signed-out-at**: `string` + +#### Defined in + +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L56) + +___ + +### expected-arrival-time + +• `Optional` **expected-arrival-time**: `string` + +#### Defined in + +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L45) + +___ + +### expected-departure-time + +• `Optional` **expected-departure-time**: `string` + +#### Defined in + +[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L46) + +___ + +### full-name + +• `Optional` **full-name**: `string` + +#### Defined in + +[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L47) + +___ + +### guest-updated-at + +• `Optional` **guest-updated-at**: `string` + +#### Defined in + +[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L48) + +___ + +### is-presigned + +• `Optional` **is-presigned**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L49) + +___ + +### notify-visitor + +• `Optional` **notify-visitor**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L52) + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L59) + +___ + +### private-notes + +• `Optional` **private-notes**: `string` + +#### Defined in + +[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L50) + +___ + +### reminder-sent-at + +• `Optional` **reminder-sent-at**: `string` + +#### Defined in + +[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L57) + +___ + +### updated-at + +• `Optional` **updated-at**: `string` + +#### Defined in + +[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L60) + +___ + +### user-data + +• `Optional` **user-data**: `Record` + +#### Defined in + +[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L51) diff --git a/docs/interfaces/invitecreationattributes.md b/docs/interfaces/invitecreationattributes.md new file mode 100644 index 0000000..93830eb --- /dev/null +++ b/docs/interfaces/invitecreationattributes.md @@ -0,0 +1,107 @@ +[@envoy/envoy-integrations-sdk](../README.md) / InviteCreationAttributes + +# Interface: InviteCreationAttributes + +## Table of contents + +### Properties + +- [attested](invitecreationattributes.md#attested) +- [email](invitecreationattributes.md#email) +- [expected-arrival-time](invitecreationattributes.md#expected-arrival-time) +- [expected-departure-time](invitecreationattributes.md#expected-departure-time) +- [full-name](invitecreationattributes.md#full-name) +- [notify-visitor](invitecreationattributes.md#notify-visitor) +- [phone](invitecreationattributes.md#phone) +- [private-notes](invitecreationattributes.md#private-notes) +- [user-data](invitecreationattributes.md#user-data) + +## Properties + +### attested + +• `Optional` **attested**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L75) + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L68) + +___ + +### expected-arrival-time + +• `Optional` **expected-arrival-time**: `string` + +#### Defined in + +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L68) + +___ + +### expected-departure-time + +• `Optional` **expected-departure-time**: `string` + +#### Defined in + +[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L69) + +___ + +### full-name + +• `Optional` **full-name**: `string` + +#### Defined in + +[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L70) + +___ + +### notify-visitor + +• `Optional` **notify-visitor**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L73) + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L76) + +___ + +### private-notes + +• `Optional` **private-notes**: `string` + +#### Defined in + +[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L71) + +___ + +### user-data + +• `Optional` **user-data**: `Record` + +#### Defined in + +[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L72) diff --git a/docs/interfaces/invitefilterfields.md b/docs/interfaces/invitefilterfields.md new file mode 100644 index 0000000..5cfe0e1 --- /dev/null +++ b/docs/interfaces/invitefilterfields.md @@ -0,0 +1,129 @@ +[@envoy/envoy-integrations-sdk](../README.md) / InviteFilterFields + +# Interface: InviteFilterFields + +## Table of contents + +### Properties + +- [date-from](invitefilterfields.md#date-from) +- [date-to](invitefilterfields.md#date-to) +- [datetime-from](invitefilterfields.md#datetime-from) +- [datetime-to](invitefilterfields.md#datetime-to) +- [email](invitefilterfields.md#email) +- [employee](invitefilterfields.md#employee) +- [employee-centric](invitefilterfields.md#employee-centric) +- [flow](invitefilterfields.md#flow) +- [for-date](invitefilterfields.md#for-date) +- [location](invitefilterfields.md#location) +- [scope](invitefilterfields.md#scope) + +## Properties + +### date-from + +• `Optional` **date-from**: `string` + +#### Defined in + +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L15) + +___ + +### date-to + +• `Optional` **date-to**: `string` + +#### Defined in + +[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L16) + +___ + +### datetime-from + +• `Optional` **datetime-from**: `string` + +#### Defined in + +[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L17) + +___ + +### datetime-to + +• `Optional` **datetime-to**: `string` + +#### Defined in + +[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L18) + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L12) + +___ + +### employee + +• `Optional` **employee**: `string` + +#### Defined in + +[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L13) + +___ + +### employee-centric + +• `Optional` **employee-centric**: `boolean` + +#### Defined in + +[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L20) + +___ + +### flow + +• `Optional` **flow**: `string` + +#### Defined in + +[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L14) + +___ + +### for-date + +• `Optional` **for-date**: `string` + +#### Defined in + +[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L19) + +___ + +### location + +• `Optional` **location**: `string` + +#### Defined in + +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L15) + +___ + +### scope + +• `Optional` **scope**: ``"hosted"`` \| ``"mine"`` \| ``"include_execs"`` + +#### Defined in + +[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L22) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index a428b93..c77a358 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/48073ad/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/locationattributes.md b/docs/interfaces/locationattributes.md new file mode 100644 index 0000000..1be233d --- /dev/null +++ b/docs/interfaces/locationattributes.md @@ -0,0 +1,415 @@ +[@envoy/envoy-integrations-sdk](../README.md) / LocationAttributes + +# Interface: LocationAttributes + +## Table of contents + +### Properties + +- [address](locationattributes.md#address) +- [address-line-1](locationattributes.md#address-line-1) +- [address-line-2](locationattributes.md#address-line-2) +- [auto-sign-out-at-midnight](locationattributes.md#auto-sign-out-at-midnight) +- [average-monthly-visitors](locationattributes.md#average-monthly-visitors) +- [capacity-limit](locationattributes.md#capacity-limit) +- [city](locationattributes.md#city) +- [company-name-override](locationattributes.md#company-name-override) +- [created-at](locationattributes.md#created-at) +- [disabled](locationattributes.md#disabled) +- [employee-screening-enabled](locationattributes.md#employee-screening-enabled) +- [host-approval-enabled](locationattributes.md#host-approval-enabled) +- [latitude](locationattributes.md#latitude) +- [locale](locationattributes.md#locale) +- [logo-small-url](locationattributes.md#logo-small-url) +- [logo-thumb-url](locationattributes.md#logo-thumb-url) +- [logo-url](locationattributes.md#logo-url) +- [longitude](locationattributes.md#longitude) +- [multiple-languages-enabled](locationattributes.md#multiple-languages-enabled) +- [name](locationattributes.md#name) +- [near-visit-screening-enabled](locationattributes.md#near-visit-screening-enabled) +- [pre-registration-enabled](locationattributes.md#pre-registration-enabled) +- [pre-registration-required-enabled](locationattributes.md#pre-registration-required-enabled) +- [printer-notifications-enabled](locationattributes.md#printer-notifications-enabled) +- [registration-eligibility-end-offset](locationattributes.md#registration-eligibility-end-offset) +- [registration-eligibility-start-offset](locationattributes.md#registration-eligibility-start-offset) +- [security-desk-link-enabled](locationattributes.md#security-desk-link-enabled) +- [state](locationattributes.md#state) +- [timezone](locationattributes.md#timezone) +- [touchless-signin-enabled](locationattributes.md#touchless-signin-enabled) +- [updated-at](locationattributes.md#updated-at) +- [visitor-registration-eligibility-start-offset](locationattributes.md#visitor-registration-eligibility-start-offset) +- [visitor-survey-enabled](locationattributes.md#visitor-survey-enabled) +- [visitors-onboarding-complete](locationattributes.md#visitors-onboarding-complete) +- [visual-compliance-enabled](locationattributes.md#visual-compliance-enabled) +- [welcome-email-preference](locationattributes.md#welcome-email-preference) +- [zip](locationattributes.md#zip) + +## Properties + +### address + +• **address**: `string` + +#### Defined in + +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L21) + +___ + +### address-line-1 + +• `Optional` **address-line-1**: `string` + +#### Defined in + +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L21) + +___ + +### address-line-2 + +• `Optional` **address-line-2**: `string` + +#### Defined in + +[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L22) + +___ + +### auto-sign-out-at-midnight + +• `Optional` **auto-sign-out-at-midnight**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L42) + +___ + +### average-monthly-visitors + +• `Optional` **average-monthly-visitors**: `number` + +#### Defined in + +[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L40) + +___ + +### capacity-limit + +• `Optional` **capacity-limit**: `number` + +#### Defined in + +[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L41) + +___ + +### city + +• `Optional` **city**: `string` + +#### Defined in + +[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L24) + +___ + +### company-name-override + +• `Optional` **company-name-override**: `string` + +#### Defined in + +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L30) + +___ + +### created-at + +• `Optional` **created-at**: `string` + +#### Defined in + +[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L54) + +___ + +### disabled + +• `Optional` **disabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L35) + +___ + +### employee-screening-enabled + +• `Optional` **employee-screening-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L43) + +___ + +### host-approval-enabled + +• `Optional` **host-approval-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L46) + +___ + +### latitude + +• `Optional` **latitude**: `number` + +#### Defined in + +[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L27) + +___ + +### locale + +• `Optional` **locale**: `string` + +#### Defined in + +[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L29) + +___ + +### logo-small-url + +• `Optional` **logo-small-url**: `string` + +#### Defined in + +[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L31) + +___ + +### logo-thumb-url + +• `Optional` **logo-thumb-url**: `string` + +#### Defined in + +[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L32) + +___ + +### logo-url + +• `Optional` **logo-url**: `string` + +#### Defined in + +[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L33) + +___ + +### longitude + +• `Optional` **longitude**: `number` + +#### Defined in + +[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L28) + +___ + +### multiple-languages-enabled + +• `Optional` **multiple-languages-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L47) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L20) + +___ + +### near-visit-screening-enabled + +• `Optional` **near-visit-screening-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L48) + +___ + +### pre-registration-enabled + +• `Optional` **pre-registration-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L44) + +___ + +### pre-registration-required-enabled + +• `Optional` **pre-registration-required-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L45) + +___ + +### printer-notifications-enabled + +• `Optional` **printer-notifications-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L49) + +___ + +### registration-eligibility-end-offset + +• `Optional` **registration-eligibility-end-offset**: `number` + +#### Defined in + +[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L36) + +___ + +### registration-eligibility-start-offset + +• `Optional` **registration-eligibility-start-offset**: `number` + +#### Defined in + +[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L37) + +___ + +### security-desk-link-enabled + +• `Optional` **security-desk-link-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L50) + +___ + +### state + +• `Optional` **state**: `string` + +#### Defined in + +[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L25) + +___ + +### timezone + +• `Optional` **timezone**: `string` + +#### Defined in + +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L30) + +___ + +### touchless-signin-enabled + +• `Optional` **touchless-signin-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L51) + +___ + +### updated-at + +• `Optional` **updated-at**: `string` + +#### Defined in + +[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L55) + +___ + +### visitor-registration-eligibility-start-offset + +• `Optional` **visitor-registration-eligibility-start-offset**: `number` + +#### Defined in + +[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L38) + +___ + +### visitor-survey-enabled + +• `Optional` **visitor-survey-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L52) + +___ + +### visitors-onboarding-complete + +• `Optional` **visitors-onboarding-complete**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L35) + +___ + +### visual-compliance-enabled + +• `Optional` **visual-compliance-enabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L53) + +___ + +### welcome-email-preference + +• `Optional` **welcome-email-preference**: `string` + +#### Defined in + +[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L39) + +___ + +### zip + +• `Optional` **zip**: `string` + +#### Defined in + +[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L26) diff --git a/docs/interfaces/locationfilterfields.md b/docs/interfaces/locationfilterfields.md new file mode 100644 index 0000000..a69d8df --- /dev/null +++ b/docs/interfaces/locationfilterfields.md @@ -0,0 +1,30 @@ +[@envoy/envoy-integrations-sdk](../README.md) / LocationFilterFields + +# Interface: LocationFilterFields + +## Table of contents + +### Properties + +- [company](locationfilterfields.md#company) +- [disabled](locationfilterfields.md#disabled) + +## Properties + +### company + +• `Optional` **company**: `string` + +#### Defined in + +[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L13) + +___ + +### disabled + +• `Optional` **disabled**: `boolean` + +#### Defined in + +[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L12) diff --git a/docs/interfaces/signinfieldattributes.md b/docs/interfaces/signinfieldattributes.md new file mode 100644 index 0000000..7aca3a5 --- /dev/null +++ b/docs/interfaces/signinfieldattributes.md @@ -0,0 +1,118 @@ +[@envoy/envoy-integrations-sdk](../README.md) / SignInFieldAttributes + +# Interface: SignInFieldAttributes + +## Table of contents + +### Properties + +- [created-at](signinfieldattributes.md#created-at) +- [identifier](signinfieldattributes.md#identifier) +- [ipad-localized-names](signinfieldattributes.md#ipad-localized-names) +- [kind](signinfieldattributes.md#kind) +- [localized](signinfieldattributes.md#localized) +- [name](signinfieldattributes.md#name) +- [position](signinfieldattributes.md#position) +- [required](signinfieldattributes.md#required) +- [store-response](signinfieldattributes.md#store-response) +- [updated-at](signinfieldattributes.md#updated-at) + +## Properties + +### created-at + +• `Optional` **created-at**: `string` + +#### Defined in + +[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L18) + +___ + +### identifier + +• `Optional` **identifier**: `string` + +#### Defined in + +[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L10) + +___ + +### ipad-localized-names + +• **ipad-localized-names**: { `display-name`: `string` ; `language-code`: `string` ; `region-code?`: `string` }[] + +#### Defined in + +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L11) + +___ + +### kind + +• **kind**: `string` + +#### Defined in + +[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L8) + +___ + +### localized + +• `Optional` **localized**: `string` + +#### Defined in + +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L11) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L7) + +___ + +### position + +• `Optional` **position**: `number` + +#### Defined in + +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L17) + +___ + +### required + +• **required**: `boolean` + +#### Defined in + +[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L9) + +___ + +### store-response + +• `Optional` **store-response**: `boolean` + +#### Defined in + +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L17) + +___ + +### updated-at + +• `Optional` **updated-at**: `string` + +#### Defined in + +[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L19) From 883a97018738936b5828a17aabce73b77c8ee84a Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 12 Jun 2021 16:46:43 -0400 Subject: [PATCH 31/91] working on test factories and some extra types --- docs/README.md | 267 +++++++++++++----- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 16 +- docs/classes/envoypluginsdk.md | 26 +- docs/classes/envoypluginstorage.md | 18 +- docs/classes/envoyuserapi.md | 50 ++-- docs/interfaces/agreementattributes.md | 18 +- docs/interfaces/companyattributes.md | 8 +- docs/interfaces/employeeattributes.md | 18 +- docs/interfaces/employeefilterfields.md | 20 +- docs/interfaces/envoybaserequest.md | 8 +- docs/interfaces/envoyresponse.md | 26 +- docs/interfaces/flowattributes.md | 10 +- docs/interfaces/flowfilterfields.md | 4 +- docs/interfaces/inviteattributes.md | 38 +-- docs/interfaces/invitecreationattributes.md | 18 +- docs/interfaces/invitefilterfields.md | 22 +- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/locationattributes.md | 74 ++--- docs/interfaces/locationfilterfields.md | 4 +- docs/interfaces/signinfieldattributes.md | 20 +- package-lock.json | 72 ++++- package.json | 3 + .../EnvoyEntryEventRequestFactory.ts | 0 src/factories/entryEventRequestFactory.ts | 108 +++++++ src/factories/eventRequestFactory.ts | 36 +++ src/factories/metaFactory.ts | 99 +++++++ src/factories/routeRequestFactory.ts | 35 +++ src/index.ts | 1 + src/internal/EnvoyEntryEvent.ts | 10 + src/internal/EnvoyInviteEvent.ts | 13 + src/internal/EnvoyOption.ts | 6 + src/internal/EnvoyOptionsRouteParams.ts | 7 + src/internal/EnvoyOptionsRouteResponseBody.ts | 4 + .../EnvoyRemoteValueRouteResponseBody.ts | 4 + .../EnvoySelectedValuesRouteParams.ts | 5 + .../EnvoySelectedValuesRouteResponseBody.ts | 4 + src/sdk/EnvoyMeta.ts | 18 +- src/sdk/EnvoyPluginSDK.ts | 12 +- src/sdk/EnvoyRequest.ts | 53 +++- src/sdk/EnvoyResponse.ts | 20 +- src/sdk/EnvoyUserAPI.ts | 2 +- 43 files changed, 888 insertions(+), 315 deletions(-) delete mode 100644 src/factories/EnvoyEntryEventRequestFactory.ts create mode 100644 src/factories/entryEventRequestFactory.ts create mode 100644 src/factories/eventRequestFactory.ts create mode 100644 src/factories/metaFactory.ts create mode 100644 src/factories/routeRequestFactory.ts create mode 100644 src/internal/EnvoyEntryEvent.ts create mode 100644 src/internal/EnvoyInviteEvent.ts create mode 100644 src/internal/EnvoyOption.ts create mode 100644 src/internal/EnvoyOptionsRouteParams.ts create mode 100644 src/internal/EnvoyOptionsRouteResponseBody.ts create mode 100644 src/internal/EnvoyRemoteValueRouteResponseBody.ts create mode 100644 src/internal/EnvoySelectedValuesRouteParams.ts create mode 100644 src/internal/EnvoySelectedValuesRouteResponseBody.ts diff --git a/docs/README.md b/docs/README.md index 0556a04..4a48d0a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -44,13 +44,13 @@ - [LocationFilterFields](interfaces/locationfilterfields.md) - [SignInFieldAttributes](interfaces/signinfieldattributes.md) -### Other Interfaces +### Base Interfaces -- [JSONAPIData](interfaces/jsonapidata.md) +- [EnvoyBaseRequest](interfaces/envoybaserequest.md) -### Request Interfaces +### Other Interfaces -- [EnvoyBaseRequest](interfaces/envoybaserequest.md) +- [JSONAPIData](interfaces/jsonapidata.md) ### Response Interfaces @@ -86,6 +86,10 @@ - [UserAttributes](README.md#userattributes) - [UserModel](README.md#usermodel) +### Base Type aliases + +- [EnvoyRequest](README.md#envoyrequest) + ### Event Type aliases - [EntryPayload](README.md#entrypayload) @@ -110,8 +114,15 @@ - [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) - [EnvoyEventRequest](README.md#envoyeventrequest) - [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) -- [EnvoyRequest](README.md#envoyrequest) +- [EnvoyOptionsRouteRequest](README.md#envoyoptionsrouterequest) +- [EnvoyRemoteValueRouteRequest](README.md#envoyremotevaluerouterequest) - [EnvoyRouteRequest](README.md#envoyrouterequest) +- [EnvoySelectedValuesRouteRequest](README.md#envoyselectedvaluesrouterequest) + +### Response Type aliases + +- [EnvoyOptionsRouteResponse](README.md#envoyoptionsrouteresponse) +- [EnvoySelectedValuesRouteResponse](README.md#envoyselectedvaluesrouteresponse) ### Storage Type aliases @@ -134,7 +145,7 @@ #### Defined in -[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L26) +[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L26) ___ @@ -151,7 +162,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementPageResource.ts#L6) +[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementPageResource.ts#L6) ___ @@ -161,7 +172,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementPageResource.ts#L19) +[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementPageResource.ts#L19) ___ @@ -171,7 +182,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementPageResource.ts#L14) +[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementPageResource.ts#L14) ___ @@ -181,7 +192,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L21) +[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L21) ___ @@ -191,7 +202,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L21) +[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L21) ___ @@ -201,7 +212,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L16) +[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L16) ___ @@ -211,7 +222,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L47) +[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L47) ___ @@ -221,7 +232,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L42) +[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L42) ___ @@ -231,7 +242,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L6) +[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L6) ___ @@ -241,7 +252,7 @@ ___ #### Defined in -[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L35) +[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L35) ___ @@ -251,7 +262,7 @@ ___ #### Defined in -[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L30) +[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L30) ___ @@ -261,7 +272,7 @@ ___ #### Defined in -[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L6) +[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L6) ___ @@ -271,7 +282,7 @@ ___ #### Defined in -[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L92) +[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L92) ___ @@ -281,7 +292,7 @@ ___ #### Defined in -[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L87) +[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L87) ___ @@ -291,7 +302,7 @@ ___ #### Defined in -[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L82) +[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L82) ___ @@ -301,7 +312,7 @@ ___ #### Defined in -[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L6) +[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L6) ___ @@ -311,7 +322,7 @@ ___ #### Defined in -[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L67) +[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L67) ___ @@ -321,7 +332,7 @@ ___ #### Defined in -[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L62) +[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L62) ___ @@ -331,7 +342,7 @@ ___ #### Defined in -[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L6) +[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L6) ___ @@ -341,7 +352,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L31) +[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L31) ___ @@ -358,7 +369,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldPageResource.ts#L6) +[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldPageResource.ts#L6) ___ @@ -368,7 +379,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldPageResource.ts#L23) +[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldPageResource.ts#L23) ___ @@ -378,7 +389,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldPageResource.ts#L14) +[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldPageResource.ts#L14) ___ @@ -388,7 +399,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L26) +[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L26) ___ @@ -405,7 +416,7 @@ ___ #### Defined in -[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/UserResource.ts#L6) +[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/UserResource.ts#L6) ___ @@ -415,7 +426,29 @@ ___ #### Defined in -[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/UserResource.ts#L14) +[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/UserResource.ts#L14) + +___ + +## Base Type aliases + +### EnvoyRequest + +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> + +You probably won't need to use this type directly. +For routes, use [EnvoyRouteRequest](README.md#envoyrouterequest), +and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest). + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `unknown` | + +#### Defined in + +[sdk/EnvoyRequest.ts:105](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L105) ___ @@ -467,7 +500,7 @@ ___ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/payloads/EntryPayload.ts#L6) ___ @@ -519,7 +552,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/payloads/InvitePayload.ts#L6) ___ @@ -547,7 +580,7 @@ ___ #### Defined in -[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/middleware.ts#L15) +[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/middleware.ts#L15) ___ @@ -566,7 +599,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -574,26 +607,33 @@ ___ ### EnvoyEventMeta -Ƭ **EnvoyEventMeta**: `Object` +Ƭ **EnvoyEventMeta**: `Object` Metadata that will be included in the request body for events. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Event` | `Event`: `string` = `string` | +| `Config` | `Config` = `Record` | + #### Type declaration | Name | Type | | :------ | :------ | | `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | | `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | -| `config` | `Record` | -| `event` | `string` | +| `config` | `Config` | +| `event` | `Event` | | `install_id` | `string` | -| `job` | [EnvoyMetaJob](README.md#envoymetajob) | +| `job` | [EnvoyMetaJob](README.md#envoymetajob) | | `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | | `plugin_id` | `string` | #### Defined in -[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L66) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L66) ___ @@ -616,7 +656,7 @@ Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L53) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L53) ___ @@ -637,13 +677,19 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L37) ___ ### EnvoyMetaJob -Ƭ **EnvoyMetaJob**: `Object` +Ƭ **EnvoyMetaJob**: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Event` | `Event`: `string` = `string` | #### Type declaration @@ -651,11 +697,11 @@ ___ | :------ | :------ | | `id` | `string` | | `identifier` | `string` | -| `name` | `string` | +| `name` | `Event` | #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L4) ___ @@ -687,34 +733,41 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L13) ___ ### EnvoyRouteMeta -Ƭ **EnvoyRouteMeta**: `Object` +Ƭ **EnvoyRouteMeta**: `Object` Metadata that will be included in the request body for setup routes, like validation URLs or options URLs. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `Record` | +| `Params` | `Params` = `Record` | + #### Type declaration | Name | Type | | :------ | :------ | | `auth` | [EnvoyMetaAuth](README.md#envoymetaauth) \| ``null`` | | `company` | [EnvoyMetaCompany](README.md#envoymetacompany) | -| `config` | `Record` | +| `config` | `Config` | | `forwarded_bearer_token?` | `string` | | `install_id` | `string` | | `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | -| `params` | `Record` | +| `params` | `Params` | | `plugin_id` | `string` | | `route` | `string` | #### Defined in -[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyMeta.ts#L83) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L83) ___ @@ -722,20 +775,20 @@ ___ ### EnvoyEntryEventRequest -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[EntryPayload](README.md#entrypayload)\> +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) Use to type your `req` object in entry event handlers, such as handlers for `entry_sign_in`. #### Defined in -[sdk/EnvoyRequest.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L53) +[sdk/EnvoyRequest.ts:88](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L88) ___ ### EnvoyEventRequest -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> Base type for event requests. You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest). @@ -744,63 +797,125 @@ You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [En | Name | Type | | :------ | :------ | +| `Event` | `Event`: `string` = `string` | | `Payload` | `Payload` = `unknown` | #### Defined in -[sdk/EnvoyRequest.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L45) +[sdk/EnvoyRequest.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L79) ___ ### EnvoyInviteEventRequest -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest)<[InvitePayload](README.md#invitepayload)\> +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) Use to type your `req` object in invite event handlers, such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[sdk/EnvoyRequest.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L61) +[sdk/EnvoyRequest.ts:96](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L96) ___ -### EnvoyRequest +### EnvoyOptionsRouteRequest -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyOptionsRouteRequest**: [EnvoyRouteRequest](README.md#envoyrouterequest) -You probably won't need to use this type directly. -For routes, use [EnvoyRouteRequest](README.md#envoyrouterequest), -and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest). +Use to type your `req` object in Envoy "options URL" route handlers. #### Type parameters | Name | Type | | :------ | :------ | -| `Payload` | `Payload` = `unknown` | +| `Config` | `Config` = `Record` | #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L54) + +___ + +### EnvoyRemoteValueRouteRequest + +Ƭ **EnvoyRemoteValueRouteRequest**: [EnvoyRouteRequest](README.md#envoyrouterequest) + +Use to type your `req` object in Envoy "remote value URL" route handlers. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `Record` | + +#### Defined in + +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L70) ___ ### EnvoyRouteRequest -Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> +Ƭ **EnvoyRouteRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta), Payload\> -Use to type your `req` object in route handlers, -such as validation URLS or options URLs. +Use to type your `req` object in Envoy route handlers such as validation URLs. #### Type parameters | Name | Type | | :------ | :------ | | `Payload` | `Payload` = `unknown` | +| `Config` | `Config` = `Record` | +| `Params` | `Params` = `Record` | #### Defined in -[sdk/EnvoyRequest.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L37) +[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L43) + +___ + +### EnvoySelectedValuesRouteRequest + +Ƭ **EnvoySelectedValuesRouteRequest**: [EnvoyRouteRequest](README.md#envoyrouterequest) + +Use to type your `req` object in Envoy "selected values URL" route handlers. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `Record` | + +#### Defined in + +[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L62) + +___ + +## Response Type aliases + +### EnvoyOptionsRouteResponse + +Ƭ **EnvoyOptionsRouteResponse**: [EnvoyResponse](interfaces/envoyresponse.md) + +Use to type your `res` object in Envoy "options URL" route handlers. + +#### Defined in + +[sdk/EnvoyResponse.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L33) + +___ + +### EnvoySelectedValuesRouteResponse + +Ƭ **EnvoySelectedValuesRouteResponse**: [EnvoyResponse](interfaces/envoyresponse.md) + +Use to type your `res` object in Envoy "selected values URL" route handlers. + +#### Defined in + +[sdk/EnvoyResponse.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L39) ___ @@ -819,13 +934,13 @@ ___ #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyStorageItem.ts#L4) ## Helper Functions ### asyncHandler -▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` +▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` Wraps any express.js-based handlers to catch Promise-based errors. @@ -847,7 +962,7 @@ to catch Promise-based errors. | Name | Type | | :------ | :------ | | `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -856,7 +971,7 @@ to catch Promise-based errors. #### Defined in -[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/asyncHandler.ts#L13) +[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/asyncHandler.ts#L13) ___ @@ -864,7 +979,7 @@ ___ ### errorMiddleware -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` Catches errors and sets the proper status code. @@ -886,7 +1001,7 @@ Catches errors and sets the proper status code. | :------ | :------ | | `err` | `Error` | | `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | | `next` | `NextFunction` | ##### Returns @@ -895,7 +1010,7 @@ Catches errors and sets the proper status code. #### Defined in -[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/errorMiddleware.ts#L11) +[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/errorMiddleware.ts#L11) ___ @@ -921,4 +1036,4 @@ as well as managing the plugin access token lifecycle. #### Defined in -[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/middleware.ts#L26) +[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/middleware.ts#L26) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 2cba781..58fd765 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 21e1ec0..f79f691 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L61) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -106,7 +106,7 @@ Fetches the current `config` saved for this install during setup by the customer #### Defined in -[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L27) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -131,7 +131,7 @@ To remove an item from the saved `config`, set the item's key to `null`. #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L45) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -196,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginAPI.ts#L72) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index c4b7a56..bf09155 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -42,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -52,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -84,7 +84,7 @@ Add attachments to this job. #### Defined in -[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L48) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -110,7 +110,7 @@ using {@link EnvoyRequest.send}. #### Defined in -[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L58) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -136,7 +136,7 @@ using {@link EnvoyRequest.sendFailed}. #### Defined in -[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L78) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -162,7 +162,7 @@ using {@link EnvoyRequest.sendIgnored}. #### Defined in -[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L68) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -187,4 +187,4 @@ Can be used to periodically update long-running jobs. #### Defined in -[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginJob.ts#L87) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 925f079..453e6d0 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -10,7 +10,7 @@ to allow for easy access to Envoy functions. | Name | Type | | :------ | :------ | -| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Meta` | `Meta` = `unknown` | | `Payload` | `Payload` = `unknown` | ## Table of contents @@ -46,7 +46,7 @@ Instead, use [middleware](../README.md#middleware) to automatically attach an in | Name | Type | | :------ | :------ | -| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Meta` | `Meta` = `unknown` | | `Payload` | `Payload` = `unknown` | #### Parameters @@ -59,7 +59,7 @@ Instead, use [middleware](../README.md#middleware) to automatically attach an in #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -87,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L140) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -103,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L133) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -119,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L122) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -135,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L158) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -151,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L147) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -168,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L171) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -185,7 +185,7 @@ Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../ #### Defined in -[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L61) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -203,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L73) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -220,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L101) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -237,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginSDK.ts#L84) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index 4e810d2..d069ac0 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -84,7 +84,7 @@ Wrapper for single pipeline get. #### Defined in -[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L35) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -100,7 +100,7 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -125,7 +125,7 @@ Wrapper for single pipeline set. #### Defined in -[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L44) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L44) ___ @@ -150,7 +150,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L53) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L53) ___ @@ -175,7 +175,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L62) ___ @@ -199,4 +199,4 @@ Wrapper for single pipeline unset. #### Defined in -[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyPluginStorage.ts#L71) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index f9a3a6b..a0d0555 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -65,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L59) ## Properties @@ -81,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L32) ## Methods @@ -104,7 +104,7 @@ May also require `invites.attest` scope if setting `attested: true`. #### Defined in -[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L188) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L188) ___ @@ -127,7 +127,7 @@ Requires `agreements.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L65) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L65) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L58) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L58) ___ @@ -173,7 +173,7 @@ Requires `companies.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L72) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L72) ___ @@ -196,7 +196,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L79) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L79) ___ @@ -219,7 +219,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -241,7 +241,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L136) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L136) ___ @@ -264,7 +264,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L86) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L86) ___ @@ -286,7 +286,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L146) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L146) ___ @@ -308,7 +308,7 @@ Requires `invites.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L172) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L172) ___ @@ -331,7 +331,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L93) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L93) ___ @@ -353,7 +353,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L154) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L154) ___ @@ -376,7 +376,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L107) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L107) ___ @@ -399,7 +399,7 @@ Requires `sign-in-field-pages.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L100) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L100) ___ @@ -421,7 +421,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L164) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L164) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L179) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L179) ___ @@ -458,7 +458,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L213) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -480,7 +480,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L226) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L226) ___ @@ -503,7 +503,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L200) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L200) ___ @@ -531,7 +531,7 @@ Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exc #### Defined in -[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L240) +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L240) ___ @@ -555,7 +555,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L306) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L306) ___ @@ -580,7 +580,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L280) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L280) ___ @@ -606,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged - use [ #### Defined in -[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyUserAPI.ts#L252) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/agreementattributes.md b/docs/interfaces/agreementattributes.md index efdd0fc..11eab1a 100644 --- a/docs/interfaces/agreementattributes.md +++ b/docs/interfaces/agreementattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L10) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L13) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L12) +[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L7) +[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L7) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L8) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L13) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L8) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L14) +[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L14) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L10) diff --git a/docs/interfaces/companyattributes.md b/docs/interfaces/companyattributes.md index 3304ed3..762ddcc 100644 --- a/docs/interfaces/companyattributes.md +++ b/docs/interfaces/companyattributes.md @@ -19,7 +19,7 @@ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L8) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L8) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L7) +[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L7) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/CompanyResource.ts#L9) +[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L9) diff --git a/docs/interfaces/employeeattributes.md b/docs/interfaces/employeeattributes.md index d1b8e32..068ac36 100644 --- a/docs/interfaces/employeeattributes.md +++ b/docs/interfaces/employeeattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L32) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L33) +[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L33) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L32) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L35) +[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L35) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L29) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L28) +[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L28) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L29) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L30) +[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L30) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L34) +[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L34) diff --git a/docs/interfaces/employeefilterfields.md b/docs/interfaces/employeefilterfields.md index cc0f97a..b15dd31 100644 --- a/docs/interfaces/employeefilterfields.md +++ b/docs/interfaces/employeefilterfields.md @@ -25,7 +25,7 @@ #### Defined in -[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L13) +[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L13) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L12) +[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L12) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L15) +[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L15) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L16) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L17) +[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L17) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L14) +[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L14) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L18) +[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L18) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L20) +[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L20) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/EmployeeResource.ts#L21) +[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L21) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 25919d5..975ccc1 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -11,7 +11,7 @@ and for events, use [EnvoyEntryEventRequest](../README.md#envoyentryeventrequest | Name | Type | | :------ | :------ | -| `Meta` | `Meta`: `EnvoyMeta` = `EnvoyMeta` | +| `Meta` | `Meta` = `EnvoyMeta` | | `Payload` | `Payload` = `unknown` | ## Hierarchy @@ -35,11 +35,11 @@ and for events, use [EnvoyEntryEventRequest](../README.md#envoyentryeventrequest #### Inherited from -VerifiedRequest.\_\_@VERIFIED@1256 +VerifiedRequest.\_\_@VERIFIED@1305 #### Defined in -[sdk/EnvoyRequest.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L16) +[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L23) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyRequest.ts#L28) +[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L35) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index f8def89..5b05e90 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -1,8 +1,14 @@ [@envoy/envoy-integrations-sdk](../README.md) / EnvoyResponse -# Interface: EnvoyResponse +# Interface: EnvoyResponse -Use to type your `res` object in Envoy request handlers. +Use to type your `res` object in Envoy event handlers. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Body` | `Body` = `unknown` | ## Hierarchy @@ -23,21 +29,21 @@ Use to type your `res` object in Envoy request handlers. ### send -• **send**: (`debugInfo?`: `unknown`) => [EnvoyResponse](envoyresponse.md) +• **send**: (`body?`: `Body`) => [EnvoyResponse](envoyresponse.md) #### Type declaration -▸ (`debugInfo?`): [EnvoyResponse](envoyresponse.md) +▸ (`body?`): [EnvoyResponse](envoyresponse.md) ##### Parameters | Name | Type | | :------ | :------ | -| `debugInfo?` | `unknown` | +| `body?` | `Body` | ##### Returns -[EnvoyResponse](envoyresponse.md) +[EnvoyResponse](envoyresponse.md) #### Overrides @@ -45,7 +51,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L9) +[sdk/EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L11) ___ @@ -73,7 +79,7 @@ Marks the job as "failed". The message will be communicated to the Envoy Dashboa #### Defined in -[sdk/EnvoyResponse.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L24) +[sdk/EnvoyResponse.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L26) ___ @@ -101,7 +107,7 @@ Marks the job as "ignored". Useful when you explicitly do not want to handle the #### Defined in -[sdk/EnvoyResponse.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L19) +[sdk/EnvoyResponse.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L21) ___ @@ -129,4 +135,4 @@ Later on, you should update the job using #### Defined in -[sdk/EnvoyResponse.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/sdk/EnvoyResponse.ts#L15) +[sdk/EnvoyResponse.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L17) diff --git a/docs/interfaces/flowattributes.md b/docs/interfaces/flowattributes.md index 09a2203..44e8483 100644 --- a/docs/interfaces/flowattributes.md +++ b/docs/interfaces/flowattributes.md @@ -20,7 +20,7 @@ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L22) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L20) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L22) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L20) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L23) +[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L23) diff --git a/docs/interfaces/flowfilterfields.md b/docs/interfaces/flowfilterfields.md index 3177add..e79b7c5 100644 --- a/docs/interfaces/flowfilterfields.md +++ b/docs/interfaces/flowfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L11) +[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L11) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/FlowResource.ts#L13) +[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L13) diff --git a/docs/interfaces/inviteattributes.md b/docs/interfaces/inviteattributes.md index 7bd78e3..d83d08c 100644 --- a/docs/interfaces/inviteattributes.md +++ b/docs/interfaces/inviteattributes.md @@ -34,7 +34,7 @@ #### Defined in -[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L28) +[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L28) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L29) +[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L29) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L55) +[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L55) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L56) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L59) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L53) +[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L53) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L45) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L56) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L45) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L46) +[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L46) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L47) +[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L47) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L48) +[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L48) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L49) +[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L49) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L52) +[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L52) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L59) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L50) +[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L50) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L57) +[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L57) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L60) +[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L60) ___ @@ -222,4 +222,4 @@ ___ #### Defined in -[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L51) +[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L51) diff --git a/docs/interfaces/invitecreationattributes.md b/docs/interfaces/invitecreationattributes.md index 93830eb..67db9bf 100644 --- a/docs/interfaces/invitecreationattributes.md +++ b/docs/interfaces/invitecreationattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L75) +[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L75) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L68) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L68) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L69) +[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L69) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L70) +[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L70) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L73) +[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L73) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L76) +[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L76) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L71) +[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L71) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L72) +[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L72) diff --git a/docs/interfaces/invitefilterfields.md b/docs/interfaces/invitefilterfields.md index 5cfe0e1..9f212c4 100644 --- a/docs/interfaces/invitefilterfields.md +++ b/docs/interfaces/invitefilterfields.md @@ -26,7 +26,7 @@ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L15) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L16) +[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L16) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L17) +[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L17) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L18) +[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L18) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L12) +[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L12) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L13) +[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L20) +[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L20) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L14) +[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L14) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L19) +[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L19) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L15) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/InviteResource.ts#L22) +[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L22) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index c77a358..ab6fca3 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/locationattributes.md b/docs/interfaces/locationattributes.md index 1be233d..c5ebee1 100644 --- a/docs/interfaces/locationattributes.md +++ b/docs/interfaces/locationattributes.md @@ -52,7 +52,7 @@ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L21) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L21) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L22) +[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L22) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L42) +[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L42) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L40) +[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L40) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L41) +[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L41) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L24) +[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L24) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L30) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L54) +[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L54) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L35) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L43) +[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L43) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L46) +[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L46) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L27) +[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L27) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L29) +[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L29) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L31) +[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L31) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L32) +[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L32) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L33) +[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L33) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L28) +[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L28) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L47) +[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L47) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L20) +[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L20) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L48) +[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L48) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L44) +[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L44) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L45) +[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L45) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L49) +[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L49) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L36) +[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L36) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L37) +[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L37) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L50) +[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L50) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L25) +[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L25) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L30) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L51) +[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L51) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L55) +[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L55) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L38) +[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L38) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L52) +[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L52) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L35) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L53) +[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L53) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L39) +[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L39) ___ @@ -412,4 +412,4 @@ ___ #### Defined in -[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L26) +[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L26) diff --git a/docs/interfaces/locationfilterfields.md b/docs/interfaces/locationfilterfields.md index a69d8df..0379112 100644 --- a/docs/interfaces/locationfilterfields.md +++ b/docs/interfaces/locationfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L13) +[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L13) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/LocationResource.ts#L12) +[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L12) diff --git a/docs/interfaces/signinfieldattributes.md b/docs/interfaces/signinfieldattributes.md index 7aca3a5..d4720fd 100644 --- a/docs/interfaces/signinfieldattributes.md +++ b/docs/interfaces/signinfieldattributes.md @@ -25,7 +25,7 @@ #### Defined in -[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L18) +[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L18) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L10) +[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L10) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L11) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L8) +[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L8) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L11) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L7) +[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L7) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L17) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L9) +[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L9) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L17) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/b26deae/src/resources/SignInFieldResource.ts#L19) +[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L19) diff --git a/package-lock.json b/package-lock.json index 1763679..836be78 100644 --- a/package-lock.json +++ b/package-lock.json @@ -217,6 +217,11 @@ "@types/range-parser": "*" } }, + "@types/faker": { + "version": "5.5.6", + "resolved": "https://registry.npmjs.org/@types/faker/-/faker-5.5.6.tgz", + "integrity": "sha512-UCRj0kLg4sXs2XFVm48OU/wIjyJZkpRkwxhRGVQb5l5GmemkeW22WTz9iiDhYPBUqTzDsIWzhFRuF/4DD5+q2Q==" + }, "@types/json-schema": { "version": "7.0.7", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", @@ -763,6 +768,11 @@ "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", "integrity": "sha1-+OcRMvf/5uAaXJaXpMbz5I1cyBk=" }, + "buffer-from": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", + "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==" + }, "bytes": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", @@ -880,6 +890,16 @@ } } }, + "clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "requires": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + } + }, "code-point-at": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", @@ -1883,6 +1903,20 @@ "strip-eof": "^1.0.0" } }, + "factory.ts": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/factory.ts/-/factory.ts-0.5.2.tgz", + "integrity": "sha512-I4YDKuyMW+s2PocnWh/Ekv9wSStt/MNN1ZRb1qhy0Kv056ndlzbLHDsW9KEmTAqMpLI3BtjSqEdZ7ZfdnaXn9w==", + "requires": { + "clone-deep": "^4.0.1", + "source-map-support": "^0.5.19" + } + }, + "faker": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/faker/-/faker-5.5.3.tgz", + "integrity": "sha512-wLTv2a28wjUyWkbnX7u/ABZBkUkIF2fCd73V6P2oFqEGEktDfzWx4UxrSqtPRw0xPRAcjeAOIiJWqZm3pP4u3g==" + }, "fast-deep-equal": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", @@ -2381,6 +2415,14 @@ "integrity": "sha1-iVJojF7C/9awPsyF52ngKQMINHA=", "dev": true }, + "is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "requires": { + "isobject": "^3.0.1" + } + }, "is-regex": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", @@ -2417,6 +2459,11 @@ "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", "dev": true }, + "isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=" + }, "js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -2635,6 +2682,11 @@ "safe-buffer": "^5.0.1" } }, + "kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==" + }, "klaw": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", @@ -3741,6 +3793,14 @@ "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz", "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==" }, + "shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "requires": { + "kind-of": "^6.0.2" + } + }, "shebang-command": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", @@ -3876,8 +3936,16 @@ "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" + }, + "source-map-support": { + "version": "0.5.19", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", + "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", + "requires": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } }, "spdx-correct": { "version": "3.1.1", diff --git a/package.json b/package.json index 6fcfcaf..98d2a75 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,7 @@ "dependencies": { "@types/dotenv": "^8.2.0", "@types/express": "^4.17.12", + "@types/faker": "^5.5.6", "@types/jsonwebtoken": "^8.5.1", "@types/node": "^15.12.0", "@types/qs": "^6.9.6", @@ -38,6 +39,8 @@ "body-parser": "^1.19.0", "dataloader": "^2.0.0", "dotenv": "^10.0.0", + "factory.ts": "^0.5.2", + "faker": "^5.5.3", "jsonwebtoken": "^8.5.1", "qs": "^6.10.1" }, diff --git a/src/factories/EnvoyEntryEventRequestFactory.ts b/src/factories/EnvoyEntryEventRequestFactory.ts deleted file mode 100644 index e69de29..0000000 diff --git a/src/factories/entryEventRequestFactory.ts b/src/factories/entryEventRequestFactory.ts new file mode 100644 index 0000000..6031b50 --- /dev/null +++ b/src/factories/entryEventRequestFactory.ts @@ -0,0 +1,108 @@ +import { Sync, each } from 'factory.ts'; +import faker from 'faker'; + +import EntryPayload from '../payloads/EntryPayload'; +import EnvoyEntryEvent from '../internal/EnvoyEntryEvent'; +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; +import EnvoyRequest, { EnvoyEntryEventRequest } from '../sdk/EnvoyRequest'; +import eventRequestFactory from './eventRequestFactory'; + +export type EntryPayloadFactoryOptions = { + isSignedIn: boolean, + hasEmail: boolean, + hasPhoneNumber: boolean, + hasPhoto: boolean, + isProtectFlow: boolean, + nonProtectFlowOptions: { + hasHost: boolean, + hasInvite: boolean, + hasDevice: boolean, + } +}; + +export const defaultIds = { + location: '1', + flow: '1', + invite: '1', + device: '1', +}; + +export function entryPayloadFactory(options: EntryPayloadFactoryOptions, ids = defaultIds): Sync.Factory { + const signedInDate = faker.date.past(); + return Sync.makeFactory({ + id: each((i) => `${i}`), + type: 'entries', + attributes: { + 'full-name': faker.name.findName(), + 'phone-number': options.hasPhoneNumber ? faker.phone.phoneNumber() : undefined, + email: options.hasEmail ? faker.internet.email() : null, + 'employee-screening-flow': options.isProtectFlow, + host: (!options.isProtectFlow && options.nonProtectFlowOptions.hasHost) ? faker.name.findName() : null, + 'host-email': (!options.isProtectFlow && options.nonProtectFlowOptions.hasHost) ? faker.internet.email() : null, + 'private-notes': null, + 'signed-in-at': signedInDate.toUTCString(), + 'signed-out-at': options.isSignedIn ? undefined : faker.date.between(signedInDate, new Date()).toUTCString(), + thumbnails: options.hasPhoto ? { + large: faker.image.avatar(), + original: faker.image.avatar(), + small: faker.image.avatar(), + } : { + large: null, + original: null, + small: null, + }, + 'flow-name': options.isProtectFlow ? 'Employee registration' : 'Visitor', + 'user-data': [] as Array<{ field: string, value: string | null }>, + }, + relationships: { + location: { + data: { + id: ids.location, + type: 'locations', + }, + }, + flow: { + data: { + id: ids.flow, + type: 'flows', + }, + }, + invite: (options.isProtectFlow || options.nonProtectFlowOptions.hasInvite) ? { + data: { + id: ids.invite, + type: 'invites', + }, + } : undefined, + device: (!options.isProtectFlow && options.nonProtectFlowOptions.hasInvite) ? { + data: { + id: ids.device, + type: 'devices', + }, + } : undefined, + }, + }); +} + +export default function entryEventRequestFactory( + req: EnvoyRequest, + options: { + event: EnvoyEntryEvent, + config: Record, + scope: Array, + payloadOptions: EntryPayloadFactoryOptions, + ids?: typeof defaultIds, + isVerified?: boolean, + pluginAccessToken?: string, + }, +): EnvoyEntryEventRequest { + const ids = options.ids || defaultIds; + return eventRequestFactory(req, { + event: options.event, + config: options.config, + scope: options.scope, + locationId: ids.location, + isVerified: options.isVerified, + pluginAccessToken: options.pluginAccessToken, + payload: entryPayloadFactory(options.payloadOptions, ids).build(), + }) as EnvoyEntryEventRequest; +} diff --git a/src/factories/eventRequestFactory.ts b/src/factories/eventRequestFactory.ts new file mode 100644 index 0000000..11a831c --- /dev/null +++ b/src/factories/eventRequestFactory.ts @@ -0,0 +1,36 @@ +import faker from 'faker'; +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; +import EnvoyRequest from '../sdk/EnvoyRequest'; +import { eventMetaFactory } from './metaFactory'; +import EnvoyPluginSDK from '../sdk/EnvoyPluginSDK'; +import { EnvoyEventMeta } from '../sdk/EnvoyMeta'; + +export default function eventRequestFactory< + Event extends string = string, + Payload extends Record = Record, + >( + req: EnvoyRequest, + options: { + event: Event, + config: Record, + payload: Payload, + scope: Array, + locationId: string, + isVerified?: boolean, + pluginAccessToken?: string, + }, +): EnvoyRequest { + const body = { + meta: eventMetaFactory( + options.event, + options.config, + options.scope, + options.locationId, + ).build(), + payload: options.payload, + }; + const isVerified = options.isVerified === undefined ? true : options.isVerified; + const pluginAccessToken = options.pluginAccessToken === undefined ? faker.random.word() : options.pluginAccessToken; + req.envoy = new EnvoyPluginSDK(body, isVerified, pluginAccessToken); + return req; +} diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts new file mode 100644 index 0000000..212fb91 --- /dev/null +++ b/src/factories/metaFactory.ts @@ -0,0 +1,99 @@ +import { Sync } from 'factory.ts'; +import faker from 'faker'; +import { + EnvoyEventMeta, EnvoyMetaAuth, EnvoyMetaCompany, EnvoyMetaJob, EnvoyMetaLocation, EnvoyRouteMeta, +} from '../sdk/EnvoyMeta'; +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; + +export function jobFactory(name: string): Sync.Factory { + return Sync.makeFactory({ + id: faker.datatype.uuid(), + identifier: faker.datatype.string(), + name, + }); +} + +export function locationFactory(id: string): Sync.Factory { + const cityName = faker.address.cityName(); + const street = faker.address.streetAddress(); + return Sync.makeFactory({ + id, + type: 'locations', + attributes: { + name: cityName, + 'company-name-override': null, + timezone: faker.address.timeZone(), + locale: null, + address: street, + 'address-line-one': street, + 'address-line-two': null, + city: cityName, + state: faker.address.stateAbbr(), + country: faker.address.country(), + zip: faker.address.zipCode(), + longitude: null, + latitude: null, + 'created-at': faker.date.past().toUTCString(), + }, + }); +} + +export function companyFactory(): Sync.Factory { + return Sync.makeFactory({ + id: faker.datatype.number().toString(), + type: 'companies', + attributes: { + name: faker.company.companyName(), + active: true, + 'created-at': faker.date.past().toUTCString(), + }, + }); +} + +export function authFactory(): Sync.Factory { + return Sync.makeFactory({ + token_type: 'Bearer', + access_token: faker.random.alphaNumeric(), + expires_in: faker.date.future().getSeconds(), + refresh_token: null, + refresh_token_expires_in: null, + }); +} + +export function routeMetaFactory( + route: string, + config: Record, + params: Record, + scope: Array, + locationId: string, +): Sync.Factory { + return Sync.makeFactory({ + plugin_id: faker.datatype.uuid(), + install_id: faker.datatype.number().toString(), + location: locationFactory(locationId).build(), + company: companyFactory().build(), + auth: scope.length ? authFactory().build() : null, + forwarded_bearer_token: faker.random.alphaNumeric(), + route, + config, + params, + }); +} + +export function eventMetaFactory( + event: string, + config: Record, + scope: Array, + locationId: string, +): Sync.Factory { + return Sync.makeFactory({ + plugin_id: faker.datatype.uuid(), + install_id: faker.datatype.number().toString(), + job: jobFactory(event).build(), + location: locationFactory(locationId).build(), + company: companyFactory().build(), + auth: scope.length ? authFactory().build() : null, + event, + config, + }); +} diff --git a/src/factories/routeRequestFactory.ts b/src/factories/routeRequestFactory.ts new file mode 100644 index 0000000..f18efb5 --- /dev/null +++ b/src/factories/routeRequestFactory.ts @@ -0,0 +1,35 @@ +import faker from 'faker'; +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; +import EnvoyRequest from '../sdk/EnvoyRequest'; +import { routeMetaFactory } from './metaFactory'; +import EnvoyPluginSDK from '../sdk/EnvoyPluginSDK'; +import { EnvoyRouteMeta } from '../sdk/EnvoyMeta'; + +export default function routeRequestFactory = Record>( + req: EnvoyRequest, + options: { + route: string, + config: Record, + params: Record, + payload: Payload, + scope: Array, + locationId: string, + isVerified?: boolean, + pluginAccessToken?: string, + }, +): EnvoyRequest { + const body = { + meta: routeMetaFactory( + options.route, + options.config, + options.params, + options.scope, + options.locationId, + ).build(), + payload: options.payload, + }; + const isVerified = options.isVerified === undefined ? true : options.isVerified; + const pluginAccessToken = options.pluginAccessToken === undefined ? faker.random.word() : options.pluginAccessToken; + req.envoy = new EnvoyPluginSDK(body, isVerified, pluginAccessToken); + return req; +} diff --git a/src/index.ts b/src/index.ts index a3c7434..63e1f1c 100644 --- a/src/index.ts +++ b/src/index.ts @@ -29,6 +29,7 @@ export * from './resources/UserResource'; export * from './sdk/EnvoyMeta'; export * from './sdk/EnvoyRequest'; +export * from './sdk/EnvoyResponse'; export * from './util/EnvoySignatureVerifier'; diff --git a/src/internal/EnvoyEntryEvent.ts b/src/internal/EnvoyEntryEvent.ts new file mode 100644 index 0000000..8c379dd --- /dev/null +++ b/src/internal/EnvoyEntryEvent.ts @@ -0,0 +1,10 @@ +type EnvoyEntryEvent = + 'entry_sign_in' | + 'entry_sign_out' | + 'entry_blacklist_review' | + 'entry_blacklist_deny' | + 'employee_entry_sign_in' | + 'employee_entry_sign_out' | + string; + +export default EnvoyEntryEvent; diff --git a/src/internal/EnvoyInviteEvent.ts b/src/internal/EnvoyInviteEvent.ts new file mode 100644 index 0000000..8af2f0f --- /dev/null +++ b/src/internal/EnvoyInviteEvent.ts @@ -0,0 +1,13 @@ +type EnvoyInviteEvent = + 'invite_created' | + 'invite_updated' | + 'invite_removed' | + 'upcoming_visit' | + 'qr_code_sent' | + 'employee_invite_created' | + 'employee_invite_updated' | + 'employee_invite_removed' | + 'employee_upcoming_visit' | + string; + +export default EnvoyInviteEvent; diff --git a/src/internal/EnvoyOption.ts b/src/internal/EnvoyOption.ts new file mode 100644 index 0000000..edebdea --- /dev/null +++ b/src/internal/EnvoyOption.ts @@ -0,0 +1,6 @@ +type EnvoyOption = { + label: string, + value: string, +}; + +export default EnvoyOption; diff --git a/src/internal/EnvoyOptionsRouteParams.ts b/src/internal/EnvoyOptionsRouteParams.ts new file mode 100644 index 0000000..c6205f8 --- /dev/null +++ b/src/internal/EnvoyOptionsRouteParams.ts @@ -0,0 +1,7 @@ +type EnvoyOptionsRouteParams = { + search?: string, + page?: number, + cursor?: string, +}; + +export default EnvoyOptionsRouteParams; diff --git a/src/internal/EnvoyOptionsRouteResponseBody.ts b/src/internal/EnvoyOptionsRouteResponseBody.ts new file mode 100644 index 0000000..1dbe54e --- /dev/null +++ b/src/internal/EnvoyOptionsRouteResponseBody.ts @@ -0,0 +1,4 @@ +import EnvoyOption from './EnvoyOption'; + +type EnvoyOptionsRouteResponseBody = Array; +export default EnvoyOptionsRouteResponseBody; diff --git a/src/internal/EnvoyRemoteValueRouteResponseBody.ts b/src/internal/EnvoyRemoteValueRouteResponseBody.ts new file mode 100644 index 0000000..7254e29 --- /dev/null +++ b/src/internal/EnvoyRemoteValueRouteResponseBody.ts @@ -0,0 +1,4 @@ +type EnvoyRemoteValueRouteResponseBody = { + value: string, +}; +export default EnvoyRemoteValueRouteResponseBody; diff --git a/src/internal/EnvoySelectedValuesRouteParams.ts b/src/internal/EnvoySelectedValuesRouteParams.ts new file mode 100644 index 0000000..86815b3 --- /dev/null +++ b/src/internal/EnvoySelectedValuesRouteParams.ts @@ -0,0 +1,5 @@ +type EnvoySelectedValuesRouteParams = { + value: Array | string, +}; + +export default EnvoySelectedValuesRouteParams; diff --git a/src/internal/EnvoySelectedValuesRouteResponseBody.ts b/src/internal/EnvoySelectedValuesRouteResponseBody.ts new file mode 100644 index 0000000..d3fe536 --- /dev/null +++ b/src/internal/EnvoySelectedValuesRouteResponseBody.ts @@ -0,0 +1,4 @@ +import EnvoyOption from './EnvoyOption'; + +type EnvoySelectedValuesRouteResponseBody = EnvoyOption; +export default EnvoySelectedValuesRouteResponseBody; diff --git a/src/sdk/EnvoyMeta.ts b/src/sdk/EnvoyMeta.ts index e8b8030..2e501af 100644 --- a/src/sdk/EnvoyMeta.ts +++ b/src/sdk/EnvoyMeta.ts @@ -1,9 +1,9 @@ /** * @category Meta */ -export type EnvoyMetaJob = { +export type EnvoyMetaJob = { id: string, - name: string, + name: Event, identifier: string, }; @@ -63,12 +63,12 @@ export type EnvoyMetaAuth = { * * @category Meta */ -export type EnvoyEventMeta = { - event: string, +export type EnvoyEventMeta> = { + event: Event, plugin_id: string, install_id: string, - config: Record, - job: EnvoyMetaJob, + config: Config, + job: EnvoyMetaJob, location: EnvoyMetaLocation, company: EnvoyMetaCompany, auth: EnvoyMetaAuth | null, @@ -80,12 +80,12 @@ export type EnvoyEventMeta = { * * @category Meta */ -export type EnvoyRouteMeta = { +export type EnvoyRouteMeta, Params = Record> = { route: string, plugin_id: string, install_id: string, - config: Record, - params: Record, + config: Config, + params: Params, location: EnvoyMetaLocation, company: EnvoyMetaCompany, auth: EnvoyMetaAuth | null, diff --git a/src/sdk/EnvoyPluginSDK.ts b/src/sdk/EnvoyPluginSDK.ts index 1bad59a..d6999e9 100644 --- a/src/sdk/EnvoyPluginSDK.ts +++ b/src/sdk/EnvoyPluginSDK.ts @@ -21,7 +21,7 @@ export interface EnvoyRequestBody { * * @category SDK */ -export default class EnvoyPluginSDK { +export default class EnvoyPluginSDK { /** * Body of the request. * use `meta` or `payload` to access the relevant properties, @@ -82,11 +82,11 @@ export default class EnvoyPluginSDK extends VerifiedRequest { +export interface EnvoyBaseRequest extends VerifiedRequest { envoy: EnvoyPluginSDK } /** - * Use to type your `req` object in route handlers, - * such as validation URLS or options URLs. + * Use to type your `req` object in Envoy route handlers such as validation URLs. * * @category Request */ -export type EnvoyRouteRequest = EnvoyBaseRequest; +export type EnvoyRouteRequest< + Payload = unknown, + Config = Record, + Params = Record, + > = EnvoyBaseRequest, Payload>; + +/** + * Use to type your `req` object in Envoy "options URL" route handlers. + * + * @category Request + */ +export type EnvoyOptionsRouteRequest> = + EnvoyRouteRequest; + +/** + * Use to type your `req` object in Envoy "selected values URL" route handlers. + * + * @category Request + */ +export type EnvoySelectedValuesRouteRequest> = + EnvoyRouteRequest; + +/** + * Use to type your `req` object in Envoy "remote value URL" route handlers. + * + * @category Request + */ +export type EnvoyRemoteValueRouteRequest> = + EnvoyRouteRequest; /** * Base type for event requests. @@ -42,7 +76,8 @@ export type EnvoyRouteRequest = EnvoyBaseRequest = EnvoyBaseRequest; +export type EnvoyEventRequest = + EnvoyBaseRequest, Payload>; /** * Use to type your `req` object in entry event handlers, @@ -50,7 +85,7 @@ export type EnvoyEventRequest = EnvoyBaseRequest; +export type EnvoyEntryEventRequest = EnvoyEventRequest; /** * Use to type your `req` object in invite event handlers, @@ -58,14 +93,14 @@ export type EnvoyEntryEventRequest = EnvoyEventRequest; * * @category Request */ -export type EnvoyInviteEventRequest = EnvoyEventRequest; +export type EnvoyInviteEventRequest = EnvoyEventRequest; /** * You probably won't need to use this type directly. * For routes, use {@link EnvoyRouteRequest}, * and for events, use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}. * - * @category Request + * @category Base */ type EnvoyRequest = EnvoyBaseRequest; export default EnvoyRequest; diff --git a/src/sdk/EnvoyResponse.ts b/src/sdk/EnvoyResponse.ts index 81eb872..d90b8fc 100644 --- a/src/sdk/EnvoyResponse.ts +++ b/src/sdk/EnvoyResponse.ts @@ -1,12 +1,14 @@ import { Response } from 'express'; import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; +import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody'; +import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody'; /** - * Use to type your `res` object in Envoy request handlers. + * Use to type your `res` object in Envoy event handlers. * @category Response */ -export default interface EnvoyResponse extends Response { - send: (debugInfo?: unknown) => this; +export default interface EnvoyResponse extends Response { + send: (body?: Body) => this; /** * Marks the job as "ongoing". This is useful for long-running event handling. * Later on, you should update the job using @@ -23,3 +25,15 @@ export default interface EnvoyResponse extends Response { */ sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array) => void; } + +/** + * Use to type your `res` object in Envoy "options URL" route handlers. + * @category Response + */ +export type EnvoyOptionsRouteResponse = EnvoyResponse; + +/** + * Use to type your `res` object in Envoy "selected values URL" route handlers. + * @category Response + */ +export type EnvoySelectedValuesRouteResponse = EnvoyResponse; diff --git a/src/sdk/EnvoyUserAPI.ts b/src/sdk/EnvoyUserAPI.ts index 2fb770f..b212afd 100644 --- a/src/sdk/EnvoyUserAPI.ts +++ b/src/sdk/EnvoyUserAPI.ts @@ -17,7 +17,7 @@ import { UserModel } from '../resources/UserResource'; import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; -type EnvoyUserAPIScope = +export type EnvoyUserAPIScope = 'flows.read' | 'entries.read' | 'entries.write' | From 5115782120acddc61fc0db35bd907a88c9e60b22 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sun, 13 Jun 2021 16:40:06 -0400 Subject: [PATCH 32/91] docs --- .eslintrc.js | 3 +- .npmignore | 2 + .nvmrc | 1 + README.md | 258 +- docs/README.md | 935 ++++++- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 20 +- docs/classes/envoypluginjob.md | 16 +- docs/classes/envoypluginsdk.md | 26 +- docs/classes/envoypluginstorage.md | 52 +- docs/classes/envoyuserapi.md | 50 +- docs/interfaces/agreementattributes.md | 18 +- docs/interfaces/companyattributes.md | 8 +- docs/interfaces/employeeattributes.md | 18 +- docs/interfaces/employeefilterfields.md | 20 +- docs/interfaces/envoybaserequest.md | 6 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/flowattributes.md | 10 +- docs/interfaces/flowfilterfields.md | 4 +- docs/interfaces/inviteattributes.md | 38 +- docs/interfaces/invitecreationattributes.md | 18 +- docs/interfaces/invitefilterfields.md | 22 +- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/locationattributes.md | 74 +- docs/interfaces/locationfilterfields.md | 4 +- docs/interfaces/signinfieldattributes.md | 20 +- package-lock.json | 2258 ++++++----------- package.json | 12 +- src/index.ts | 11 +- .../EnvoySelectedValuesRouteResponseBody.ts | 2 +- src/sdk/EnvoyPluginStorage.ts | 16 +- src/sdk/EnvoyRequest.ts | 29 +- src/sdk/EnvoyResponse.ts | 7 + src/sdk/EnvoyStorageItem.ts | 4 +- src/sdk/asyncHandler.ts | 22 - src/sdk/errorMiddleware.ts | 21 - src/sdk/filters.ts | 96 + src/sdk/handlers.ts | 195 ++ src/sdk/middleware.ts | 65 +- 39 files changed, 2355 insertions(+), 2024 deletions(-) create mode 100644 .npmignore create mode 100644 .nvmrc delete mode 100644 src/sdk/asyncHandler.ts delete mode 100644 src/sdk/errorMiddleware.ts create mode 100644 src/sdk/filters.ts create mode 100644 src/sdk/handlers.ts diff --git a/.eslintrc.js b/.eslintrc.js index 25f4aad..731d9fc 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -11,7 +11,7 @@ module.exports = { rules: { 'no-param-reassign': 'off', 'no-void': 'off', - 'max-len': ["error", { "code": 120 }], + 'max-len': ["error", { "code": 150 }], 'consistent-return': 'off', '@typescript-eslint/no-unsafe-assignment': 'off', '@typescript-eslint/no-unsafe-return': 'off', @@ -20,6 +20,7 @@ module.exports = { '@typescript-eslint/no-misused-promises': 'off', '@typescript-eslint/no-unused-expressions': 'off', '@typescript-eslint/restrict-template-expressions': 'off', + '@typescript-eslint/explicit-module-boundary-types': 'off' }, overrides: [ { diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..e0e2404 --- /dev/null +++ b/.npmignore @@ -0,0 +1,2 @@ +.idea +.github diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..8351c19 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +14 diff --git a/README.md b/README.md index 050cbdf..ed04073 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Envoy Node.js SDK -The SDK exports several classes and functions, however the most typical way to integrate the SDK is as middleware. The `middleware()` function call returns a middleware that attaches an instance of `EnvoyPluginSDK` to the `req` object and verifies that the request came from Envoy. It is available as `req.envoy`. +The SDK exports several classes and functions, however the most typical way to integrate the SDK is as middleware. The `envoyMiddleware()` function call returns a middleware that attaches an instance of `EnvoyPluginSDK` to the `req` object and verifies that the request came from Envoy. It is available as `req.envoy`. ## Installation @@ -25,109 +25,175 @@ View our Node.js [quickstart guide](https://developers.envoy.com/hub/docs/nodejs ### Usage -Here's the typical SDK usage at a glance. +#### Define your `config` +When customers go through your integration's setup steps, that info is saved in a `config` object that is sent along with every request Envoy makes to your integration. -```javascript -const express = require('express'); -const { middleware, errorMiddleware, asyncHandler } = require('@envoy/envoy-integrations-sdk'); +Defining this object as a specific type allows us to safely type the various handlers that will use those values. +```typescript +// defs/Config.ts +type Config = { + greeting: string +}; +export default Config; +``` + +#### Implement setup routes +As customers go through the setup steps of your integration, they may trigger several requests to your integration for things like: +- loading dropdown options +- loading text fields with remote data +- validating submitted step data + +Below, we'll implement a route that will load a list of greetings into a dropdown in our setup steps. + +View the other types of handlers. + +```typescript +// greetingOptions.ts +import { optionsRouteHandler } from '@envoy/envoy-integrations-sdk'; + +export default optionsRouteHandler((req, res) => { + res.send([ + { + label: 'Hello', + value: 'Hello', + }, + { + label: 'Hola', + value: 'Hola', + }, + { + label: 'Aloha', + value: 'Aloha', + }, + ]); +}); +``` + +#### Implement event handlers +Your integration can respond to several Envoy events. Below, we'll implement a simple event handler for an `entry_sign_in` event. + +All it does is to take the greeting that the customer chose during setup, and displays it in the Envoy Dashboard when a visitor signs in. +```typescript +// entrySignIn.ts +import { entryEventHandler } from '@envoy/envoy-integrations-sdk'; +import Config from './defs/Config'; + +export default entryEventHandler(async (req, res) => { + const { envoy } = req; + const { job, meta, payload: visitor } = envoy; + const hello = `${meta.config.greeting} ${visitor.attributes['full-name']}!`; // our custom greeting + await job.attach({ label: 'Greeting', value: hello }); // show in the Envoy dashboard. + res.send({ hello }); +}); +``` + + +#### Setup your `express.js` app + +```typescript +// index.ts +import express from 'express'; +import { envoyMiddleware, errorMiddleware } from '@envoy/envoy-integrations-sdk'; + +import greetingOptions from './greetingOptions'; +import entrySignIn from './entrySignIn' const app = express(); +app.use(envoyMiddleware()); +app.post('/greeting-options', greetingOptions); +app.post('/entry-sign-in', entrySignIn); +app.use(errorMiddleware()); +app.listen(process.env.PORT); +``` + +#### More examples +Here's some more things you can do with the `req.envoy` object. +```typescript + /** + * @type EnvoyPluginSDK + */ +const { envoy } = req; // "envoy" is the SDK +const { + meta, // the platform event request_meta object + payload, // the platform event request_body object + userAPI, // user-scoped API calls, used in routes + pluginAPI, // plugin-scoped API calls, for plugin services + installStorage, // install-scoped storage + globalStorage, // global-scoped storage + job, // update the job (if in an event handler) + jwt, // helper to encode/decode jwts +} = envoy; + +/** + * User API usage + */ +const visitorTypes = await userAPI.getFlows({ filter: { location: '1' } }); + +/** + * Storage usage + * The below can be used both at the install level or global level + */ +await installStorage.set('foo', 'bar'); // sets foo=bar in storage for this install +const { value } = await installStorage.get('foo'); // also gets the current value of foo +const { value } = await installStorage.setUnique('foo'); // creates and returns a unique text value for foo +const { value } = await installStorage.get('foo'); // also gets the current value of foo +const { value } = await installStorage.setUniqueNum('foo'); // creates and returns a unique number for foo +const { value } = await installStorage.get('foo'); // also gets the current value of foo +await installStorage.unset('foo'); // deletes foo /** - * "middleware()" returns an instance of bodyParser.json, - * that also verifies the Envoy signature in addition to - * parsing the request body as JSON. + * You can also send multiple commands at once, + * to be executed in the same transaction. + * The response will be an array of the results of each command, in order. */ -app.use(middleware()); +const results = await installStorage.pipeline().set('foo1', 'bar').unset('foo2').get('foo3').execute(); -app.post('/url-to-a-route-or-worker', asyncHandler(async (req, res) => { +/** + * Job updates + * Note that job.complete can take any number of attachments after the first argument. + */ +await job.complete('Credentials provisioned.', { label: 'password', value: 'password' }); +await job.ignore('No credentials provisioned.', 'Email was not supplied.'); +await job.fail('Could not provision credentials.', 'Server could not be reached.'); +/** + * You can also just attach things without completing the job. + * Attach more things by providing more arguments. + */ +await job.attach({ type: 'text', label: 'foo', value: 'bar' }); +/** + * If the job is some multi-step process, + * you can update it's message without changing the status. + * You can also optionally attach things by providing more arguments. + */ +await job.update('Still working...'); - /** - * @type EnvoyPluginSDK - */ - const { envoy } = req; // "envoy" is the SDK - const { - meta, // the platform event request_meta object - payload, // the platform event request_body object - userAPI, // user-scoped API calls, used in routes - pluginAPI, // plugin-scoped API calls, for plugin services - installStorage, // install-scoped storage - globalStorage, // global-scoped storage - job, // update the job (if in a worker) - jwt, // helper to encode/decode jwts - } = envoy; - - /** - * User API usage - */ - const visitorTypes = await userAPI.flows(locationId); - - /** - * Storage usage - * The below can be used both at the install level or global level - */ - await installStorage.set('foo', 'bar'); // sets foo=bar in storage for this install - const { value } = await installStorage.setUnique('foo'); // creates and returns a unique text value for foo - const { value } = await installStorage.setUniqueNum('foo'); // creates and returns a unique number for foo - const { value } = await installStorage.get('foo'); // also gets the current value of foo - await installStorage.unset('foo'); // deletes foo - /** - * You can also send multiple commands at once, - * to be executed in the same transaction. - * The response will be an array of the results of each command, in order. - */ - const results = await installStorage.pipeline().set('foo1', 'bar').unset('foo2').get('foo3').execute(); - - /** - * Job updates - * Note that job.complete can take any number of attachments after the first argument. - */ - await job.complete('Credentials provisioned.', { label: 'password', value: 'password' }); - await job.ignore('No credentials provisioned.', 'Email was not supplied.'); - await job.fail('Could not provision credentials.', 'Server could not be reached.'); - /** - * You can also just attach things without completing the job. - * Attach more things by providing more arguments. - */ - await job.attach({ type: 'text', label: 'foo', value: 'bar' }); - /** - * If the job is some multi-step process, - * you can update it's message without changing the status. - * You can also optionally attach things by providing more arguments. - */ - await job.update('Still working...'); - - /** - * JWT usage - */ - const token = await jwt.encode(visitorId, '30m'); - const { sub: visitorId } = await jwt.decode(token); - - /** - * If in a validation URL: - */ - res.send({ foo: 'bar' }); // will save foo in the installation config. - // or - res.sendFailed('This step has failed validation.'); // prevent the installer from progressing. - - /** - * If in an options URL: - */ - res.send([ { label: 'Foo', value: 1 }, { label: 'Bar', value: 2 } ]); // display these options in the dropdown. - - /** - * If in a worker: - */ - res.send({ hello: 'world' }); // the job was a success, and here's some data about it. - // or - res.sendOngoing({ hello: 'world' }); // the job is still ongoing, but here's some data about it. - // or - res.sendIgnored("We're not gonna do this one, sorry.", { hello: 'world' }); // doesnt meet the requirements to continue. - // or - res.sendFailed('We tried, but failed.', { hello: 'world' }); // we cant continue with this job. - -})); +/** + * JWT usage + */ +const token = await jwt.encode(visitorId, '30m'); +const { sub: visitorId } = await jwt.decode(token); -app.use(errorMiddleware()); +/** + * If in a validation route: + */ +res.send({ foo: 'bar' }); // will save foo in the installation config. +// or +res.sendFailed('This step has failed validation.'); // prevent the installer from progressing. + +/** + * If in an options route: + */ +res.send([ { label: 'Foo', value: 1 }, { label: 'Bar', value: 2 } ]); // display these options in the dropdown. + +/** + * If in an event handler: + */ +res.send({ hello: 'world' }); // the job was a success, and here's some data about it. +// or +res.sendOngoing("We're still working on it.", { hello: 'world' }); // the job is still ongoing, but here's some data about it. +// or +res.sendIgnored("We're not gonna do this one, sorry.", { hello: 'world' }); // doesnt meet the requirements to continue. +// or +res.sendFailed('We tried, but failed.', { hello: 'world' }); // we cant continue with this job. ``` ## SDK Reference diff --git a/docs/README.md b/docs/README.md index 4a48d0a..a061e91 100644 --- a/docs/README.md +++ b/docs/README.md @@ -95,9 +95,19 @@ - [EntryPayload](README.md#entrypayload) - [InvitePayload](README.md#invitepayload) +### Handler Type aliases + +- [EntryEventHandler](README.md#entryeventhandler) +- [InviteEventHandler](README.md#inviteeventhandler) +- [MigrationRouteHandler](README.md#migrationroutehandler) +- [OptionsRouteHandler](README.md#optionsroutehandler) +- [PluginUninstalledEventHandler](README.md#pluginuninstalledeventhandler) +- [RemoteValueRouteHandler](README.md#remotevalueroutehandler) +- [SelectedValuesRouteHandler](README.md#selectedvaluesroutehandler) +- [ValidationRouteHandler](README.md#validationroutehandler) + ### Helper Type aliases -- [EnvoyMiddleware](README.md#envoymiddleware) - [EnvoySignatureVerifierOptions](README.md#envoysignatureverifieroptions) ### Meta Type aliases @@ -114,28 +124,48 @@ - [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) - [EnvoyEventRequest](README.md#envoyeventrequest) - [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) +- [EnvoyMigrationRouteRequest](README.md#envoymigrationrouterequest) - [EnvoyOptionsRouteRequest](README.md#envoyoptionsrouterequest) - [EnvoyRemoteValueRouteRequest](README.md#envoyremotevaluerouterequest) - [EnvoyRouteRequest](README.md#envoyrouterequest) - [EnvoySelectedValuesRouteRequest](README.md#envoyselectedvaluesrouterequest) +- [EnvoyValidationRouteRequest](README.md#envoyvalidationrouterequest) ### Response Type aliases - [EnvoyOptionsRouteResponse](README.md#envoyoptionsrouteresponse) +- [EnvoyRemoteValueRouteResponse](README.md#envoyremotevaluerouteresponse) - [EnvoySelectedValuesRouteResponse](README.md#envoyselectedvaluesrouteresponse) ### Storage Type aliases - [EnvoyStorageItem](README.md#envoystorageitem) -### Helper Functions +### Filter Functions -- [asyncHandler](README.md#asynchandler) +- [employeeSignInEnabledMiddleware](README.md#employeesigninenabledmiddleware) +- [excludeEmployeesMiddleware](README.md#excludeemployeesmiddleware) +- [inviteOnlyEntryFilterMiddleware](README.md#inviteonlyentryfiltermiddleware) -### SDK Functions +### Handler Functions +- [asyncHandler](README.md#asynchandler) +- [entryEventHandler](README.md#entryeventhandler) +- [inviteEventHandler](README.md#inviteeventhandler) +- [migrationRouteHandler](README.md#migrationroutehandler) +- [optionsRouteHandler](README.md#optionsroutehandler) +- [pluginUninstalledEventHandler](README.md#pluginuninstalledeventhandler) +- [remoteValueRouteHandler](README.md#remotevalueroutehandler) +- [selectedValuesRouteHandler](README.md#selectedvaluesroutehandler) +- [validationRouteHandler](README.md#validationroutehandler) + +### Middleware Functions + +- [employeeSignInEnabledMiddleware](README.md#employeesigninenabledmiddleware) +- [envoyMiddleware](README.md#envoymiddleware) - [errorMiddleware](README.md#errormiddleware) -- [middleware](README.md#middleware) +- [excludeEmployeesMiddleware](README.md#excludeemployeesmiddleware) +- [inviteOnlyEntryFilterMiddleware](README.md#inviteonlyentryfiltermiddleware) ## API Resource Type aliases @@ -145,7 +175,7 @@ #### Defined in -[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L26) +[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L26) ___ @@ -162,7 +192,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementPageResource.ts#L6) +[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementPageResource.ts#L6) ___ @@ -172,7 +202,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementPageResource.ts#L19) +[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementPageResource.ts#L19) ___ @@ -182,7 +212,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementPageResource.ts#L14) +[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementPageResource.ts#L14) ___ @@ -192,7 +222,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L21) +[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L21) ___ @@ -202,7 +232,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L21) +[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L21) ___ @@ -212,7 +242,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L16) +[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L16) ___ @@ -222,7 +252,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L47) +[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L47) ___ @@ -232,7 +262,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L42) +[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L42) ___ @@ -242,7 +272,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L6) +[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L6) ___ @@ -252,7 +282,7 @@ ___ #### Defined in -[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L35) +[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L35) ___ @@ -262,7 +292,7 @@ ___ #### Defined in -[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L30) +[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L30) ___ @@ -272,7 +302,7 @@ ___ #### Defined in -[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L6) +[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L6) ___ @@ -282,7 +312,7 @@ ___ #### Defined in -[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L92) +[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L92) ___ @@ -292,7 +322,7 @@ ___ #### Defined in -[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L87) +[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L87) ___ @@ -302,7 +332,7 @@ ___ #### Defined in -[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L82) +[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L82) ___ @@ -312,7 +342,7 @@ ___ #### Defined in -[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L6) +[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L6) ___ @@ -322,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L67) +[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L67) ___ @@ -332,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L62) +[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L62) ___ @@ -342,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L6) +[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L6) ___ @@ -352,7 +382,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L31) +[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L31) ___ @@ -369,7 +399,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldPageResource.ts#L6) +[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldPageResource.ts#L6) ___ @@ -379,7 +409,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldPageResource.ts#L23) +[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldPageResource.ts#L23) ___ @@ -389,7 +419,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldPageResource.ts#L14) +[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldPageResource.ts#L14) ___ @@ -399,7 +429,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L26) +[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L26) ___ @@ -416,7 +446,7 @@ ___ #### Defined in -[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/UserResource.ts#L6) +[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/UserResource.ts#L6) ___ @@ -426,7 +456,7 @@ ___ #### Defined in -[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/UserResource.ts#L14) +[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/UserResource.ts#L14) ___ @@ -434,7 +464,7 @@ ___ ### EnvoyRequest -Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyRouteMeta](README.md#envoyroutemeta) \| [EnvoyEventMeta](README.md#envoyeventmeta), Payload\> You probably won't need to use this type directly. For routes, use [EnvoyRouteRequest](README.md#envoyrouterequest), @@ -445,10 +475,11 @@ and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) o | Name | Type | | :------ | :------ | | `Payload` | `Payload` = `unknown` | +| `Config` | `Config` = `Record` | #### Defined in -[sdk/EnvoyRequest.ts:105](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L105) +[sdk/EnvoyRequest.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L123) ___ @@ -500,7 +531,7 @@ ___ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/payloads/EntryPayload.ts#L6) ___ @@ -552,38 +583,289 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/payloads/InvitePayload.ts#L6) ___ -## Helper Type aliases +## Handler Type aliases + +### EntryEventHandler + +Ƭ **EntryEventHandler**: (`req`: [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)) => `Result` + +Handle an entry event, such as `entry_sign_in`. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) & `Additions` | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L31) + +___ + +### InviteEventHandler + +Ƭ **InviteEventHandler**: (`req`: [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)) => `Result` + +Handle an invite event, such as `invite_created`. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest) & `Additions` | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L38) + +___ + +### MigrationRouteHandler + +Ƭ **MigrationRouteHandler**: (`req`: [EnvoyMigrationRouteRequest](README.md#envoymigrationrouterequest) & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)) => `Result` + +Handle a "migration" route. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `OldConfig` | `OldConfig` = `SomeObject` | +| `NewConfig` | `NewConfig` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | -### EnvoyMiddleware +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyMigrationRouteRequest](README.md#envoymigrationrouterequest) & `Additions` | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L52) + +___ + +### OptionsRouteHandler + +Ƭ **OptionsRouteHandler**: (`req`: [EnvoyOptionsRouteRequest](README.md#envoyoptionsrouterequest) & `Additions`, `res`: [EnvoyOptionsRouteResponse](README.md#envoyoptionsrouteresponse)) => `Result` + +Handle an "options" route. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyOptionsRouteRequest](README.md#envoyoptionsrouterequest) & `Additions` | +| `res` | [EnvoyOptionsRouteResponse](README.md#envoyoptionsrouteresponse) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L59) + +___ + +### PluginUninstalledEventHandler -Ƭ **EnvoyMiddleware**: (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +Ƭ **PluginUninstalledEventHandler**: (`req`: [EnvoyEventRequest](README.md#envoyeventrequest)<``"plugin_uninstalled"``, never, Config\> & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)) => `Result` + +Handle a `plugin_uninstalled` event for cleaning up. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | #### Type declaration -▸ (`req`, `res`, `next`): `void` +▸ (`req`, `res`): `Result` ##### Parameters | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | +| `req` | [EnvoyEventRequest](README.md#envoyeventrequest)<``"plugin_uninstalled"``, never, Config\> & `Additions` | | `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | ##### Returns -`void` +`Result` #### Defined in -[sdk/middleware.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/middleware.ts#L15) +[sdk/handlers.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L45) ___ +### RemoteValueRouteHandler + +Ƭ **RemoteValueRouteHandler**: (`req`: [EnvoyRemoteValueRouteRequest](README.md#envoyremotevaluerouterequest) & `Additions`, `res`: [EnvoyRemoteValueRouteResponse](README.md#envoyremotevaluerouteresponse)) => `Result` + +Handle a "remote value" route. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyRemoteValueRouteRequest](README.md#envoyremotevaluerouterequest) & `Additions` | +| `res` | [EnvoyRemoteValueRouteResponse](README.md#envoyremotevaluerouteresponse) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L66) + +___ + +### SelectedValuesRouteHandler + +Ƭ **SelectedValuesRouteHandler**: (`req`: [EnvoySelectedValuesRouteRequest](README.md#envoyselectedvaluesrouterequest) & `Additions`, `res`: [EnvoySelectedValuesRouteResponse](README.md#envoyselectedvaluesrouteresponse)) => `Result` + +Handle a "selected values" route. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoySelectedValuesRouteRequest](README.md#envoyselectedvaluesrouterequest) & `Additions` | +| `res` | [EnvoySelectedValuesRouteResponse](README.md#envoyselectedvaluesrouteresponse) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L73) + +___ + +### ValidationRouteHandler + +Ƭ **ValidationRouteHandler**: (`req`: [EnvoyValidationRouteRequest](README.md#envoyvalidationrouterequest) & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)) => `Result` + +Handle a "validation" route. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Payload` | `Payload` = `SomeObject` | +| `Body` | `Body` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Type declaration + +▸ (`req`, `res`): `Result` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | [EnvoyValidationRouteRequest](README.md#envoyvalidationrouterequest) & `Additions` | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | + +##### Returns + +`Result` + +#### Defined in + +[sdk/handlers.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L80) + +___ + +## Helper Type aliases + ### EnvoySignatureVerifierOptions Ƭ **EnvoySignatureVerifierOptions**: `Object` @@ -599,7 +881,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -633,7 +915,7 @@ Metadata that will be included in the request body for events. #### Defined in -[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L66) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L66) ___ @@ -656,7 +938,7 @@ Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L53) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L53) ___ @@ -677,7 +959,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L37) ___ @@ -701,7 +983,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L4) ___ @@ -733,7 +1015,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L13) ___ @@ -767,7 +1049,7 @@ like validation URLs or options URLs. #### Defined in -[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyMeta.ts#L83) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L83) ___ @@ -775,20 +1057,26 @@ ___ ### EnvoyEntryEventRequest -Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) +Ƭ **EnvoyEntryEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) Use to type your `req` object in entry event handlers, such as handlers for `entry_sign_in`. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `Record` | + #### Defined in -[sdk/EnvoyRequest.ts:88](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L88) +[sdk/EnvoyRequest.ts:104](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L104) ___ ### EnvoyEventRequest -Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> +Ƭ **EnvoyEventRequest**: [EnvoyBaseRequest](interfaces/envoybaserequest.md)<[EnvoyEventMeta](README.md#envoyeventmeta), Payload\> Base type for event requests. You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [EnvoyInviteEventRequest](README.md#envoyinviteeventrequest). @@ -799,23 +1087,48 @@ You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [En | :------ | :------ | | `Event` | `Event`: `string` = `string` | | `Payload` | `Payload` = `unknown` | +| `Config` | `Config` = `Record` | #### Defined in -[sdk/EnvoyRequest.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L79) +[sdk/EnvoyRequest.ts:95](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L95) ___ ### EnvoyInviteEventRequest -Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) +Ƭ **EnvoyInviteEventRequest**: [EnvoyEventRequest](README.md#envoyeventrequest) Use to type your `req` object in invite event handlers, such as handlers for `invite_created` or `upcoming_visit`. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `Record` | + +#### Defined in + +[sdk/EnvoyRequest.ts:113](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L113) + +___ + +### EnvoyMigrationRouteRequest + +Ƭ **EnvoyMigrationRouteRequest**: [EnvoyRouteRequest](README.md#envoyrouterequest) + +Use to type your `req` object in Envoy "migration" route handlers. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `OldConfig` | `OldConfig` = `Record` | + #### Defined in -[sdk/EnvoyRequest.ts:96](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L96) +[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L54) ___ @@ -833,7 +1146,7 @@ Use to type your `req` object in Envoy "options URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L54) +[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L62) ___ @@ -851,7 +1164,7 @@ Use to type your `req` object in Envoy "remote value URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L78) ___ @@ -871,7 +1184,7 @@ Use to type your `req` object in Envoy route handlers such as validation URLs. #### Defined in -[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L43) +[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L43) ___ @@ -889,7 +1202,26 @@ Use to type your `req` object in Envoy "selected values URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L62) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L70) + +___ + +### EnvoyValidationRouteRequest + +Ƭ **EnvoyValidationRouteRequest**: [EnvoyRouteRequest](README.md#envoyrouterequest) + +Use to type your `req` object in Envoy "validation URL" route handlers. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Payload` | `Payload` = `Record` | +| `Config` | `Config` = `Record` | + +#### Defined in + +[sdk/EnvoyRequest.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L86) ___ @@ -903,7 +1235,19 @@ Use to type your `res` object in Envoy "options URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L33) +[sdk/EnvoyResponse.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L34) + +___ + +### EnvoyRemoteValueRouteResponse + +Ƭ **EnvoyRemoteValueRouteResponse**: [EnvoyResponse](interfaces/envoyresponse.md) + +Use to type your `res` object in Envoy "remote value URL" route handlers. + +#### Defined in + +[sdk/EnvoyResponse.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L40) ___ @@ -915,7 +1259,7 @@ Use to type your `res` object in Envoy "selected values URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L39) +[sdk/EnvoyResponse.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L46) ___ @@ -923,100 +1267,416 @@ ___ ### EnvoyStorageItem -Ƭ **EnvoyStorageItem**: `Object` +Ƭ **EnvoyStorageItem**: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Value` | `Value` = `unknown` | #### Type declaration | Name | Type | | :------ | :------ | | `key` | `string` | -| `value` | `unknown` | +| `value` | `Value` | #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyStorageItem.ts#L4) + +## Filter Functions + +### employeeSignInEnabledMiddleware + +▸ **employeeSignInEnabledMiddleware**(`employeeSignInEnabledKey`, `message?`): `RequestHandler` + +Will only proceed if the install's `config` has a truthy value for the given `employeeSignInEnabledKey`. + +#### Type parameters + +| Name | +| :------ | +| `Config` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `employeeSignInEnabledKey` | keyof `Config` | `undefined` | +| `message` | `string` | 'Envoy Protect is disabled.' | + +#### Returns + +`RequestHandler` + +#### Defined in + +[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L30) + +___ -## Helper Functions +### excludeEmployeesMiddleware + +▸ **excludeEmployeesMiddleware**(`excludeEmployeesKey`, `message?`): `RequestHandler` + +Will not proceed if the employee who's signing in is present in the excluded employees list. + +#### Type parameters + +| Name | +| :------ | +| `Config` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `excludeEmployeesKey` | keyof `Config` | `undefined` | +| `message` | `string` | 'Employee excluded from integration.' | + +#### Returns + +`RequestHandler` + +#### Defined in + +[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L43) + +___ + +### inviteOnlyEntryFilterMiddleware + +▸ **inviteOnlyEntryFilterMiddleware**(`invitesOnlyKey`, `message?`): `RequestHandler` + +Will only proceed if the entry has an invite +and the install's `config` has a truthy value for the given `invitesOnlyKey`. + +#### Type parameters + +| Name | +| :------ | +| `Config` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `invitesOnlyKey` | keyof `Config` | `undefined` | +| `message` | `string` | 'Visitors must be invited.' | + +#### Returns + +`RequestHandler` + +#### Defined in + +[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L78) + +___ + +## Handler Functions ### asyncHandler -▸ **asyncHandler**(`handler`): (`req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `Promise` +▸ **asyncHandler**(`handler`): `RequestHandler` Wraps any express.js-based handlers to catch Promise-based errors. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Req` | `Req`: `Request`, Req\> | +| `Res` | `Res`: `Response`, Res\> | + #### Parameters | Name | Type | | :------ | :------ | -| `handler` | `RequestHandler` \| `EnvoyHandler` | +| `handler` | (`req`: `Req`, `res`: `Res`) => `Result` | #### Returns -`fn` +`RequestHandler` + +#### Defined in -▸ (`req`, `res`, `next`): `Promise` +[sdk/handlers.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L90) -##### Parameters +___ + +### entryEventHandler + +▸ **entryEventHandler**(`handler`): `RequestHandler`\> + +Handler for entry events. + +#### Type parameters | Name | Type | | :------ | :------ | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | -##### Returns +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [EntryEventHandler](README.md#entryeventhandler) | + +#### Returns -`Promise` +`RequestHandler`\> #### Defined in -[sdk/asyncHandler.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/asyncHandler.ts#L13) +[sdk/handlers.ts:103](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L103) ___ -## SDK Functions +### inviteEventHandler -### errorMiddleware +▸ **inviteEventHandler**(`handler`): `RequestHandler`\> -▸ **errorMiddleware**(`onError?`): (`err`: `Error`, `req`: [EnvoyRequest](README.md#envoyrequest), `res`: [EnvoyResponse](interfaces/envoyresponse.md), `next`: `NextFunction`) => `void` +Handler for invite events. -Catches errors and sets the proper status code. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | #### Parameters | Name | Type | | :------ | :------ | -| `onError` | (`err`: `Error`) => `void` | +| `handler` | [InviteEventHandler](README.md#inviteeventhandler) | #### Returns -`fn` +`RequestHandler`\> -▸ (`err`, `req`, `res`, `next`): `void` +#### Defined in -##### Parameters +[sdk/handlers.ts:115](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L115) + +___ + +### migrationRouteHandler + +▸ **migrationRouteHandler**(`handler`): `RequestHandler`\> + +Handler for a migration route. + +#### Type parameters | Name | Type | | :------ | :------ | -| `err` | `Error` | -| `req` | [EnvoyRequest](README.md#envoyrequest) | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | -| `next` | `NextFunction` | +| `OldConfig` | `OldConfig` | +| `NewConfig` | `NewConfig` | +| `Additions` | `Additions` = `SomeObject` | -##### Returns +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [MigrationRouteHandler](README.md#migrationroutehandler) | + +#### Returns + +`RequestHandler`\> + +#### Defined in + +[sdk/handlers.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L139) + +___ + +### optionsRouteHandler + +▸ **optionsRouteHandler**(`handler`): `RequestHandler`\> + +Handler for options URL routes. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [OptionsRouteHandler](README.md#optionsroutehandler) | + +#### Returns + +`RequestHandler`\> + +#### Defined in + +[sdk/handlers.ts:152](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L152) + +___ + +### pluginUninstalledEventHandler + +▸ **pluginUninstalledEventHandler**(`handler`): `RequestHandler`\> + +Handler for `plugin_uninstalled` events. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [PluginUninstalledEventHandler](README.md#pluginuninstalledeventhandler) | + +#### Returns + +`RequestHandler`\> + +#### Defined in + +[sdk/handlers.ts:127](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L127) + +___ + +### remoteValueRouteHandler -`void` +▸ **remoteValueRouteHandler**(`handler`): `RequestHandler`\> + +Handler for remote value URL routes. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [RemoteValueRouteHandler](README.md#remotevalueroutehandler) | + +#### Returns + +`RequestHandler`\> + +#### Defined in + +[sdk/handlers.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L164) + +___ + +### selectedValuesRouteHandler + +▸ **selectedValuesRouteHandler**(`handler`): `RequestHandler`\> + +Handler for selected values URL routes. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [SelectedValuesRouteHandler](README.md#selectedvaluesroutehandler) | + +#### Returns + +`RequestHandler`\> + +#### Defined in + +[sdk/handlers.ts:176](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L176) + +___ + +### validationRouteHandler + +▸ **validationRouteHandler**(`handler`): `RequestHandler`\> + +Handler for validation URL routes. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | `Config` = `SomeObject` | +| `Payload` | `Payload` = `SomeObject` | +| `ToSave` | `ToSave` = `SomeObject` | +| `Additions` | `Additions` = `SomeObject` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handler` | [ValidationRouteHandler](README.md#validationroutehandler) | + +#### Returns + +`RequestHandler`\> #### Defined in -[sdk/errorMiddleware.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/errorMiddleware.ts#L11) +[sdk/handlers.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L188) ___ -### middleware +## Middleware Functions + +### employeeSignInEnabledMiddleware + +▸ **employeeSignInEnabledMiddleware**(`employeeSignInEnabledKey`, `message?`): `RequestHandler` + +Will only proceed if the install's `config` has a truthy value for the given `employeeSignInEnabledKey`. + +#### Type parameters + +| Name | +| :------ | +| `Config` | + +#### Parameters -▸ **middleware**(`options?`): [EnvoyMiddleware](README.md#envoymiddleware) +| Name | Type | Default value | +| :------ | :------ | :------ | +| `employeeSignInEnabledKey` | keyof `Config` | `undefined` | +| `message` | `string` | 'Envoy Protect is disabled.' | + +#### Returns + +`RequestHandler` + +#### Defined in + +[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L30) + +___ + +### envoyMiddleware + +▸ **envoyMiddleware**(`options?`): `RequestHandler` Sets up an [EnvoyPluginSDK](classes/envoypluginsdk.md) object in the path `req.envoy`. Modifies the `res` object to include Envoy's helpers, per [EnvoyResponse](interfaces/envoyresponse.md). @@ -1032,8 +1692,89 @@ as well as managing the plugin access token lifecycle. #### Returns -[EnvoyMiddleware](README.md#envoymiddleware) +`RequestHandler` + +#### Defined in + +[sdk/middleware.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/middleware.ts#L27) + +___ + +### errorMiddleware + +▸ **errorMiddleware**(`onError?`): `ErrorRequestHandler` + +Catches errors and sets the proper status code. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `onError` | (`err`: `Error`) => `void` | + +#### Returns + +`ErrorRequestHandler` + +#### Defined in + +[sdk/middleware.ts:91](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/middleware.ts#L91) + +___ + +### excludeEmployeesMiddleware + +▸ **excludeEmployeesMiddleware**(`excludeEmployeesKey`, `message?`): `RequestHandler` + +Will not proceed if the employee who's signing in is present in the excluded employees list. + +#### Type parameters + +| Name | +| :------ | +| `Config` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `excludeEmployeesKey` | keyof `Config` | `undefined` | +| `message` | `string` | 'Employee excluded from integration.' | + +#### Returns + +`RequestHandler` + +#### Defined in + +[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L43) + +___ + +### inviteOnlyEntryFilterMiddleware + +▸ **inviteOnlyEntryFilterMiddleware**(`invitesOnlyKey`, `message?`): `RequestHandler` + +Will only proceed if the entry has an invite +and the install's `config` has a truthy value for the given `invitesOnlyKey`. + +#### Type parameters + +| Name | +| :------ | +| `Config` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `invitesOnlyKey` | keyof `Config` | `undefined` | +| `message` | `string` | 'Visitors must be invited.' | + +#### Returns + +`RequestHandler` #### Defined in -[sdk/middleware.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/middleware.ts#L26) +[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L78) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 58fd765..5cd1f4c 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index f79f691..d570c6e 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L61) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -106,7 +106,7 @@ Fetches the current `config` saved for this install during setup by the customer #### Defined in -[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L27) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -131,13 +131,13 @@ To remove an item from the saved `config`, set the item's key to `null`. #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L37) ___ ### storagePipeline -▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +▸ **storagePipeline**(`commands`, `installId?`): `Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Parameters @@ -148,11 +148,11 @@ ___ #### Returns -`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> +`Promise`<(``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem))[]\> #### Defined in -[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L45) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -196,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginAPI.ts#L72) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index bf09155..eb014b7 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -42,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -52,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -84,7 +84,7 @@ Add attachments to this job. #### Defined in -[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L48) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -110,7 +110,7 @@ using {@link EnvoyRequest.send}. #### Defined in -[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L58) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -136,7 +136,7 @@ using {@link EnvoyRequest.sendFailed}. #### Defined in -[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L78) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -162,7 +162,7 @@ using {@link EnvoyRequest.sendIgnored}. #### Defined in -[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L68) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -187,4 +187,4 @@ Can be used to periodically update long-running jobs. #### Defined in -[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginJob.ts#L87) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 453e6d0..a8f0fbd 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -3,7 +3,7 @@ # Class: EnvoyPluginSDK Sets up all relevant Envoy functions. -Attaches itself to every request object using our [middleware](../README.md#middleware), +Attaches itself to every request object using our {@link middleware}, to allow for easy access to Envoy functions. ## Type parameters @@ -40,7 +40,7 @@ to allow for easy access to Envoy functions. Don't create an instance of this class directly. -Instead, use [middleware](../README.md#middleware) to automatically attach an instance to `req` on every request. +Instead, use {@link middleware} to automatically attach an instance to `req` on every request. #### Type parameters @@ -59,7 +59,7 @@ Instead, use [middleware](../README.md#middleware) to automatically attach an in #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -87,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L140) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -103,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L133) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -119,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L122) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -135,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L158) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -151,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L147) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -168,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L171) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -185,7 +185,7 @@ Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../ #### Defined in -[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L61) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -203,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L73) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -220,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L101) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -237,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginSDK.ts#L84) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index d069ac0..43e4022 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,18 +60,24 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods ### get -▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **get**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Gets a single [EnvoyStorageItem](../README.md#envoystorageitem) from storage. Wrapper for single pipeline get. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Value` | `Value` = `unknown` | + #### Parameters | Name | Type | @@ -80,11 +86,11 @@ Wrapper for single pipeline get. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L35) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -100,38 +106,44 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L26) ___ ### set -▸ **set**(`key`, `value`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **set**(`key`, `value`): `Promise`<[EnvoyStorageItem](../README.md#envoystorageitem)\> Sets a single [EnvoyStorageItem](../README.md#envoystorageitem) from storage. Wrapper for single pipeline set. +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Value` | `Value` = `unknown` | + #### Parameters | Name | Type | | :------ | :------ | | `key` | `string` | -| `value` | `unknown` | +| `value` | `Value` | #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<[EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L44) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L44) ___ ### setUnique -▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **setUnique**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Sets a single unique string [EnvoyStorageItem](../README.md#envoystorageitem) from storage. @@ -146,17 +158,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L53) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L53) ___ ### setUniqueNum -▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **setUniqueNum**(`key`, `options?`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Sets a single unique number [EnvoyStorageItem](../README.md#envoystorageitem) from storage. @@ -171,17 +183,17 @@ Wrapper for single pipeline setUnique. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L62) ___ ### unset -▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +▸ **unset**(`key`): `Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> Unsets an [EnvoyStorageItem](../README.md#envoystorageitem) from storage. Returns null if the item did not previously exist. @@ -195,8 +207,8 @@ Wrapper for single pipeline unset. #### Returns -`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> +`Promise`<``null`` \| [EnvoyStorageItem](../README.md#envoystorageitem)\> #### Defined in -[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyPluginStorage.ts#L71) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index a0d0555..ec8de88 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -65,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L59) ## Properties @@ -81,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L32) ## Methods @@ -104,7 +104,7 @@ May also require `invites.attest` scope if setting `attested: true`. #### Defined in -[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L188) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L188) ___ @@ -127,7 +127,7 @@ Requires `agreements.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L65) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L65) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L58) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L58) ___ @@ -173,7 +173,7 @@ Requires `companies.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L72) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L72) ___ @@ -196,7 +196,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L79) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L79) ___ @@ -219,7 +219,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -241,7 +241,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L136) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L136) ___ @@ -264,7 +264,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L86) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L86) ___ @@ -286,7 +286,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L146) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L146) ___ @@ -308,7 +308,7 @@ Requires `invites.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L172) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L172) ___ @@ -331,7 +331,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L93) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L93) ___ @@ -353,7 +353,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L154) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L154) ___ @@ -376,7 +376,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L107) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L107) ___ @@ -399,7 +399,7 @@ Requires `sign-in-field-pages.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L100) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L100) ___ @@ -421,7 +421,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L164) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L164) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L179) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L179) ___ @@ -458,7 +458,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L213) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -480,7 +480,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L226) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L226) ___ @@ -503,7 +503,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L200) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L200) ___ @@ -531,7 +531,7 @@ Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exc #### Defined in -[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L240) +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L240) ___ @@ -555,7 +555,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L306) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L306) ___ @@ -580,7 +580,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L280) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L280) ___ @@ -606,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged - use [ #### Defined in -[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyUserAPI.ts#L252) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/agreementattributes.md b/docs/interfaces/agreementattributes.md index 11eab1a..021411d 100644 --- a/docs/interfaces/agreementattributes.md +++ b/docs/interfaces/agreementattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L10) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L13) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L12) +[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L7) +[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L7) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L8) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L13) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L8) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L14) +[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L14) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L10) diff --git a/docs/interfaces/companyattributes.md b/docs/interfaces/companyattributes.md index 762ddcc..b8ee3dc 100644 --- a/docs/interfaces/companyattributes.md +++ b/docs/interfaces/companyattributes.md @@ -19,7 +19,7 @@ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L8) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L8) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L7) +[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L7) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/CompanyResource.ts#L9) +[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L9) diff --git a/docs/interfaces/employeeattributes.md b/docs/interfaces/employeeattributes.md index 068ac36..c2246b0 100644 --- a/docs/interfaces/employeeattributes.md +++ b/docs/interfaces/employeeattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L32) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L33) +[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L33) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L32) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L35) +[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L35) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L29) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L28) +[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L28) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L29) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L30) +[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L30) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L34) +[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L34) diff --git a/docs/interfaces/employeefilterfields.md b/docs/interfaces/employeefilterfields.md index b15dd31..fa16298 100644 --- a/docs/interfaces/employeefilterfields.md +++ b/docs/interfaces/employeefilterfields.md @@ -25,7 +25,7 @@ #### Defined in -[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L13) +[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L13) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L12) +[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L12) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L15) +[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L15) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L16) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L17) +[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L17) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L14) +[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L14) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L18) +[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L18) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L20) +[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L20) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/EmployeeResource.ts#L21) +[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L21) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index 975ccc1..c8746b0 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -35,11 +35,11 @@ and for events, use [EnvoyEntryEventRequest](../README.md#envoyentryeventrequest #### Inherited from -VerifiedRequest.\_\_@VERIFIED@1305 +VerifiedRequest.\_\_@VERIFIED@1313 #### Defined in -[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L23) +[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L23) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyRequest.ts#L35) +[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L35) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 5b05e90..e928c29 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -51,7 +51,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L11) +[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L12) ___ @@ -79,7 +79,7 @@ Marks the job as "failed". The message will be communicated to the Envoy Dashboa #### Defined in -[sdk/EnvoyResponse.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L26) +[sdk/EnvoyResponse.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L27) ___ @@ -107,7 +107,7 @@ Marks the job as "ignored". Useful when you explicitly do not want to handle the #### Defined in -[sdk/EnvoyResponse.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L21) +[sdk/EnvoyResponse.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L22) ___ @@ -135,4 +135,4 @@ Later on, you should update the job using #### Defined in -[sdk/EnvoyResponse.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/sdk/EnvoyResponse.ts#L17) +[sdk/EnvoyResponse.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L18) diff --git a/docs/interfaces/flowattributes.md b/docs/interfaces/flowattributes.md index 44e8483..d9e64cb 100644 --- a/docs/interfaces/flowattributes.md +++ b/docs/interfaces/flowattributes.md @@ -20,7 +20,7 @@ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L22) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L20) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L22) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L20) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L23) +[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L23) diff --git a/docs/interfaces/flowfilterfields.md b/docs/interfaces/flowfilterfields.md index e79b7c5..3be3c1d 100644 --- a/docs/interfaces/flowfilterfields.md +++ b/docs/interfaces/flowfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L11) +[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L11) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/FlowResource.ts#L13) +[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L13) diff --git a/docs/interfaces/inviteattributes.md b/docs/interfaces/inviteattributes.md index d83d08c..d8c2a52 100644 --- a/docs/interfaces/inviteattributes.md +++ b/docs/interfaces/inviteattributes.md @@ -34,7 +34,7 @@ #### Defined in -[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L28) +[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L28) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L29) +[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L29) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L55) +[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L55) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L56) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L59) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L53) +[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L53) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L45) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L56) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L45) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L46) +[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L46) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L47) +[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L47) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L48) +[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L48) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L49) +[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L49) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L52) +[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L52) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L59) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L50) +[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L50) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L57) +[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L57) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L60) +[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L60) ___ @@ -222,4 +222,4 @@ ___ #### Defined in -[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L51) +[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L51) diff --git a/docs/interfaces/invitecreationattributes.md b/docs/interfaces/invitecreationattributes.md index 67db9bf..5bbb43a 100644 --- a/docs/interfaces/invitecreationattributes.md +++ b/docs/interfaces/invitecreationattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L75) +[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L75) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L68) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L68) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L69) +[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L69) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L70) +[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L70) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L73) +[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L73) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L76) +[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L76) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L71) +[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L71) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L72) +[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L72) diff --git a/docs/interfaces/invitefilterfields.md b/docs/interfaces/invitefilterfields.md index 9f212c4..e201fb6 100644 --- a/docs/interfaces/invitefilterfields.md +++ b/docs/interfaces/invitefilterfields.md @@ -26,7 +26,7 @@ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L15) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L16) +[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L16) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L17) +[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L17) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L18) +[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L18) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L12) +[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L12) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L13) +[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L20) +[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L20) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L14) +[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L14) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L19) +[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L19) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L15) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/InviteResource.ts#L22) +[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L22) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index ab6fca3..d8d8403 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/locationattributes.md b/docs/interfaces/locationattributes.md index c5ebee1..1c54091 100644 --- a/docs/interfaces/locationattributes.md +++ b/docs/interfaces/locationattributes.md @@ -52,7 +52,7 @@ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L21) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L21) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L22) +[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L22) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L42) +[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L42) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L40) +[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L40) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L41) +[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L41) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L24) +[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L24) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L30) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L54) +[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L54) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L35) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L43) +[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L43) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L46) +[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L46) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L27) +[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L27) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L29) +[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L29) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L31) +[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L31) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L32) +[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L32) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L33) +[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L33) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L28) +[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L28) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L47) +[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L47) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L20) +[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L20) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L48) +[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L48) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L44) +[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L44) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L45) +[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L45) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L49) +[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L49) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L36) +[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L36) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L37) +[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L37) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L50) +[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L50) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L25) +[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L25) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L30) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L51) +[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L51) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L55) +[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L55) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L38) +[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L38) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L52) +[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L52) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L35) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L53) +[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L53) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L39) +[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L39) ___ @@ -412,4 +412,4 @@ ___ #### Defined in -[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L26) +[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L26) diff --git a/docs/interfaces/locationfilterfields.md b/docs/interfaces/locationfilterfields.md index 0379112..7f6d7be 100644 --- a/docs/interfaces/locationfilterfields.md +++ b/docs/interfaces/locationfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L13) +[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L13) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/LocationResource.ts#L12) +[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L12) diff --git a/docs/interfaces/signinfieldattributes.md b/docs/interfaces/signinfieldattributes.md index d4720fd..e9616af 100644 --- a/docs/interfaces/signinfieldattributes.md +++ b/docs/interfaces/signinfieldattributes.md @@ -25,7 +25,7 @@ #### Defined in -[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L18) +[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L18) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L10) +[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L10) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L11) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L8) +[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L8) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L11) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L7) +[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L7) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L17) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L9) +[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L9) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L17) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/c0e2fd5/src/resources/SignInFieldResource.ts#L19) +[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L19) diff --git a/package-lock.json b/package-lock.json index 836be78..ed93d17 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "1.2.1", + "version": "2.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -14,38 +14,57 @@ } }, "@babel/helper-validator-identifier": { - "version": "7.14.0", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.14.0.tgz", - "integrity": "sha512-V3ts7zMSu5lfiwWDVWzRDGIN+lnCEUdaXgtVHJgLb1rGaA6jMrtB9EmE7L18foXJIE8Un/A/h6NJfGQp/e1J4A==", + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.14.5.tgz", + "integrity": "sha512-5lsetuxCLilmVGyiLEfoHBRX8UCFD+1m2x3Rj97WrW3V7H3u4RWRXA4evMjImCsin2J2YT0QaVDGf+z8ondbAg==", "dev": true }, "@babel/highlight": { - "version": "7.14.0", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.0.tgz", - "integrity": "sha512-YSCOwxvTYEIMSGaBQb5kDDsCopDdiUGsqpatp3fOlI4+2HQSkTmEVWnVuySdAC5EWCqSWWTv0ib63RjR7dTBdg==", + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.5.tgz", + "integrity": "sha512-qf9u2WFWVV0MppaL877j2dBtQIDgmidgjGk5VIMw3OadXvYaXn66U1BFlH2t4+t3i+8PhedppRv+i40ABzd+gg==", "dev": true, "requires": { - "@babel/helper-validator-identifier": "^7.14.0", + "@babel/helper-validator-identifier": "^7.14.5", "chalk": "^2.0.0", "js-tokens": "^4.0.0" + }, + "dependencies": { + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + } } }, "@babel/parser": { - "version": "7.5.5", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.5.5.tgz", - "integrity": "sha512-E5BN68cqR7dhKan1SfqgPGhQ178bkVKpXTPEXnFJBrEt8/DKRZlybmy+IgYLTeN7tp1R5Ccmbm2rBk17sHYU3g==", + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.14.5.tgz", + "integrity": "sha512-TM8C+xtH/9n1qzX+JNHi7AN2zHMTiPUtspO0ZdHflW8KaskkALhMmuMHb4bCmNdv9VAPzJX3/bXqkVLnAvsPfg==", "dev": true }, "@eslint/eslintrc": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.1.tgz", - "integrity": "sha512-5v7TDE9plVhvxQeWLXDTvFvJBdH6pEsdnl2g/dAptmuFEPedQ4Erq5rsDsX+mvAM610IhNaO2W5V1dOOnDKxkQ==", + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.2.tgz", + "integrity": "sha512-8nmGq/4ycLpIwzvhI4tNDmQztZ8sp+hI7cyG8i1nQDhkAbRzHpXPidRAHlNvCZQpJTKw5ItIpMw9RSToGF00mg==", "dev": true, "requires": { "ajv": "^6.12.4", "debug": "^4.1.1", "espree": "^7.3.0", - "globals": "^12.1.0", + "globals": "^13.9.0", "ignore": "^4.0.6", "import-fresh": "^3.2.1", "js-yaml": "^3.13.1", @@ -53,18 +72,6 @@ "strip-json-comments": "^3.1.1" }, "dependencies": { - "ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "requires": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - } - }, "debug": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", @@ -74,21 +81,6 @@ "ms": "2.1.2" } }, - "fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true - }, - "globals": { - "version": "12.4.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-12.4.0.tgz", - "integrity": "sha512-BWICuzzDvDoH54NHKCseDanAhE3CeDorgDL5MT6LMXXj2WCnd9UC2szdk4AWLfjdgNBCXLUanXYcpBBKOSWGwg==", - "dev": true, - "requires": { - "type-fest": "^0.8.1" - } - }, "ignore": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", @@ -100,54 +92,48 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true - }, - "strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true } } }, "@nodelib/fs.scandir": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.4.tgz", - "integrity": "sha512-33g3pMJk3bg5nXbL/+CY6I2eJDzZAni49PfJnL5fghPTggPvBd/pFNSgJsdAgWptuFu7qq/ERvOYFlhvsLTCKA==", + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", "dev": true, "requires": { - "@nodelib/fs.stat": "2.0.4", + "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" } }, "@nodelib/fs.stat": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.4.tgz", - "integrity": "sha512-IYlHJA0clt2+Vg7bccq+TzRdJvv19c2INqBSsoOLp1je7xjtr7J26+WXR72MCdvU9q1qTzIWDfhMf+DRvQJK4Q==", + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", "dev": true }, "@nodelib/fs.walk": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.6.tgz", - "integrity": "sha512-8Broas6vTtW4GIXTAHDoE32hnN2M5ykgCpWGbuXHQ15vEMqr23pB76e/GZcYsZCHALv50ktd24qhEyKr6wBtow==", + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.7.tgz", + "integrity": "sha512-BTIhocbPBSrRmHxOAJFtR18oLhxTtAFDAvL8hY1S3iU8k+E60W/YFs4jrixGzQjMpF4qPXxIQHcjVD9dz1C2QA==", "dev": true, "requires": { - "@nodelib/fs.scandir": "2.1.4", + "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, "@sinonjs/commons": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.6.0.tgz", - "integrity": "sha512-w4/WHG7C4WWFyE5geCieFJF6MZkbW4VAriol5KlmQXpAQdxvV0p26sqNZOW6Qyw6Y0l9K4g+cHvvczR2sEEpqg==", + "version": "1.8.3", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", + "integrity": "sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==", "dev": true, "requires": { "type-detect": "4.0.8" } }, "@sinonjs/formatio": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/@sinonjs/formatio/-/formatio-3.2.1.tgz", - "integrity": "sha512-tsHvOB24rvyvV2+zKMmPkZ7dXX6LSLKZ7aOtXY6Edklp0uRcgGpOsQTTGTcWViFyx4uhWc6GV8QdnALbIbIdeQ==", + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@sinonjs/formatio/-/formatio-3.2.2.tgz", + "integrity": "sha512-B8SEsgd8gArBLMD6zpRw3juQ2FVSsmdd7qlevyDqzS9WTCtvF55/gAL+h6gue8ZvPYcdiPdvueM/qm//9XzyTQ==", "dev": true, "requires": { "@sinonjs/commons": "^1", @@ -175,6 +161,7 @@ "version": "1.19.0", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", + "dev": true, "requires": { "@types/connect": "*", "@types/node": "*" @@ -184,6 +171,7 @@ "version": "3.4.34", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", + "dev": true, "requires": { "@types/node": "*" } @@ -200,6 +188,7 @@ "version": "4.17.12", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", "integrity": "sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==", + "dev": true, "requires": { "@types/body-parser": "*", "@types/express-serve-static-core": "^4.17.18", @@ -211,6 +200,7 @@ "version": "4.17.21", "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.21.tgz", "integrity": "sha512-gwCiEZqW6f7EoR8TTEfalyEhb1zA5jQJnRngr97+3pzMaO1RKoI1w2bw07TK72renMUVWcWS5mLI6rk1NqN0nA==", + "dev": true, "requires": { "@types/node": "*", "@types/qs": "*", @@ -245,12 +235,13 @@ "@types/mime": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", - "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==" + "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", + "dev": true }, "@types/node": { - "version": "15.12.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.0.tgz", - "integrity": "sha512-+aHJvoCsVhO2ZCuT4o5JtcPrCPyDE3+1nvbDprYes+pPkEsbjH7AGUCNtjMOXS0fqH14t+B7yLzaqSz92FPWyw==" + "version": "15.12.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.2.tgz", + "integrity": "sha512-zjQ69G564OCIWIOHSXyQEEDpdpGl+G348RAKY0XXy9Z5kU9Vzv1GMNnkar/ZJ8dzXB3COzD9Mo9NtRZ4xfgUww==" }, "@types/qs": { "version": "6.9.6", @@ -260,25 +251,27 @@ "@types/range-parser": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", - "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==" + "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", + "dev": true }, "@types/serve-static": { "version": "1.13.9", "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", + "dev": true, "requires": { "@types/mime": "^1", "@types/node": "*" } }, "@typescript-eslint/eslint-plugin": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.26.0.tgz", - "integrity": "sha512-yA7IWp+5Qqf+TLbd8b35ySFOFzUfL7i+4If50EqvjT6w35X8Lv0eBHb6rATeWmucks37w+zV+tWnOXI9JlG6Eg==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.26.1.tgz", + "integrity": "sha512-aoIusj/8CR+xDWmZxARivZjbMBQTT9dImUtdZ8tVCVRXgBUuuZyM5Of5A9D9arQPxbi/0rlJLcuArclz/rCMJw==", "dev": true, "requires": { - "@typescript-eslint/experimental-utils": "4.26.0", - "@typescript-eslint/scope-manager": "4.26.0", + "@typescript-eslint/experimental-utils": "4.26.1", + "@typescript-eslint/scope-manager": "4.26.1", "debug": "^4.3.1", "functional-red-black-tree": "^1.0.1", "lodash": "^4.17.21", @@ -296,12 +289,6 @@ "ms": "2.1.2" } }, - "lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "dev": true - }, "ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -320,28 +307,28 @@ } }, "@typescript-eslint/experimental-utils": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.26.0.tgz", - "integrity": "sha512-TH2FO2rdDm7AWfAVRB5RSlbUhWxGVuxPNzGT7W65zVfl8H/WeXTk1e69IrcEVsBslrQSTDKQSaJD89hwKrhdkw==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.26.1.tgz", + "integrity": "sha512-sQHBugRhrXzRCs9PaGg6rowie4i8s/iD/DpTB+EXte8OMDfdCG5TvO73XlO9Wc/zi0uyN4qOmX9hIjQEyhnbmQ==", "dev": true, "requires": { "@types/json-schema": "^7.0.7", - "@typescript-eslint/scope-manager": "4.26.0", - "@typescript-eslint/types": "4.26.0", - "@typescript-eslint/typescript-estree": "4.26.0", + "@typescript-eslint/scope-manager": "4.26.1", + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/typescript-estree": "4.26.1", "eslint-scope": "^5.1.1", "eslint-utils": "^3.0.0" } }, "@typescript-eslint/parser": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.26.0.tgz", - "integrity": "sha512-b4jekVJG9FfmjUfmM4VoOItQhPlnt6MPOBUL0AQbiTmm+SSpSdhHYlwayOm4IW9KLI/4/cRKtQCmDl1oE2OlPg==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.26.1.tgz", + "integrity": "sha512-q7F3zSo/nU6YJpPJvQveVlIIzx9/wu75lr6oDbDzoeIRWxpoc/HQ43G4rmMoCc5my/3uSj2VEpg/D83LYZF5HQ==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "4.26.0", - "@typescript-eslint/types": "4.26.0", - "@typescript-eslint/typescript-estree": "4.26.0", + "@typescript-eslint/scope-manager": "4.26.1", + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/typescript-estree": "4.26.1", "debug": "^4.3.1" }, "dependencies": { @@ -363,29 +350,29 @@ } }, "@typescript-eslint/scope-manager": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.26.0.tgz", - "integrity": "sha512-G6xB6mMo4xVxwMt5lEsNTz3x4qGDt0NSGmTBNBPJxNsrTXJSm21c6raeYroS2OwQsOyIXqKZv266L/Gln1BWqg==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.26.1.tgz", + "integrity": "sha512-TW1X2p62FQ8Rlne+WEShyd7ac2LA6o27S9i131W4NwDSfyeVlQWhw8ylldNNS8JG6oJB9Ha9Xyc+IUcqipvheQ==", "dev": true, "requires": { - "@typescript-eslint/types": "4.26.0", - "@typescript-eslint/visitor-keys": "4.26.0" + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/visitor-keys": "4.26.1" } }, "@typescript-eslint/types": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.26.0.tgz", - "integrity": "sha512-rADNgXl1kS/EKnDr3G+m7fB9yeJNnR9kF7xMiXL6mSIWpr3Wg5MhxyfEXy/IlYthsqwBqHOr22boFbf/u6O88A==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.26.1.tgz", + "integrity": "sha512-STyMPxR3cS+LaNvS8yK15rb8Y0iL0tFXq0uyl6gY45glyI7w0CsyqyEXl/Fa0JlQy+pVANeK3sbwPneCbWE7yg==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.26.0.tgz", - "integrity": "sha512-GHUgahPcm9GfBuy3TzdsizCcPjKOAauG9xkz9TR8kOdssz2Iz9jRCSQm6+aVFa23d5NcSpo1GdHGSQKe0tlcbg==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.26.1.tgz", + "integrity": "sha512-l3ZXob+h0NQzz80lBGaykdScYaiEbFqznEs99uwzm8fPHhDjwaBFfQkjUC/slw6Sm7npFL8qrGEAMxcfBsBJUg==", "dev": true, "requires": { - "@typescript-eslint/types": "4.26.0", - "@typescript-eslint/visitor-keys": "4.26.0", + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/visitor-keys": "4.26.1", "debug": "^4.3.1", "globby": "^11.0.3", "is-glob": "^4.0.1", @@ -420,12 +407,12 @@ } }, "@typescript-eslint/visitor-keys": { - "version": "4.26.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.26.0.tgz", - "integrity": "sha512-cw4j8lH38V1ycGBbF+aFiLUls9Z0Bw8QschP3mkth50BbWzgFS33ISIgBzUMuQ2IdahoEv/rXstr8Zhlz4B1Zg==", + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.26.1.tgz", + "integrity": "sha512-IGouNSSd+6x/fHtYRyLOM6/C+QxMDzWlDtN41ea+flWuSF9g02iqcIlX8wM53JkfljoIjP0U+yp7SiTS1onEkw==", "dev": true, "requires": { - "@typescript-eslint/types": "4.26.0", + "@typescript-eslint/types": "4.26.1", "eslint-visitor-keys": "^2.0.0" } }, @@ -442,21 +429,21 @@ "dev": true }, "ajv": { - "version": "6.10.2", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.10.2.tgz", - "integrity": "sha512-TXtUUEYHuaTEbLZWIKUr5pmBuhDLy+8KYtPYdcV8qC+pOZL+NKqYwvWSRrVXHn+ZmRRAu8vJTAznH7Oag6RVRw==", + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "dev": true, "requires": { - "fast-deep-equal": "^2.0.1", + "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "ansi-colors": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", - "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", "dev": true }, "ansi-escape-sequences": { @@ -466,12 +453,20 @@ "dev": true, "requires": { "array-back": "^3.0.1" + }, + "dependencies": { + "array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true + } } }, "ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, "ansi-styles": { @@ -493,9 +488,9 @@ } }, "array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-4.0.2.tgz", + "integrity": "sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg==", "dev": true }, "array-from": { @@ -515,77 +510,6 @@ "es-abstract": "^1.18.0-next.2", "get-intrinsic": "^1.1.1", "is-string": "^1.0.5" - }, - "dependencies": { - "es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", - "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" - } - }, - "es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - }, - "is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true - }, - "is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" - } - }, - "object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - } - } } }, "array-union": { @@ -603,77 +527,6 @@ "call-bind": "^1.0.0", "define-properties": "^1.1.3", "es-abstract": "^1.18.0-next.1" - }, - "dependencies": { - "es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", - "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" - } - }, - "es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - }, - "is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true - }, - "is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" - } - }, - "object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - } - } } }, "assertion-error": { @@ -703,15 +556,15 @@ } }, "balanced-match": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", - "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true }, "bluebird": { - "version": "3.5.5", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.5.5.tgz", - "integrity": "sha512-5am6HnnfN+urzt4yfg7IgTbotDjIT/u8AJpEt0sIU9FtXfVeezXAPKswrG+xKUCOYAINpSdgZVDU6QFh+cuH3w==", + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", + "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", "dev": true }, "body-parser": { @@ -779,25 +632,14 @@ "integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==" }, "cache-point": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-0.4.1.tgz", - "integrity": "sha512-4TgWfe9SF+bUy5cCql8gWHqKNrviufNwSYxLjf2utB0pY4+bdcuFwMmY1hDB+67Gz/L1vmhFNhePAjJTFBtV+Q==", + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-1.0.0.tgz", + "integrity": "sha512-ZqrZp9Hi5Uq7vfSGmNP2bUT/9DzZC2Y/GXjHB8rUJN1a+KLmbV05+vxHipNsg8+CSVgjcVVzLV8VZms6w8ZeRw==", "dev": true, "requires": { - "array-back": "^2.0.0", + "array-back": "^4.0.0", "fs-then-native": "^2.0.0", - "mkdirp2": "^1.0.3" - }, - "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } + "mkdirp2": "^1.0.4" } }, "call-bind": { @@ -822,37 +664,77 @@ "dev": true }, "catharsis": { - "version": "0.8.11", - "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.8.11.tgz", - "integrity": "sha512-a+xUyMV7hD1BrDQA/3iPV7oc+6W26BgVJO05PGEoatMyIuPScQKsde6i3YorWX1qs+AZjnJ18NqdKoCtKiNh1g==", + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", + "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", "dev": true, "requires": { - "lodash": "^4.17.14" + "lodash": "^4.17.15" } }, "chai": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/chai/-/chai-4.2.0.tgz", - "integrity": "sha512-XQU3bhBukrOsQCuwZndwGcCVQHyZi53fQ6Ys1Fym7E4olpIqqZZhhoFJoaKVvV17lWQoXYwgWN2nF5crA8J2jw==", + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.4.tgz", + "integrity": "sha512-yS5H68VYOCtN1cjfwumDSuzn/9c+yza4f3reKXlE5rUg7SFcCEy90gJvydNgOYtblyf4Zi6jIWRnXOgErta0KA==", "dev": true, "requires": { "assertion-error": "^1.1.0", "check-error": "^1.0.2", "deep-eql": "^3.0.1", "get-func-name": "^2.0.0", - "pathval": "^1.1.0", + "pathval": "^1.1.1", "type-detect": "^4.0.5" } }, "chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", + "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", "dev": true, "requires": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } } }, "check-error": { @@ -862,16 +744,28 @@ "dev": true }, "cliui": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", - "integrity": "sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", + "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", "dev": true, "requires": { - "string-width": "^2.1.1", - "strip-ansi": "^4.0.0", - "wrap-ansi": "^2.0.0" + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" }, "dependencies": { + "ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true + }, + "emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, "is-fullwidth-code-point": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", @@ -879,13 +773,23 @@ "dev": true }, "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", "dev": true, "requires": { + "emoji-regex": "^7.0.1", "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" + "strip-ansi": "^5.1.0" + } + }, + "strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "requires": { + "ansi-regex": "^4.1.0" } } } @@ -900,16 +804,10 @@ "shallow-clone": "^3.0.0" } }, - "code-point-at": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", - "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", - "dev": true - }, "collect-all": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.3.tgz", - "integrity": "sha512-0y0rBgoX8IzIjBAUnO73SEtSb4Mhk3IoceWJq5zZSxb9mWORhWH8xLYo4EDSOE1jRBk1LhmfjqWFFt10h/+MEA==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.4.tgz", + "integrity": "sha512-RKZhRwJtJEP5FWul+gkSMEnaK6H3AGPTTWOiRimCcs+rc/OmQE3Yhy1Q7A7KsdkG3ZXVdZq68Y6ONSdvkeEcKA==", "dev": true, "requires": { "stream-connect": "^1.0.2", @@ -949,6 +847,12 @@ "typical": "^4.0.0" }, "dependencies": { + "array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true + }, "typical": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/typical/-/typical-4.0.0.tgz", @@ -1004,17 +908,10 @@ } } }, - "commander": { - "version": "2.20.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.0.tgz", - "integrity": "sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==", - "dev": true, - "optional": true - }, "common-sequence": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-1.0.2.tgz", - "integrity": "sha1-MOB/P49vf5s97oVPILLTnu4Ibeg=", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-2.0.2.tgz", + "integrity": "sha512-jAg09gkdkrDO9EWTdXfv80WWH3yeZl5oT69fGfedBNS9pXUKYInVJ1bJ+/ht2+Moeei48TmSbQDYMc8EOx9G0g==", "dev": true }, "concat-map": { @@ -1040,22 +937,26 @@ } } }, + "confusing-browser-globals": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", + "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", + "dev": true + }, "content-type": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==" }, "cross-spawn": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", - "integrity": "sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==", + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", "dev": true, "requires": { - "nice-try": "^1.0.4", - "path-key": "^2.0.1", - "semver": "^5.5.0", - "shebang-command": "^1.2.0", - "which": "^1.2.9" + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" } }, "dataloader": { @@ -1128,29 +1029,29 @@ } }, "dmd": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/dmd/-/dmd-4.0.0.tgz", - "integrity": "sha512-J+4CgbQiMuJHiU9dvTVN8iOOZGeR3bef1wBqz6eVvvX17jkpkKVd8TeeutA/FJAeFbLQfXnyQ3o4qY7W+c5cxQ==", + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/dmd/-/dmd-4.0.6.tgz", + "integrity": "sha512-7ZYAnFQ6jGm4SICArwqNPylJ83PaOdPTAkds3Z/s1ueFqSc5ilJ2F0b7uP+35W1PUbemH++gn5/VlC3KwEgiHQ==", "dev": true, "requires": { - "array-back": "^3.1.0", - "cache-point": "^0.4.1", - "common-sequence": "^1.0.2", - "file-set": "^2.0.0", - "handlebars": "^4.1.2", - "marked": "^0.6.2", + "array-back": "^4.0.1", + "cache-point": "^1.0.0", + "common-sequence": "^2.0.0", + "file-set": "^3.0.0", + "handlebars": "^4.5.3", + "marked": "^0.7.0", "object-get": "^2.1.0", - "reduce-flatten": "^2.0.0", + "reduce-flatten": "^3.0.0", "reduce-unique": "^2.0.1", "reduce-without": "^1.0.1", "test-value": "^3.0.0", - "walk-back": "^3.0.1" + "walk-back": "^4.0.0" }, "dependencies": { "reduce-flatten": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-2.0.0.tgz", - "integrity": "sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-3.0.1.tgz", + "integrity": "sha512-bYo+97BmUUOzg09XwfkwALt4PQH1M5L0wzKerBt6WLm3Fhdd43mMS89HiT1B9pJIqko/6lWx3OnV4J9f2Kqp5Q==", "dev": true } } @@ -1188,15 +1089,6 @@ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, - "end-of-stream": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", - "integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", - "dev": true, - "requires": { - "once": "^1.4.0" - } - }, "enquirer": { "version": "2.3.6", "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", @@ -1204,20 +1096,12 @@ "dev": true, "requires": { "ansi-colors": "^4.1.1" - }, - "dependencies": { - "ansi-colors": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", - "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", - "dev": true - } } }, "entities": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", - "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", + "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", "dev": true }, "error-ex": { @@ -1230,23 +1114,33 @@ } }, "es-abstract": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.13.0.tgz", - "integrity": "sha512-vDZfg/ykNxQVwup/8E1BZhVzFfBxs9NqMzGcvIJrqg5k2/5Za2bWo40dK2J1pgLngZ7c+Shh8lwYtLGyrwPutg==", + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", "dev": true, "requires": { - "es-to-primitive": "^1.2.0", + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", "has": "^1.0.3", - "is-callable": "^1.1.4", - "is-regex": "^1.0.4", - "object-keys": "^1.0.12" + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" } }, "es-to-primitive": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.0.tgz", - "integrity": "sha512-qZryBOJjV//LaxLTV6UC//WewneB3LcXOL9NP++ozKVXsIIIpm/2c13UDiD9Jp2eThsecw9m3jPqDwTyobcdbg==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", "dev": true, "requires": { "is-callable": "^1.1.4", @@ -1255,19 +1149,19 @@ } }, "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true }, "eslint": { - "version": "7.27.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.27.0.tgz", - "integrity": "sha512-JZuR6La2ZF0UD384lcbnd0Cgg6QJjiCwhMD6eU4h/VGPcVGwawNNzKU41tgokGXnfjOOyI6QIffthhJTPzzuRA==", + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.28.0.tgz", + "integrity": "sha512-UMfH0VSjP0G4p3EWirscJEQ/cHqnT/iuH6oNZOB94nBjWbMnhGEPxsZm1eyIW0C/9jLI0Fow4W5DXLjEI7mn1g==", "dev": true, "requires": { "@babel/code-frame": "7.12.11", - "@eslint/eslintrc": "^0.4.1", + "@eslint/eslintrc": "^0.4.2", "ajv": "^6.10.0", "chalk": "^4.0.0", "cross-spawn": "^7.0.2", @@ -1284,7 +1178,7 @@ "fast-deep-equal": "^3.1.3", "file-entry-cache": "^6.0.1", "functional-red-black-tree": "^1.0.1", - "glob-parent": "^5.0.0", + "glob-parent": "^5.1.2", "globals": "^13.6.0", "ignore": "^4.0.6", "import-fresh": "^3.0.0", @@ -1307,57 +1201,6 @@ "v8-compile-cache": "^2.0.3" }, "dependencies": { - "ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", - "dev": true - }, - "ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "requires": { - "color-convert": "^2.0.1" - } - }, - "chalk": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", - "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", - "dev": true, - "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - } - }, - "color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "requires": { - "color-name": "~1.1.4" - } - }, - "color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - }, - "cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, - "requires": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - } - }, "debug": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", @@ -1367,12 +1210,6 @@ "ms": "2.1.2" } }, - "escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true - }, "eslint-utils": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", @@ -1390,18 +1227,6 @@ } } }, - "fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true - }, - "has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true - }, "ignore": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", @@ -1414,12 +1239,6 @@ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true }, - "path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true - }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -1428,54 +1247,6 @@ "requires": { "lru-cache": "^6.0.0" } - }, - "shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "requires": { - "shebang-regex": "^3.0.0" - } - }, - "shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true - }, - "strip-ansi": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", - "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", - "dev": true, - "requires": { - "ansi-regex": "^5.0.0" - } - }, - "strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true - }, - "supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "requires": { - "has-flag": "^4.0.0" - } - }, - "which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } } } }, @@ -1486,217 +1257,30 @@ "dev": true, "requires": { "eslint-config-airbnb-base": "^14.2.1", - "object.assign": "^4.1.2", - "object.entries": "^1.1.2" - }, - "dependencies": { - "confusing-browser-globals": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", - "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", - "dev": true - }, - "es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", - "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" - } - }, - "es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, - "eslint-config-airbnb-base": { - "version": "14.2.1", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", - "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", - "dev": true, - "requires": { - "confusing-browser-globals": "^1.0.10", - "object.assign": "^4.1.2", - "object.entries": "^1.1.2" - } - }, - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - }, - "is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true - }, - "is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" - } - }, - "object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - } - }, - "object.entries": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", - "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.2" - } - } - } - }, - "eslint-config-airbnb-typescript": { - "version": "12.3.1", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb-typescript/-/eslint-config-airbnb-typescript-12.3.1.tgz", - "integrity": "sha512-ql/Pe6/hppYuRp4m3iPaHJqkBB7dgeEmGPQ6X0UNmrQOfTF+dXw29/ZjU2kQ6RDoLxaxOA+Xqv07Vbef6oVTWw==", - "dev": true, - "requires": { - "@typescript-eslint/parser": "^4.4.1", - "eslint-config-airbnb": "^18.2.0", - "eslint-config-airbnb-base": "^14.2.0" - }, - "dependencies": { - "confusing-browser-globals": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", - "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", - "dev": true - }, - "es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", - "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" - } - }, - "es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, - "eslint-config-airbnb-base": { - "version": "14.2.1", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", - "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", - "dev": true, - "requires": { - "confusing-browser-globals": "^1.0.10", - "object.assign": "^4.1.2", - "object.entries": "^1.1.2" - } - }, - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - }, - "is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true - }, - "is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" - } - }, - "object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - } - }, - "object.entries": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", - "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.2" - } - } + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" + } + }, + "eslint-config-airbnb-base": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", + "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", + "dev": true, + "requires": { + "confusing-browser-globals": "^1.0.10", + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" + } + }, + "eslint-config-airbnb-typescript": { + "version": "12.3.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-typescript/-/eslint-config-airbnb-typescript-12.3.1.tgz", + "integrity": "sha512-ql/Pe6/hppYuRp4m3iPaHJqkBB7dgeEmGPQ6X0UNmrQOfTF+dXw29/ZjU2kQ6RDoLxaxOA+Xqv07Vbef6oVTWw==", + "dev": true, + "requires": { + "@typescript-eslint/parser": "^4.4.1", + "eslint-config-airbnb": "^18.2.0", + "eslint-config-airbnb-base": "^14.2.0" } }, "eslint-import-resolver-node": { @@ -1707,18 +1291,6 @@ "requires": { "debug": "^2.6.9", "resolve": "^1.13.1" - }, - "dependencies": { - "resolve": { - "version": "1.20.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", - "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", - "dev": true, - "requires": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" - } - } } }, "eslint-module-utils": { @@ -1779,16 +1351,6 @@ "requires": { "esutils": "^2.0.2" } - }, - "resolve": { - "version": "1.20.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", - "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", - "dev": true, - "requires": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" - } } } }, @@ -1888,21 +1450,6 @@ "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", "dev": true }, - "execa": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz", - "integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==", - "dev": true, - "requires": { - "cross-spawn": "^6.0.0", - "get-stream": "^4.0.0", - "is-stream": "^1.1.0", - "npm-run-path": "^2.0.0", - "p-finally": "^1.0.0", - "signal-exit": "^3.0.0", - "strip-eof": "^1.0.0" - } - }, "factory.ts": { "version": "0.5.2", "resolved": "https://registry.npmjs.org/factory.ts/-/factory.ts-0.5.2.tgz", @@ -1918,9 +1465,9 @@ "integrity": "sha512-wLTv2a28wjUyWkbnX7u/ABZBkUkIF2fCd73V6P2oFqEGEktDfzWx4UxrSqtPRw0xPRAcjeAOIiJWqZm3pP4u3g==" }, "fast-deep-equal": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", - "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true }, "fast-glob": { @@ -1938,9 +1485,9 @@ } }, "fast-json-stable-stringify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", - "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", "dev": true }, "fast-levenshtein": { @@ -1968,24 +1515,13 @@ } }, "file-set": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz", - "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/file-set/-/file-set-3.0.0.tgz", + "integrity": "sha512-B/SdeSIeRv7VlOgIjtH3dkxMI+tEy5m+OeCXfAUsirBoVoY+bGtsmvmmTFPm/G23TBY4RiTtjpcgePCfwXRjqA==", "dev": true, "requires": { - "array-back": "^2.0.0", - "glob": "^7.1.3" - }, - "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } + "array-back": "^4.0.0", + "glob": "^7.1.5" } }, "fill-keys": { @@ -2014,6 +1550,14 @@ "dev": true, "requires": { "array-back": "^3.0.1" + }, + "dependencies": { + "array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true + } } }, "find-up": { @@ -2026,9 +1570,9 @@ } }, "flat": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.0.tgz", - "integrity": "sha512-Px/TiLIznH7gEDlPXcUD4KnBusa6kR6ayRUVcnEAbreRIuhkqow/mun59BuRXwoYk7ZQOLW1ZM05ilIvK38hFw==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.1.tgz", + "integrity": "sha512-FmTtBsHskrU6FJ2VxCnsDb84wu9zhmO3cUX2kGFb5tuwhfXxGciiT0oRY+cck35QmG+NmGh5eLz6lLCpWTqwpA==", "dev": true, "requires": { "is-buffer": "~2.0.3" @@ -2110,28 +1654,12 @@ "function-bind": "^1.1.1", "has": "^1.0.3", "has-symbols": "^1.0.1" - }, - "dependencies": { - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==" - } - } - }, - "get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "dev": true, - "requires": { - "pump": "^3.0.0" } }, "glob": { - "version": "7.1.4", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.4.tgz", - "integrity": "sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A==", + "version": "7.1.7", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.7.tgz", + "integrity": "sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ==", "dev": true, "requires": { "fs.realpath": "^1.0.0", @@ -2158,14 +1686,6 @@ "dev": true, "requires": { "type-fest": "^0.20.2" - }, - "dependencies": { - "type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true - } } }, "globby": { @@ -2183,9 +1703,9 @@ } }, "graceful-fs": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.2.tgz", - "integrity": "sha512-IItsdsea19BoLC7ELy13q1iJFNmd7ofZH5+X/pJr90/nRoPEX0DJo1dHDbgtYWOhJhcCgMDTOw84RZ72q6lB+Q==", + "version": "4.2.6", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.6.tgz", + "integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ==", "dev": true }, "growl": { @@ -2195,9 +1715,9 @@ "dev": true }, "handlebars": { - "version": "4.7.6", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.6.tgz", - "integrity": "sha512-1f2BACcBfiwAfStCKZNrUCgqNZkGsAT7UM3kkYtXuLo0KnaVfjKOyf7PRzB6++aK9STyT1Pd2ZCPe3EGOXleXA==", + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", "dev": true, "requires": { "minimist": "^1.2.5", @@ -2205,14 +1725,6 @@ "source-map": "^0.6.1", "uglify-js": "^3.1.4", "wordwrap": "^1.0.0" - }, - "dependencies": { - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - } } }, "has": { @@ -2236,10 +1748,9 @@ "dev": true }, "has-symbols": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.0.tgz", - "integrity": "sha1-uhqPGvKg/DllD1yFA2dwQSIGO0Q=", - "dev": true + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==" }, "he": { "version": "1.2.0", @@ -2316,12 +1827,6 @@ "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", "dev": true }, - "invert-kv": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", - "integrity": "sha512-wPVv/y/QQ/Uiirj/vh3oP+1Ww+AWehmi1g5fFWGPF6IpCBCDVrhgHRMvrLfdYcwDh3QJbGXDW4JAuzxElLSqKA==", - "dev": true - }, "is-arrayish": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", @@ -2344,15 +1849,15 @@ } }, "is-buffer": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.3.tgz", - "integrity": "sha512-U15Q7MXTuZlrbymiz95PJpZxu8IlipAp4dtS3wOdgPXx3mqBnslrWU14kxfHB+Py/+2PVKSr37dMAgM2A4uArw==", + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz", + "integrity": "sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==", "dev": true }, "is-callable": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.4.tgz", - "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==", + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", "dev": true }, "is-core-module": { @@ -2365,9 +1870,9 @@ } }, "is-date-object": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.1.tgz", - "integrity": "sha1-mqIOtq7rv/d/vTPnTKAbM1gdOhY=", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.4.tgz", + "integrity": "sha512-/b4ZVsG7Z5XVtIxs/h9W8nvfLgSAyKYdtGWQLbqy6jA1icmgjf8WCoTKgeS4wy5tYaPePouzFMANbnj94c2Z+A==", "dev": true }, "is-extglob": { @@ -2410,9 +1915,9 @@ "dev": true }, "is-object": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.1.tgz", - "integrity": "sha1-iVJojF7C/9awPsyF52ngKQMINHA=", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.2.tgz", + "integrity": "sha512-2rRIahhZr2UWb45fIOuvZGpFtz0TyOZLf32KxBbSoUCeZR495zCKlWUKKUByk3geS2eAs7ZAABt0Y/Rx0GiQGA==", "dev": true }, "is-plain-object": { @@ -2424,20 +1929,15 @@ } }, "is-regex": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", - "integrity": "sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", "dev": true, "requires": { - "has": "^1.0.1" + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" } }, - "is-stream": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", - "dev": true - }, "is-string": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", @@ -2445,14 +1945,20 @@ "dev": true }, "is-symbol": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.2.tgz", - "integrity": "sha512-HS8bZ9ox60yCJLH9snBpIwv9pYUAkcuLhSA1oero1UB5y9aiQpRA8y2ex945AOtCZL1lJDeIk3G5LthswI46Lw==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", "dev": true, "requires": { - "has-symbols": "^1.0.0" + "has-symbols": "^1.0.2" } }, + "isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", + "dev": true + }, "isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -2471,9 +1977,9 @@ "dev": true }, "js-yaml": { - "version": "3.13.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", - "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", "dev": true, "requires": { "argparse": "^1.0.7", @@ -2481,34 +1987,34 @@ } }, "js2xmlparser": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.0.tgz", - "integrity": "sha512-WuNgdZOXVmBk5kUPMcTcVUpbGRzLfNkv7+7APq7WiDihpXVKrgxo6wwRpRl9OQeEBgKCVk9mR7RbzrnNWC8oBw==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz", + "integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==", "dev": true, "requires": { - "xmlcreate": "^2.0.0" + "xmlcreate": "^2.0.3" } }, "jsdoc": { - "version": "3.6.3", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.3.tgz", - "integrity": "sha512-Yf1ZKA3r9nvtMWHO1kEuMZTlHOF8uoQ0vyo5eH7SQy5YeIiHM+B0DgKnn+X6y6KDYZcF7G2SPkKF+JORCXWE/A==", + "version": "3.6.7", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.7.tgz", + "integrity": "sha512-sxKt7h0vzCd+3Y81Ey2qinupL6DpRSZJclS04ugHDNmRUXGzqicMJ6iwayhSA0S0DwwX30c5ozyUthr1QKF6uw==", "dev": true, "requires": { - "@babel/parser": "^7.4.4", - "bluebird": "^3.5.4", - "catharsis": "^0.8.11", + "@babel/parser": "^7.9.4", + "bluebird": "^3.7.2", + "catharsis": "^0.9.0", "escape-string-regexp": "^2.0.0", - "js2xmlparser": "^4.0.0", + "js2xmlparser": "^4.0.1", "klaw": "^3.0.0", - "markdown-it": "^8.4.2", - "markdown-it-anchor": "^5.0.2", - "marked": "^0.7.0", - "mkdirp": "^0.5.1", + "markdown-it": "^10.0.0", + "markdown-it-anchor": "^5.2.7", + "marked": "^2.0.3", + "mkdirp": "^1.0.4", "requizzle": "^0.2.3", - "strip-json-comments": "^3.0.1", + "strip-json-comments": "^3.1.0", "taffydb": "2.6.2", - "underscore": "~1.9.1" + "underscore": "~1.13.1" }, "dependencies": { "escape-string-regexp": { @@ -2518,74 +2024,86 @@ "dev": true }, "marked": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", - "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", - "dev": true - }, - "strip-json-comments": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.0.1.tgz", - "integrity": "sha512-VTyMAUfdm047mwKl+u79WIdrZxtFtn+nBxHeb844XBQ9uMNTuTHdx2hc5RiAJYqwTj3wc/xe5HLSdJSkJ+WfZw==", + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", + "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", "dev": true } } }, "jsdoc-api": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-5.0.2.tgz", - "integrity": "sha512-nC5uvd907gbqTRinrHeX5EBNw2Yc/0/7qONbRu5R5wrq/1OaRHtqDWGLDu+6BFI6RyuEgp87IH/IdOz4CdN6RA==", + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-5.0.4.tgz", + "integrity": "sha512-1KMwLnfo0FyhF06TQKzqIm8BiY1yoMIGICxRdJHUjzskaHMzHMmpLlmNFgzoa4pAC8t1CDPK5jWuQTvv1pBsEQ==", "dev": true, "requires": { - "array-back": "^3.1.0", - "cache-point": "^0.4.1", + "array-back": "^4.0.0", + "cache-point": "^1.0.0", "collect-all": "^1.0.3", "file-set": "^2.0.1", "fs-then-native": "^2.0.0", - "jsdoc": "^3.6.2", + "jsdoc": "^3.6.3", "object-to-spawn-args": "^1.1.1", "temp-path": "^1.0.0", "walk-back": "^3.0.1" + }, + "dependencies": { + "file-set": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz", + "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==", + "dev": true, + "requires": { + "array-back": "^2.0.0", + "glob": "^7.1.3" + }, + "dependencies": { + "array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "requires": { + "typical": "^2.6.1" + } + } + } + }, + "walk-back": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.1.tgz", + "integrity": "sha512-umiNB2qLO731Sxbp6cfZ9pwURJzTnftxE4Gc7hq8n/ehkuXC//s9F65IEIJA2ZytQZ1ZOsm/Fju4IWx0bivkUQ==", + "dev": true + } } }, "jsdoc-parse": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-3.0.1.tgz", - "integrity": "sha512-btZLp4wYl90vcAfgk4hoGQbO17iBVrhh3LJRMKZNtZgniO3F8H2CjxXld0owBIB1XxN+j3bAcWZnZKMnSj3iMA==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-4.0.1.tgz", + "integrity": "sha512-qIObw8yqYZjrP2qxWROB5eLQFLTUX2jRGLhW9hjo2CC2fQVlskidCIzjCoctwsDvauBp2a/lR31jkSleczSo8Q==", "dev": true, "requires": { - "array-back": "^2.0.0", + "array-back": "^4.0.0", "lodash.omit": "^4.5.0", "lodash.pick": "^4.4.0", "reduce-extract": "^1.0.0", "sort-array": "^2.0.0", "test-value": "^3.0.0" - }, - "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } } }, "jsdoc-to-markdown": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-5.0.0.tgz", - "integrity": "sha512-3gKEnbay7dSdyvtMDDkUf4r7pmBVgs3aqeT0Cg/ngTILPpJUzf8iKgASIo5psF007L45OIJtIuRX5VL/YUXKaA==", + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-5.0.3.tgz", + "integrity": "sha512-tQv5tBV0fTYidRQtE60lJKxE98mmuLcYuITFDKQiDPE9hGccpeEGUNFcVkInq1vigyuPnZmt79bQ8wv2GKjY0Q==", "dev": true, "requires": { - "array-back": "^3.1.0", + "array-back": "^4.0.1", "command-line-tool": "^0.8.0", "config-master": "^3.1.0", - "dmd": "^4.0.0", - "jsdoc-api": "^5.0.1", - "jsdoc-parse": "^3.0.1", - "walk-back": "^3.0.1" + "dmd": "^4.0.5", + "jsdoc-api": "^5.0.4", + "jsdoc-parse": "^4.0.1", + "walk-back": "^4.0.0" } }, "json-parse-better-errors": { @@ -2613,14 +2131,6 @@ "dev": true, "requires": { "minimist": "^1.2.0" - }, - "dependencies": { - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - } } }, "jsonfile": { @@ -2651,16 +2161,16 @@ }, "dependencies": { "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==" + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" } } }, "just-extend": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.0.2.tgz", - "integrity": "sha512-FrLwOgm+iXrPV+5zDU6Jqu4gCRXbWEQg2O3SKONsWE4w7AXFRkryS53bpWdaL9cNol+AmR3AEYz6kn+o0fCPnw==", + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", + "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", "dev": true }, "jwa": { @@ -2696,15 +2206,6 @@ "graceful-fs": "^4.1.9" } }, - "lcid": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lcid/-/lcid-2.0.0.tgz", - "integrity": "sha512-avPEb8P8EGnwXKClwsNUgryVjllcRqtMYa49NTsbQagYuT1DcXnl1915oxWjoyGrXR6zH/Y0Zc96xWsPcoDKeA==", - "dev": true, - "requires": { - "invert-kv": "^2.0.0" - } - }, "levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", @@ -2747,9 +2248,9 @@ } }, "lodash": { - "version": "4.17.15", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz", - "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==", + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, "lodash.camelcase": { @@ -2836,6 +2337,25 @@ "dev": true, "requires": { "chalk": "^2.0.1" + }, + "dependencies": { + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + } } }, "lolex": { @@ -2859,38 +2379,29 @@ "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", "dev": true }, - "map-age-cleaner": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz", - "integrity": "sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w==", - "dev": true, - "requires": { - "p-defer": "^1.0.0" - } - }, "markdown-it": { - "version": "8.4.2", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-8.4.2.tgz", - "integrity": "sha512-GcRz3AWTqSUphY3vsUqQSFMbgR38a4Lh3GWlHRh/7MRwz8mcu9n2IO7HOh+bXHrR9kOPDl5RNCaEsrneb+xhHQ==", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", + "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==", "dev": true, "requires": { "argparse": "^1.0.7", - "entities": "~1.1.1", + "entities": "~2.0.0", "linkify-it": "^2.0.0", "mdurl": "^1.0.1", "uc.micro": "^1.0.5" } }, "markdown-it-anchor": { - "version": "5.2.4", - "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.2.4.tgz", - "integrity": "sha512-n8zCGjxA3T+Mx1pG8HEgbJbkB8JFUuRkeTZQuIM8iPY6oQ8sWOPRZJDFC9a/pNg2QkHEjjGkhBEl/RSyzaDZ3A==", + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", + "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", "dev": true }, "marked": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.6.3.tgz", - "integrity": "sha512-Fqa7eq+UaxfMriqzYLayfqAE40WN03jf+zHjT18/uXNuzjq3TY0XTbrAoPeqSJrAmPz11VuUA+kBPYOhHt9oOQ==", + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", + "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", "dev": true }, "mdurl": { @@ -2904,17 +2415,6 @@ "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=" }, - "mem": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/mem/-/mem-4.3.0.tgz", - "integrity": "sha512-qX2bG48pTqYRVmDB37rn/6PT7LcR8T7oAX3bf99u1Tt1nzxYfxkgqDwUwolPlXweM0XzBOBFzSx4kfp7KP1s/w==", - "dev": true, - "requires": { - "map-age-cleaner": "^0.1.1", - "mimic-fn": "^2.0.0", - "p-is-promise": "^2.0.0" - } - }, "merge-descriptors": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", @@ -2938,24 +2438,18 @@ } }, "mime-db": { - "version": "1.40.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.40.0.tgz", - "integrity": "sha512-jYdeOMPy9vnxEqFRRo6ZvTZ8d9oPb+k18PKoYNYUe2stVEBPPwsln/qWzdbmaIvnhZ9v2P+CuecK+fpUfsV2mA==" + "version": "1.48.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.48.0.tgz", + "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==" }, "mime-types": { - "version": "2.1.24", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.24.tgz", - "integrity": "sha512-WaFHS3MCl5fapm3oLxU4eYDw77IQM2ACcxQ9RIxfaC3ooc6PFuBMGZZsYpvoXS5D5QTWPieo1jjLdAm3TBP3cQ==", + "version": "2.1.31", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.31.tgz", + "integrity": "sha512-XGZnNzm3QvgKxa8dpzyhFTHmpP3l5YNusmne07VUOXxou9CqUqYa/HBy124RqtVh/O2pECas/MOcsDgpilPOPg==", "requires": { - "mime-db": "1.40.0" + "mime-db": "1.48.0" } }, - "mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true - }, "minimatch": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", @@ -2966,19 +2460,16 @@ } }, "minimist": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", - "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", "dev": true }, "mkdirp": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", - "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", - "dev": true, - "requires": { - "minimist": "0.0.8" - } + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true }, "mkdirp2": { "version": "1.0.4", @@ -2987,9 +2478,9 @@ "dev": true }, "mocha": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.0.tgz", - "integrity": "sha512-qwfFgY+7EKAAUAdv7VYMZQknI7YJSGesxHyhn6qD52DV8UcSZs5XwCifcZGMVIE4a5fbmhvbotxC0DLQ0oKohQ==", + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.3.tgz", + "integrity": "sha512-0R/3FvjIGH3eEuG17ccFPk117XL2rWxatr81a57D+r/x2uTYZRbdZ4oVidEUMh2W2TJDa7MdAb12Lm2/qrKajg==", "dev": true, "requires": { "ansi-colors": "3.2.3", @@ -3004,7 +2495,7 @@ "js-yaml": "3.13.1", "log-symbols": "2.2.0", "minimatch": "3.0.4", - "mkdirp": "0.5.1", + "mkdirp": "0.5.4", "ms": "2.1.1", "node-environment-flags": "1.0.5", "object.assign": "4.1.0", @@ -3012,11 +2503,17 @@ "supports-color": "6.0.0", "which": "1.3.1", "wide-align": "1.1.3", - "yargs": "13.2.2", - "yargs-parser": "13.0.0", - "yargs-unparser": "1.5.0" + "yargs": "13.3.2", + "yargs-parser": "13.1.2", + "yargs-unparser": "1.6.0" }, "dependencies": { + "ansi-colors": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", + "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "dev": true + }, "debug": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", @@ -3026,6 +2523,12 @@ "ms": "^2.1.1" } }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + }, "find-up": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", @@ -3049,6 +2552,16 @@ "path-is-absolute": "^1.0.0" } }, + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, "locate-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", @@ -3059,16 +2572,37 @@ "path-exists": "^3.0.0" } }, + "mkdirp": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.4.tgz", + "integrity": "sha512-iG9AK/dJLtJ0XNgTuDbSyNS3zECqDlAhnQW4CsNxBG3LQJBbHmRX1egw39DmtOdCAqY+dKXV+sgPgilNWUKMVw==", + "dev": true, + "requires": { + "minimist": "^1.2.5" + } + }, "ms": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", "dev": true }, + "object.assign": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", + "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", + "dev": true, + "requires": { + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" + } + }, "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", "dev": true, "requires": { "p-try": "^2.0.0" @@ -3089,6 +2623,12 @@ "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", "dev": true }, + "strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", + "dev": true + }, "supports-color": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", @@ -3097,6 +2637,15 @@ "requires": { "has-flag": "^3.0.0" } + }, + "which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } } } }, @@ -3118,28 +2667,33 @@ "dev": true }, "neo-async": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.1.tgz", - "integrity": "sha512-iyam8fBuCUpWeKPGpaNMetEocMt364qkCsfL9JuhjXX6dRnguRVOfk2GZaDpPjcOKiiXCPINZC1GczQ7iTq3Zw==", - "dev": true - }, - "nice-try": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", - "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==", + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", "dev": true }, "nise": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/nise/-/nise-1.5.1.tgz", - "integrity": "sha512-edFWm0fsFG2n318rfEnKlTZTkjlbVOFF9XIA+fj+Ed+Qz1laYW2lobwavWoMzGrYDHH1EpiNJgDfvGnkZztR/g==", + "version": "1.5.3", + "resolved": "https://registry.npmjs.org/nise/-/nise-1.5.3.tgz", + "integrity": "sha512-Ymbac/94xeIrMf59REBPOv0thr+CJVFMhrlAkW/gjCIE58BGQdCj0x7KRCb3yz+Ga2Rz3E9XXSvUyyxqqhjQAQ==", "dev": true, "requires": { "@sinonjs/formatio": "^3.2.1", "@sinonjs/text-encoding": "^0.7.1", "just-extend": "^4.0.2", - "lolex": "^4.1.0", + "lolex": "^5.0.1", "path-to-regexp": "^1.7.0" + }, + "dependencies": { + "lolex": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/lolex/-/lolex-5.1.2.tgz", + "integrity": "sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A==", + "dev": true, + "requires": { + "@sinonjs/commons": "^1.7.0" + } + } } }, "node-environment-flags": { @@ -3164,25 +2718,10 @@ "validate-npm-package-license": "^3.0.1" } }, - "npm-run-path": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", - "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", - "dev": true, - "requires": { - "path-key": "^2.0.0" - } - }, - "number-is-nan": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", - "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", - "dev": true - }, "object-get": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.0.tgz", - "integrity": "sha1-ciu9tgA576R8rTxtws5RqFwCxa4=", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.1.tgz", + "integrity": "sha512-7n4IpLMzGGcLEMiQKsNR7vCe+N5E9LORFrtNUVy4sO3dj9a3HedZCxEL2T7QuLhcHN1NBuBsMOKaOsAYI9IIvg==", "dev": true }, "object-inspect": { @@ -3203,25 +2742,37 @@ "dev": true }, "object.assign": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", - "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", "dev": true, "requires": { - "define-properties": "^1.1.2", - "function-bind": "^1.1.1", - "has-symbols": "^1.0.0", - "object-keys": "^1.0.11" + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + }, + "object.entries": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", + "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.2" } }, "object.getownpropertydescriptors": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz", - "integrity": "sha1-h1jIRvW0B62rDyNuCYbxSwUcqhY=", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.2.tgz", + "integrity": "sha512-WtxeKSzfBjlzL+F9b7M7hewDzMwy+C8NRssHd1YrNlzHzIDrXcXiNOMrezdAEM4UXixgV+vvnyBeN7Rygl2ttQ==", "dev": true, "requires": { - "define-properties": "^1.1.2", - "es-abstract": "^1.5.1" + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.2" } }, "object.values": { @@ -3233,77 +2784,6 @@ "call-bind": "^1.0.2", "define-properties": "^1.1.3", "es-abstract": "^1.18.2" - }, - "dependencies": { - "es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", - "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" - } - }, - "es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - }, - "is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true - }, - "is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" - } - }, - "object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", - "dev": true, - "requires": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - } - } } }, "on-finished": { @@ -3363,35 +2843,6 @@ "word-wrap": "^1.2.3" } }, - "os-locale": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-3.1.0.tgz", - "integrity": "sha512-Z8l3R4wYWM40/52Z+S265okfFj8Kt2cC2MKY+xNi3kFs+XGI7WXu/I309QQQYbRW4ijiZ+yxs9pqEhJh0DqW3Q==", - "dev": true, - "requires": { - "execa": "^1.0.0", - "lcid": "^2.0.0", - "mem": "^4.0.0" - } - }, - "p-defer": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-defer/-/p-defer-1.0.0.tgz", - "integrity": "sha1-n26xgvbJqozXQwBKfU+WsZaw+ww=", - "dev": true - }, - "p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", - "dev": true - }, - "p-is-promise": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/p-is-promise/-/p-is-promise-2.1.0.tgz", - "integrity": "sha512-Y3W0wlRPK8ZMRbNq97l4M5otioeA5lm1z7bkNkxCka8HSPjR0xRWmpCmc9utiaLP9Jb1eD8BgeIxTW4AIF45Pg==", - "dev": true - }, "p-limit": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", @@ -3448,32 +2899,24 @@ "dev": true }, "path-key": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", - "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", "dev": true }, "path-parse": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz", - "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, "path-to-regexp": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.7.0.tgz", - "integrity": "sha1-Wf3g9DW62suhA6hOnTvGTpa5k30=", + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", + "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", "dev": true, "requires": { "isarray": "0.0.1" - }, - "dependencies": { - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - } } }, "path-type": { @@ -3483,9 +2926,9 @@ "dev": true }, "pathval": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.0.tgz", - "integrity": "sha1-uULm1L3mUwBe9rcTYd74cn0GReA=", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", + "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", "dev": true }, "picomatch": { @@ -3541,16 +2984,6 @@ "resolve": "^1.11.1" } }, - "pump": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "dev": true, - "requires": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } - }, "punycode": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", @@ -3729,11 +3162,12 @@ } }, "resolve": { - "version": "1.12.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.12.0.tgz", - "integrity": "sha512-B/dOmuoAik5bKcD6s6nXDCjzUKnaDvdkRyAk6rsmsKLipWj4797iothd7jmmUhWTfinVMU+wc56rYKsit2Qy4w==", + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", + "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", "dev": true, "requires": { + "is-core-module": "^2.2.0", "path-parse": "^1.0.6" } }, @@ -3768,9 +3202,9 @@ } }, "safe-buffer": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.0.tgz", - "integrity": "sha512-fZEwUGbVl7kouZs1jCdMLdt95hdIv0ZeHg6L7qPeciMZhZ+/gdesW4wgTARkrFWEpspjEATAzUGPG8N2jJiwbg==" + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==" }, "safer-buffer": { "version": "2.1.2", @@ -3802,18 +3236,18 @@ } }, "shebang-command": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", - "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", "dev": true, "requires": { - "shebang-regex": "^1.0.0" + "shebang-regex": "^3.0.0" } }, "shebang-regex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", - "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", "dev": true }, "shelljs": { @@ -3847,24 +3281,18 @@ "object-inspect": "^1.9.0" } }, - "signal-exit": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", - "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", - "dev": true - }, "sinon": { - "version": "7.4.1", - "resolved": "https://registry.npmjs.org/sinon/-/sinon-7.4.1.tgz", - "integrity": "sha512-7s9buHGHN/jqoy/v4bJgmt0m1XEkCEd/tqdHXumpBp0JSujaT4Ng84JU5wDdK4E85ZMq78NuDe0I3NAqXY8TFg==", + "version": "7.5.0", + "resolved": "https://registry.npmjs.org/sinon/-/sinon-7.5.0.tgz", + "integrity": "sha512-AoD0oJWerp0/rY9czP/D6hDTTUYGpObhZjMpd7Cl/A6+j0xBE+ayL/ldfggkBXUs0IkvIiM1ljM8+WkOc5k78Q==", "dev": true, "requires": { "@sinonjs/commons": "^1.4.0", "@sinonjs/formatio": "^3.2.1", - "@sinonjs/samsam": "^3.3.2", + "@sinonjs/samsam": "^3.3.3", "diff": "^3.5.0", "lolex": "^4.2.0", - "nise": "^1.5.1", + "nise": "^1.5.2", "supports-color": "^5.5.0" } }, @@ -4025,23 +3453,6 @@ "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", "strip-ansi": "^6.0.0" - }, - "dependencies": { - "ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", - "dev": true - }, - "strip-ansi": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", - "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", - "dev": true, - "requires": { - "ansi-regex": "^5.0.0" - } - } } }, "string.prototype.trimend": { @@ -4065,20 +3476,12 @@ } }, "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", "dev": true, "requires": { - "ansi-regex": "^3.0.0" - }, - "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - } + "ansi-regex": "^5.0.0" } }, "strip-bom": { @@ -4087,16 +3490,10 @@ "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", "dev": true }, - "strip-eof": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", - "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", - "dev": true - }, "strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true }, "supports-color": { @@ -4123,9 +3520,9 @@ }, "dependencies": { "ajv": { - "version": "8.5.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.5.0.tgz", - "integrity": "sha512-Y2l399Tt1AguU3BPRP9Fn4eN+Or+StUGWCUpbnFyXSo8NZ9S4uj+AG2pjs5apK+ZMOwYOz1+a+VKvKH7CudXgQ==", + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.0.tgz", + "integrity": "sha512-cnUG4NSBiM4YFBxgZIj/In3/6KX+rQ2l2YPRVcvAMQGWEPKuXoPIhxzwqh31jA3IPbI4qEOp/5ILI4ynioXsGQ==", "dev": true, "requires": { "fast-deep-equal": "^3.1.1", @@ -4134,32 +3531,11 @@ "uri-js": "^4.2.2" } }, - "ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", - "dev": true - }, - "fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true - }, "json-schema-traverse": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", "dev": true - }, - "strip-ansi": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", - "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", - "dev": true, - "requires": { - "ansi-regex": "^5.0.0" - } } } }, @@ -4250,14 +3626,6 @@ "json5": "^1.0.1", "minimist": "^1.2.0", "strip-bom": "^3.0.0" - }, - "dependencies": { - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - } } }, "tslib": { @@ -4291,9 +3659,9 @@ "dev": true }, "type-fest": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", - "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", "dev": true }, "type-is": { @@ -4324,36 +3692,11 @@ "typedoc-default-themes": "^0.12.10" }, "dependencies": { - "handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "requires": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "uglify-js": "^3.1.4", - "wordwrap": "^1.0.0" - } - }, - "lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "dev": true - }, "marked": { "version": "2.0.7", "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", "dev": true - }, - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true } } }, @@ -4376,27 +3719,6 @@ "dev": true, "requires": { "handlebars": "^4.7.7" - }, - "dependencies": { - "handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "requires": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "uglify-js": "^3.1.4", - "wordwrap": "^1.0.0" - } - }, - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - } } }, "typescript": { @@ -4418,15 +3740,11 @@ "dev": true }, "uglify-js": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.6.0.tgz", - "integrity": "sha512-W+jrUHJr3DXKhrsS7NUVxn3zqMOFn0hL/Ei6v0anCIMoKC93TjcflTagwIHLW7SfMFfiQuktQyFVCFHGUE0+yg==", + "version": "3.13.9", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.9.tgz", + "integrity": "sha512-wZbyTQ1w6Y7fHdt8sJnHfSIuWeDgk6B5rCb4E/AM6QNNPbOMIZph21PW5dRB3h7Df0GszN+t7RuUH6sWK5bF0g==", "dev": true, - "optional": true, - "requires": { - "commander": "~2.20.0", - "source-map": "~0.6.1" - } + "optional": true }, "unbox-primitive": { "version": "1.0.1", @@ -4438,20 +3756,12 @@ "has-bigints": "^1.0.1", "has-symbols": "^1.0.2", "which-boxed-primitive": "^1.0.2" - }, - "dependencies": { - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - } } }, "underscore": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.9.1.tgz", - "integrity": "sha512-5/4etnCkd9c8gwgowi5/om/mYO5ajCaOgdzj/oW+0eQV9WxKBDZw5+ycmKmeaTXjInS/W0BzpGLo2xR2aBwZdg==", + "version": "1.13.1", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.1.tgz", + "integrity": "sha512-hzSoAVtJF+3ZtiFX0VgfFPHEDRm7Y/QPjGyNo4TVdnDTdft3tr8hEkD25a1jC+TjTuE7tkHGKkhwCgs9dgBB2g==", "dev": true }, "universalify": { @@ -4466,9 +3776,9 @@ "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" }, "uri-js": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", - "integrity": "sha512-KY9Frmirql91X2Qgjry0Wd4Y+YTdrdZheS8TFwvkbLWf/G5KNJDCh6pKL5OZctEW4+0Baa5idK2ZQuELRwPznQ==", + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", "dev": true, "requires": { "punycode": "^2.1.0" @@ -4497,15 +3807,15 @@ "dev": true }, "walk-back": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.1.tgz", - "integrity": "sha512-umiNB2qLO731Sxbp6cfZ9pwURJzTnftxE4Gc7hq8n/ehkuXC//s9F65IEIJA2ZytQZ1ZOsm/Fju4IWx0bivkUQ==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-4.0.0.tgz", + "integrity": "sha512-kudCA8PXVQfrqv2mFTG72vDBRi8BKWxGgFLwPpzHcpZnSwZk93WMwUDVcLHWNsnm+Y0AC4Vb6MUNRgaHfyV2DQ==", "dev": true }, "which": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", - "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", "dev": true, "requires": { "isexe": "^2.0.0" @@ -4522,23 +3832,6 @@ "is-number-object": "^1.0.4", "is-string": "^1.0.5", "is-symbol": "^1.0.3" - }, - "dependencies": { - "has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "dev": true - }, - "is-symbol": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", - "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", - "dev": true, - "requires": { - "has-symbols": "^1.0.2" - } - } } }, "which-module": { @@ -4556,6 +3849,12 @@ "string-width": "^1.0.2 || 2" }, "dependencies": { + "ansi-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", + "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", + "dev": true + }, "is-fullwidth-code-point": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", @@ -4571,6 +3870,15 @@ "is-fullwidth-code-point": "^2.0.0", "strip-ansi": "^4.0.0" } + }, + "strip-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", + "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", + "dev": true, + "requires": { + "ansi-regex": "^3.0.0" + } } } }, @@ -4597,48 +3905,52 @@ } }, "wrap-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", - "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", + "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", "dev": true, "requires": { - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1" + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" }, "dependencies": { "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true + }, + "emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", "dev": true }, "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", - "dev": true, - "requires": { - "number-is-nan": "^1.0.0" - } + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true }, "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", "dev": true, "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" } }, "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", "dev": true, "requires": { - "ansi-regex": "^2.0.0" + "ansi-regex": "^4.1.0" } } } @@ -4650,15 +3962,15 @@ "dev": true }, "xmlcreate": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.1.tgz", - "integrity": "sha512-MjGsXhKG8YjTKrDCXseFo3ClbMGvUD4en29H2Cev1dv4P/chlpw6KdYmlCWDkhosBVKRDjM836+3e3pm1cBNJA==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz", + "integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==", "dev": true }, "y18n": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz", - "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==", + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", "dev": true }, "yallist": { @@ -4668,24 +3980,29 @@ "dev": true }, "yargs": { - "version": "13.2.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.2.2.tgz", - "integrity": "sha512-WyEoxgyTD3w5XRpAQNYUB9ycVH/PQrToaTXdYXRdOXvEy1l19br+VJsc0vcO8PTGg5ro/l/GY7F/JMEBmI0BxA==", + "version": "13.3.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", + "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", "dev": true, "requires": { - "cliui": "^4.0.0", + "cliui": "^5.0.0", "find-up": "^3.0.0", "get-caller-file": "^2.0.1", - "os-locale": "^3.1.0", "require-directory": "^2.1.1", "require-main-filename": "^2.0.0", "set-blocking": "^2.0.0", "string-width": "^3.0.0", "which-module": "^2.0.0", "y18n": "^4.0.0", - "yargs-parser": "^13.0.0" + "yargs-parser": "^13.1.2" }, "dependencies": { + "ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true + }, "emoji-regex": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", @@ -4718,9 +4035,9 @@ } }, "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", "dev": true, "requires": { "p-try": "^2.0.0" @@ -4764,9 +4081,9 @@ } }, "yargs-parser": { - "version": "13.0.0", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.0.0.tgz", - "integrity": "sha512-w2LXjoL8oRdRQN+hOyppuXs+V/fVAYtpcrRxZuF7Kt/Oc+Jr2uAcVntaUTNT6w5ihoWfFDpNY8CPx1QskxZ/pw==", + "version": "13.1.2", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", + "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", "dev": true, "requires": { "camelcase": "^5.0.0", @@ -4774,117 +4091,14 @@ } }, "yargs-unparser": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.5.0.tgz", - "integrity": "sha512-HK25qidFTCVuj/D1VfNiEndpLIeJN78aqgR23nL3y4N0U/91cOAzqfHlF8n2BvoNDcZmJKin3ddNSvOxSr8flw==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.6.0.tgz", + "integrity": "sha512-W9tKgmSn0DpSatfri0nx52Joq5hVXgeLiqR/5G0sZNDoLZFOr/xjBUDcShCOGNsBnEMNo1KAMBkTej1Hm62HTw==", "dev": true, "requires": { "flat": "^4.1.0", - "lodash": "^4.17.11", - "yargs": "^12.0.5" - }, - "dependencies": { - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "get-caller-file": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-1.0.3.tgz", - "integrity": "sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - }, - "require-main-filename": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-1.0.1.tgz", - "integrity": "sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE=", - "dev": true - }, - "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "requires": { - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" - } - }, - "yargs": { - "version": "12.0.5", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-12.0.5.tgz", - "integrity": "sha512-Lhz8TLaYnxq/2ObqHDql8dX8CJi97oHxrjUcYtzKbbykPtVW9WB+poxI+NM2UIzsMgNCZTIf0AQwsjK5yMAqZw==", - "dev": true, - "requires": { - "cliui": "^4.0.0", - "decamelize": "^1.2.0", - "find-up": "^3.0.0", - "get-caller-file": "^1.0.1", - "os-locale": "^3.0.0", - "require-directory": "^2.1.1", - "require-main-filename": "^1.0.1", - "set-blocking": "^2.0.0", - "string-width": "^2.0.0", - "which-module": "^2.0.0", - "y18n": "^3.2.1 || ^4.0.0", - "yargs-parser": "^11.1.1" - } - }, - "yargs-parser": { - "version": "11.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-11.1.1.tgz", - "integrity": "sha512-C6kB/WJDiaxONLJQnF8ccx9SEeoTTLek8RVbaOIsrAUS8VrBEXfmeSnCZxygc+XC2sNMBIwOOnfcxiynjHsVSQ==", - "dev": true, - "requires": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" - } - } + "lodash": "^4.17.15", + "yargs": "^13.3.0" } } } diff --git a/package.json b/package.json index 98d2a75..c84d9b9 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "1.2.1", - "description": "SDK for building integrations.", + "version": "2.0.0", + "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", "directories": { @@ -16,7 +16,8 @@ ], "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "docs:generate": "typedoc" + "docs:generate": "typedoc", + "prepublishOnly": "tsc" }, "repository": { "type": "git", @@ -30,7 +31,6 @@ "homepage": "https://github.com/envoy/envoy-integrations-sdk-nodejs#readme", "dependencies": { "@types/dotenv": "^8.2.0", - "@types/express": "^4.17.12", "@types/faker": "^5.5.6", "@types/jsonwebtoken": "^8.5.1", "@types/node": "^15.12.0", @@ -45,6 +45,7 @@ "qs": "^6.10.1" }, "devDependencies": { + "@types/express": "^4.17.12", "@typescript-eslint/eslint-plugin": "^4.26.0", "@typescript-eslint/parser": "^4.26.0", "chai": "^4.2.0", @@ -59,5 +60,8 @@ "typedoc-github-wiki-theme": "^0.3.0", "typedoc-plugin-markdown": "^3.9.0", "typescript": "4.2" + }, + "peerDependencies": { + "@types/express": "^4" } } diff --git a/src/index.ts b/src/index.ts index 63e1f1c..e1e0c54 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,8 +1,7 @@ +import './constants'; import EntryPayload from './payloads/EntryPayload'; import InvitePayload from './payloads/InvitePayload'; -import asyncHandler from './sdk/asyncHandler'; -import errorMiddleware from './sdk/errorMiddleware'; import EnvoyPluginJob from './sdk/EnvoyPluginJob'; import EnvoyPluginSDK from './sdk/EnvoyPluginSDK'; import EnvoyPluginStorage from './sdk/EnvoyPluginStorage'; @@ -11,7 +10,6 @@ import EnvoyResponse from './sdk/EnvoyResponse'; import EnvoyStorageItem from './sdk/EnvoyStorageItem'; import EnvoyUserAPI from './sdk/EnvoyUserAPI'; import EnvoyPluginAPI from './sdk/EnvoyPluginAPI'; -import middleware, { EnvoyMiddleware } from './sdk/middleware'; import EnvoyJWT from './util/EnvoyJWT'; import JSONAPIData from './util/json-api/JSONAPIData'; @@ -30,16 +28,16 @@ export * from './resources/UserResource'; export * from './sdk/EnvoyMeta'; export * from './sdk/EnvoyRequest'; export * from './sdk/EnvoyResponse'; +export * from './sdk/filters'; +export * from './sdk/handlers'; +export * from './sdk/middleware'; export * from './util/EnvoySignatureVerifier'; export { - asyncHandler, - errorMiddleware, EntryPayload, InvitePayload, EnvoyJWT, - EnvoyMiddleware, EnvoyPluginJob, EnvoyPluginSDK, EnvoyPluginStorage, @@ -49,5 +47,4 @@ export { EnvoyPluginAPI, EnvoyUserAPI, JSONAPIData, - middleware, }; diff --git a/src/internal/EnvoySelectedValuesRouteResponseBody.ts b/src/internal/EnvoySelectedValuesRouteResponseBody.ts index d3fe536..49aa79e 100644 --- a/src/internal/EnvoySelectedValuesRouteResponseBody.ts +++ b/src/internal/EnvoySelectedValuesRouteResponseBody.ts @@ -1,4 +1,4 @@ import EnvoyOption from './EnvoyOption'; -type EnvoySelectedValuesRouteResponseBody = EnvoyOption; +type EnvoySelectedValuesRouteResponseBody = Array | EnvoyOption | null; export default EnvoySelectedValuesRouteResponseBody; diff --git a/src/sdk/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts index 6723b3b..1de4322 100644 --- a/src/sdk/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -32,8 +32,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline get. */ - get(key: string): Promise { - return this.pipeline().get(key).executeSingle(); + get(key: string): Promise | null> { + return this.pipeline().get(key).executeSingle() as Promise | null>; } /** @@ -41,8 +41,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline set. */ - set(key: string, value: unknown): Promise { - return this.pipeline().set(key, value).executeSingle(); + set(key: string, value: Value): Promise> { + return this.pipeline().set(key, value).executeSingle() as Promise>; } /** @@ -50,8 +50,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline setUnique. */ - setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): Promise { - return this.pipeline().setUnique(key, options).executeSingle(); + setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): Promise | null> { + return this.pipeline().setUnique(key, options).executeSingle() as Promise | null>; } /** @@ -59,8 +59,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline setUnique. */ - setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): Promise { - return this.pipeline().setUniqueNum(key, options).executeSingle(); + setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): Promise | null> { + return this.pipeline().setUniqueNum(key, options).executeSingle() as Promise | null>; } /** diff --git a/src/sdk/EnvoyRequest.ts b/src/sdk/EnvoyRequest.ts index f262bc0..29e6b2f 100644 --- a/src/sdk/EnvoyRequest.ts +++ b/src/sdk/EnvoyRequest.ts @@ -46,6 +46,14 @@ export type EnvoyRouteRequest< Params = Record, > = EnvoyBaseRequest, Payload>; +/** + * Use to type your `req` object in Envoy "migration" route handlers. + * + * @category Request + */ +export type EnvoyMigrationRouteRequest> = + EnvoyRouteRequest; + /** * Use to type your `req` object in Envoy "options URL" route handlers. * @@ -70,14 +78,22 @@ export type EnvoySelectedValuesRouteRequest> = export type EnvoyRemoteValueRouteRequest> = EnvoyRouteRequest; +/** + * Use to type your `req` object in Envoy "validation URL" route handlers. + * + * @category Request + */ +export type EnvoyValidationRouteRequest, Config = Record> = + EnvoyRouteRequest; + /** * Base type for event requests. * You should use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}. * * @category Request */ -export type EnvoyEventRequest = - EnvoyBaseRequest, Payload>; +export type EnvoyEventRequest> = + EnvoyBaseRequest, Payload>; /** * Use to type your `req` object in entry event handlers, @@ -85,7 +101,8 @@ export type EnvoyEventRequest * * @category Request */ -export type EnvoyEntryEventRequest = EnvoyEventRequest; +export type EnvoyEntryEventRequest> = + EnvoyEventRequest; /** * Use to type your `req` object in invite event handlers, @@ -93,7 +110,8 @@ export type EnvoyEntryEventRequest = EnvoyEventRequest; +export type EnvoyInviteEventRequest> = + EnvoyEventRequest; /** * You probably won't need to use this type directly. @@ -102,5 +120,6 @@ export type EnvoyInviteEventRequest = EnvoyEventRequest = EnvoyBaseRequest; +type EnvoyRequest> = + EnvoyBaseRequest | EnvoyEventMeta, Payload>; export default EnvoyRequest; diff --git a/src/sdk/EnvoyResponse.ts b/src/sdk/EnvoyResponse.ts index d90b8fc..bb4ccb7 100644 --- a/src/sdk/EnvoyResponse.ts +++ b/src/sdk/EnvoyResponse.ts @@ -2,6 +2,7 @@ import { Response } from 'express'; import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody'; import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody'; +import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody'; /** * Use to type your `res` object in Envoy event handlers. @@ -32,6 +33,12 @@ export default interface EnvoyResponse extends Response { */ export type EnvoyOptionsRouteResponse = EnvoyResponse; +/** + * Use to type your `res` object in Envoy "remote value URL" route handlers. + * @category Response + */ +export type EnvoyRemoteValueRouteResponse = EnvoyResponse; + /** * Use to type your `res` object in Envoy "selected values URL" route handlers. * @category Response diff --git a/src/sdk/EnvoyStorageItem.ts b/src/sdk/EnvoyStorageItem.ts index 6524252..5238940 100644 --- a/src/sdk/EnvoyStorageItem.ts +++ b/src/sdk/EnvoyStorageItem.ts @@ -1,9 +1,9 @@ /** * @category Storage */ -type EnvoyStorageItem = { +type EnvoyStorageItem = { key: string, - value: unknown, + value: Value, }; export default EnvoyStorageItem; diff --git a/src/sdk/asyncHandler.ts b/src/sdk/asyncHandler.ts deleted file mode 100644 index 5a45e89..0000000 --- a/src/sdk/asyncHandler.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { RequestHandler, NextFunction } from 'express'; -import EnvoyRequest from './EnvoyRequest'; -import EnvoyResponse from './EnvoyResponse'; - -export type EnvoyHandler = (req: EnvoyRequest, res: EnvoyResponse) => void | Promise; - -/** - * Wraps any express.js-based handlers - * to catch Promise-based errors. - * - * @category Helper - */ -export default function asyncHandler(handler: RequestHandler | EnvoyHandler) { - return async (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): Promise => { - try { - // eslint-disable-next-line @typescript-eslint/await-thenable - await handler(req, res, next); - } catch (err) { - next(err); - } - }; -} diff --git a/src/sdk/errorMiddleware.ts b/src/sdk/errorMiddleware.ts deleted file mode 100644 index d384661..0000000 --- a/src/sdk/errorMiddleware.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { NextFunction } from 'express'; -import HttpStatus from '../internal/HttpStatus'; -import EnvoyRequest from './EnvoyRequest'; -import EnvoyResponse from './EnvoyResponse'; - -/** - * Catches errors and sets the proper status code. - * - * @category SDK - */ -export default function errorMiddleware(onError: (err: Error) => void = () => {}) { - return (err: Error, req: EnvoyRequest, res: EnvoyResponse, next: NextFunction): void => { - onError(err); - if (res.headersSent) { - return next(err); - } - res.statusCode = HttpStatus.UNEXPECTED_FAILURE; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ message: err.message })); - }; -} diff --git a/src/sdk/filters.ts b/src/sdk/filters.ts new file mode 100644 index 0000000..7e1d549 --- /dev/null +++ b/src/sdk/filters.ts @@ -0,0 +1,96 @@ +import { + Request, + Response, + NextFunction, + RequestHandler, +} from 'express'; +import EnvoyRequest, { EnvoyEntryEventRequest } from './EnvoyRequest'; +import EnvoyResponse from './EnvoyResponse'; + +/** + * Will only proceed if the install's `config` has a truthy value for the given `key`. + * + * @internal + */ +export function booleanFilterMiddleware(key: keyof Config, message: string): RequestHandler { + return (req: Request, res: Response, next: NextFunction): void => { + if ((req as EnvoyRequest).envoy.meta.config[key]) { + return next(); + } + (res as EnvoyResponse).sendIgnored(message); + }; +} + +/** + * Will only proceed if the install's `config` has a truthy value for the given `employeeSignInEnabledKey`. + * + * @category Filter + * @category Middleware + */ +export function employeeSignInEnabledMiddleware( + employeeSignInEnabledKey: keyof Config, + message = 'Envoy Protect is disabled.', +): RequestHandler { + return booleanFilterMiddleware(employeeSignInEnabledKey, message); +} + +/** + * Will not proceed if the employee who's signing in is present in the excluded employees list. + * + * @category Filter + * @category Middleware + */ +export function excludeEmployeesMiddleware( + excludeEmployeesKey: keyof Config, + message = 'Employee excluded from integration.', +): RequestHandler { + return (req: Request, res: Response, next: NextFunction): void => { + const { + envoy: { + meta: { + config, + }, + payload, + }, + } = req as EnvoyEntryEventRequest; + if (!payload.attributes['employee-screening-flow']) { + return next(); + } + const excludedEmployees = config[excludeEmployeesKey]; + if (!Array.isArray(excludedEmployees)) { + return next(new Error(`${excludeEmployeesKey} is not an array.`)); + } + const employeeId = payload.relationships.employee?.data.id; + if (!employeeId || !excludedEmployees.includes(employeeId)) { + return next(); + } + (res as EnvoyResponse).sendIgnored(message); + }; +} + +/** + * Will only proceed if the entry has an invite + * and the install's `config` has a truthy value for the given `invitesOnlyKey`. + * + * @category Filter + * @category Middleware + */ +export function inviteOnlyEntryFilterMiddleware( + invitesOnlyKey: keyof Config, + message = 'Visitors must be invited.', +): RequestHandler { + return (req: Request, res: Response, next: NextFunction): void => { + const { + envoy: { + meta: { + config, + }, + payload, + }, + } = (req as EnvoyEntryEventRequest); + if (!payload.relationships.invite && config[invitesOnlyKey]) { + return (res as EnvoyResponse).sendIgnored(message); + } + next(); + }; +} diff --git a/src/sdk/handlers.ts b/src/sdk/handlers.ts new file mode 100644 index 0000000..42acfe2 --- /dev/null +++ b/src/sdk/handlers.ts @@ -0,0 +1,195 @@ +import { + NextFunction, + RequestHandler, + Request, + Response, +} from 'express'; +import { + EnvoyEntryEventRequest, + EnvoyEventRequest, + EnvoyInviteEventRequest, + EnvoyMigrationRouteRequest, + EnvoyOptionsRouteRequest, + EnvoyRemoteValueRouteRequest, + EnvoySelectedValuesRouteRequest, + EnvoyValidationRouteRequest, +} from './EnvoyRequest'; +import EnvoyResponse, { + EnvoyOptionsRouteResponse, + EnvoyRemoteValueRouteResponse, + EnvoySelectedValuesRouteResponse, +} from './EnvoyResponse'; + +type SomeObject = Record; + +type Result = Promise | void; + +/** + * Handle an entry event, such as `entry_sign_in`. + * @category Handler + */ +export type EntryEventHandler = + (req: EnvoyEntryEventRequest & Additions, res: EnvoyResponse) => Result; + +/** + * Handle an invite event, such as `invite_created`. + * @category Handler + */ +export type InviteEventHandler = + (req: EnvoyInviteEventRequest & Additions, res: EnvoyResponse) => Result; + +/** + * Handle a `plugin_uninstalled` event for cleaning up. + * @category Handler + */ +export type PluginUninstalledEventHandler = + (req: EnvoyEventRequest<'plugin_uninstalled', never, Config> & Additions, res: EnvoyResponse) => Result; + +/** + * Handle a "migration" route. + * @category Handler + */ +export type MigrationRouteHandler = + (req: EnvoyMigrationRouteRequest & Additions, res: EnvoyResponse) => Result; + +/** + * Handle an "options" route. + * @category Handler + */ +export type OptionsRouteHandler = + (req: EnvoyOptionsRouteRequest & Additions, res: EnvoyOptionsRouteResponse) => Result; + +/** + * Handle a "remote value" route. + * @category Handler + */ +export type RemoteValueRouteHandler = + (req: EnvoyRemoteValueRouteRequest & Additions, res: EnvoyRemoteValueRouteResponse) => Result; + +/** + * Handle a "selected values" route. + * @category Handler + */ +export type SelectedValuesRouteHandler = + (req: EnvoySelectedValuesRouteRequest & Additions, res: EnvoySelectedValuesRouteResponse) => Result; + +/** + * Handle a "validation" route. + * @category Handler + */ +export type ValidationRouteHandler = + (req: EnvoyValidationRouteRequest & Additions, res: EnvoyResponse) => Result; + +/** + * Wraps any express.js-based handlers + * to catch Promise-based errors. + * + * @category Handler + */ +// eslint-disable-next-line max-len +export function asyncHandler(handler: (req: Req, res: Res) => Result): RequestHandler { + // eslint-disable-next-line @typescript-eslint/ban-ts-comment + // @ts-ignore + return (req: Req, res: Res, next: NextFunction): void => { + void Promise.resolve().then(() => handler(req, res)).catch(next); + }; +} + +/** + * Handler for entry events. + * + * @category Handler + */ +export function entryEventHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: EntryEventHandler) { + return asyncHandler(handler); +} + +/** + * Handler for invite events. + * + * @category Handler + */ +export function inviteEventHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: InviteEventHandler) { + return asyncHandler(handler); +} + +/** + * Handler for `plugin_uninstalled` events. + * + * @category Handler + */ +export function pluginUninstalledEventHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: PluginUninstalledEventHandler) { + return asyncHandler(handler); +} + +/** + * Handler for a migration route. + * + * @category Handler + */ +export function migrationRouteHandler< + OldConfig, + NewConfig, + Additions = SomeObject, + >(handler: MigrationRouteHandler) { + return asyncHandler(handler); +} + +/** + * Handler for options URL routes. + * + * @category Handler + */ +export function optionsRouteHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: OptionsRouteHandler) { + return asyncHandler(handler); +} + +/** + * Handler for remote value URL routes. + * + * @category Handler + */ +export function remoteValueRouteHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: RemoteValueRouteHandler) { + return asyncHandler(handler); +} + +/** + * Handler for selected values URL routes. + * + * @category Handler + */ +export function selectedValuesRouteHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: SelectedValuesRouteHandler) { + return asyncHandler(handler); +} + +/** + * Handler for validation URL routes. + * + * @category Handler + */ +export function validationRouteHandler< + Config = SomeObject, + Payload = SomeObject, + ToSave = SomeObject, + Additions = SomeObject, + >(handler: ValidationRouteHandler) { + return asyncHandler(handler); +} diff --git a/src/sdk/middleware.ts b/src/sdk/middleware.ts index 6e43cac..bb3182e 100644 --- a/src/sdk/middleware.ts +++ b/src/sdk/middleware.ts @@ -1,5 +1,11 @@ import bodyParser from 'body-parser'; -import { Response, NextFunction } from 'express'; +import { + Request, + Response, + NextFunction, + ErrorRequestHandler, + RequestHandler, +} from 'express'; import HttpStatus from '../internal/HttpStatus'; import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from '../util/EnvoySignatureVerifier'; @@ -9,11 +15,6 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment'; import EnvoyPluginSDK from './EnvoyPluginSDK'; import EnvoyPluginAPI from './EnvoyPluginAPI'; -/** - * @category Helper - */ -export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => void; - /** * Sets up an {@link EnvoyPluginSDK} object in the path `req.envoy`. * Modifies the `res` object to include Envoy's helpers, per {@link EnvoyResponse}. @@ -21,9 +22,9 @@ export type EnvoyMiddleware = (req: EnvoyRequest, res: EnvoyResponse, next: Next * Also verifies that the request is coming from Envoy, * as well as managing the plugin access token lifecycle. * - * @category SDK + * @category Middleware */ -export default function middleware(options?: EnvoySignatureVerifierOptions): EnvoyMiddleware { +export function envoyMiddleware(options?: EnvoySignatureVerifierOptions): RequestHandler { const signatureVerifier = new EnvoySignatureVerifier(options); const verify = (req: VerifiedRequest, res: Response, rawBody: Buffer) => { req[VERIFIED] = signatureVerifier.verify(req, rawBody); @@ -32,7 +33,7 @@ export default function middleware(options?: EnvoySignatureVerifierOptions): Env let accessToken: string | null = null; let threshold = 0; - return (req: EnvoyRequest, res: EnvoyResponse, next: NextFunction) => { + return (req: Request, res: Response, next: NextFunction) => { json(req, res, async (err) => { if (err) { return next(err); @@ -44,34 +45,35 @@ export default function middleware(options?: EnvoySignatureVerifierOptions): Env accessToken = rawAccessToken; threshold = now + (expiresIn * 1000) - (1000 * 60 * 10); } - - req.envoy = new EnvoyPluginSDK(req.body, req[VERIFIED], accessToken); + const envoyRequest = req as EnvoyRequest; + const envoyResponse = res as EnvoyResponse; + envoyRequest.envoy = new EnvoyPluginSDK(envoyRequest.body, envoyRequest[VERIFIED], accessToken); /** * Respond with "ongoing" for long jobs. */ - res.sendOngoing = (message = '', debugInfo: unknown = {}) => { - res.statusCode = HttpStatus.ONGOING; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ message, debugInfo })); + envoyResponse.sendOngoing = (message = '', debugInfo: unknown = {}) => { + envoyResponse.statusCode = HttpStatus.ONGOING; + envoyResponse.setHeader('Content-Type', 'application/json'); + envoyResponse.end(JSON.stringify({ message, debugInfo })); }; /** * Respond with "ignored" if no action will be performed. */ - res.sendIgnored = (message = '', debugInfo: unknown = {}, ...attachments: Array) => { - res.statusCode = HttpStatus.IGNORED; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ message, debugInfo, attachments })); + envoyResponse.sendIgnored = (message = '', debugInfo: unknown = {}, ...attachments: Array) => { + envoyResponse.statusCode = HttpStatus.IGNORED; + envoyResponse.setHeader('Content-Type', 'application/json'); + envoyResponse.end(JSON.stringify({ message, debugInfo, attachments })); }; /** * Respond with "failed" in case of errors. */ - res.sendFailed = (message = '', debugInfo: unknown = {}, ...attachments: Array) => { - res.statusCode = HttpStatus.FAILED; - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify({ message, debugInfo, attachments })); + envoyResponse.sendFailed = (message = '', debugInfo: unknown = {}, ...attachments: Array) => { + envoyResponse.statusCode = HttpStatus.FAILED; + envoyResponse.setHeader('Content-Type', 'application/json'); + envoyResponse.end(JSON.stringify({ message, debugInfo, attachments })); }; next(); } catch (error) { @@ -80,3 +82,20 @@ export default function middleware(options?: EnvoySignatureVerifierOptions): Env }); }; } + +/** + * Catches errors and sets the proper status code. + * + * @category Middleware + */ +export function errorMiddleware(onError: (err: Error) => void = () => {}): ErrorRequestHandler { + return (err: Error, req: Request, res: Response, next: NextFunction): void => { + onError(err); + if (res.headersSent) { + return next(err); + } + res.statusCode = HttpStatus.UNEXPECTED_FAILURE; + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify({ message: err.message })); + }; +} From 6f08a8269daa3fd2dd34b931bb509859f2756cec Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sun, 13 Jun 2021 16:42:55 -0400 Subject: [PATCH 33/91] docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed04073..b078b99 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ View our Node.js [quickstart guide](https://developers.envoy.com/hub/docs/nodejs When customers go through your integration's setup steps, that info is saved in a `config` object that is sent along with every request Envoy makes to your integration. Defining this object as a specific type allows us to safely type the various handlers that will use those values. + ```typescript // defs/Config.ts type Config = { @@ -45,7 +46,7 @@ As customers go through the setup steps of your integration, they may trigger se Below, we'll implement a route that will load a list of greetings into a dropdown in our setup steps. -View the other types of handlers. +View the other types of handlers [here](docs#handler-functions). ```typescript // greetingOptions.ts @@ -73,6 +74,9 @@ export default optionsRouteHandler((req, res) => { Your integration can respond to several Envoy events. Below, we'll implement a simple event handler for an `entry_sign_in` event. All it does is to take the greeting that the customer chose during setup, and displays it in the Envoy Dashboard when a visitor signs in. + +View the other types of handlers [here](docs#handler-functions). + ```typescript // entrySignIn.ts import { entryEventHandler } from '@envoy/envoy-integrations-sdk'; @@ -89,7 +93,9 @@ export default entryEventHandler(async (req, res) => { #### Setup your `express.js` app +Use the `envoyMiddleware` to get an instance of [EnvoyPluginSDK](docs/classes/envoypluginsdk.md) attached to every request. +View the other types of middleware [here](docs#middleware-functions). ```typescript // index.ts import express from 'express'; From 410ee70bbf24e7ad2074cedc415a420789d45806 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sun, 13 Jun 2021 17:05:47 -0400 Subject: [PATCH 34/91] simplified validation handler --- docs/README.md | 160 ++++++++++---------- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 16 +- docs/classes/envoypluginsdk.md | 22 +-- docs/classes/envoypluginstorage.md | 18 +-- docs/classes/envoyuserapi.md | 50 +++--- docs/interfaces/agreementattributes.md | 18 +-- docs/interfaces/companyattributes.md | 8 +- docs/interfaces/employeeattributes.md | 18 +-- docs/interfaces/employeefilterfields.md | 20 +-- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/flowattributes.md | 10 +- docs/interfaces/flowfilterfields.md | 4 +- docs/interfaces/inviteattributes.md | 38 ++--- docs/interfaces/invitecreationattributes.md | 18 +-- docs/interfaces/invitefilterfields.md | 22 +-- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/locationattributes.md | 74 ++++----- docs/interfaces/locationfilterfields.md | 4 +- docs/interfaces/signinfieldattributes.md | 20 +-- src/sdk/handlers.ts | 7 +- 23 files changed, 281 insertions(+), 284 deletions(-) diff --git a/docs/README.md b/docs/README.md index a061e91..92b773c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -175,7 +175,7 @@ #### Defined in -[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L26) +[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L26) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementPageResource.ts#L6) +[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementPageResource.ts#L6) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementPageResource.ts#L19) +[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementPageResource.ts#L19) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementPageResource.ts#L14) +[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementPageResource.ts#L14) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L21) +[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L21) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L21) +[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L21) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L16) +[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L16) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L47) +[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L47) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L42) +[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L42) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L6) +[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L6) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L35) +[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L35) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L30) +[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L30) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L6) +[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L6) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L92) +[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L92) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L87) +[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L87) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L82) +[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L82) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L6) +[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L6) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L67) +[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L67) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L62) +[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L62) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L6) +[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L6) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L31) +[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L31) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldPageResource.ts#L6) +[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldPageResource.ts#L6) ___ @@ -409,7 +409,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldPageResource.ts#L23) +[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldPageResource.ts#L23) ___ @@ -419,7 +419,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldPageResource.ts#L14) +[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldPageResource.ts#L14) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L26) +[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L26) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/UserResource.ts#L6) +[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/UserResource.ts#L6) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/UserResource.ts#L14) +[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/UserResource.ts#L14) ___ @@ -479,7 +479,7 @@ and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) o #### Defined in -[sdk/EnvoyRequest.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L123) +[sdk/EnvoyRequest.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L123) ___ @@ -531,7 +531,7 @@ ___ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/payloads/EntryPayload.ts#L6) ___ @@ -583,7 +583,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/payloads/InvitePayload.ts#L6) ___ @@ -619,7 +619,7 @@ Handle an entry event, such as `entry_sign_in`. #### Defined in -[sdk/handlers.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L31) +[sdk/handlers.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L31) ___ @@ -653,7 +653,7 @@ Handle an invite event, such as `invite_created`. #### Defined in -[sdk/handlers.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L38) +[sdk/handlers.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L38) ___ @@ -688,7 +688,7 @@ Handle a "migration" route. #### Defined in -[sdk/handlers.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L52) +[sdk/handlers.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L52) ___ @@ -722,7 +722,7 @@ Handle an "options" route. #### Defined in -[sdk/handlers.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L59) +[sdk/handlers.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L59) ___ @@ -756,7 +756,7 @@ Handle a `plugin_uninstalled` event for cleaning up. #### Defined in -[sdk/handlers.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L45) +[sdk/handlers.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L45) ___ @@ -790,7 +790,7 @@ Handle a "remote value" route. #### Defined in -[sdk/handlers.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L66) +[sdk/handlers.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L66) ___ @@ -824,13 +824,13 @@ Handle a "selected values" route. #### Defined in -[sdk/handlers.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L73) +[sdk/handlers.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L73) ___ ### ValidationRouteHandler -Ƭ **ValidationRouteHandler**: (`req`: [EnvoyValidationRouteRequest](README.md#envoyvalidationrouterequest) & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)) => `Result` +Ƭ **ValidationRouteHandler**: (`req`: [EnvoyValidationRouteRequest](README.md#envoyvalidationrouterequest) & `Additions`, `res`: [EnvoyResponse](interfaces/envoyresponse.md)\>) => `Result` Handle a "validation" route. @@ -840,7 +840,6 @@ Handle a "validation" route. | :------ | :------ | | `Config` | `Config` = `SomeObject` | | `Payload` | `Payload` = `SomeObject` | -| `Body` | `Body` = `SomeObject` | | `Additions` | `Additions` = `SomeObject` | #### Type declaration @@ -852,7 +851,7 @@ Handle a "validation" route. | Name | Type | | :------ | :------ | | `req` | [EnvoyValidationRouteRequest](README.md#envoyvalidationrouterequest) & `Additions` | -| `res` | [EnvoyResponse](interfaces/envoyresponse.md) | +| `res` | [EnvoyResponse](interfaces/envoyresponse.md)\> | ##### Returns @@ -860,7 +859,7 @@ Handle a "validation" route. #### Defined in -[sdk/handlers.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L80) +[sdk/handlers.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L80) ___ @@ -881,7 +880,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -915,7 +914,7 @@ Metadata that will be included in the request body for events. #### Defined in -[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L66) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L66) ___ @@ -938,7 +937,7 @@ Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L53) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L53) ___ @@ -959,7 +958,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L37) ___ @@ -983,7 +982,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L4) ___ @@ -1015,7 +1014,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L13) ___ @@ -1049,7 +1048,7 @@ like validation URLs or options URLs. #### Defined in -[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyMeta.ts#L83) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L83) ___ @@ -1070,7 +1069,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[sdk/EnvoyRequest.ts:104](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L104) +[sdk/EnvoyRequest.ts:104](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L104) ___ @@ -1091,7 +1090,7 @@ You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [En #### Defined in -[sdk/EnvoyRequest.ts:95](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L95) +[sdk/EnvoyRequest.ts:95](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L95) ___ @@ -1110,7 +1109,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[sdk/EnvoyRequest.ts:113](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L113) +[sdk/EnvoyRequest.ts:113](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L113) ___ @@ -1128,7 +1127,7 @@ Use to type your `req` object in Envoy "migration" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L54) +[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L54) ___ @@ -1146,7 +1145,7 @@ Use to type your `req` object in Envoy "options URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L62) +[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L62) ___ @@ -1164,7 +1163,7 @@ Use to type your `req` object in Envoy "remote value URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L78) +[sdk/EnvoyRequest.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L78) ___ @@ -1184,7 +1183,7 @@ Use to type your `req` object in Envoy route handlers such as validation URLs. #### Defined in -[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L43) +[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L43) ___ @@ -1202,7 +1201,7 @@ Use to type your `req` object in Envoy "selected values URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L70) ___ @@ -1221,7 +1220,7 @@ Use to type your `req` object in Envoy "validation URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L86) +[sdk/EnvoyRequest.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L86) ___ @@ -1235,7 +1234,7 @@ Use to type your `res` object in Envoy "options URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L34) +[sdk/EnvoyResponse.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L34) ___ @@ -1247,7 +1246,7 @@ Use to type your `res` object in Envoy "remote value URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L40) +[sdk/EnvoyResponse.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L40) ___ @@ -1259,7 +1258,7 @@ Use to type your `res` object in Envoy "selected values URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L46) +[sdk/EnvoyResponse.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L46) ___ @@ -1284,7 +1283,7 @@ ___ #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyStorageItem.ts#L4) ## Filter Functions @@ -1313,7 +1312,7 @@ Will only proceed if the install's `config` has a truthy value for the given `em #### Defined in -[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L30) +[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L30) ___ @@ -1342,7 +1341,7 @@ Will not proceed if the employee who's signing in is present in the excluded emp #### Defined in -[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L43) +[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L43) ___ @@ -1372,7 +1371,7 @@ and the install's `config` has a truthy value for the given `invitesOnlyKey`. #### Defined in -[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L78) +[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L78) ___ @@ -1404,7 +1403,7 @@ to catch Promise-based errors. #### Defined in -[sdk/handlers.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L90) +[sdk/handlers.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L90) ___ @@ -1433,7 +1432,7 @@ Handler for entry events. #### Defined in -[sdk/handlers.ts:103](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L103) +[sdk/handlers.ts:103](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L103) ___ @@ -1462,7 +1461,7 @@ Handler for invite events. #### Defined in -[sdk/handlers.ts:115](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L115) +[sdk/handlers.ts:115](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L115) ___ @@ -1492,7 +1491,7 @@ Handler for a migration route. #### Defined in -[sdk/handlers.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L139) +[sdk/handlers.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L139) ___ @@ -1521,7 +1520,7 @@ Handler for options URL routes. #### Defined in -[sdk/handlers.ts:152](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L152) +[sdk/handlers.ts:152](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L152) ___ @@ -1550,7 +1549,7 @@ Handler for `plugin_uninstalled` events. #### Defined in -[sdk/handlers.ts:127](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L127) +[sdk/handlers.ts:127](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L127) ___ @@ -1579,7 +1578,7 @@ Handler for remote value URL routes. #### Defined in -[sdk/handlers.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L164) +[sdk/handlers.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L164) ___ @@ -1608,13 +1607,13 @@ Handler for selected values URL routes. #### Defined in -[sdk/handlers.ts:176](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L176) +[sdk/handlers.ts:176](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L176) ___ ### validationRouteHandler -▸ **validationRouteHandler**(`handler`): `RequestHandler`\> +▸ **validationRouteHandler**(`handler`): `RequestHandler`\> Handler for validation URL routes. @@ -1624,14 +1623,13 @@ Handler for validation URL routes. | :------ | :------ | | `Config` | `Config` = `SomeObject` | | `Payload` | `Payload` = `SomeObject` | -| `ToSave` | `ToSave` = `SomeObject` | | `Additions` | `Additions` = `SomeObject` | #### Parameters | Name | Type | | :------ | :------ | -| `handler` | [ValidationRouteHandler](README.md#validationroutehandler) | +| `handler` | [ValidationRouteHandler](README.md#validationroutehandler) | #### Returns @@ -1639,7 +1637,7 @@ Handler for validation URL routes. #### Defined in -[sdk/handlers.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/handlers.ts#L188) +[sdk/handlers.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L188) ___ @@ -1670,7 +1668,7 @@ Will only proceed if the install's `config` has a truthy value for the given `em #### Defined in -[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L30) +[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L30) ___ @@ -1696,7 +1694,7 @@ as well as managing the plugin access token lifecycle. #### Defined in -[sdk/middleware.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/middleware.ts#L27) +[sdk/middleware.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/middleware.ts#L27) ___ @@ -1718,7 +1716,7 @@ Catches errors and sets the proper status code. #### Defined in -[sdk/middleware.ts:91](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/middleware.ts#L91) +[sdk/middleware.ts:91](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/middleware.ts#L91) ___ @@ -1747,7 +1745,7 @@ Will not proceed if the employee who's signing in is present in the excluded emp #### Defined in -[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L43) +[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L43) ___ @@ -1777,4 +1775,4 @@ and the install's `config` has a truthy value for the given `invitesOnlyKey`. #### Defined in -[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/filters.ts#L78) +[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L78) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 5cd1f4c..00fe4d2 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index d570c6e..069edef 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L61) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -106,7 +106,7 @@ Fetches the current `config` saved for this install during setup by the customer #### Defined in -[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L27) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -131,7 +131,7 @@ To remove an item from the saved `config`, set the item's key to `null`. #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L45) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -196,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginAPI.ts#L72) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index eb014b7..2384a33 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -42,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -52,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -84,7 +84,7 @@ Add attachments to this job. #### Defined in -[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L48) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -110,7 +110,7 @@ using {@link EnvoyRequest.send}. #### Defined in -[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L58) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -136,7 +136,7 @@ using {@link EnvoyRequest.sendFailed}. #### Defined in -[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L78) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -162,7 +162,7 @@ using {@link EnvoyRequest.sendIgnored}. #### Defined in -[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L68) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -187,4 +187,4 @@ Can be used to periodically update long-running jobs. #### Defined in -[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginJob.ts#L87) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index a8f0fbd..43dda98 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -59,7 +59,7 @@ Instead, use {@link middleware} to automatically attach an instance to `req` on #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -87,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L140) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -103,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L133) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -119,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L122) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -135,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L158) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -151,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L147) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -168,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L171) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -185,7 +185,7 @@ Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../ #### Defined in -[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L61) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -203,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L73) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -220,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L101) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -237,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginSDK.ts#L84) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index 43e4022..b95c7dc 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -90,7 +90,7 @@ Wrapper for single pipeline get. #### Defined in -[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L35) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -106,7 +106,7 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -137,7 +137,7 @@ Wrapper for single pipeline set. #### Defined in -[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L44) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L44) ___ @@ -162,7 +162,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L53) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L53) ___ @@ -187,7 +187,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L62) ___ @@ -211,4 +211,4 @@ Wrapper for single pipeline unset. #### Defined in -[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyPluginStorage.ts#L71) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index ec8de88..686db0f 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -65,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L59) ## Properties @@ -81,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L32) ## Methods @@ -104,7 +104,7 @@ May also require `invites.attest` scope if setting `attested: true`. #### Defined in -[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L188) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L188) ___ @@ -127,7 +127,7 @@ Requires `agreements.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L65) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L65) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L58) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L58) ___ @@ -173,7 +173,7 @@ Requires `companies.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L72) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L72) ___ @@ -196,7 +196,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L79) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L79) ___ @@ -219,7 +219,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -241,7 +241,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L136) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L136) ___ @@ -264,7 +264,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L86) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L86) ___ @@ -286,7 +286,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L146) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L146) ___ @@ -308,7 +308,7 @@ Requires `invites.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L172) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L172) ___ @@ -331,7 +331,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L93) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L93) ___ @@ -353,7 +353,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L154) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L154) ___ @@ -376,7 +376,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L107) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L107) ___ @@ -399,7 +399,7 @@ Requires `sign-in-field-pages.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L100) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L100) ___ @@ -421,7 +421,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L164) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L164) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L179) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L179) ___ @@ -458,7 +458,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L213) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -480,7 +480,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L226) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L226) ___ @@ -503,7 +503,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L200) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L200) ___ @@ -531,7 +531,7 @@ Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exc #### Defined in -[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L240) +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L240) ___ @@ -555,7 +555,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L306) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L306) ___ @@ -580,7 +580,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L280) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L280) ___ @@ -606,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged - use [ #### Defined in -[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyUserAPI.ts#L252) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/agreementattributes.md b/docs/interfaces/agreementattributes.md index 021411d..1a8e691 100644 --- a/docs/interfaces/agreementattributes.md +++ b/docs/interfaces/agreementattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L10) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L13) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L12) +[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L7) +[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L7) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L8) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L13) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L8) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L14) +[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L14) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L10) diff --git a/docs/interfaces/companyattributes.md b/docs/interfaces/companyattributes.md index b8ee3dc..b28185f 100644 --- a/docs/interfaces/companyattributes.md +++ b/docs/interfaces/companyattributes.md @@ -19,7 +19,7 @@ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L8) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L8) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L7) +[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L7) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/CompanyResource.ts#L9) +[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L9) diff --git a/docs/interfaces/employeeattributes.md b/docs/interfaces/employeeattributes.md index c2246b0..6269bb8 100644 --- a/docs/interfaces/employeeattributes.md +++ b/docs/interfaces/employeeattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L32) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L33) +[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L33) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L32) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L35) +[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L35) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L29) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L28) +[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L28) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L29) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L30) +[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L30) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L34) +[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L34) diff --git a/docs/interfaces/employeefilterfields.md b/docs/interfaces/employeefilterfields.md index fa16298..2c3b683 100644 --- a/docs/interfaces/employeefilterfields.md +++ b/docs/interfaces/employeefilterfields.md @@ -25,7 +25,7 @@ #### Defined in -[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L13) +[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L13) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L12) +[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L12) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L15) +[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L15) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L16) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L17) +[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L17) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L14) +[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L14) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L18) +[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L18) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L20) +[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L20) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/EmployeeResource.ts#L21) +[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L21) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index c8746b0..d2ce381 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -39,7 +39,7 @@ VerifiedRequest.\_\_@VERIFIED@1313 #### Defined in -[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L23) +[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L23) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyRequest.ts#L35) +[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L35) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index e928c29..51366b6 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -51,7 +51,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L12) +[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L12) ___ @@ -79,7 +79,7 @@ Marks the job as "failed". The message will be communicated to the Envoy Dashboa #### Defined in -[sdk/EnvoyResponse.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L27) +[sdk/EnvoyResponse.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L27) ___ @@ -107,7 +107,7 @@ Marks the job as "ignored". Useful when you explicitly do not want to handle the #### Defined in -[sdk/EnvoyResponse.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L22) +[sdk/EnvoyResponse.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L22) ___ @@ -135,4 +135,4 @@ Later on, you should update the job using #### Defined in -[sdk/EnvoyResponse.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/sdk/EnvoyResponse.ts#L18) +[sdk/EnvoyResponse.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L18) diff --git a/docs/interfaces/flowattributes.md b/docs/interfaces/flowattributes.md index d9e64cb..28934db 100644 --- a/docs/interfaces/flowattributes.md +++ b/docs/interfaces/flowattributes.md @@ -20,7 +20,7 @@ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L22) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L20) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L22) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L20) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L23) +[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L23) diff --git a/docs/interfaces/flowfilterfields.md b/docs/interfaces/flowfilterfields.md index 3be3c1d..61696af 100644 --- a/docs/interfaces/flowfilterfields.md +++ b/docs/interfaces/flowfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L11) +[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L11) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/FlowResource.ts#L13) +[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L13) diff --git a/docs/interfaces/inviteattributes.md b/docs/interfaces/inviteattributes.md index d8c2a52..7c0ac17 100644 --- a/docs/interfaces/inviteattributes.md +++ b/docs/interfaces/inviteattributes.md @@ -34,7 +34,7 @@ #### Defined in -[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L28) +[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L28) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L29) +[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L29) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L55) +[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L55) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L56) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L59) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L53) +[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L53) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L45) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L56) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L45) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L46) +[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L46) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L47) +[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L47) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L48) +[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L48) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L49) +[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L49) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L52) +[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L52) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L59) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L50) +[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L50) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L57) +[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L57) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L60) +[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L60) ___ @@ -222,4 +222,4 @@ ___ #### Defined in -[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L51) +[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L51) diff --git a/docs/interfaces/invitecreationattributes.md b/docs/interfaces/invitecreationattributes.md index 5bbb43a..6de70c0 100644 --- a/docs/interfaces/invitecreationattributes.md +++ b/docs/interfaces/invitecreationattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L75) +[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L75) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L68) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L68) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L69) +[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L69) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L70) +[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L70) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L73) +[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L73) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L76) +[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L76) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L71) +[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L71) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L72) +[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L72) diff --git a/docs/interfaces/invitefilterfields.md b/docs/interfaces/invitefilterfields.md index e201fb6..8c77a49 100644 --- a/docs/interfaces/invitefilterfields.md +++ b/docs/interfaces/invitefilterfields.md @@ -26,7 +26,7 @@ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L15) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L16) +[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L16) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L17) +[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L17) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L18) +[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L18) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L12) +[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L12) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L13) +[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L20) +[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L20) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L14) +[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L14) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L19) +[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L19) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L15) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/InviteResource.ts#L22) +[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L22) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index d8d8403..74c0954 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/locationattributes.md b/docs/interfaces/locationattributes.md index 1c54091..4e7f976 100644 --- a/docs/interfaces/locationattributes.md +++ b/docs/interfaces/locationattributes.md @@ -52,7 +52,7 @@ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L21) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L21) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L22) +[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L22) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L42) +[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L42) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L40) +[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L40) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L41) +[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L41) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L24) +[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L24) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L30) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L54) +[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L54) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L35) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L43) +[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L43) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L46) +[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L46) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L27) +[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L27) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L29) +[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L29) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L31) +[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L31) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L32) +[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L32) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L33) +[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L33) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L28) +[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L28) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L47) +[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L47) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L20) +[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L20) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L48) +[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L48) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L44) +[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L44) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L45) +[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L45) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L49) +[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L49) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L36) +[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L36) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L37) +[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L37) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L50) +[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L50) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L25) +[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L25) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L30) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L51) +[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L51) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L55) +[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L55) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L38) +[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L38) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L52) +[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L52) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L35) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L53) +[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L53) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L39) +[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L39) ___ @@ -412,4 +412,4 @@ ___ #### Defined in -[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L26) +[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L26) diff --git a/docs/interfaces/locationfilterfields.md b/docs/interfaces/locationfilterfields.md index 7f6d7be..fea7f96 100644 --- a/docs/interfaces/locationfilterfields.md +++ b/docs/interfaces/locationfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L13) +[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L13) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/LocationResource.ts#L12) +[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L12) diff --git a/docs/interfaces/signinfieldattributes.md b/docs/interfaces/signinfieldattributes.md index e9616af..e860979 100644 --- a/docs/interfaces/signinfieldattributes.md +++ b/docs/interfaces/signinfieldattributes.md @@ -25,7 +25,7 @@ #### Defined in -[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L18) +[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L18) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L10) +[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L10) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L11) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L8) +[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L8) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L11) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L7) +[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L7) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L17) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L9) +[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L9) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L17) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/883a970/src/resources/SignInFieldResource.ts#L19) +[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L19) diff --git a/src/sdk/handlers.ts b/src/sdk/handlers.ts index 42acfe2..7fdbe02 100644 --- a/src/sdk/handlers.ts +++ b/src/sdk/handlers.ts @@ -77,8 +77,8 @@ export type SelectedValuesRouteHandler = - (req: EnvoyValidationRouteRequest & Additions, res: EnvoyResponse) => Result; +export type ValidationRouteHandler = + (req: EnvoyValidationRouteRequest & Additions, res: EnvoyResponse>) => Result; /** * Wraps any express.js-based handlers @@ -188,8 +188,7 @@ export function selectedValuesRouteHandler< export function validationRouteHandler< Config = SomeObject, Payload = SomeObject, - ToSave = SomeObject, Additions = SomeObject, - >(handler: ValidationRouteHandler) { + >(handler: ValidationRouteHandler) { return asyncHandler(handler); } From 94bc1ac43dae6079e13fc5c7367f696f0674835f Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Tue, 15 Jun 2021 01:02:52 -0400 Subject: [PATCH 35/91] better naming --- docs/README.md | 174 ++++++++++---------- docs/classes/envoyjwt.md | 6 +- docs/classes/envoypluginapi.md | 16 +- docs/classes/envoypluginjob.md | 16 +- docs/classes/envoypluginsdk.md | 22 +-- docs/classes/envoypluginstorage.md | 18 +- docs/classes/envoyuserapi.md | 50 +++--- docs/interfaces/agreementattributes.md | 18 +- docs/interfaces/companyattributes.md | 8 +- docs/interfaces/employeeattributes.md | 18 +- docs/interfaces/employeefilterfields.md | 20 +-- docs/interfaces/envoybaserequest.md | 4 +- docs/interfaces/envoyresponse.md | 8 +- docs/interfaces/flowattributes.md | 10 +- docs/interfaces/flowfilterfields.md | 4 +- docs/interfaces/inviteattributes.md | 38 ++--- docs/interfaces/invitecreationattributes.md | 18 +- docs/interfaces/invitefilterfields.md | 22 +-- docs/interfaces/jsonapidata.md | 4 +- docs/interfaces/locationattributes.md | 74 ++++----- docs/interfaces/locationfilterfields.md | 4 +- docs/interfaces/signinfieldattributes.md | 20 +-- src/sdk/filters.ts | 4 +- 23 files changed, 288 insertions(+), 288 deletions(-) diff --git a/docs/README.md b/docs/README.md index 92b773c..64fd812 100644 --- a/docs/README.md +++ b/docs/README.md @@ -143,8 +143,8 @@ ### Filter Functions -- [employeeSignInEnabledMiddleware](README.md#employeesigninenabledmiddleware) -- [excludeEmployeesMiddleware](README.md#excludeemployeesmiddleware) +- [employeeSignInEnabledFilterMiddleware](README.md#employeesigninenabledfiltermiddleware) +- [excludedEmployeesFilterMiddleware](README.md#excludedemployeesfiltermiddleware) - [inviteOnlyEntryFilterMiddleware](README.md#inviteonlyentryfiltermiddleware) ### Handler Functions @@ -161,10 +161,10 @@ ### Middleware Functions -- [employeeSignInEnabledMiddleware](README.md#employeesigninenabledmiddleware) +- [employeeSignInEnabledFilterMiddleware](README.md#employeesigninenabledfiltermiddleware) - [envoyMiddleware](README.md#envoymiddleware) - [errorMiddleware](README.md#errormiddleware) -- [excludeEmployeesMiddleware](README.md#excludeemployeesmiddleware) +- [excludedEmployeesFilterMiddleware](README.md#excludedemployeesfiltermiddleware) - [inviteOnlyEntryFilterMiddleware](README.md#inviteonlyentryfiltermiddleware) ## API Resource Type aliases @@ -175,7 +175,7 @@ #### Defined in -[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L26) +[resources/AgreementResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L26) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementPageResource.ts#L6) +[resources/AgreementPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementPageResource.ts#L6) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementPageResource.ts#L19) +[resources/AgreementPageResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementPageResource.ts#L19) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementPageResource.ts#L14) +[resources/AgreementPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementPageResource.ts#L14) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L21) +[resources/AgreementResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L21) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L21) +[resources/CompanyResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/CompanyResource.ts#L21) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L16) +[resources/CompanyResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/CompanyResource.ts#L16) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L47) +[resources/EmployeeResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L47) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L42) +[resources/EmployeeResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L42) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L6) +[resources/EmployeeResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L6) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L35) +[resources/FlowResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L35) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L30) +[resources/FlowResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L30) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L6) +[resources/FlowResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L6) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L92) +[resources/InviteResource.ts:92](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L92) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L87) +[resources/InviteResource.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L87) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L82) +[resources/InviteResource.ts:82](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L82) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L6) +[resources/InviteResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L6) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L67) +[resources/LocationResource.ts:67](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L67) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L62) +[resources/LocationResource.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L62) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L6) +[resources/LocationResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L6) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L31) +[resources/SignInFieldResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L31) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldPageResource.ts#L6) +[resources/SignInFieldPageResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldPageResource.ts#L6) ___ @@ -409,7 +409,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldPageResource.ts#L23) +[resources/SignInFieldPageResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldPageResource.ts#L23) ___ @@ -419,7 +419,7 @@ ___ #### Defined in -[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldPageResource.ts#L14) +[resources/SignInFieldPageResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldPageResource.ts#L14) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L26) +[resources/SignInFieldResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L26) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/UserResource.ts#L6) +[resources/UserResource.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/UserResource.ts#L6) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/UserResource.ts#L14) +[resources/UserResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/UserResource.ts#L14) ___ @@ -479,7 +479,7 @@ and for events, use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) o #### Defined in -[sdk/EnvoyRequest.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L123) +[sdk/EnvoyRequest.ts:123](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L123) ___ @@ -531,7 +531,7 @@ ___ #### Defined in -[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/payloads/EntryPayload.ts#L6) +[payloads/EntryPayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/payloads/EntryPayload.ts#L6) ___ @@ -583,7 +583,7 @@ ___ #### Defined in -[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/payloads/InvitePayload.ts#L6) +[payloads/InvitePayload.ts:6](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/payloads/InvitePayload.ts#L6) ___ @@ -619,7 +619,7 @@ Handle an entry event, such as `entry_sign_in`. #### Defined in -[sdk/handlers.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L31) +[sdk/handlers.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L31) ___ @@ -653,7 +653,7 @@ Handle an invite event, such as `invite_created`. #### Defined in -[sdk/handlers.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L38) +[sdk/handlers.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L38) ___ @@ -688,7 +688,7 @@ Handle a "migration" route. #### Defined in -[sdk/handlers.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L52) +[sdk/handlers.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L52) ___ @@ -722,7 +722,7 @@ Handle an "options" route. #### Defined in -[sdk/handlers.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L59) +[sdk/handlers.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L59) ___ @@ -756,7 +756,7 @@ Handle a `plugin_uninstalled` event for cleaning up. #### Defined in -[sdk/handlers.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L45) +[sdk/handlers.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L45) ___ @@ -790,7 +790,7 @@ Handle a "remote value" route. #### Defined in -[sdk/handlers.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L66) +[sdk/handlers.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L66) ___ @@ -824,7 +824,7 @@ Handle a "selected values" route. #### Defined in -[sdk/handlers.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L73) +[sdk/handlers.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L73) ___ @@ -859,7 +859,7 @@ Handle a "validation" route. #### Defined in -[sdk/handlers.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L80) +[sdk/handlers.ts:80](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L80) ___ @@ -880,7 +880,7 @@ ___ #### Defined in -[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoySignatureVerifier.ts#L8) +[util/EnvoySignatureVerifier.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/util/EnvoySignatureVerifier.ts#L8) ___ @@ -914,7 +914,7 @@ Metadata that will be included in the request body for events. #### Defined in -[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L66) +[sdk/EnvoyMeta.ts:66](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L66) ___ @@ -937,7 +937,7 @@ Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. #### Defined in -[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L53) +[sdk/EnvoyMeta.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L53) ___ @@ -958,7 +958,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L37) +[sdk/EnvoyMeta.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L37) ___ @@ -982,7 +982,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L4) +[sdk/EnvoyMeta.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L4) ___ @@ -1014,7 +1014,7 @@ ___ #### Defined in -[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L13) +[sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L13) ___ @@ -1048,7 +1048,7 @@ like validation URLs or options URLs. #### Defined in -[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyMeta.ts#L83) +[sdk/EnvoyMeta.ts:83](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L83) ___ @@ -1069,7 +1069,7 @@ such as handlers for `entry_sign_in`. #### Defined in -[sdk/EnvoyRequest.ts:104](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L104) +[sdk/EnvoyRequest.ts:104](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L104) ___ @@ -1090,7 +1090,7 @@ You should use [EnvoyEntryEventRequest](README.md#envoyentryeventrequest) or [En #### Defined in -[sdk/EnvoyRequest.ts:95](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L95) +[sdk/EnvoyRequest.ts:95](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L95) ___ @@ -1109,7 +1109,7 @@ such as handlers for `invite_created` or `upcoming_visit`. #### Defined in -[sdk/EnvoyRequest.ts:113](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L113) +[sdk/EnvoyRequest.ts:113](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L113) ___ @@ -1127,7 +1127,7 @@ Use to type your `req` object in Envoy "migration" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L54) +[sdk/EnvoyRequest.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L54) ___ @@ -1145,7 +1145,7 @@ Use to type your `req` object in Envoy "options URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L62) +[sdk/EnvoyRequest.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L62) ___ @@ -1163,7 +1163,7 @@ Use to type your `req` object in Envoy "remote value URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L78) +[sdk/EnvoyRequest.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L78) ___ @@ -1183,7 +1183,7 @@ Use to type your `req` object in Envoy route handlers such as validation URLs. #### Defined in -[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L43) +[sdk/EnvoyRequest.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L43) ___ @@ -1201,7 +1201,7 @@ Use to type your `req` object in Envoy "selected values URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L70) +[sdk/EnvoyRequest.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L70) ___ @@ -1220,7 +1220,7 @@ Use to type your `req` object in Envoy "validation URL" route handlers. #### Defined in -[sdk/EnvoyRequest.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L86) +[sdk/EnvoyRequest.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L86) ___ @@ -1234,7 +1234,7 @@ Use to type your `res` object in Envoy "options URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L34) +[sdk/EnvoyResponse.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L34) ___ @@ -1246,7 +1246,7 @@ Use to type your `res` object in Envoy "remote value URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L40) +[sdk/EnvoyResponse.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L40) ___ @@ -1258,7 +1258,7 @@ Use to type your `res` object in Envoy "selected values URL" route handlers. #### Defined in -[sdk/EnvoyResponse.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L46) +[sdk/EnvoyResponse.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L46) ___ @@ -1283,13 +1283,13 @@ ___ #### Defined in -[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyStorageItem.ts#L4) +[sdk/EnvoyStorageItem.ts:4](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyStorageItem.ts#L4) ## Filter Functions -### employeeSignInEnabledMiddleware +### employeeSignInEnabledFilterMiddleware -▸ **employeeSignInEnabledMiddleware**(`employeeSignInEnabledKey`, `message?`): `RequestHandler` +▸ **employeeSignInEnabledFilterMiddleware**(`employeeSignInEnabledKey`, `message?`): `RequestHandler` Will only proceed if the install's `config` has a truthy value for the given `employeeSignInEnabledKey`. @@ -1312,13 +1312,13 @@ Will only proceed if the install's `config` has a truthy value for the given `em #### Defined in -[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L30) +[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/filters.ts#L30) ___ -### excludeEmployeesMiddleware +### excludedEmployeesFilterMiddleware -▸ **excludeEmployeesMiddleware**(`excludeEmployeesKey`, `message?`): `RequestHandler` +▸ **excludedEmployeesFilterMiddleware**(`excludeEmployeesKey`, `message?`): `RequestHandler` Will not proceed if the employee who's signing in is present in the excluded employees list. @@ -1341,7 +1341,7 @@ Will not proceed if the employee who's signing in is present in the excluded emp #### Defined in -[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L43) +[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/filters.ts#L43) ___ @@ -1371,7 +1371,7 @@ and the install's `config` has a truthy value for the given `invitesOnlyKey`. #### Defined in -[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L78) +[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/filters.ts#L78) ___ @@ -1403,7 +1403,7 @@ to catch Promise-based errors. #### Defined in -[sdk/handlers.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L90) +[sdk/handlers.ts:90](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L90) ___ @@ -1432,7 +1432,7 @@ Handler for entry events. #### Defined in -[sdk/handlers.ts:103](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L103) +[sdk/handlers.ts:103](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L103) ___ @@ -1461,7 +1461,7 @@ Handler for invite events. #### Defined in -[sdk/handlers.ts:115](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L115) +[sdk/handlers.ts:115](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L115) ___ @@ -1491,7 +1491,7 @@ Handler for a migration route. #### Defined in -[sdk/handlers.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L139) +[sdk/handlers.ts:139](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L139) ___ @@ -1520,7 +1520,7 @@ Handler for options URL routes. #### Defined in -[sdk/handlers.ts:152](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L152) +[sdk/handlers.ts:152](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L152) ___ @@ -1549,7 +1549,7 @@ Handler for `plugin_uninstalled` events. #### Defined in -[sdk/handlers.ts:127](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L127) +[sdk/handlers.ts:127](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L127) ___ @@ -1578,7 +1578,7 @@ Handler for remote value URL routes. #### Defined in -[sdk/handlers.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L164) +[sdk/handlers.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L164) ___ @@ -1607,7 +1607,7 @@ Handler for selected values URL routes. #### Defined in -[sdk/handlers.ts:176](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L176) +[sdk/handlers.ts:176](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L176) ___ @@ -1637,15 +1637,15 @@ Handler for validation URL routes. #### Defined in -[sdk/handlers.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/handlers.ts#L188) +[sdk/handlers.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/handlers.ts#L188) ___ ## Middleware Functions -### employeeSignInEnabledMiddleware +### employeeSignInEnabledFilterMiddleware -▸ **employeeSignInEnabledMiddleware**(`employeeSignInEnabledKey`, `message?`): `RequestHandler` +▸ **employeeSignInEnabledFilterMiddleware**(`employeeSignInEnabledKey`, `message?`): `RequestHandler` Will only proceed if the install's `config` has a truthy value for the given `employeeSignInEnabledKey`. @@ -1668,7 +1668,7 @@ Will only proceed if the install's `config` has a truthy value for the given `em #### Defined in -[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L30) +[sdk/filters.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/filters.ts#L30) ___ @@ -1694,7 +1694,7 @@ as well as managing the plugin access token lifecycle. #### Defined in -[sdk/middleware.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/middleware.ts#L27) +[sdk/middleware.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/middleware.ts#L27) ___ @@ -1716,13 +1716,13 @@ Catches errors and sets the proper status code. #### Defined in -[sdk/middleware.ts:91](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/middleware.ts#L91) +[sdk/middleware.ts:91](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/middleware.ts#L91) ___ -### excludeEmployeesMiddleware +### excludedEmployeesFilterMiddleware -▸ **excludeEmployeesMiddleware**(`excludeEmployeesKey`, `message?`): `RequestHandler` +▸ **excludedEmployeesFilterMiddleware**(`excludeEmployeesKey`, `message?`): `RequestHandler` Will not proceed if the employee who's signing in is present in the excluded employees list. @@ -1745,7 +1745,7 @@ Will not proceed if the employee who's signing in is present in the excluded emp #### Defined in -[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L43) +[sdk/filters.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/filters.ts#L43) ___ @@ -1775,4 +1775,4 @@ and the install's `config` has a truthy value for the given `invitesOnlyKey`. #### Defined in -[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/filters.ts#L78) +[sdk/filters.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/filters.ts#L78) diff --git a/docs/classes/envoyjwt.md b/docs/classes/envoyjwt.md index 00fe4d2..1dba864 100644 --- a/docs/classes/envoyjwt.md +++ b/docs/classes/envoyjwt.md @@ -30,7 +30,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoyJWT.ts#L15) +[util/EnvoyJWT.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/util/EnvoyJWT.ts#L15) ## Methods @@ -51,7 +51,7 @@ Helper to encode and decode JWTs. #### Defined in -[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoyJWT.ts#L42) +[util/EnvoyJWT.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/util/EnvoyJWT.ts#L42) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/EnvoyJWT.ts#L25) +[util/EnvoyJWT.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/util/EnvoyJWT.ts#L25) diff --git a/docs/classes/envoypluginapi.md b/docs/classes/envoypluginapi.md index 069edef..434cdb5 100644 --- a/docs/classes/envoypluginapi.md +++ b/docs/classes/envoypluginapi.md @@ -47,7 +47,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/base/EnvoyAPI.ts#L59) ## Properties @@ -63,7 +63,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/base/EnvoyAPI.ts#L32) ## Methods @@ -84,7 +84,7 @@ EnvoyAPI.axios #### Defined in -[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L61) +[sdk/EnvoyPluginAPI.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginAPI.ts#L61) ___ @@ -106,7 +106,7 @@ Fetches the current `config` saved for this install during setup by the customer #### Defined in -[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L27) +[sdk/EnvoyPluginAPI.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginAPI.ts#L27) ___ @@ -131,7 +131,7 @@ To remove an item from the saved `config`, set the item's key to `null`. #### Defined in -[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L37) +[sdk/EnvoyPluginAPI.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginAPI.ts#L37) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L45) +[sdk/EnvoyPluginAPI.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginAPI.ts#L45) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L16) +[sdk/EnvoyPluginAPI.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginAPI.ts#L16) ___ @@ -196,4 +196,4 @@ Gets a plugin access token using `client_credentials` as the grant type. #### Defined in -[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginAPI.ts#L72) +[sdk/EnvoyPluginAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginAPI.ts#L72) diff --git a/docs/classes/envoypluginjob.md b/docs/classes/envoypluginjob.md index 2384a33..1e6eead 100644 --- a/docs/classes/envoypluginjob.md +++ b/docs/classes/envoypluginjob.md @@ -42,7 +42,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L17) ## Properties @@ -52,7 +52,7 @@ as well as attach extra data to the event's subject #### Defined in -[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L15) +[sdk/EnvoyPluginJob.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L15) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L17) +[sdk/EnvoyPluginJob.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L17) ## Methods @@ -84,7 +84,7 @@ Add attachments to this job. #### Defined in -[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L48) +[sdk/EnvoyPluginJob.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L48) ___ @@ -110,7 +110,7 @@ using {@link EnvoyRequest.send}. #### Defined in -[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L58) +[sdk/EnvoyPluginJob.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L58) ___ @@ -136,7 +136,7 @@ using {@link EnvoyRequest.sendFailed}. #### Defined in -[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L78) +[sdk/EnvoyPluginJob.ts:78](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L78) ___ @@ -162,7 +162,7 @@ using {@link EnvoyRequest.sendIgnored}. #### Defined in -[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L68) +[sdk/EnvoyPluginJob.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L68) ___ @@ -187,4 +187,4 @@ Can be used to periodically update long-running jobs. #### Defined in -[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginJob.ts#L87) +[sdk/EnvoyPluginJob.ts:87](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginJob.ts#L87) diff --git a/docs/classes/envoypluginsdk.md b/docs/classes/envoypluginsdk.md index 43dda98..dee755e 100644 --- a/docs/classes/envoypluginsdk.md +++ b/docs/classes/envoypluginsdk.md @@ -59,7 +59,7 @@ Instead, use {@link middleware} to automatically attach an instance to `req` on #### Defined in -[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L41) +[sdk/EnvoyPluginSDK.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L41) ## Accessors @@ -87,7 +87,7 @@ Returns a job based on an ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L140) +[sdk/EnvoyPluginSDK.ts:140](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L140) ___ @@ -103,7 +103,7 @@ Storage scoped globally (across installs). #### Defined in -[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L133) +[sdk/EnvoyPluginSDK.ts:133](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L133) ___ @@ -119,7 +119,7 @@ Storage scoped to the install. #### Defined in -[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L122) +[sdk/EnvoyPluginSDK.ts:122](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L122) ___ @@ -135,7 +135,7 @@ Perform operations on the current job. #### Defined in -[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L158) +[sdk/EnvoyPluginSDK.ts:158](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L158) ___ @@ -151,7 +151,7 @@ Returns the current job's ID. #### Defined in -[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L147) +[sdk/EnvoyPluginSDK.ts:147](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L147) ___ @@ -168,7 +168,7 @@ Useful for verifiable communications between plugin endpoints. #### Defined in -[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L171) +[sdk/EnvoyPluginSDK.ts:171](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L171) ___ @@ -185,7 +185,7 @@ Either an [EnvoyEventMeta](../README.md#envoyeventmeta)} or [EnvoyRouteMeta](../ #### Defined in -[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L61) +[sdk/EnvoyPluginSDK.ts:61](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L61) ___ @@ -203,7 +203,7 @@ For setup step validation URLs, it's the form submitted values for a validation #### Defined in -[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L73) +[sdk/EnvoyPluginSDK.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L73) ___ @@ -220,7 +220,7 @@ Used to perform storage or job operations. #### Defined in -[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L101) +[sdk/EnvoyPluginSDK.ts:101](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L101) ___ @@ -237,4 +237,4 @@ Used only in routes. #### Defined in -[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginSDK.ts#L84) +[sdk/EnvoyPluginSDK.ts:84](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginSDK.ts#L84) diff --git a/docs/classes/envoypluginstorage.md b/docs/classes/envoypluginstorage.md index b95c7dc..69dbef7 100644 --- a/docs/classes/envoypluginstorage.md +++ b/docs/classes/envoypluginstorage.md @@ -40,7 +40,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L16) ## Properties @@ -50,7 +50,7 @@ or to the plugin itself. #### Defined in -[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L14) +[sdk/EnvoyPluginStorage.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L16) +[sdk/EnvoyPluginStorage.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L16) ## Methods @@ -90,7 +90,7 @@ Wrapper for single pipeline get. #### Defined in -[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L35) +[sdk/EnvoyPluginStorage.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L35) ___ @@ -106,7 +106,7 @@ Creates a new pipeline instance. #### Defined in -[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L26) +[sdk/EnvoyPluginStorage.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L26) ___ @@ -137,7 +137,7 @@ Wrapper for single pipeline set. #### Defined in -[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L44) +[sdk/EnvoyPluginStorage.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L44) ___ @@ -162,7 +162,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L53) +[sdk/EnvoyPluginStorage.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L53) ___ @@ -187,7 +187,7 @@ Wrapper for single pipeline setUnique. #### Defined in -[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L62) +[sdk/EnvoyPluginStorage.ts:62](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L62) ___ @@ -211,4 +211,4 @@ Wrapper for single pipeline unset. #### Defined in -[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyPluginStorage.ts#L71) +[sdk/EnvoyPluginStorage.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyPluginStorage.ts#L71) diff --git a/docs/classes/envoyuserapi.md b/docs/classes/envoyuserapi.md index 686db0f..a9f8c65 100644 --- a/docs/classes/envoyuserapi.md +++ b/docs/classes/envoyuserapi.md @@ -65,7 +65,7 @@ EnvoyAPI.constructor #### Defined in -[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L59) +[base/EnvoyAPI.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/base/EnvoyAPI.ts#L59) ## Properties @@ -81,7 +81,7 @@ EnvoyAPI.axios #### Defined in -[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/base/EnvoyAPI.ts#L32) +[base/EnvoyAPI.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/base/EnvoyAPI.ts#L32) ## Methods @@ -104,7 +104,7 @@ May also require `invites.attest` scope if setting `attested: true`. #### Defined in -[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L188) +[sdk/EnvoyUserAPI.ts:188](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L188) ___ @@ -127,7 +127,7 @@ Requires `agreements.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L65) +[sdk/EnvoyUserAPI.ts:65](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L65) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L58) +[sdk/EnvoyUserAPI.ts:58](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L58) ___ @@ -173,7 +173,7 @@ Requires `companies.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L72) +[sdk/EnvoyUserAPI.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L72) ___ @@ -196,7 +196,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L79) +[sdk/EnvoyUserAPI.ts:79](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L79) ___ @@ -219,7 +219,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L114) +[sdk/EnvoyUserAPI.ts:114](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L114) ___ @@ -241,7 +241,7 @@ Requires `employees.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L136) +[sdk/EnvoyUserAPI.ts:136](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L136) ___ @@ -264,7 +264,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L86) +[sdk/EnvoyUserAPI.ts:86](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L86) ___ @@ -286,7 +286,7 @@ Requires `flows.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L146) +[sdk/EnvoyUserAPI.ts:146](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L146) ___ @@ -308,7 +308,7 @@ Requires `invites.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L172) +[sdk/EnvoyUserAPI.ts:172](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L172) ___ @@ -331,7 +331,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L93) +[sdk/EnvoyUserAPI.ts:93](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L93) ___ @@ -353,7 +353,7 @@ Requires `locations.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L154) +[sdk/EnvoyUserAPI.ts:154](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L154) ___ @@ -376,7 +376,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L107) +[sdk/EnvoyUserAPI.ts:107](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L107) ___ @@ -399,7 +399,7 @@ Requires `sign-in-field-pages.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L100) +[sdk/EnvoyUserAPI.ts:100](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L100) ___ @@ -421,7 +421,7 @@ Requires `sign-in-fields.read` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L164) +[sdk/EnvoyUserAPI.ts:164](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L164) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L179) +[sdk/EnvoyUserAPI.ts:179](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L179) ___ @@ -458,7 +458,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L213) +[sdk/EnvoyUserAPI.ts:213](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L213) ___ @@ -480,7 +480,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L226) +[sdk/EnvoyUserAPI.ts:226](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L226) ___ @@ -503,7 +503,7 @@ Requires `invites.write` scope. #### Defined in -[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L200) +[sdk/EnvoyUserAPI.ts:200](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L200) ___ @@ -531,7 +531,7 @@ Use the [loginAsUserWithCode](envoyuserapi.md#loginasuserwithcode) method to exc #### Defined in -[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L240) +[sdk/EnvoyUserAPI.ts:240](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L240) ___ @@ -555,7 +555,7 @@ Gets a user access token using `plugin_install` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L306) +[sdk/EnvoyUserAPI.ts:306](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L306) ___ @@ -580,7 +580,7 @@ Gets a user access token using `code` as the grant type. #### Defined in -[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L280) +[sdk/EnvoyUserAPI.ts:280](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L280) ___ @@ -606,4 +606,4 @@ Gets a user access token using `password` as the grant type (discouraged - use [ #### Defined in -[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyUserAPI.ts#L252) +[sdk/EnvoyUserAPI.ts:252](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyUserAPI.ts#L252) diff --git a/docs/interfaces/agreementattributes.md b/docs/interfaces/agreementattributes.md index 1a8e691..3172a45 100644 --- a/docs/interfaces/agreementattributes.md +++ b/docs/interfaces/agreementattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L10) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L13) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L12) +[resources/AgreementResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L7) +[resources/AgreementResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L7) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L8) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L13) +[resources/AgreementResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L13) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L8) +[resources/AgreementResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L8) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L14) +[resources/AgreementResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L14) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/AgreementResource.ts#L10) +[resources/AgreementResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/AgreementResource.ts#L10) diff --git a/docs/interfaces/companyattributes.md b/docs/interfaces/companyattributes.md index b28185f..a05a94f 100644 --- a/docs/interfaces/companyattributes.md +++ b/docs/interfaces/companyattributes.md @@ -19,7 +19,7 @@ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/CompanyResource.ts#L8) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L8) +[resources/CompanyResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/CompanyResource.ts#L8) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L7) +[resources/CompanyResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/CompanyResource.ts#L7) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/CompanyResource.ts#L9) +[resources/CompanyResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/CompanyResource.ts#L9) diff --git a/docs/interfaces/employeeattributes.md b/docs/interfaces/employeeattributes.md index 6269bb8..4492694 100644 --- a/docs/interfaces/employeeattributes.md +++ b/docs/interfaces/employeeattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L32) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L33) +[resources/EmployeeResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L33) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L32) +[resources/EmployeeResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L32) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L35) +[resources/EmployeeResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L35) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L29) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L28) +[resources/EmployeeResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L28) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L29) +[resources/EmployeeResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L29) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L30) +[resources/EmployeeResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L30) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L34) +[resources/EmployeeResource.ts:34](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L34) diff --git a/docs/interfaces/employeefilterfields.md b/docs/interfaces/employeefilterfields.md index 2c3b683..e79d48a 100644 --- a/docs/interfaces/employeefilterfields.md +++ b/docs/interfaces/employeefilterfields.md @@ -25,7 +25,7 @@ #### Defined in -[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L13) +[resources/EmployeeResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L13) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L12) +[resources/EmployeeResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L12) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L15) +[resources/EmployeeResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L15) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L16) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L17) +[resources/EmployeeResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L17) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L16) +[resources/EmployeeResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L14) +[resources/EmployeeResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L14) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L18) +[resources/EmployeeResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L18) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L20) +[resources/EmployeeResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L20) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/EmployeeResource.ts#L21) +[resources/EmployeeResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/EmployeeResource.ts#L21) diff --git a/docs/interfaces/envoybaserequest.md b/docs/interfaces/envoybaserequest.md index d2ce381..fb2427d 100644 --- a/docs/interfaces/envoybaserequest.md +++ b/docs/interfaces/envoybaserequest.md @@ -39,7 +39,7 @@ VerifiedRequest.\_\_@VERIFIED@1313 #### Defined in -[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L23) +[sdk/EnvoyRequest.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L23) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyRequest.ts#L35) +[sdk/EnvoyRequest.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyRequest.ts#L35) diff --git a/docs/interfaces/envoyresponse.md b/docs/interfaces/envoyresponse.md index 51366b6..28e2291 100644 --- a/docs/interfaces/envoyresponse.md +++ b/docs/interfaces/envoyresponse.md @@ -51,7 +51,7 @@ Response.send #### Defined in -[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L12) +[sdk/EnvoyResponse.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L12) ___ @@ -79,7 +79,7 @@ Marks the job as "failed". The message will be communicated to the Envoy Dashboa #### Defined in -[sdk/EnvoyResponse.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L27) +[sdk/EnvoyResponse.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L27) ___ @@ -107,7 +107,7 @@ Marks the job as "ignored". Useful when you explicitly do not want to handle the #### Defined in -[sdk/EnvoyResponse.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L22) +[sdk/EnvoyResponse.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L22) ___ @@ -135,4 +135,4 @@ Later on, you should update the job using #### Defined in -[sdk/EnvoyResponse.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/sdk/EnvoyResponse.ts#L18) +[sdk/EnvoyResponse.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyResponse.ts#L18) diff --git a/docs/interfaces/flowattributes.md b/docs/interfaces/flowattributes.md index 28934db..2e3e09a 100644 --- a/docs/interfaces/flowattributes.md +++ b/docs/interfaces/flowattributes.md @@ -20,7 +20,7 @@ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L22) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L20) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L22) +[resources/FlowResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L22) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L20) +[resources/FlowResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L20) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L23) +[resources/FlowResource.ts:23](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L23) diff --git a/docs/interfaces/flowfilterfields.md b/docs/interfaces/flowfilterfields.md index 61696af..b751117 100644 --- a/docs/interfaces/flowfilterfields.md +++ b/docs/interfaces/flowfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L11) +[resources/FlowResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L11) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/FlowResource.ts#L13) +[resources/FlowResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/FlowResource.ts#L13) diff --git a/docs/interfaces/inviteattributes.md b/docs/interfaces/inviteattributes.md index 7c0ac17..9886411 100644 --- a/docs/interfaces/inviteattributes.md +++ b/docs/interfaces/inviteattributes.md @@ -34,7 +34,7 @@ #### Defined in -[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L28) +[resources/InviteResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L28) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L29) +[resources/InviteResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L29) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L55) +[resources/InviteResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L55) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L56) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L59) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L53) +[resources/InviteResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L53) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L45) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L56) +[resources/InviteResource.ts:56](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L56) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L45) +[resources/InviteResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L45) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L46) +[resources/InviteResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L46) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L47) +[resources/InviteResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L47) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L48) +[resources/InviteResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L48) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L49) +[resources/InviteResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L49) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L52) +[resources/InviteResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L52) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L59) +[resources/InviteResource.ts:59](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L59) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L50) +[resources/InviteResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L50) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L57) +[resources/InviteResource.ts:57](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L57) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L60) +[resources/InviteResource.ts:60](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L60) ___ @@ -222,4 +222,4 @@ ___ #### Defined in -[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L51) +[resources/InviteResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L51) diff --git a/docs/interfaces/invitecreationattributes.md b/docs/interfaces/invitecreationattributes.md index 6de70c0..4ecf348 100644 --- a/docs/interfaces/invitecreationattributes.md +++ b/docs/interfaces/invitecreationattributes.md @@ -24,7 +24,7 @@ #### Defined in -[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L75) +[resources/InviteResource.ts:75](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L75) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L68) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L68) +[resources/InviteResource.ts:68](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L68) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L69) +[resources/InviteResource.ts:69](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L69) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L70) +[resources/InviteResource.ts:70](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L70) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L73) +[resources/InviteResource.ts:73](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L73) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L76) +[resources/InviteResource.ts:76](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L76) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L71) +[resources/InviteResource.ts:71](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L71) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L72) +[resources/InviteResource.ts:72](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L72) diff --git a/docs/interfaces/invitefilterfields.md b/docs/interfaces/invitefilterfields.md index 8c77a49..a2b99f7 100644 --- a/docs/interfaces/invitefilterfields.md +++ b/docs/interfaces/invitefilterfields.md @@ -26,7 +26,7 @@ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L15) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L16) +[resources/InviteResource.ts:16](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L16) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L17) +[resources/InviteResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L17) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L18) +[resources/InviteResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L18) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L12) +[resources/InviteResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L12) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L13) +[resources/InviteResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L20) +[resources/InviteResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L20) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L14) +[resources/InviteResource.ts:14](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L14) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L19) +[resources/InviteResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L19) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L15) +[resources/InviteResource.ts:15](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L15) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/InviteResource.ts#L22) +[resources/InviteResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/InviteResource.ts#L22) diff --git a/docs/interfaces/jsonapidata.md b/docs/interfaces/jsonapidata.md index 74c0954..1168826 100644 --- a/docs/interfaces/jsonapidata.md +++ b/docs/interfaces/jsonapidata.md @@ -24,7 +24,7 @@ #### Defined in -[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/json-api/JSONAPIData.ts#L2) +[util/json-api/JSONAPIData.ts:2](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/util/json-api/JSONAPIData.ts#L2) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/util/json-api/JSONAPIData.ts#L3) +[util/json-api/JSONAPIData.ts:3](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/util/json-api/JSONAPIData.ts#L3) diff --git a/docs/interfaces/locationattributes.md b/docs/interfaces/locationattributes.md index 4e7f976..ac56b30 100644 --- a/docs/interfaces/locationattributes.md +++ b/docs/interfaces/locationattributes.md @@ -52,7 +52,7 @@ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L21) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L21) +[resources/LocationResource.ts:21](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L21) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L22) +[resources/LocationResource.ts:22](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L22) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L42) +[resources/LocationResource.ts:42](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L42) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L40) +[resources/LocationResource.ts:40](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L40) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L41) +[resources/LocationResource.ts:41](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L41) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L24) +[resources/LocationResource.ts:24](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L24) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L30) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L54) +[resources/LocationResource.ts:54](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L54) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L35) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L43) +[resources/LocationResource.ts:43](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L43) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L46) +[resources/LocationResource.ts:46](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L46) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L27) +[resources/LocationResource.ts:27](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L27) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L29) +[resources/LocationResource.ts:29](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L29) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L31) +[resources/LocationResource.ts:31](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L31) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L32) +[resources/LocationResource.ts:32](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L32) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L33) +[resources/LocationResource.ts:33](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L33) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L28) +[resources/LocationResource.ts:28](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L28) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L47) +[resources/LocationResource.ts:47](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L47) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L20) +[resources/LocationResource.ts:20](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L20) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L48) +[resources/LocationResource.ts:48](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L48) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L44) +[resources/LocationResource.ts:44](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L44) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L45) +[resources/LocationResource.ts:45](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L45) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L49) +[resources/LocationResource.ts:49](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L49) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L36) +[resources/LocationResource.ts:36](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L36) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L37) +[resources/LocationResource.ts:37](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L37) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L50) +[resources/LocationResource.ts:50](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L50) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L25) +[resources/LocationResource.ts:25](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L25) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L30) +[resources/LocationResource.ts:30](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L30) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L51) +[resources/LocationResource.ts:51](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L51) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L55) +[resources/LocationResource.ts:55](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L55) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L38) +[resources/LocationResource.ts:38](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L38) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L52) +[resources/LocationResource.ts:52](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L52) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L35) +[resources/LocationResource.ts:35](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L35) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L53) +[resources/LocationResource.ts:53](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L53) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L39) +[resources/LocationResource.ts:39](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L39) ___ @@ -412,4 +412,4 @@ ___ #### Defined in -[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L26) +[resources/LocationResource.ts:26](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L26) diff --git a/docs/interfaces/locationfilterfields.md b/docs/interfaces/locationfilterfields.md index fea7f96..5209a5e 100644 --- a/docs/interfaces/locationfilterfields.md +++ b/docs/interfaces/locationfilterfields.md @@ -17,7 +17,7 @@ #### Defined in -[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L13) +[resources/LocationResource.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L13) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/LocationResource.ts#L12) +[resources/LocationResource.ts:12](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/LocationResource.ts#L12) diff --git a/docs/interfaces/signinfieldattributes.md b/docs/interfaces/signinfieldattributes.md index e860979..51a96e9 100644 --- a/docs/interfaces/signinfieldattributes.md +++ b/docs/interfaces/signinfieldattributes.md @@ -25,7 +25,7 @@ #### Defined in -[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L18) +[resources/SignInFieldResource.ts:18](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L18) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L10) +[resources/SignInFieldResource.ts:10](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L10) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L11) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L8) +[resources/SignInFieldResource.ts:8](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L8) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L11) +[resources/SignInFieldResource.ts:11](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L11) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L7) +[resources/SignInFieldResource.ts:7](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L7) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L17) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L9) +[resources/SignInFieldResource.ts:9](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L9) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L17) +[resources/SignInFieldResource.ts:17](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L17) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/6f08a82/src/resources/SignInFieldResource.ts#L19) +[resources/SignInFieldResource.ts:19](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/resources/SignInFieldResource.ts#L19) diff --git a/src/sdk/filters.ts b/src/sdk/filters.ts index 7e1d549..2f0b9fa 100644 --- a/src/sdk/filters.ts +++ b/src/sdk/filters.ts @@ -27,7 +27,7 @@ export function booleanFilterMiddleware(key: keyof Config, message: stri * @category Filter * @category Middleware */ -export function employeeSignInEnabledMiddleware( +export function employeeSignInEnabledFilterMiddleware( employeeSignInEnabledKey: keyof Config, message = 'Envoy Protect is disabled.', ): RequestHandler { @@ -40,7 +40,7 @@ export function employeeSignInEnabledMiddleware( * @category Filter * @category Middleware */ -export function excludeEmployeesMiddleware( +export function excludedEmployeesFilterMiddleware( excludeEmployeesKey: keyof Config, message = 'Employee excluded from integration.', ): RequestHandler { From 6e47419f56437693d0a1964ad5986775c2928107 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Tue, 22 Jun 2021 12:56:53 -0400 Subject: [PATCH 36/91] publishing beta package --- .github/workflows/package.yaml | 4 ++-- package-lock.json | 11 +++++++++++ package.json | 4 +++- src/payloads/EntryPayload.ts | 21 +++++++++++++++++++++ src/payloads/InvitePayload.ts | 13 +++++++++++++ src/sdk/EnvoyPluginSDK.ts | 13 ++++++++++++- 6 files changed, 62 insertions(+), 4 deletions(-) diff --git a/.github/workflows/package.yaml b/.github/workflows/package.yaml index 3206088..4c521f4 100644 --- a/.github/workflows/package.yaml +++ b/.github/workflows/package.yaml @@ -29,7 +29,7 @@ jobs: env: NODE_AUTH_TOKEN: ${{ secrets.ENVOYBOT_PERSONAL_ACCESS_TOKEN }} - - run: npm publish --access public + - run: npm publish --tag beta --access public env: NODE_AUTH_TOKEN: ${{ secrets.ENVOY_NPM_AUTOMATION_TOKEN }} @@ -38,6 +38,6 @@ jobs: with: registry-url: "https://npm.pkg.github.com" - - run: npm publish + - run: npm publish --tag beta env: NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/package-lock.json b/package-lock.json index ed93d17..09c0e8c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -232,6 +232,12 @@ "@types/node": "*" } }, + "@types/luxon": { + "version": "1.27.0", + "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-1.27.0.tgz", + "integrity": "sha512-rr2lNXsErnA/ARtgFn46NtQjUa66cuwZYeo/2K7oqqxhJErhXgHBPyNKCo+pfOC3L7HFwtao8ebViiU9h4iAxA==", + "dev": true + }, "@types/mime": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", @@ -2379,6 +2385,11 @@ "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", "dev": true }, + "luxon": { + "version": "1.27.0", + "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.27.0.tgz", + "integrity": "sha512-VKsFsPggTA0DvnxtJdiExAucKdAnwbCCNlMM5ENvHlxubqWd0xhZcdb4XgZ7QFNhaRhilXCFxHuoObP5BNA4PA==" + }, "markdown-it": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", diff --git a/package.json b/package.json index c84d9b9..698d8ac 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0", + "version": "2.0.0-beta.0", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -42,10 +42,12 @@ "factory.ts": "^0.5.2", "faker": "^5.5.3", "jsonwebtoken": "^8.5.1", + "luxon": "^1.27.0", "qs": "^6.10.1" }, "devDependencies": { "@types/express": "^4.17.12", + "@types/luxon": "^1.27.0", "@typescript-eslint/eslint-plugin": "^4.26.0", "@typescript-eslint/parser": "^4.26.0", "chai": "^4.2.0", diff --git a/src/payloads/EntryPayload.ts b/src/payloads/EntryPayload.ts index c38bb3c..4c7a4ad 100644 --- a/src/payloads/EntryPayload.ts +++ b/src/payloads/EntryPayload.ts @@ -1,3 +1,4 @@ +import { DateTime } from 'luxon'; import JSONAPIData from '../util/json-api/JSONAPIData'; /** @@ -61,4 +62,24 @@ type EntryPayload = { } }; +export function normalizeEntryPayload(payload : EntryPayload): EntryPayload { + const { + 'signed-in-at': signedInAt, + 'signed-out-at': signedOutAt, + 'legal-docs': legalDocs, + } = payload.attributes; + const normalized = { ...payload }; + normalized.attributes['signed-in-at'] = DateTime.fromSQL(signedInAt, { zone: 'UTC' }).toISO(); + if (signedOutAt) { + normalized.attributes['signed-out-at'] = DateTime.fromSQL(signedOutAt, { zone: 'UTC' }).toISO(); + } + if (Array.isArray(legalDocs) && legalDocs.length) { + normalized.attributes['legal-docs'] = legalDocs.map((doc) => ({ + ...doc, + 'signed-at': DateTime.fromSQL(doc['signed-at'], { zone: 'UTC' }).toISO(), + })); + } + return normalized; +} + export default EntryPayload; diff --git a/src/payloads/InvitePayload.ts b/src/payloads/InvitePayload.ts index 08e6b04..a406b02 100644 --- a/src/payloads/InvitePayload.ts +++ b/src/payloads/InvitePayload.ts @@ -1,3 +1,4 @@ +import { DateTime } from 'luxon'; import JSONAPIData from '../util/json-api/JSONAPIData'; /** @@ -60,4 +61,16 @@ type InvitePayload = { } }; +export function normalizeInvitePayload(payload: InvitePayload): InvitePayload { + const { 'legal-docs': legalDocs } = payload.attributes; + const normalized = { ...payload }; + if (Array.isArray(legalDocs) && legalDocs.length) { + normalized.attributes['legal-docs'] = legalDocs.map((doc) => ({ + ...doc, + 'signed-at': DateTime.fromSQL(doc['signed-at'], { zone: 'UTC' }).toISO(), + })); + } + return normalized; +} + export default InvitePayload; diff --git a/src/sdk/EnvoyPluginSDK.ts b/src/sdk/EnvoyPluginSDK.ts index d6999e9..d0eb156 100644 --- a/src/sdk/EnvoyPluginSDK.ts +++ b/src/sdk/EnvoyPluginSDK.ts @@ -4,6 +4,9 @@ import EnvoyPluginJob from './EnvoyPluginJob'; import EnvoyJWT from '../util/EnvoyJWT'; import EnvoyUserAPI from './EnvoyUserAPI'; import EnvoyPluginAPI from './EnvoyPluginAPI'; +import JSONAPIData from '../util/json-api/JSONAPIData'; +import EntryPayload, { normalizeEntryPayload } from '../payloads/EntryPayload'; +import InvitePayload, { normalizeInvitePayload } from '../payloads/InvitePayload'; /** * Every Envoy request has a `meta` and `payload`. @@ -74,7 +77,15 @@ export default class EnvoyPluginSDK { if (!this.isVerified) { throw new Error('Could not verify payload.'); } - return this.body.payload; + const payload = this.body.payload as unknown as JSONAPIData; + switch (payload.type) { + case 'entries': + return normalizeEntryPayload(payload as unknown as EntryPayload) as unknown as Payload; + case 'invites': + return normalizeInvitePayload(payload as unknown as InvitePayload) as unknown as Payload; + default: + return payload as unknown as Payload; + } } /** From 25db6b4c3932e86269f8f28da136add3cfe8b439 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 7 Jul 2021 12:47:46 -0400 Subject: [PATCH 37/91] added location event support --- package.json | 2 +- src/index.ts | 2 ++ src/internal/EnvoyLocationEvent.ts | 3 +++ src/payloads/LocationPayload.ts | 8 ++++++++ src/sdk/EnvoyRequest.ts | 11 +++++++++++ src/sdk/handlers.ts | 20 ++++++++++++++++++++ 6 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 src/internal/EnvoyLocationEvent.ts create mode 100644 src/payloads/LocationPayload.ts diff --git a/package.json b/package.json index 698d8ac..8ab8bca 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.0", + "version": "2.0.0-beta.1", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/index.ts b/src/index.ts index e1e0c54..d7e66fe 100644 --- a/src/index.ts +++ b/src/index.ts @@ -12,6 +12,7 @@ import EnvoyUserAPI from './sdk/EnvoyUserAPI'; import EnvoyPluginAPI from './sdk/EnvoyPluginAPI'; import EnvoyJWT from './util/EnvoyJWT'; +import EnvoySignatureVerifier from './util/EnvoySignatureVerifier'; import JSONAPIData from './util/json-api/JSONAPIData'; export * from './resources/AgreementPageResource'; @@ -43,6 +44,7 @@ export { EnvoyPluginStorage, EnvoyRequest, EnvoyResponse, + EnvoySignatureVerifier, EnvoyStorageItem, EnvoyPluginAPI, EnvoyUserAPI, diff --git a/src/internal/EnvoyLocationEvent.ts b/src/internal/EnvoyLocationEvent.ts new file mode 100644 index 0000000..7e96030 --- /dev/null +++ b/src/internal/EnvoyLocationEvent.ts @@ -0,0 +1,3 @@ +type EnvoyLocationEvent = 'location_capacity_updated' | string; + +export default EnvoyLocationEvent; diff --git a/src/payloads/LocationPayload.ts b/src/payloads/LocationPayload.ts new file mode 100644 index 0000000..7e74a97 --- /dev/null +++ b/src/payloads/LocationPayload.ts @@ -0,0 +1,8 @@ +import { LocationModel } from '../resources/LocationResource'; + +/** + * @category Event + */ +type LocationPayload = LocationModel; + +export default LocationPayload; diff --git a/src/sdk/EnvoyRequest.ts b/src/sdk/EnvoyRequest.ts index 29e6b2f..56298aa 100644 --- a/src/sdk/EnvoyRequest.ts +++ b/src/sdk/EnvoyRequest.ts @@ -3,8 +3,10 @@ import EnvoyPluginSDK from './EnvoyPluginSDK'; import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta'; import EntryPayload from '../payloads/EntryPayload'; import InvitePayload from '../payloads/InvitePayload'; +import LocationPayload from '../payloads/LocationPayload'; import EnvoyEntryEvent from '../internal/EnvoyEntryEvent'; import EnvoyInviteEvent from '../internal/EnvoyInviteEvent'; +import EnvoyLocationEvent from '../internal/EnvoyLocationEvent'; import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody'; import EnvoyOptionsRouteParams from '../internal/EnvoyOptionsRouteParams'; import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody'; @@ -113,6 +115,15 @@ export type EnvoyEntryEventRequest> = export type EnvoyInviteEventRequest> = EnvoyEventRequest; +/** + * Use to type your `req` object in location event handlers, + * such as handlers for `location_capacity_updated`. + * + * @category Request + */ +export type EnvoyLocationEventRequest> = + EnvoyEventRequest; + /** * You probably won't need to use this type directly. * For routes, use {@link EnvoyRouteRequest}, diff --git a/src/sdk/handlers.ts b/src/sdk/handlers.ts index 7fdbe02..a3f504c 100644 --- a/src/sdk/handlers.ts +++ b/src/sdk/handlers.ts @@ -8,6 +8,7 @@ import { EnvoyEntryEventRequest, EnvoyEventRequest, EnvoyInviteEventRequest, + EnvoyLocationEventRequest, EnvoyMigrationRouteRequest, EnvoyOptionsRouteRequest, EnvoyRemoteValueRouteRequest, @@ -38,6 +39,13 @@ export type EntryEventHandler = export type InviteEventHandler = (req: EnvoyInviteEventRequest & Additions, res: EnvoyResponse) => Result; +/** + * Handle an location event, such as `location_capacity_updated`. + * @category Handler + */ +export type LocationEventHandler = + (req: EnvoyLocationEventRequest & Additions, res: EnvoyResponse) => Result; + /** * Handle a `plugin_uninstalled` event for cleaning up. * @category Handler @@ -119,6 +127,18 @@ export function inviteEventHandler< return asyncHandler(handler); } +/** + * Handler for location events. + * + * @category Handler + */ +export function locationEventHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: LocationEventHandler) { + return asyncHandler(handler); +} + /** * Handler for `plugin_uninstalled` events. * From 4494c11aeb8642f8e27ab0a83b17c06b3240db9e Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:03:54 -0400 Subject: [PATCH 38/91] exposing factories --- package-lock.json | 22 ++- package.json | 2 + src/base/EnvoyPluginStoragePipeline.ts | 4 +- ...estFactory.ts => entryEventBodyFactory.ts} | 46 +++-- src/factories/eventBodyFactory.ts | 32 ++++ src/factories/eventRequestFactory.ts | 36 ---- src/factories/metaFactory.ts | 19 +- src/factories/routeBodyFactory.ts | 31 +++ src/factories/routeRequestFactory.ts | 35 ---- src/index.ts | 23 +++ src/internal/EnvoyStorageCommand.ts | 8 + src/mocks/EnvoyPluginJobMock.ts | 33 ++++ src/mocks/EnvoyPluginStoragePipelineMock.ts | 181 ++++++++++++++++++ src/payloads/NotificationPayload.ts | 54 ++++++ src/sdk/EnvoyPluginJob.ts | 2 +- src/sdk/EnvoyPluginJobAttachment.ts | 2 +- src/sdk/EnvoyPluginStorage.ts | 2 +- src/sdk/EnvoyRequest.ts | 9 + src/sdk/handlers.ts | 38 +++- 19 files changed, 466 insertions(+), 113 deletions(-) rename src/factories/{entryEventRequestFactory.ts => entryEventBodyFactory.ts} (73%) create mode 100644 src/factories/eventBodyFactory.ts delete mode 100644 src/factories/eventRequestFactory.ts create mode 100644 src/factories/routeBodyFactory.ts delete mode 100644 src/factories/routeRequestFactory.ts create mode 100644 src/mocks/EnvoyPluginJobMock.ts create mode 100644 src/mocks/EnvoyPluginStoragePipelineMock.ts create mode 100644 src/payloads/NotificationPayload.ts diff --git a/package-lock.json b/package-lock.json index 09c0e8c..9421fc7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0", + "version": "2.0.0-beta.1", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -232,6 +232,21 @@ "@types/node": "*" } }, + "@types/lodash": { + "version": "4.14.171", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.171.tgz", + "integrity": "sha512-7eQ2xYLLI/LsicL2nejW9Wyko3lcpN6O/z0ZLHrEQsg280zIdCv1t/0m6UtBjUHokCGBQ3gYTbHzDkZ1xOBwwg==", + "dev": true + }, + "@types/lodash.ismatch": { + "version": "4.4.6", + "resolved": "https://registry.npmjs.org/@types/lodash.ismatch/-/lodash.ismatch-4.4.6.tgz", + "integrity": "sha512-Qy6R9c+LOc3M+kBTDgQGAWxzcrXFKznXuIyg8tbw2/Ct3D3lBmQd3yMTD+NjGzIATgUr0v4uWzW3+ALid+LXsQ==", + "dev": true, + "requires": { + "@types/lodash": "*" + } + }, "@types/luxon": { "version": "1.27.0", "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-1.27.0.tgz", @@ -2286,6 +2301,11 @@ "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", "integrity": "sha1-YZwK89A/iwTDH1iChAt3sRzWg0M=" }, + "lodash.ismatch": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz", + "integrity": "sha1-dWy1FQyjum8RCFp4hJZF8Yj4Xzc=" + }, "lodash.isnumber": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/lodash.isnumber/-/lodash.isnumber-3.0.3.tgz", diff --git a/package.json b/package.json index 8ab8bca..1fde48f 100644 --- a/package.json +++ b/package.json @@ -42,11 +42,13 @@ "factory.ts": "^0.5.2", "faker": "^5.5.3", "jsonwebtoken": "^8.5.1", + "lodash.ismatch": "^4.4.0", "luxon": "^1.27.0", "qs": "^6.10.1" }, "devDependencies": { "@types/express": "^4.17.12", + "@types/lodash.ismatch": "^4.4.6", "@types/luxon": "^1.27.0", "@typescript-eslint/eslint-plugin": "^4.26.0", "@typescript-eslint/parser": "^4.26.0", diff --git a/src/base/EnvoyPluginStoragePipeline.ts b/src/base/EnvoyPluginStoragePipeline.ts index 189d9e6..9975479 100644 --- a/src/base/EnvoyPluginStoragePipeline.ts +++ b/src/base/EnvoyPluginStoragePipeline.ts @@ -11,11 +11,11 @@ import EnvoyPluginAPI from '../sdk/EnvoyPluginAPI'; * @category Base */ export default class EnvoyPluginStoragePipeline { - readonly api: EnvoyPluginAPI; + protected readonly api: EnvoyPluginAPI; readonly installId: string | undefined; - private readonly commands: Array; + protected readonly commands: Array; constructor(pluginAPI: EnvoyPluginAPI, installId?: string) { this.api = pluginAPI; diff --git a/src/factories/entryEventRequestFactory.ts b/src/factories/entryEventBodyFactory.ts similarity index 73% rename from src/factories/entryEventRequestFactory.ts rename to src/factories/entryEventBodyFactory.ts index 6031b50..b78c6b2 100644 --- a/src/factories/entryEventRequestFactory.ts +++ b/src/factories/entryEventBodyFactory.ts @@ -4,8 +4,7 @@ import faker from 'faker'; import EntryPayload from '../payloads/EntryPayload'; import EnvoyEntryEvent from '../internal/EnvoyEntryEvent'; import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; -import EnvoyRequest, { EnvoyEntryEventRequest } from '../sdk/EnvoyRequest'; -import eventRequestFactory from './eventRequestFactory'; +import eventBodyFactory from './eventBodyFactory'; export type EntryPayloadFactoryOptions = { isSignedIn: boolean, @@ -22,20 +21,23 @@ export type EntryPayloadFactoryOptions = { export const defaultIds = { location: '1', + company: '1', flow: '1', invite: '1', device: '1', + employee: '1', }; -export function entryPayloadFactory(options: EntryPayloadFactoryOptions, ids = defaultIds): Sync.Factory { +export function entryPayloadFactory(options: EntryPayloadFactoryOptions, ids: Partial = defaultIds): Sync.Factory { const signedInDate = faker.date.past(); + const allIds = { ...defaultIds, ...ids }; return Sync.makeFactory({ id: each((i) => `${i}`), type: 'entries', attributes: { 'full-name': faker.name.findName(), 'phone-number': options.hasPhoneNumber ? faker.phone.phoneNumber() : undefined, - email: options.hasEmail ? faker.internet.email() : null, + email: (options.hasEmail || options.isProtectFlow) ? faker.internet.email() : null, 'employee-screening-flow': options.isProtectFlow, host: (!options.isProtectFlow && options.nonProtectFlowOptions.hasHost) ? faker.name.findName() : null, 'host-email': (!options.isProtectFlow && options.nonProtectFlowOptions.hasHost) ? faker.internet.email() : null, @@ -57,52 +59,54 @@ export function entryPayloadFactory(options: EntryPayloadFactoryOptions, ids = d relationships: { location: { data: { - id: ids.location, + id: allIds.location, type: 'locations', }, }, flow: { data: { - id: ids.flow, + id: allIds.flow, type: 'flows', }, }, invite: (options.isProtectFlow || options.nonProtectFlowOptions.hasInvite) ? { data: { - id: ids.invite, + id: allIds.invite, type: 'invites', }, } : undefined, device: (!options.isProtectFlow && options.nonProtectFlowOptions.hasInvite) ? { data: { - id: ids.device, + id: allIds.device, type: 'devices', }, } : undefined, + employee: (options.isProtectFlow || options.nonProtectFlowOptions.hasHost) ? { + data: { + id: allIds.employee, + type: 'employees', + }, + } : undefined, }, }); } -export default function entryEventRequestFactory( - req: EnvoyRequest, +export default function entryEventBodyFactory( options: { event: EnvoyEntryEvent, config: Record, - scope: Array, payloadOptions: EntryPayloadFactoryOptions, - ids?: typeof defaultIds, - isVerified?: boolean, - pluginAccessToken?: string, + scope?: Array, + ids?: Partial, }, -): EnvoyEntryEventRequest { +) { const ids = options.ids || defaultIds; - return eventRequestFactory(req, { + return eventBodyFactory({ event: options.event, config: options.config, - scope: options.scope, - locationId: ids.location, - isVerified: options.isVerified, - pluginAccessToken: options.pluginAccessToken, + scope: options.scope || [], + locationId: options.ids?.location || defaultIds.location, + companyId: options.ids?.company || defaultIds.company, payload: entryPayloadFactory(options.payloadOptions, ids).build(), - }) as EnvoyEntryEventRequest; + }); } diff --git a/src/factories/eventBodyFactory.ts b/src/factories/eventBodyFactory.ts new file mode 100644 index 0000000..f9b4d1a --- /dev/null +++ b/src/factories/eventBodyFactory.ts @@ -0,0 +1,32 @@ +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; +import { eventMetaFactory } from './metaFactory'; + +export const defaultIds = { + locationId: '1', + companyId: '1', +}; + +export default function eventBodyFactory< + Event extends string = string, + Payload extends Record = Record, + >( + options: { + event: Event, + config: Record, + payload: Payload, + scope: Array, + locationId?: string, + companyId?: string, + }, +) { + return { + meta: eventMetaFactory( + options.event, + options.config, + options.scope, + options.locationId || defaultIds.locationId, + options.companyId || defaultIds.companyId, + ).build(), + payload: options.payload, + }; +} diff --git a/src/factories/eventRequestFactory.ts b/src/factories/eventRequestFactory.ts deleted file mode 100644 index 11a831c..0000000 --- a/src/factories/eventRequestFactory.ts +++ /dev/null @@ -1,36 +0,0 @@ -import faker from 'faker'; -import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; -import EnvoyRequest from '../sdk/EnvoyRequest'; -import { eventMetaFactory } from './metaFactory'; -import EnvoyPluginSDK from '../sdk/EnvoyPluginSDK'; -import { EnvoyEventMeta } from '../sdk/EnvoyMeta'; - -export default function eventRequestFactory< - Event extends string = string, - Payload extends Record = Record, - >( - req: EnvoyRequest, - options: { - event: Event, - config: Record, - payload: Payload, - scope: Array, - locationId: string, - isVerified?: boolean, - pluginAccessToken?: string, - }, -): EnvoyRequest { - const body = { - meta: eventMetaFactory( - options.event, - options.config, - options.scope, - options.locationId, - ).build(), - payload: options.payload, - }; - const isVerified = options.isVerified === undefined ? true : options.isVerified; - const pluginAccessToken = options.pluginAccessToken === undefined ? faker.random.word() : options.pluginAccessToken; - req.envoy = new EnvoyPluginSDK(body, isVerified, pluginAccessToken); - return req; -} diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts index 212fb91..ab3ef6d 100644 --- a/src/factories/metaFactory.ts +++ b/src/factories/metaFactory.ts @@ -1,7 +1,12 @@ import { Sync } from 'factory.ts'; import faker from 'faker'; import { - EnvoyEventMeta, EnvoyMetaAuth, EnvoyMetaCompany, EnvoyMetaJob, EnvoyMetaLocation, EnvoyRouteMeta, + EnvoyEventMeta, + EnvoyMetaAuth, + EnvoyMetaCompany, + EnvoyMetaJob, + EnvoyMetaLocation, + EnvoyRouteMeta, } from '../sdk/EnvoyMeta'; import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; @@ -38,9 +43,9 @@ export function locationFactory(id: string): Sync.Factory { }); } -export function companyFactory(): Sync.Factory { +export function companyFactory(id: string): Sync.Factory { return Sync.makeFactory({ - id: faker.datatype.number().toString(), + id, type: 'companies', attributes: { name: faker.company.companyName(), @@ -66,12 +71,13 @@ export function routeMetaFactory( params: Record, scope: Array, locationId: string, + companyId: string, ): Sync.Factory { return Sync.makeFactory({ plugin_id: faker.datatype.uuid(), install_id: faker.datatype.number().toString(), location: locationFactory(locationId).build(), - company: companyFactory().build(), + company: companyFactory(companyId).build(), auth: scope.length ? authFactory().build() : null, forwarded_bearer_token: faker.random.alphaNumeric(), route, @@ -80,18 +86,19 @@ export function routeMetaFactory( }); } -export function eventMetaFactory( +export default function eventMetaFactory( event: string, config: Record, scope: Array, locationId: string, + companyId: string, ): Sync.Factory { return Sync.makeFactory({ plugin_id: faker.datatype.uuid(), install_id: faker.datatype.number().toString(), job: jobFactory(event).build(), location: locationFactory(locationId).build(), - company: companyFactory().build(), + company: companyFactory(companyId).build(), auth: scope.length ? authFactory().build() : null, event, config, diff --git a/src/factories/routeBodyFactory.ts b/src/factories/routeBodyFactory.ts new file mode 100644 index 0000000..5a1f454 --- /dev/null +++ b/src/factories/routeBodyFactory.ts @@ -0,0 +1,31 @@ +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; +import { routeMetaFactory } from './metaFactory'; + +export const defaultIds = { + locationId: '1', + companyId: '1', +}; + +export default function routeBodyFactory = Record>( + options: { + config: Record, + params: Record, + payload: Payload, + scope?: Array, + locationId?: string, + companyId?: string, + route?: string, + }, +) { + return { + meta: routeMetaFactory( + options.route || '', + options.config, + options.params, + options.scope || [], + options.locationId || defaultIds.locationId, + options.companyId || defaultIds.companyId, + ).build(), + payload: options.payload, + }; +} diff --git a/src/factories/routeRequestFactory.ts b/src/factories/routeRequestFactory.ts deleted file mode 100644 index f18efb5..0000000 --- a/src/factories/routeRequestFactory.ts +++ /dev/null @@ -1,35 +0,0 @@ -import faker from 'faker'; -import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; -import EnvoyRequest from '../sdk/EnvoyRequest'; -import { routeMetaFactory } from './metaFactory'; -import EnvoyPluginSDK from '../sdk/EnvoyPluginSDK'; -import { EnvoyRouteMeta } from '../sdk/EnvoyMeta'; - -export default function routeRequestFactory = Record>( - req: EnvoyRequest, - options: { - route: string, - config: Record, - params: Record, - payload: Payload, - scope: Array, - locationId: string, - isVerified?: boolean, - pluginAccessToken?: string, - }, -): EnvoyRequest { - const body = { - meta: routeMetaFactory( - options.route, - options.config, - options.params, - options.scope, - options.locationId, - ).build(), - payload: options.payload, - }; - const isVerified = options.isVerified === undefined ? true : options.isVerified; - const pluginAccessToken = options.pluginAccessToken === undefined ? faker.random.word() : options.pluginAccessToken; - req.envoy = new EnvoyPluginSDK(body, isVerified, pluginAccessToken); - return req; -} diff --git a/src/index.ts b/src/index.ts index d7e66fe..463adfd 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,7 +1,21 @@ import './constants'; + +import EnvoyPluginStoragePipeline from './base/EnvoyPluginStoragePipeline'; + +import entryEventBodyFactory from './factories/entryEventBodyFactory'; +import eventBodyFactory from './factories/eventBodyFactory'; +import metaFactory from './factories/metaFactory'; +import routeBodyFactory from './factories/routeBodyFactory'; + +import HttpStatus from './internal/HttpStatus'; + +import EnvoyPluginJobMock from './mocks/EnvoyPluginJobMock'; +import EnvoyPluginStoragePipelineMock from './mocks/EnvoyPluginStoragePipelineMock'; + import EntryPayload from './payloads/EntryPayload'; import InvitePayload from './payloads/InvitePayload'; +import EnvoyMeta from './sdk/EnvoyMeta'; import EnvoyPluginJob from './sdk/EnvoyPluginJob'; import EnvoyPluginSDK from './sdk/EnvoyPluginSDK'; import EnvoyPluginStorage from './sdk/EnvoyPluginStorage'; @@ -39,9 +53,13 @@ export { EntryPayload, InvitePayload, EnvoyJWT, + EnvoyMeta, EnvoyPluginJob, + EnvoyPluginJobMock, EnvoyPluginSDK, EnvoyPluginStorage, + EnvoyPluginStoragePipeline, + EnvoyPluginStoragePipelineMock, EnvoyRequest, EnvoyResponse, EnvoySignatureVerifier, @@ -49,4 +67,9 @@ export { EnvoyPluginAPI, EnvoyUserAPI, JSONAPIData, + HttpStatus, + entryEventBodyFactory, + eventBodyFactory, + metaFactory, + routeBodyFactory, }; diff --git a/src/internal/EnvoyStorageCommand.ts b/src/internal/EnvoyStorageCommand.ts index b927416..2bd6c2c 100644 --- a/src/internal/EnvoyStorageCommand.ts +++ b/src/internal/EnvoyStorageCommand.ts @@ -1,3 +1,11 @@ +export const UNIQUE_OPTIONS_DEFAULT_CHARS = '0123456789'; + +export const UNIQUE_OPTIONS_DEFAULT_SIZE = 12; + +export const UNIQUE_NUM_OPTIONS_DEFAULT_MIN = 0; + +export const UNIQUE_NUM_OPTIONS_DEFAULT_MAX = 9_007_199_254_740_991; + export interface EnvoyStorageSetUniqueOptions { chars?: string, size?: number, diff --git a/src/mocks/EnvoyPluginJobMock.ts b/src/mocks/EnvoyPluginJobMock.ts new file mode 100644 index 0000000..1712c03 --- /dev/null +++ b/src/mocks/EnvoyPluginJobMock.ts @@ -0,0 +1,33 @@ +import isMatch from 'lodash.ismatch'; +import EnvoyPluginJob from '../sdk/EnvoyPluginJob'; +import EnvoyPluginAPI from '../sdk/EnvoyPluginAPI'; +import EnvoyPluginJobUpdate from '../internal/EnvoyPluginJobUpdate'; +import EnvoyPluginJobAttachment from '../sdk/EnvoyPluginJobAttachment'; + +export default class EnvoyPluginJobMock extends EnvoyPluginJob { + constructor(pluginAPI: EnvoyPluginAPI, jobId: string) { + super(pluginAPI, jobId); + this.api.updateJob = (id, updates) => { + EnvoyPluginJobMock.updates.push(updates); + return Promise.resolve(); + }; + } + + private static updates: Array = []; + + static hasAttachmentLike(partialAttachment: Partial) { + return EnvoyPluginJobMock.updates.find( + ({ attachments }) => attachments.find( + (attachment) => isMatch(partialAttachment, attachment), + ), + ); + } + + static get lastStatus() { + return [...EnvoyPluginJobMock.updates].reverse().find(({ status }) => !!status); + } + + static reset() { + EnvoyPluginJobMock.updates = []; + } +} diff --git a/src/mocks/EnvoyPluginStoragePipelineMock.ts b/src/mocks/EnvoyPluginStoragePipelineMock.ts new file mode 100644 index 0000000..c009221 --- /dev/null +++ b/src/mocks/EnvoyPluginStoragePipelineMock.ts @@ -0,0 +1,181 @@ +import EnvoyPluginStoragePipeline from '../base/EnvoyPluginStoragePipeline'; +import EnvoyStorageItem from '../sdk/EnvoyStorageItem'; +import { + EnvoyStorageSetUniqueNumOptions, + EnvoyStorageSetUniqueOptions, + UNIQUE_NUM_OPTIONS_DEFAULT_MAX, + UNIQUE_NUM_OPTIONS_DEFAULT_MIN, + UNIQUE_OPTIONS_DEFAULT_CHARS, + UNIQUE_OPTIONS_DEFAULT_SIZE, +} from '../internal/EnvoyStorageCommand'; + +const DEFAULT_UNIQUE_OPTIONS: EnvoyStorageSetUniqueOptions = { + chars: UNIQUE_OPTIONS_DEFAULT_CHARS, + size: UNIQUE_OPTIONS_DEFAULT_SIZE, +}; + +const DEFAULT_UNIQUE_NUM_OPTIONS: EnvoyStorageSetUniqueNumOptions = { + min: UNIQUE_NUM_OPTIONS_DEFAULT_MIN, + max: UNIQUE_NUM_OPTIONS_DEFAULT_MAX, +}; + +export default class EnvoyPluginStoragePipelineMock extends EnvoyPluginStoragePipeline { + execute(): Promise> { + return Promise.resolve( + this.commands.map((command) => { + const { key } = command; + const item: EnvoyStorageItem = { key, value: undefined }; + const isGlobal = !this.installId; + switch (command.action) { + case 'get': + item.value = EnvoyPluginStoragePipelineMock.get(key, isGlobal); + if (item.value === null) { + return null; + } + break; + case 'set': + item.value = EnvoyPluginStoragePipelineMock.set(key, command.value, isGlobal); + break; + case 'set_unique': + try { + item.value = EnvoyPluginStoragePipelineMock.setUnique(key, command as EnvoyStorageSetUniqueOptions, isGlobal); + } catch (err) { + return null; + } + break; + case 'set_unique_num': { + try { + item.value = EnvoyPluginStoragePipelineMock.setUniqueNum(key, command as EnvoyStorageSetUniqueNumOptions, isGlobal); + } catch (err) { + return null; + } + break; + } + case 'unset': + item.value = EnvoyPluginStoragePipelineMock.unset(key, isGlobal); + if (item.value === null) { + return null; + } + break; + default: + return null; + } + return item; + }), + ); + } + + private static storage: Record = {}; + + private static uniqueStringKeys = new Set(); + + private static uniqueStringValues = new Set(); + + private static uniqueNumberKeys = new Set(); + + private static uniqueNumberValues = new Set(); + + private static normalizeKey(key: string, isGlobal: boolean) { + return isGlobal ? `global_${key}` : `install_${key}`; + } + + static get(key: string, isGlobal = false): Value | null { + key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal); + if (!Object.keys(EnvoyPluginStoragePipelineMock.storage).includes(key)) { + return null; + } + return EnvoyPluginStoragePipelineMock.storage[key] as Value; + } + + static set(key: string, value: Value, isGlobal = false) { + key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal); + EnvoyPluginStoragePipelineMock.unset(key); + EnvoyPluginStoragePipelineMock.storage[key] = value; + return value; + } + + static setUnique(key:string, options = DEFAULT_UNIQUE_OPTIONS, isGlobal = false) { + key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal); + const chars = (options.chars && options.chars.length) ? options.chars : UNIQUE_OPTIONS_DEFAULT_CHARS; + const size = options.size || UNIQUE_OPTIONS_DEFAULT_SIZE; + if (!chars || !size) { + throw new Error('Invalid "chars" or "size" arguments'); + } + let value = EnvoyPluginStoragePipelineMock.makeUniqueString(chars, size); + let numTries = 0; + while (EnvoyPluginStoragePipelineMock.uniqueStringValues.has(value)) { + value = EnvoyPluginStoragePipelineMock.makeUniqueString(chars, size); + // eslint-disable-next-line no-plusplus + if (++numTries > 1000) { + throw new Error('Max tries reached'); + } + } + EnvoyPluginStoragePipelineMock.unset(key); + EnvoyPluginStoragePipelineMock.uniqueStringValues.add(value); + EnvoyPluginStoragePipelineMock.uniqueStringKeys.add(key); + EnvoyPluginStoragePipelineMock.storage[key] = value; + return value; + } + + static setUniqueNum(key: string, options = DEFAULT_UNIQUE_NUM_OPTIONS, isGlobal = false) { + key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal); + const min = options.min || UNIQUE_NUM_OPTIONS_DEFAULT_MIN; + const max = options.max || UNIQUE_NUM_OPTIONS_DEFAULT_MAX; + if (min >= max) { + throw new Error('"min" must be lower than "max"'); + } + let value = EnvoyPluginStoragePipelineMock.makeUniqueNumber(min, max); + let numTries = 0; + while (EnvoyPluginStoragePipelineMock.uniqueNumberValues.has(value)) { + value = EnvoyPluginStoragePipelineMock.makeUniqueNumber(min, max); + // eslint-disable-next-line no-plusplus + if (++numTries > 1000) { + throw new Error('Max tries reached'); + } + } + EnvoyPluginStoragePipelineMock.unset(key); + EnvoyPluginStoragePipelineMock.uniqueNumberValues.add(value); + EnvoyPluginStoragePipelineMock.uniqueNumberKeys.add(key); + EnvoyPluginStoragePipelineMock.storage[key] = value; + return value; + } + + static unset(key: string, isGlobal = false) { + key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal); + if (!Object.keys(EnvoyPluginStoragePipelineMock.storage).includes(key)) { + return null; + } + const value = EnvoyPluginStoragePipelineMock.storage[key]; + if (EnvoyPluginStoragePipelineMock.uniqueStringKeys.has(key)) { + EnvoyPluginStoragePipelineMock.uniqueStringValues.delete(value as string); + EnvoyPluginStoragePipelineMock.uniqueStringKeys.delete(key); + } + if (EnvoyPluginStoragePipelineMock.uniqueNumberKeys.has(key)) { + EnvoyPluginStoragePipelineMock.uniqueNumberValues.delete(value as number); + EnvoyPluginStoragePipelineMock.uniqueNumberKeys.delete(key); + } + delete EnvoyPluginStoragePipelineMock.storage[key]; + return value as Value; + } + + static reset() { + EnvoyPluginStoragePipelineMock.storage = {}; + EnvoyPluginStoragePipelineMock.uniqueStringKeys.clear(); + EnvoyPluginStoragePipelineMock.uniqueStringValues.clear(); + EnvoyPluginStoragePipelineMock.uniqueNumberKeys.clear(); + EnvoyPluginStoragePipelineMock.uniqueNumberValues.clear(); + } + + static makeUniqueString(chars: string, size: number) { + let result = ''; + // eslint-disable-next-line no-plusplus + for (let i = 0; i < size; i++) { + result += chars.charAt(Math.floor(Math.random() * chars.length)); + } + return result; + } + + static makeUniqueNumber(min: number, max: number) { + return Math.random() * (max - min) + min; + } +} diff --git a/src/payloads/NotificationPayload.ts b/src/payloads/NotificationPayload.ts new file mode 100644 index 0000000..7a104c0 --- /dev/null +++ b/src/payloads/NotificationPayload.ts @@ -0,0 +1,54 @@ +type NotificationPayload = { + recipient: { + name: { + full: string, + }, + email: string | null, + user_id: number | null, + employee_id: number | null, + phone_number: string | null, + }, + message?: string, + details?: Array<{ + label: string, + value: string, + }>, + actions?: Array<{ + label: string, + callback_url: string, + }>, + attachments?: Array<{ + url: string, + }>, + channel_overrides?: { + slack?: { + dm_only?: boolean, + footer_text?: string, + short_details?: boolean, + large_image?: boolean, + attachments?: Array>, + message?: string, + text?: string, + }, + email?: { + from: string, + subject: string, + html_body: string, + text_body: string, + reply_to?: { + name: { + full: string, + }, + email: string, + }, + bcc?: Array<{ + name: { + full: string, + }, + email: string, + }> + } + }, +}; + +export default NotificationPayload; diff --git a/src/sdk/EnvoyPluginJob.ts b/src/sdk/EnvoyPluginJob.ts index eff721d..dad334c 100644 --- a/src/sdk/EnvoyPluginJob.ts +++ b/src/sdk/EnvoyPluginJob.ts @@ -12,7 +12,7 @@ import EnvoyPluginAPI from './EnvoyPluginAPI'; * @category Request Object */ export default class EnvoyPluginJob { - readonly api: EnvoyPluginAPI; + protected readonly api: EnvoyPluginAPI; readonly id: string; diff --git a/src/sdk/EnvoyPluginJobAttachment.ts b/src/sdk/EnvoyPluginJobAttachment.ts index 9fe490f..9570f56 100644 --- a/src/sdk/EnvoyPluginJobAttachment.ts +++ b/src/sdk/EnvoyPluginJobAttachment.ts @@ -4,7 +4,7 @@ * @category Attachment */ export interface EnvoyPluginTextJobAttachment { - type?: 'text' | 'password' | 'link' | 'credential_image', + type?: 'text' | 'password' | string, label: string, value: string, } diff --git a/src/sdk/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts index 1de4322..20bd44d 100644 --- a/src/sdk/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -11,7 +11,7 @@ import EnvoyPluginAPI from './EnvoyPluginAPI'; * @category Request Object */ export default class EnvoyPluginStorage { - readonly api: EnvoyPluginAPI; + protected readonly api: EnvoyPluginAPI; readonly installId: string | undefined; diff --git a/src/sdk/EnvoyRequest.ts b/src/sdk/EnvoyRequest.ts index 56298aa..ff40004 100644 --- a/src/sdk/EnvoyRequest.ts +++ b/src/sdk/EnvoyRequest.ts @@ -4,6 +4,7 @@ import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta'; import EntryPayload from '../payloads/EntryPayload'; import InvitePayload from '../payloads/InvitePayload'; import LocationPayload from '../payloads/LocationPayload'; +import NotificationPayload from '../payloads/NotificationPayload'; import EnvoyEntryEvent from '../internal/EnvoyEntryEvent'; import EnvoyInviteEvent from '../internal/EnvoyInviteEvent'; import EnvoyLocationEvent from '../internal/EnvoyLocationEvent'; @@ -124,6 +125,14 @@ export type EnvoyInviteEventRequest> = export type EnvoyLocationEventRequest> = EnvoyEventRequest; +/** + * Use to type your `req` object in your notification event handler. + * + * @category Request + */ +export type EnvoyNotificationEventRequest> = + EnvoyEventRequest; + /** * You probably won't need to use this type directly. * For routes, use {@link EnvoyRouteRequest}, diff --git a/src/sdk/handlers.ts b/src/sdk/handlers.ts index a3f504c..5636e72 100644 --- a/src/sdk/handlers.ts +++ b/src/sdk/handlers.ts @@ -10,6 +10,7 @@ import { EnvoyInviteEventRequest, EnvoyLocationEventRequest, EnvoyMigrationRouteRequest, + EnvoyNotificationEventRequest, EnvoyOptionsRouteRequest, EnvoyRemoteValueRouteRequest, EnvoySelectedValuesRouteRequest, @@ -46,6 +47,13 @@ export type InviteEventHandler = export type LocationEventHandler = (req: EnvoyLocationEventRequest & Additions, res: EnvoyResponse) => Result; +/** + * Handle an notification event. + * @category Handler + */ +export type NotificationEventHandler = + (req: EnvoyNotificationEventRequest & Additions, res: EnvoyResponse) => Result; + /** * Handle a `plugin_uninstalled` event for cleaning up. * @category Handler @@ -140,27 +148,27 @@ export function locationEventHandler< } /** - * Handler for `plugin_uninstalled` events. + * Handler for a migration route. * * @category Handler */ -export function pluginUninstalledEventHandler< - Config = SomeObject, +export function migrationRouteHandler< + OldConfig, + NewConfig, Additions = SomeObject, - >(handler: PluginUninstalledEventHandler) { + >(handler: MigrationRouteHandler) { return asyncHandler(handler); } /** - * Handler for a migration route. + * Handler for notification events. * * @category Handler */ -export function migrationRouteHandler< - OldConfig, - NewConfig, +export function notificationEventHandler< + Config = SomeObject, Additions = SomeObject, - >(handler: MigrationRouteHandler) { + >(handler: NotificationEventHandler) { return asyncHandler(handler); } @@ -176,6 +184,18 @@ export function optionsRouteHandler< return asyncHandler(handler); } +/** + * Handler for `plugin_uninstalled` events. + * + * @category Handler + */ +export function pluginUninstalledEventHandler< + Config = SomeObject, + Additions = SomeObject, + >(handler: PluginUninstalledEventHandler) { + return asyncHandler(handler); +} + /** * Handler for remote value URL routes. * From 15ee2469185d6847738dde8f31968123d7117cc1 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:05:48 -0400 Subject: [PATCH 39/91] exposing factories --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 1fde48f..886730d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.1", + "version": "2.0.0-beta.2", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 97debdd159dc01f85824e6a23ce43ef09e982c37 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:08:01 -0400 Subject: [PATCH 40/91] exposing factories --- src/factories/metaFactory.ts | 2 +- src/index.ts | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts index ab3ef6d..38ec8e8 100644 --- a/src/factories/metaFactory.ts +++ b/src/factories/metaFactory.ts @@ -86,7 +86,7 @@ export function routeMetaFactory( }); } -export default function eventMetaFactory( +export function eventMetaFactory( event: string, config: Record, scope: Array, diff --git a/src/index.ts b/src/index.ts index 463adfd..d06ffe8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,7 +4,6 @@ import EnvoyPluginStoragePipeline from './base/EnvoyPluginStoragePipeline'; import entryEventBodyFactory from './factories/entryEventBodyFactory'; import eventBodyFactory from './factories/eventBodyFactory'; -import metaFactory from './factories/metaFactory'; import routeBodyFactory from './factories/routeBodyFactory'; import HttpStatus from './internal/HttpStatus'; @@ -70,6 +69,5 @@ export { HttpStatus, entryEventBodyFactory, eventBodyFactory, - metaFactory, routeBodyFactory, }; From 6e03dfd299b5825c6ae79ee62f8ffb60a2194669 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:09:18 -0400 Subject: [PATCH 41/91] increment version number --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 886730d..3fa09c9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.2", + "version": "2.0.0-beta.3", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 08d82d35c8422068fc09a1e446649c1ceaa20001 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:09:54 -0400 Subject: [PATCH 42/91] rollback version number --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3fa09c9..886730d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.3", + "version": "2.0.0-beta.2", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From c901f06b8726e27bf1bd01f9a0c1259353b58ded Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:10:29 -0400 Subject: [PATCH 43/91] new release --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 886730d..3fa09c9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.2", + "version": "2.0.0-beta.3", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 10bee35105c8da8bdb25baa5f76c70a1aa0ee9e3 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:14:02 -0400 Subject: [PATCH 44/91] back to 2 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3fa09c9..886730d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.3", + "version": "2.0.0-beta.2", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 38ebe61f22b3b2f13cfd07abb053a05109383440 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 14:49:09 -0400 Subject: [PATCH 45/91] Using dotenv-flow instead to get automatic switching of env variables based on environment --- package-lock.json | 23 ++++++++++++++++++++++- package.json | 5 +++-- src/constants.ts | 2 +- 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9421fc7..2551fc9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.1", + "version": "2.0.0-beta.2", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -184,6 +184,12 @@ "dotenv": "*" } }, + "@types/dotenv-flow": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@types/dotenv-flow/-/dotenv-flow-3.1.1.tgz", + "integrity": "sha512-khxgP+KkHPL72SP0Wqn1gB6EHj6yk79OBGJEKW64XL13RbyDGTkRbbA47VICOLRrvgKOpZeun2uMsgO7pAsExQ==", + "dev": true + }, "@types/express": { "version": "4.17.12", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", @@ -1091,6 +1097,21 @@ "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz", "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==" }, + "dotenv-flow": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/dotenv-flow/-/dotenv-flow-3.2.0.tgz", + "integrity": "sha512-GEB6RrR4AbqDJvNSFrYHqZ33IKKbzkvLYiD5eo4+9aFXr4Y4G+QaFrB/fNp0y6McWBmvaPn3ZNjIufnj8irCtg==", + "requires": { + "dotenv": "^8.0.0" + }, + "dependencies": { + "dotenv": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", + "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==" + } + } + }, "ecdsa-sig-formatter": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", diff --git a/package.json b/package.json index 886730d..00bb284 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.2", + "version": "2.0.0-beta.3", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -38,7 +38,7 @@ "axios": "^0.21.1", "body-parser": "^1.19.0", "dataloader": "^2.0.0", - "dotenv": "^10.0.0", + "dotenv-flow": "^3.2.0", "factory.ts": "^0.5.2", "faker": "^5.5.3", "jsonwebtoken": "^8.5.1", @@ -47,6 +47,7 @@ "qs": "^6.10.1" }, "devDependencies": { + "@types/dotenv-flow": "^3.1.1", "@types/express": "^4.17.12", "@types/lodash.ismatch": "^4.4.6", "@types/luxon": "^1.27.0", diff --git a/src/constants.ts b/src/constants.ts index 918a64f..f0b66e7 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -1,4 +1,4 @@ -import dotenv from 'dotenv'; +import dotenv from 'dotenv-flow'; dotenv.config(); export const envoyBaseURL = process.env.ENVOY_BASE_URL || 'https://app.envoy.com'; From ccbdbf42809a1b29b795660c649e4b4dad0ff576 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 19:40:34 -0400 Subject: [PATCH 46/91] Making building up test configs easier --- package.json | 2 +- src/factories/entryEventBodyFactory.ts | 20 +++++++++--------- src/factories/eventBodyFactory.ts | 21 ++++++++++--------- src/factories/metaFactory.ts | 13 +++++++----- src/factories/routeBodyFactory.ts | 28 ++++++++++++++++---------- 5 files changed, 49 insertions(+), 35 deletions(-) diff --git a/package.json b/package.json index 00bb284..479e805 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.3", + "version": "2.0.0-beta.4", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/factories/entryEventBodyFactory.ts b/src/factories/entryEventBodyFactory.ts index b78c6b2..edd7ac3 100644 --- a/src/factories/entryEventBodyFactory.ts +++ b/src/factories/entryEventBodyFactory.ts @@ -91,17 +91,19 @@ export function entryPayloadFactory(options: EntryPayloadFactoryOptions, ids: Pa }); } -export default function entryEventBodyFactory( - options: { - event: EnvoyEntryEvent, - config: Record, - payloadOptions: EntryPayloadFactoryOptions, - scope?: Array, - ids?: Partial, - }, +export type EntryEventBodyFactoryOptions = Record> = { + event: EnvoyEntryEvent, + config: Config, + payloadOptions: EntryPayloadFactoryOptions, + scope?: Array, + ids?: Partial, +}; + +export default function entryEventBodyFactory = Record>( + options: EntryEventBodyFactoryOptions, ) { const ids = options.ids || defaultIds; - return eventBodyFactory({ + return eventBodyFactory({ event: options.event, config: options.config, scope: options.scope || [], diff --git a/src/factories/eventBodyFactory.ts b/src/factories/eventBodyFactory.ts index f9b4d1a..4898618 100644 --- a/src/factories/eventBodyFactory.ts +++ b/src/factories/eventBodyFactory.ts @@ -6,21 +6,24 @@ export const defaultIds = { companyId: '1', }; +export type EventBodyFactoryOptions = { + event: Event, + config: Config, + payload: Payload, + scope: Array, + locationId?: string, + companyId?: string, +}; + export default function eventBodyFactory< Event extends string = string, + Config extends Record = Record, Payload extends Record = Record, >( - options: { - event: Event, - config: Record, - payload: Payload, - scope: Array, - locationId?: string, - companyId?: string, - }, + options: EventBodyFactoryOptions, ) { return { - meta: eventMetaFactory( + meta: eventMetaFactory( options.event, options.config, options.scope, diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts index 38ec8e8..4521722 100644 --- a/src/factories/metaFactory.ts +++ b/src/factories/metaFactory.ts @@ -65,10 +65,13 @@ export function authFactory(): Sync.Factory { }); } -export function routeMetaFactory( +export function routeMetaFactory< + Config extends Record = Record, + Params extends Record = Record, + >( route: string, - config: Record, - params: Record, + config: Config, + params: Params, scope: Array, locationId: string, companyId: string, @@ -86,9 +89,9 @@ export function routeMetaFactory( }); } -export function eventMetaFactory( +export function eventMetaFactory = Record>( event: string, - config: Record, + config: Config, scope: Array, locationId: string, companyId: string, diff --git a/src/factories/routeBodyFactory.ts b/src/factories/routeBodyFactory.ts index 5a1f454..721e79a 100644 --- a/src/factories/routeBodyFactory.ts +++ b/src/factories/routeBodyFactory.ts @@ -6,19 +6,25 @@ export const defaultIds = { companyId: '1', }; -export default function routeBodyFactory = Record>( - options: { - config: Record, - params: Record, - payload: Payload, - scope?: Array, - locationId?: string, - companyId?: string, - route?: string, - }, +export type RouteBodyFactoryOptions = { + config: Config, + params: Params, + payload: Payload, + scope?: Array, + locationId?: string, + companyId?: string, + route?: string, +}; + +export default function routeBodyFactory< + Config extends Record = Record, + Params extends Record = Record, + Payload extends Record = Record, + >( + options: RouteBodyFactoryOptions, ) { return { - meta: routeMetaFactory( + meta: routeMetaFactory( options.route || '', options.config, options.params, From d52fe53c1d7e6454a13cb939439ab6924cc28d48 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 19:47:23 -0400 Subject: [PATCH 47/91] Exposing all factory types --- package.json | 2 +- src/factories/entryEventBodyFactory.ts | 17 ++++++++++------- src/factories/eventBodyFactory.ts | 6 +++--- src/factories/routeBodyFactory.ts | 6 +++--- src/index.ts | 5 +++++ 5 files changed, 22 insertions(+), 14 deletions(-) diff --git a/package.json b/package.json index 479e805..5b23e36 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.4", + "version": "2.0.0-beta.5", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/factories/entryEventBodyFactory.ts b/src/factories/entryEventBodyFactory.ts index edd7ac3..6037128 100644 --- a/src/factories/entryEventBodyFactory.ts +++ b/src/factories/entryEventBodyFactory.ts @@ -19,7 +19,7 @@ export type EntryPayloadFactoryOptions = { } }; -export const defaultIds = { +export const entryEventBodyFactoryDefaultIds = { location: '1', company: '1', flow: '1', @@ -28,9 +28,12 @@ export const defaultIds = { employee: '1', }; -export function entryPayloadFactory(options: EntryPayloadFactoryOptions, ids: Partial = defaultIds): Sync.Factory { +export function entryPayloadFactory( + options: EntryPayloadFactoryOptions, + ids: Partial = entryEventBodyFactoryDefaultIds, +): Sync.Factory { const signedInDate = faker.date.past(); - const allIds = { ...defaultIds, ...ids }; + const allIds = { ...entryEventBodyFactoryDefaultIds, ...ids }; return Sync.makeFactory({ id: each((i) => `${i}`), type: 'entries', @@ -96,19 +99,19 @@ export type EntryEventBodyFactoryOptions config: Config, payloadOptions: EntryPayloadFactoryOptions, scope?: Array, - ids?: Partial, + ids?: Partial, }; export default function entryEventBodyFactory = Record>( options: EntryEventBodyFactoryOptions, ) { - const ids = options.ids || defaultIds; + const ids = options.ids || entryEventBodyFactoryDefaultIds; return eventBodyFactory({ event: options.event, config: options.config, scope: options.scope || [], - locationId: options.ids?.location || defaultIds.location, - companyId: options.ids?.company || defaultIds.company, + locationId: options.ids?.location || entryEventBodyFactoryDefaultIds.location, + companyId: options.ids?.company || entryEventBodyFactoryDefaultIds.company, payload: entryPayloadFactory(options.payloadOptions, ids).build(), }); } diff --git a/src/factories/eventBodyFactory.ts b/src/factories/eventBodyFactory.ts index 4898618..868da18 100644 --- a/src/factories/eventBodyFactory.ts +++ b/src/factories/eventBodyFactory.ts @@ -1,7 +1,7 @@ import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; import { eventMetaFactory } from './metaFactory'; -export const defaultIds = { +export const eventBodyFactoryDefaultIds = { locationId: '1', companyId: '1', }; @@ -27,8 +27,8 @@ export default function eventBodyFactory< options.event, options.config, options.scope, - options.locationId || defaultIds.locationId, - options.companyId || defaultIds.companyId, + options.locationId || eventBodyFactoryDefaultIds.locationId, + options.companyId || eventBodyFactoryDefaultIds.companyId, ).build(), payload: options.payload, }; diff --git a/src/factories/routeBodyFactory.ts b/src/factories/routeBodyFactory.ts index 721e79a..cb49bec 100644 --- a/src/factories/routeBodyFactory.ts +++ b/src/factories/routeBodyFactory.ts @@ -1,7 +1,7 @@ import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; import { routeMetaFactory } from './metaFactory'; -export const defaultIds = { +export const routeBodyFactoryDefaultIds = { locationId: '1', companyId: '1', }; @@ -29,8 +29,8 @@ export default function routeBodyFactory< options.config, options.params, options.scope || [], - options.locationId || defaultIds.locationId, - options.companyId || defaultIds.companyId, + options.locationId || routeBodyFactoryDefaultIds.locationId, + options.companyId || routeBodyFactoryDefaultIds.companyId, ).build(), payload: options.payload, }; diff --git a/src/index.ts b/src/index.ts index d06ffe8..6f67ece 100644 --- a/src/index.ts +++ b/src/index.ts @@ -28,6 +28,11 @@ import EnvoyJWT from './util/EnvoyJWT'; import EnvoySignatureVerifier from './util/EnvoySignatureVerifier'; import JSONAPIData from './util/json-api/JSONAPIData'; +export * from './factories/entryEventBodyFactory'; +export * from './factories/eventBodyFactory'; +export * from './factories/metaFactory'; +export * from './factories/routeBodyFactory'; + export * from './resources/AgreementPageResource'; export * from './resources/AgreementResource'; export * from './resources/CompanyResource'; From 4f273f64d0fd0aae2c7a155ce014676fd23eba55 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sat, 24 Jul 2021 20:19:22 -0400 Subject: [PATCH 48/91] Separated protect and visitors factory options. --- package.json | 2 +- src/factories/entryEventBodyFactory.ts | 31 ++++++++++++++------------ 2 files changed, 18 insertions(+), 15 deletions(-) diff --git a/package.json b/package.json index 5b23e36..92cb81f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.5", + "version": "2.0.0-beta.6", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/factories/entryEventBodyFactory.ts b/src/factories/entryEventBodyFactory.ts index 6037128..dc76900 100644 --- a/src/factories/entryEventBodyFactory.ts +++ b/src/factories/entryEventBodyFactory.ts @@ -7,16 +7,19 @@ import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; import eventBodyFactory from './eventBodyFactory'; export type EntryPayloadFactoryOptions = { + isProtectFlow: false, isSignedIn: boolean, hasEmail: boolean, - hasPhoneNumber: boolean, - hasPhoto: boolean, - isProtectFlow: boolean, - nonProtectFlowOptions: { - hasHost: boolean, - hasInvite: boolean, - hasDevice: boolean, - } + hasHost: boolean, + hasInvite: boolean, + hasDevice: boolean, + hasPhoneNumber?: boolean, + hasPhoto?: boolean, +} | { + isProtectFlow: true, + isSignedIn: boolean, + hasPhoneNumber?: boolean, + hasPhoto?: boolean, }; export const entryEventBodyFactoryDefaultIds = { @@ -40,10 +43,10 @@ export function entryPayloadFactory( attributes: { 'full-name': faker.name.findName(), 'phone-number': options.hasPhoneNumber ? faker.phone.phoneNumber() : undefined, - email: (options.hasEmail || options.isProtectFlow) ? faker.internet.email() : null, + email: (options.isProtectFlow || options.hasEmail) ? faker.internet.email() : null, 'employee-screening-flow': options.isProtectFlow, - host: (!options.isProtectFlow && options.nonProtectFlowOptions.hasHost) ? faker.name.findName() : null, - 'host-email': (!options.isProtectFlow && options.nonProtectFlowOptions.hasHost) ? faker.internet.email() : null, + host: (!options.isProtectFlow && options.hasHost) ? faker.name.findName() : null, + 'host-email': (!options.isProtectFlow && options.hasHost) ? faker.internet.email() : null, 'private-notes': null, 'signed-in-at': signedInDate.toUTCString(), 'signed-out-at': options.isSignedIn ? undefined : faker.date.between(signedInDate, new Date()).toUTCString(), @@ -72,19 +75,19 @@ export function entryPayloadFactory( type: 'flows', }, }, - invite: (options.isProtectFlow || options.nonProtectFlowOptions.hasInvite) ? { + invite: (options.isProtectFlow || options.hasInvite) ? { data: { id: allIds.invite, type: 'invites', }, } : undefined, - device: (!options.isProtectFlow && options.nonProtectFlowOptions.hasInvite) ? { + device: (!options.isProtectFlow && options.hasDevice) ? { data: { id: allIds.device, type: 'devices', }, } : undefined, - employee: (options.isProtectFlow || options.nonProtectFlowOptions.hasHost) ? { + employee: (options.isProtectFlow || options.hasHost) ? { data: { id: allIds.employee, type: 'employees', From 830be1b3d3dc399a38c8ecde73aeda53e3103c6e Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sun, 25 Jul 2021 14:06:44 -0400 Subject: [PATCH 49/91] Made configs partial during testing --- package.json | 2 +- src/factories/entryEventBodyFactory.ts | 2 +- src/factories/eventBodyFactory.ts | 2 +- src/factories/metaFactory.ts | 4 ++-- src/factories/routeBodyFactory.ts | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package.json b/package.json index 92cb81f..2d1c1ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.6", + "version": "2.0.0-beta.7", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/factories/entryEventBodyFactory.ts b/src/factories/entryEventBodyFactory.ts index dc76900..3b6163c 100644 --- a/src/factories/entryEventBodyFactory.ts +++ b/src/factories/entryEventBodyFactory.ts @@ -99,7 +99,7 @@ export function entryPayloadFactory( export type EntryEventBodyFactoryOptions = Record> = { event: EnvoyEntryEvent, - config: Config, + config: Partial, payloadOptions: EntryPayloadFactoryOptions, scope?: Array, ids?: Partial, diff --git a/src/factories/eventBodyFactory.ts b/src/factories/eventBodyFactory.ts index 868da18..b5e2f10 100644 --- a/src/factories/eventBodyFactory.ts +++ b/src/factories/eventBodyFactory.ts @@ -8,7 +8,7 @@ export const eventBodyFactoryDefaultIds = { export type EventBodyFactoryOptions = { event: Event, - config: Config, + config: Partial, payload: Payload, scope: Array, locationId?: string, diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts index 4521722..a2e69a3 100644 --- a/src/factories/metaFactory.ts +++ b/src/factories/metaFactory.ts @@ -70,7 +70,7 @@ export function routeMetaFactory< Params extends Record = Record, >( route: string, - config: Config, + config: Partial, params: Params, scope: Array, locationId: string, @@ -91,7 +91,7 @@ export function routeMetaFactory< export function eventMetaFactory = Record>( event: string, - config: Config, + config: Partial, scope: Array, locationId: string, companyId: string, diff --git a/src/factories/routeBodyFactory.ts b/src/factories/routeBodyFactory.ts index cb49bec..9bc7c97 100644 --- a/src/factories/routeBodyFactory.ts +++ b/src/factories/routeBodyFactory.ts @@ -7,7 +7,7 @@ export const routeBodyFactoryDefaultIds = { }; export type RouteBodyFactoryOptions = { - config: Config, + config: Partial, params: Params, payload: Payload, scope?: Array, From 75c22a00770730c6b54443db47857196a10911f0 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sun, 25 Jul 2021 16:17:27 -0400 Subject: [PATCH 50/91] Change job mock method name --- package.json | 2 +- src/mocks/EnvoyPluginJobMock.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2d1c1ae..e236fae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.7", + "version": "2.0.0-beta.8", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/mocks/EnvoyPluginJobMock.ts b/src/mocks/EnvoyPluginJobMock.ts index 1712c03..99187c5 100644 --- a/src/mocks/EnvoyPluginJobMock.ts +++ b/src/mocks/EnvoyPluginJobMock.ts @@ -15,7 +15,7 @@ export default class EnvoyPluginJobMock extends EnvoyPluginJob { private static updates: Array = []; - static hasAttachmentLike(partialAttachment: Partial) { + static attachmentLike(partialAttachment: Partial) { return EnvoyPluginJobMock.updates.find( ({ attachments }) => attachments.find( (attachment) => isMatch(partialAttachment, attachment), From f216cd167547c65920d4c7542445230d073b403a Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Sun, 25 Jul 2021 16:25:09 -0400 Subject: [PATCH 51/91] Partial match bug --- package.json | 2 +- src/mocks/EnvoyPluginJobMock.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index e236fae..c435a5b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.8", + "version": "2.0.0-beta.9", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/mocks/EnvoyPluginJobMock.ts b/src/mocks/EnvoyPluginJobMock.ts index 99187c5..c399711 100644 --- a/src/mocks/EnvoyPluginJobMock.ts +++ b/src/mocks/EnvoyPluginJobMock.ts @@ -18,7 +18,7 @@ export default class EnvoyPluginJobMock extends EnvoyPluginJob { static attachmentLike(partialAttachment: Partial) { return EnvoyPluginJobMock.updates.find( ({ attachments }) => attachments.find( - (attachment) => isMatch(partialAttachment, attachment), + (attachment) => isMatch(attachment, partialAttachment), ), ); } From 9c29ff4964ffbcb752ff80d30a13250e09115357 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Mon, 23 Aug 2021 13:05:56 -0400 Subject: [PATCH 52/91] Some bugs --- package.json | 2 +- src/factories/entryEventBodyFactory.ts | 14 +++++++++----- src/factories/metaFactory.ts | 8 ++++---- src/sdk/filters.ts | 2 +- 4 files changed, 15 insertions(+), 11 deletions(-) diff --git a/package.json b/package.json index c435a5b..f927184 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.9", + "version": "2.0.0-beta.10", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/factories/entryEventBodyFactory.ts b/src/factories/entryEventBodyFactory.ts index 3b6163c..aa13fff 100644 --- a/src/factories/entryEventBodyFactory.ts +++ b/src/factories/entryEventBodyFactory.ts @@ -6,7 +6,7 @@ import EnvoyEntryEvent from '../internal/EnvoyEntryEvent'; import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; import eventBodyFactory from './eventBodyFactory'; -export type EntryPayloadFactoryOptions = { +export type EntryPayloadFactoryVisitorOptions = { isProtectFlow: false, isSignedIn: boolean, hasEmail: boolean, @@ -15,13 +15,17 @@ export type EntryPayloadFactoryOptions = { hasDevice: boolean, hasPhoneNumber?: boolean, hasPhoto?: boolean, -} | { +}; + +export type EntryPayloadFactoryProtectOptions = { isProtectFlow: true, isSignedIn: boolean, hasPhoneNumber?: boolean, hasPhoto?: boolean, }; +export type EntryPayloadFactoryOptions = EntryPayloadFactoryVisitorOptions | EntryPayloadFactoryProtectOptions; + export const entryEventBodyFactoryDefaultIds = { location: '1', company: '1', @@ -38,7 +42,7 @@ export function entryPayloadFactory( const signedInDate = faker.date.past(); const allIds = { ...entryEventBodyFactoryDefaultIds, ...ids }; return Sync.makeFactory({ - id: each((i) => `${i}`), + id: each((i) => `${i + 1}`), type: 'entries', attributes: { 'full-name': faker.name.findName(), @@ -48,8 +52,8 @@ export function entryPayloadFactory( host: (!options.isProtectFlow && options.hasHost) ? faker.name.findName() : null, 'host-email': (!options.isProtectFlow && options.hasHost) ? faker.internet.email() : null, 'private-notes': null, - 'signed-in-at': signedInDate.toUTCString(), - 'signed-out-at': options.isSignedIn ? undefined : faker.date.between(signedInDate, new Date()).toUTCString(), + 'signed-in-at': signedInDate.toISOString(), + 'signed-out-at': options.isSignedIn ? undefined : faker.date.between(signedInDate, new Date()).toISOString(), thumbnails: options.hasPhoto ? { large: faker.image.avatar(), original: faker.image.avatar(), diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts index a2e69a3..c2b3473 100644 --- a/src/factories/metaFactory.ts +++ b/src/factories/metaFactory.ts @@ -38,7 +38,7 @@ export function locationFactory(id: string): Sync.Factory { zip: faker.address.zipCode(), longitude: null, latitude: null, - 'created-at': faker.date.past().toUTCString(), + 'created-at': faker.date.past().toISOString(), }, }); } @@ -50,7 +50,7 @@ export function companyFactory(id: string): Sync.Factory { attributes: { name: faker.company.companyName(), active: true, - 'created-at': faker.date.past().toUTCString(), + 'created-at': faker.date.past().toISOString(), }, }); } @@ -78,7 +78,7 @@ export function routeMetaFactory< ): Sync.Factory { return Sync.makeFactory({ plugin_id: faker.datatype.uuid(), - install_id: faker.datatype.number().toString(), + install_id: Math.ceil(Math.abs(faker.datatype.number())).toString(), location: locationFactory(locationId).build(), company: companyFactory(companyId).build(), auth: scope.length ? authFactory().build() : null, @@ -98,7 +98,7 @@ export function eventMetaFactory = Record ): Sync.Factory { return Sync.makeFactory({ plugin_id: faker.datatype.uuid(), - install_id: faker.datatype.number().toString(), + install_id: Math.ceil(Math.abs(faker.datatype.number())).toString(), job: jobFactory(event).build(), location: locationFactory(locationId).build(), company: companyFactory(companyId).build(), diff --git a/src/sdk/filters.ts b/src/sdk/filters.ts index 2f0b9fa..343b95c 100644 --- a/src/sdk/filters.ts +++ b/src/sdk/filters.ts @@ -56,7 +56,7 @@ export function excludedEmployeesFilterMiddleware( if (!payload.attributes['employee-screening-flow']) { return next(); } - const excludedEmployees = config[excludeEmployeesKey]; + const excludedEmployees = config[excludeEmployeesKey] as unknown as Array || []; if (!Array.isArray(excludedEmployees)) { return next(new Error(`${excludeEmployeesKey} is not an array.`)); } From 12e2cc8d145f835d2ac56fb2863b0924c6e95f6a Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 17 Nov 2021 12:17:18 -0500 Subject: [PATCH 53/91] Casting the min and max to numbers --- package.json | 2 +- src/base/EnvoyPluginStoragePipeline.ts | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index f927184..1802677 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.10", + "version": "2.0.0-beta.11", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/base/EnvoyPluginStoragePipeline.ts b/src/base/EnvoyPluginStoragePipeline.ts index 9975479..e9871ab 100644 --- a/src/base/EnvoyPluginStoragePipeline.ts +++ b/src/base/EnvoyPluginStoragePipeline.ts @@ -71,6 +71,12 @@ export default class EnvoyPluginStoragePipeline { * and returns that item. */ setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): EnvoyPluginStoragePipeline { + if (options.min) { + options.min = Number(options.min); + } + if (options.max) { + options.max = Number(options.max); + } return this.addCommand({ action: 'set_unique_num', key, ...options }); } From f93b76581577b7a49f9f1275e2ae14f53b95e65b Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Mon, 6 Dec 2021 12:13:04 -0500 Subject: [PATCH 54/91] added a factory for invite events --- package.json | 2 +- src/factories/inviteEventBodyFactory.ts | 107 ++++++++++++++++++++++++ src/index.ts | 2 + 3 files changed, 110 insertions(+), 1 deletion(-) create mode 100644 src/factories/inviteEventBodyFactory.ts diff --git a/package.json b/package.json index 1802677..229f107 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.11", + "version": "2.0.0-beta.12", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/factories/inviteEventBodyFactory.ts b/src/factories/inviteEventBodyFactory.ts new file mode 100644 index 0000000..4ad4069 --- /dev/null +++ b/src/factories/inviteEventBodyFactory.ts @@ -0,0 +1,107 @@ +import { Sync, each } from 'factory.ts'; +import faker from 'faker'; + +import InvitePayload from '../payloads/InvitePayload'; +import EnvoyInviteEvent from '../internal/EnvoyInviteEvent'; +import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; +import eventBodyFactory from './eventBodyFactory'; + +export type InvitePayloadFactoryVisitorOptions = { + isProtectFlow: false, + hasEmail: boolean, + hasHost: boolean, + preregistrationComplete: boolean, + hasPhoto?: boolean, +}; + +export type InvitePayloadFactoryProtectOptions = { + isProtectFlow: true, + preregistrationComplete: boolean, + hasPhoto?: boolean, +}; + +export type InvitePayloadFactoryOptions = InvitePayloadFactoryVisitorOptions | InvitePayloadFactoryProtectOptions; + +export const inviteEventBodyFactoryDefaultIds = { + location: '1', + company: '1', + flow: '1', + invite: '1', + device: '1', + employee: '1', +}; + +export function invitePayloadFactory( + options: InvitePayloadFactoryOptions, + ids: Partial = inviteEventBodyFactoryDefaultIds, +): Sync.Factory { + const signedInDate = faker.date.past(); + const allIds = { ...inviteEventBodyFactoryDefaultIds, ...ids }; + return Sync.makeFactory({ + id: each((i) => `${i + 1}`), + type: 'invites', + attributes: { + 'employee-screening-flow': options.isProtectFlow, + 'full-name': faker.name.findName(), + email: (options.isProtectFlow || options.hasEmail) ? faker.internet.email() : null, + 'inviter-name': (!options.isProtectFlow && options.hasHost) ? faker.name.findName() : null, + 'inviter-email': (!options.isProtectFlow && options.hasHost) ? faker.internet.email() : null, + 'expected-arrival-time': faker.date.future().toISOString(), + 'private-notes': null, + arrived: false, + 'been-here-before': false, + 'flow-name': options.isProtectFlow ? 'Employee registration' : 'Visitor', + 'flow-id': allIds.flow, + 'user-data': [] as Array<{ field: string, value: string | null }>, + 'secret-token': faker.random.alphaNumeric(10), + 'edit-token': faker.random.alphaNumeric(10), + 'photo-url': faker.image.avatar(), + 'qr-code': null, + 'qr-code-sent-at': null, + 'preregistration-complete': options.preregistrationComplete, + 'reminder-sent-at': null, + }, + relationships: { + location: { + data: { + id: allIds.location, + type: 'locations', + }, + }, + flow: { + data: { + id: allIds.flow, + type: 'flows', + }, + }, + employee: (options.isProtectFlow || options.hasHost) ? { + data: { + id: allIds.employee, + type: 'employees', + }, + } : undefined, + }, + }); +} + +export type InviteEventBodyFactoryOptions = Record> = { + event: EnvoyInviteEvent, + config: Partial, + payloadOptions: InvitePayloadFactoryOptions, + scope?: Array, + ids?: Partial, +}; + +export default function entryEventBodyFactory = Record>( + options: InviteEventBodyFactoryOptions, +) { + const ids = options.ids || inviteEventBodyFactoryDefaultIds; + return eventBodyFactory({ + event: options.event, + config: options.config, + scope: options.scope || [], + locationId: options.ids?.location || inviteEventBodyFactoryDefaultIds.location, + companyId: options.ids?.company || inviteEventBodyFactoryDefaultIds.company, + payload: invitePayloadFactory(options.payloadOptions, ids).build(), + }); +} diff --git a/src/index.ts b/src/index.ts index 6f67ece..ca11a4b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,6 +4,7 @@ import EnvoyPluginStoragePipeline from './base/EnvoyPluginStoragePipeline'; import entryEventBodyFactory from './factories/entryEventBodyFactory'; import eventBodyFactory from './factories/eventBodyFactory'; +import inviteEventBodyFactory from './factories/inviteEventBodyFactory'; import routeBodyFactory from './factories/routeBodyFactory'; import HttpStatus from './internal/HttpStatus'; @@ -74,5 +75,6 @@ export { HttpStatus, entryEventBodyFactory, eventBodyFactory, + inviteEventBodyFactory, routeBodyFactory, }; From 5fa86e1eeac14495d25978ade1a3b228b0f731a6 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Mon, 13 Dec 2021 14:43:39 -0500 Subject: [PATCH 55/91] forgot to export invite factory options. --- src/index.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/index.ts b/src/index.ts index ca11a4b..523486a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -31,6 +31,7 @@ import JSONAPIData from './util/json-api/JSONAPIData'; export * from './factories/entryEventBodyFactory'; export * from './factories/eventBodyFactory'; +export * from './factories/inviteEventBodyFactory'; export * from './factories/metaFactory'; export * from './factories/routeBodyFactory'; From 75ea2c83bd2556399f7193f683ecde77b4b98e8d Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Tue, 14 Dec 2021 10:15:26 -0500 Subject: [PATCH 56/91] Added the list storage API to the SDK. Necessary for the lambda adapter to fetch all its storage items. --- package.json | 2 +- src/base/EnvoyPluginStoragePipeline.ts | 20 +++++-- src/internal/EnvoyStorageCommand.ts | 8 ++- src/internal/EnvoyStorageResult.ts | 5 ++ src/mocks/EnvoyPluginStoragePipelineMock.ts | 63 ++++++++++++++------- src/sdk/EnvoyPluginAPI.ts | 6 +- src/sdk/EnvoyPluginStorage.ts | 29 ++++++---- 7 files changed, 93 insertions(+), 40 deletions(-) create mode 100644 src/internal/EnvoyStorageResult.ts diff --git a/package.json b/package.json index 229f107..4f46c95 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.12", + "version": "2.0.0-beta.13", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/base/EnvoyPluginStoragePipeline.ts b/src/base/EnvoyPluginStoragePipeline.ts index e9871ab..e150d0d 100644 --- a/src/base/EnvoyPluginStoragePipeline.ts +++ b/src/base/EnvoyPluginStoragePipeline.ts @@ -2,7 +2,7 @@ import EnvoyStorageCommand, { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions, } from '../internal/EnvoyStorageCommand'; -import EnvoyStorageItem from '../sdk/EnvoyStorageItem'; +import EnvoyStorageResult from '../internal/EnvoyStorageResult'; import EnvoyPluginAPI from '../sdk/EnvoyPluginAPI'; /** @@ -26,15 +26,15 @@ export default class EnvoyPluginStoragePipeline { /** * Executes all the commands in the pipeline. */ - execute(): Promise> { - return this.api.storagePipeline(this.commands, this.installId); + execute(): Promise> { + return this.api.storagePipeline(this.commands, this.installId); } /** * Executes the pipeline and returns the first result. */ - async executeSingle(): Promise { - const [result] = await this.execute(); + async executeSingle(): Promise { + const [result] = await this.execute(); return result; } @@ -86,4 +86,14 @@ export default class EnvoyPluginStoragePipeline { unset(key: string): EnvoyPluginStoragePipeline { return this.addCommand({ action: 'unset', key }); } + + /** + * Lists storage items. + */ + list(page = 1): EnvoyPluginStoragePipeline { + if (!page) { + page = 1; + } + return this.addCommand({ action: 'list', page }); + } } diff --git a/src/internal/EnvoyStorageCommand.ts b/src/internal/EnvoyStorageCommand.ts index 2bd6c2c..6fad4e7 100644 --- a/src/internal/EnvoyStorageCommand.ts +++ b/src/internal/EnvoyStorageCommand.ts @@ -42,6 +42,11 @@ export interface EnvoyUnsetStorageCommand extends EnvoyBaseStorageCommand { action: 'unset', } +export interface EnvoyListStorageCommand { + action: 'list', + page: number, +} + /** * @internal */ @@ -49,6 +54,7 @@ type EnvoyStorageCommand = EnvoyGetStorageCommand | EnvoySetStorageCommand | EnvoySetUniqueStorageCommand | EnvoySetUniqueNumStorageCommand -| EnvoyUnsetStorageCommand; +| EnvoyUnsetStorageCommand +| EnvoyListStorageCommand; export default EnvoyStorageCommand; diff --git a/src/internal/EnvoyStorageResult.ts b/src/internal/EnvoyStorageResult.ts new file mode 100644 index 0000000..eb62365 --- /dev/null +++ b/src/internal/EnvoyStorageResult.ts @@ -0,0 +1,5 @@ +import EnvoyStorageItem from '../sdk/EnvoyStorageItem'; + +type EnvoyStorageResult = EnvoyStorageItem | Array> | null; + +export default EnvoyStorageResult; diff --git a/src/mocks/EnvoyPluginStoragePipelineMock.ts b/src/mocks/EnvoyPluginStoragePipelineMock.ts index c009221..b7f051a 100644 --- a/src/mocks/EnvoyPluginStoragePipelineMock.ts +++ b/src/mocks/EnvoyPluginStoragePipelineMock.ts @@ -8,6 +8,7 @@ import { UNIQUE_OPTIONS_DEFAULT_CHARS, UNIQUE_OPTIONS_DEFAULT_SIZE, } from '../internal/EnvoyStorageCommand'; +import EnvoyStorageResult from '../internal/EnvoyStorageResult'; const DEFAULT_UNIQUE_OPTIONS: EnvoyStorageSetUniqueOptions = { chars: UNIQUE_OPTIONS_DEFAULT_CHARS, @@ -20,48 +21,50 @@ const DEFAULT_UNIQUE_NUM_OPTIONS: EnvoyStorageSetUniqueNumOptions = { }; export default class EnvoyPluginStoragePipelineMock extends EnvoyPluginStoragePipeline { - execute(): Promise> { + execute(): Promise> { return Promise.resolve( this.commands.map((command) => { - const { key } = command; - const item: EnvoyStorageItem = { key, value: undefined }; const isGlobal = !this.installId; switch (command.action) { - case 'get': - item.value = EnvoyPluginStoragePipelineMock.get(key, isGlobal); - if (item.value === null) { + case 'get': { + const value = EnvoyPluginStoragePipelineMock.get(command.key, isGlobal); + if (value === null) { return null; } - break; - case 'set': - item.value = EnvoyPluginStoragePipelineMock.set(key, command.value, isGlobal); - break; + return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value); + } + case 'set': { + const value = EnvoyPluginStoragePipelineMock.set(command.key, command.value, isGlobal); + return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value); + } case 'set_unique': try { - item.value = EnvoyPluginStoragePipelineMock.setUnique(key, command as EnvoyStorageSetUniqueOptions, isGlobal); + const value = EnvoyPluginStoragePipelineMock.setUnique(command.key, command as EnvoyStorageSetUniqueOptions, isGlobal); + return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value); } catch (err) { return null; } - break; case 'set_unique_num': { try { - item.value = EnvoyPluginStoragePipelineMock.setUniqueNum(key, command as EnvoyStorageSetUniqueNumOptions, isGlobal); + const value = EnvoyPluginStoragePipelineMock.setUniqueNum(command.key, command as EnvoyStorageSetUniqueNumOptions, isGlobal); + return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value); } catch (err) { return null; } - break; } - case 'unset': - item.value = EnvoyPluginStoragePipelineMock.unset(key, isGlobal); - if (item.value === null) { + case 'unset': { + const value = EnvoyPluginStoragePipelineMock.unset(command.key, isGlobal); + if (value === null) { return null; } - break; + return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value); + } + case 'list': + return EnvoyPluginStoragePipelineMock.list(command.page); default: return null; } - return item; - }), + }) as Array, ); } @@ -79,6 +82,10 @@ export default class EnvoyPluginStoragePipelineMock extends EnvoyPluginStoragePi return isGlobal ? `global_${key}` : `install_${key}`; } + private static itemFromKeyValue(key: string, value: Value) { + return { key, value } as EnvoyStorageItem; + } + static get(key: string, isGlobal = false): Value | null { key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal); if (!Object.keys(EnvoyPluginStoragePipelineMock.storage).includes(key)) { @@ -158,6 +165,22 @@ export default class EnvoyPluginStoragePipelineMock extends EnvoyPluginStoragePi return value as Value; } + static list(page = 1, isGlobal = false) { + const limit = 100; + const offset = (page - 1) * limit; + return Object.keys(EnvoyPluginStoragePipelineMock.storage) + .filter((key) => (key.startsWith('global_') && isGlobal) || (key.startsWith('install_') && !isGlobal)) + .sort() + .slice(offset, limit) + .map((key) => { + const value = EnvoyPluginStoragePipelineMock.storage[key]; + const pieces = key.split('_'); + pieces.shift(); + const normalizedKey = pieces.join(); + return { key: normalizedKey, value } as EnvoyStorageItem; + }); + } + static reset() { EnvoyPluginStoragePipelineMock.storage = {}; EnvoyPluginStoragePipelineMock.uniqueStringKeys.clear(); diff --git a/src/sdk/EnvoyPluginAPI.ts b/src/sdk/EnvoyPluginAPI.ts index c2ff81d..db5c580 100644 --- a/src/sdk/EnvoyPluginAPI.ts +++ b/src/sdk/EnvoyPluginAPI.ts @@ -2,7 +2,7 @@ import axios from 'axios'; import EnvoyAPI from '../base/EnvoyAPI'; import EnvoyPluginJobUpdate from '../internal/EnvoyPluginJobUpdate'; import EnvoyStorageCommand from '../internal/EnvoyStorageCommand'; -import EnvoyStorageItem from './EnvoyStorageItem'; +import EnvoyStorageResult from '../internal/EnvoyStorageResult'; import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; @@ -42,10 +42,10 @@ export default class EnvoyPluginAPI extends EnvoyAPI { }); } - async storagePipeline( + async storagePipeline( commands: Array, installId?: string, - ): Promise> { + ): Promise> { const request: Record = { commands }; if (installId) { request.install_id = installId; diff --git a/src/sdk/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts index 20bd44d..aade7ae 100644 --- a/src/sdk/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -32,8 +32,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline get. */ - get(key: string): Promise | null> { - return this.pipeline().get(key).executeSingle() as Promise | null>; + get(key: string) { + return this.pipeline().get(key).executeSingle | null>(); } /** @@ -41,8 +41,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline set. */ - set(key: string, value: Value): Promise> { - return this.pipeline().set(key, value).executeSingle() as Promise>; + set(key: string, value: Value) { + return this.pipeline().set(key, value).executeSingle>(); } /** @@ -50,8 +50,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline setUnique. */ - setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): Promise | null> { - return this.pipeline().setUnique(key, options).executeSingle() as Promise | null>; + setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}) { + return this.pipeline().setUnique(key, options).executeSingle | null>(); } /** @@ -59,8 +59,8 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline setUnique. */ - setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): Promise | null> { - return this.pipeline().setUniqueNum(key, options).executeSingle() as Promise | null>; + setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}) { + return this.pipeline().setUniqueNum(key, options).executeSingle | null>(); } /** @@ -68,7 +68,16 @@ export default class EnvoyPluginStorage { * * Wrapper for single pipeline unset. */ - unset(key: string): Promise { - return this.pipeline().unset(key).executeSingle(); + unset(key: string) { + return this.pipeline().unset(key).executeSingle | null>(); + } + + /** + * Returns an array of {@link EnvoyStorageItem} from storage. + * + * Wrapper for single pipeline list. + */ + list(page = 1) { + return this.pipeline().list(page).executeSingle>>(); } } From efd601b977d249567ccd1d0a6396e00125b5b0ab Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 19 Jan 2022 11:38:43 -0500 Subject: [PATCH 57/91] added and fixed resources --- package-lock.json | 2 +- package.json | 2 +- src/index.ts | 3 ++ src/resources/CompanyRoleResource.ts | 10 ++++ src/resources/CurrentUserResource.ts | 10 ++++ src/resources/FlowResource.ts | 8 +-- src/resources/LocationResource.ts | 71 ++++++++++++++------------- src/resources/LocationRoleResource.ts | 10 ++++ 8 files changed, 75 insertions(+), 41 deletions(-) create mode 100644 src/resources/CurrentUserResource.ts create mode 100644 src/resources/LocationRoleResource.ts diff --git a/package-lock.json b/package-lock.json index 2551fc9..a439fb9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.2", + "version": "2.0.0-beta.14", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 4f46c95..9bdc52c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.13", + "version": "2.0.0-beta.15", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/index.ts b/src/index.ts index 523486a..50f6a85 100644 --- a/src/index.ts +++ b/src/index.ts @@ -38,10 +38,13 @@ export * from './factories/routeBodyFactory'; export * from './resources/AgreementPageResource'; export * from './resources/AgreementResource'; export * from './resources/CompanyResource'; +export * from './resources/CompanyRoleResource'; +export * from './resources/CurrentUserResource'; export * from './resources/EmployeeResource'; export * from './resources/FlowResource'; export * from './resources/InviteResource'; export * from './resources/LocationResource'; +export * from './resources/LocationRoleResource'; export * from './resources/SignInFieldPageResource'; export * from './resources/SignInFieldResource'; export * from './resources/UserResource'; diff --git a/src/resources/CompanyRoleResource.ts b/src/resources/CompanyRoleResource.ts index e69de29..f09bd72 100644 --- a/src/resources/CompanyRoleResource.ts +++ b/src/resources/CompanyRoleResource.ts @@ -0,0 +1,10 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export interface CompanyRoleAttributes { + 'role-name': string; + 'confirmed-at': string; +} + +export type CompanyRoleRelationships = 'company'; + +export type CompanyRoleModel = JSONAPIModel; diff --git a/src/resources/CurrentUserResource.ts b/src/resources/CurrentUserResource.ts new file mode 100644 index 0000000..e21d2fe --- /dev/null +++ b/src/resources/CurrentUserResource.ts @@ -0,0 +1,10 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export interface CurrentUserAttributes { + 'full-name': string; + email: string; +} + +export type CurrentUserRelationships = 'location-roles' | 'company-roles'; + +export type CurrentUserModel = JSONAPIModel; diff --git a/src/resources/FlowResource.ts b/src/resources/FlowResource.ts index 4f64cc9..067e5f9 100644 --- a/src/resources/FlowResource.ts +++ b/src/resources/FlowResource.ts @@ -18,10 +18,10 @@ export interface FlowFilterFields { */ export interface FlowAttributes { name: string; - 'employee-centric'?: boolean; - enabled?: boolean; - 'created-at'?: string; - 'updated-at'?: string; + 'employee-centric': boolean; + enabled: boolean; + 'created-at': string; + 'updated-at': string; } /** diff --git a/src/resources/LocationResource.ts b/src/resources/LocationResource.ts index 51528e6..7bd3689 100644 --- a/src/resources/LocationResource.ts +++ b/src/resources/LocationResource.ts @@ -19,41 +19,42 @@ export interface LocationFilterFields { export interface LocationAttributes { name: string; address: string; - 'address-line-1'?: string; - 'address-line-2'?: string; - city?: string; - state?: string; - zip?: string; - latitude?: number; - longitude?: number; - locale?: string; - timezone?: string; - 'company-name-override'?: string; - 'logo-small-url'?: string; - 'logo-thumb-url'?: string; - 'logo-url'?: string; - disabled?: boolean; - 'visitors-onboarding-complete'?: boolean; - 'registration-eligibility-end-offset'?: number; - 'registration-eligibility-start-offset'?: number; - 'visitor-registration-eligibility-start-offset'?: number; - 'welcome-email-preference'?: string; - 'average-monthly-visitors'?: number; - 'capacity-limit'?: number; - 'auto-sign-out-at-midnight'?: boolean; - 'employee-screening-enabled'?: boolean; - 'pre-registration-enabled'?: boolean; - 'pre-registration-required-enabled'?: boolean; - 'host-approval-enabled'?: boolean; - 'multiple-languages-enabled'?: boolean; - 'near-visit-screening-enabled'?: boolean; - 'printer-notifications-enabled'?: boolean; - 'security-desk-link-enabled'?: boolean; - 'touchless-signin-enabled'?: boolean; - 'visitor-survey-enabled'?: boolean; - 'visual-compliance-enabled'?: boolean; - 'created-at'?: string; - 'updated-at'?: string; + 'address-line-1': string | null; + 'address-line-2': string | null; + city: string | null; + state: string | null; + country: string | null; + zip: string | null; + latitude: number | null; + longitude: number | null; + locale: string | null; + timezone: string; + 'company-name-override': string | null; + 'logo-small-url': string | null; + 'logo-thumb-url': string | null; + 'logo-url': string | null; + disabled: boolean | null; + 'visitors-onboarding-complete': boolean | null; + 'registration-eligibility-end-offset': number | null; + 'registration-eligibility-start-offset': number | null; + 'visitor-registration-eligibility-start-offset': number | null; + 'welcome-email-preference': string | null; + 'average-monthly-visitors': number | null; + 'capacity-limit': number | null; + 'auto-sign-out-at-midnight': boolean | null; + 'employee-screening-enabled': boolean | null; + 'pre-registration-enabled': boolean | null; + 'pre-registration-required-enabled': boolean | null; + 'host-approval-enabled': boolean | null; + 'multiple-languages-enabled': boolean | null; + 'near-visit-screening-enabled': boolean | null; + 'printer-notifications-enabled': boolean | null; + 'security-desk-link-enabled': boolean | null; + 'touchless-signin-enabled': boolean | null; + 'visitor-survey-enabled': boolean | null; + 'visual-compliance-enabled': boolean | null; + 'created-at': string; + 'updated-at': string; } /** diff --git a/src/resources/LocationRoleResource.ts b/src/resources/LocationRoleResource.ts new file mode 100644 index 0000000..b3d947d --- /dev/null +++ b/src/resources/LocationRoleResource.ts @@ -0,0 +1,10 @@ +import JSONAPIModel from '../util/json-api/JSONAPIModel'; + +export interface LocationRoleAttributes { + 'role-name': string; + 'confirmed-at': string; +} + +export type LocationRoleRelationships = 'location'; + +export type LocationRoleModel = JSONAPIModel; From bcdd58ac0a394e351660bd5b4e4e47c9fcba0dfb Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 19 Jan 2022 11:39:07 -0500 Subject: [PATCH 58/91] added and fixed resources --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index a439fb9..4274f54 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.14", + "version": "2.0.0-beta.15", "lockfileVersion": 1, "requires": true, "dependencies": { From 513e2c3ebc2733ecaaa6c8ed1e1dc2a08a2c9616 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 19 Jan 2022 11:42:09 -0500 Subject: [PATCH 59/91] increment --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9bdc52c..10d6137 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.15", + "version": "2.0.0-beta.16", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 5f90d9ae69b46f0516dd60ada3b6748dae6a9027 Mon Sep 17 00:00:00 2001 From: Sam Kalum <32343294+skalum@users.noreply.github.com> Date: Wed, 26 Jan 2022 14:21:43 -0500 Subject: [PATCH 60/91] add approval-status to EntryPayload (#8) * add approval-status to EntryPayload * add comma --- package-lock.json | 2 +- package.json | 2 +- src/payloads/EntryPayload.ts | 18 +++++++++++++++++- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 4274f54..b003c2d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.15", + "version": "2.0.0-beta.17", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 10d6137..8cb976a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.16", + "version": "2.0.0-beta.17", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/payloads/EntryPayload.ts b/src/payloads/EntryPayload.ts index 4c7a4ad..88b0edc 100644 --- a/src/payloads/EntryPayload.ts +++ b/src/payloads/EntryPayload.ts @@ -35,7 +35,23 @@ type EntryPayload = { 'user-data': Array<{ field: string, value: string | null, - }> + }>, + 'approval-status'?: { + status: string, + 'auto-approved': boolean, + report: Array<{ + reason?: string, + result: string, + source: string, + messages: Array<{ + failure: { + text: string, + header: string, + }, + }>, + }>, + blacklistReportUUID?: string, + }, }, relationships: { location: { From 18be8c2f889d7a139b91bea0f8d80573962b0ce6 Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 2 Feb 2022 14:23:01 -0500 Subject: [PATCH 61/91] add options to sign in field model (#9) * add options * increment version --- src/resources/SignInFieldResource.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/resources/SignInFieldResource.ts b/src/resources/SignInFieldResource.ts index eca5728..cd589ea 100644 --- a/src/resources/SignInFieldResource.ts +++ b/src/resources/SignInFieldResource.ts @@ -14,6 +14,10 @@ export interface SignInFieldAttributes { 'region-code'?: string; 'display-name': string; }>; + options?: Array<{ + value: string, + position: number, + }>, position?: number; 'store-response'?: boolean; 'created-at'?: string; From 7630cc1d4c90b837398328fa7469423b147707ce Mon Sep 17 00:00:00 2001 From: Shaun Persad Date: Wed, 2 Feb 2022 14:24:22 -0500 Subject: [PATCH 62/91] increment version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 8cb976a..537bb3e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.17", + "version": "2.0.0-beta.18", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From a578bc0f1c81357a640f921e358b04c11362e85e Mon Sep 17 00:00:00 2001 From: Anthony Floccari Date: Thu, 11 Aug 2022 13:30:24 -0700 Subject: [PATCH 63/91] DEVP-1456: Add tenant relationship --- src/payloads/InvitePayload.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/payloads/InvitePayload.ts b/src/payloads/InvitePayload.ts index a406b02..5e48bb4 100644 --- a/src/payloads/InvitePayload.ts +++ b/src/payloads/InvitePayload.ts @@ -57,7 +57,10 @@ type InvitePayload = { }, 'agreeable-ndas'?: { data: Array>, - } + }, + 'tenant'?: { + data: JSONAPIData<'tenants'>, + }, } }; From b5dd698de3cd7b0828bbcb9b4e44b16a6ed02d9b Mon Sep 17 00:00:00 2001 From: Anthony Floccari Date: Thu, 11 Aug 2022 13:31:54 -0700 Subject: [PATCH 64/91] version bump --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 537bb3e..590840b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.18", + "version": "2.0.0-beta.19", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From de14296ca97c73d7b6dbe05d1f2f5e0f45c273e9 Mon Sep 17 00:00:00 2001 From: Ryan Flynn Date: Thu, 19 Jan 2023 12:19:27 -0500 Subject: [PATCH 65/91] Added axios loggers for easy logging of requests, responses and errors --- README.md | 9 +++ package-lock.json | 2 +- src/sdk/loggers.ts | 165 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 175 insertions(+), 1 deletion(-) create mode 100644 src/sdk/loggers.ts diff --git a/README.md b/README.md index b078b99..4ee3b62 100644 --- a/README.md +++ b/README.md @@ -200,8 +200,17 @@ res.sendOngoing("We're still working on it.", { hello: 'world' }); // the job is res.sendIgnored("We're not gonna do this one, sorry.", { hello: 'world' }); // doesnt meet the requirements to continue. // or res.sendFailed('We tried, but failed.', { hello: 'world' }); // we cant continue with this job. + +/** +* Implement Axios Loggers +*/ +this.axios.interceptors.request.use(envoyAxiosRequestLogger, envoyAxiosErrorLogger); // Request interceptor + +this.axios.interceptors.response.use(envoyAxiosResponseLogger, envoyAxiosErrorLogger); // Response interceptor + ``` + ## SDK Reference Please see detailed documentation [here](docs/README.md). diff --git a/package-lock.json b/package-lock.json index b003c2d..152deee 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.17", + "version": "2.0.0-beta.19", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/src/sdk/loggers.ts b/src/sdk/loggers.ts new file mode 100644 index 0000000..33159ae --- /dev/null +++ b/src/sdk/loggers.ts @@ -0,0 +1,165 @@ +import { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios'; +import chalk from 'chalk'; +import util from 'util'; + +function envoyAxiosRequestLogger(config: AxiosRequestConfig) { + const log = console.log; + log('---------------- Axios Request ----------------\n'); + if (config?.method) { + const boldMethodText = chalk.bold('Method:'); + const method = config.method.toUpperCase(); + switch (method) { + case 'GET': + log(`${boldMethodText} ${chalk.green(method)}\n`); + break; + case 'PUT': + log(`${boldMethodText} ${chalk.yellow(method)}\n`); + break; + case 'PATCH': + log(`${boldMethodText} ${chalk.yellow(method)}\n`); + break; + case 'POST': + log(`${boldMethodText} ${chalk.blue(method)}\n`); + break; + case 'DELETE': + log(`${boldMethodText} ${chalk.red(method)}\n`); + break; + default: + log(`${boldMethodText} ${method}\n`); + break; + }; + } + if (config?.baseURL && config?.url) { + log(`${chalk.bold('URL')}: ${config.baseURL}/${config.url}\n`); + } + + if (config?.headers) { + log(`${chalk.bold('Headers:')} ${util.inspect(config?.headers)}\n`); + } + + if (config?.auth) { + log(`${chalk.bold('Auth:')} ${util.inspect(config?.auth)}\n`); + } + + if (config?.params) { + log(`${chalk.bold('Params:')} ${util.inspect(config?.params)}\n`); + } + + if (config?.data) { + log(`${chalk.bold('Request Data:')} ${util.inspect(config?.data)}\n`); + } + + log('------------ End Of Axios Request ------------\n'); + + return config; +} + +function envoyAxiosResponseLogger(response: AxiosResponse) { + const log = console.log; + log('---------------- Axios Response ----------------\n'); + if (response?.request?.method) { + const boldMethodText = chalk.bold('Method:'); + const method = response.request.method; + switch (method) { + case 'GET': + log(`${boldMethodText} ${chalk.green(method)}\n`); + break; + case 'PUT': + log(`${boldMethodText} ${chalk.yellow(method)}\n`); + break; + case 'PATCH': + log(`${boldMethodText} ${chalk.yellow(method)}\n`); + break; + case 'POST': + log(`${boldMethodText} ${chalk.blue(method)}\n`); + break; + case 'DELETE': + log(`${boldMethodText} ${chalk.red(method)}\n`); + break; + default: + log(`${boldMethodText} ${method}\n`); + break; + }; + } + if (response?.request?.baseURL && response?.request?.url) { + log(`${chalk.bold('Request URL')}: ${response.request.baseURL}/${response.request.url}\n`); + } + + if (response?.status && response?.statusText) { + const boldStatusTitle = chalk.bold('Status:'); + const boldStatusTextTitle = chalk.bold('Status Text:'); + const status = response.status; + const statusText = response.statusText; + if (199 < status && status < 300) { + log(`${boldStatusTitle} ${chalk.green(status)}\n`); + log(`${boldStatusTextTitle} ${chalk.green(statusText)}\n`); + } else { + log(`${boldStatusTitle} ${chalk.red(status)}\n`); + log(`${boldStatusTextTitle} ${chalk.red(statusText)}\n`); + } + } + + if (response?.data) { + log(`${chalk.bold('Response Data:')} ${util.inspect(response?.data)}\n`); + } + + log('------------ End Of Axios Response ------------\n'); + + return response; +} + +function envoyAxiosErrorLogger(error: AxiosError) { + const log = console.log; + log('---------------- Axios Error ----------------\n'); + if (error?.request?.method) { + const boldMethodText = chalk.bold('Method:'); + const method = error.request.method; + switch (method) { + case 'GET': + log(`${boldMethodText} ${chalk.green(method)}\n`); + break; + case 'PUT': + log(`${boldMethodText} ${chalk.yellow(method)}\n`); + break; + case 'PATCH': + log(`${boldMethodText} ${chalk.yellow(method)}\n`); + break; + case 'POST': + log(`${boldMethodText} ${chalk.blue(method)}\n`); + break; + case 'DELETE': + log(`${boldMethodText} ${chalk.red(method)}\n`); + break; + default: + log(`${boldMethodText} ${method}\n`); + break; + }; + } + if (error?.request?.baseURL && error?.request?.url) { + log(`${chalk.bold('Request URL')}: ${error.request.baseURL}/${error.request.url}\n`); + } + + if (error?.response?.status && error?.response?.statusText) { + const boldStatusTitle = chalk.bold('Status:'); + const boldStatusTextTitle = chalk.bold('Status Text:'); + const status = error.response.status; + const statusText = error.response.statusText; + if (199 < status && status < 300) { + log(`${boldStatusTitle} ${chalk.green(status)}\n`); + log(`${boldStatusTextTitle} ${chalk.green(statusText)}\n`); + } else { + log(`${boldStatusTitle} ${chalk.red(status)}\n`); + log(`${boldStatusTextTitle} ${chalk.red(statusText)}\n`); + } + } + + if (error.response?.data) { + log(`${chalk.bold('Response Data:')} ${util.inspect(error.response.data)}\n`); + } + + log('------------ End Of Axios Error ------------\n'); + + return error; +} + +export { envoyAxiosRequestLogger, envoyAxiosResponseLogger, envoyAxiosErrorLogger }; \ No newline at end of file From 274bbabae714d7a907a0513fdc67b86ad759d2e7 Mon Sep 17 00:00:00 2001 From: Ryan Flynn Date: Thu, 19 Jan 2023 12:46:24 -0500 Subject: [PATCH 66/91] Changing version number --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 590840b..36b55ab 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 2d8ae36a6799227453e1d2347e1c00669a6378f9 Mon Sep 17 00:00:00 2001 From: Ryan Flynn Date: Thu, 19 Jan 2023 13:03:33 -0500 Subject: [PATCH 67/91] Export Loggers --- src/index.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/index.ts b/src/index.ts index 50f6a85..d3ac1b1 100644 --- a/src/index.ts +++ b/src/index.ts @@ -54,6 +54,7 @@ export * from './sdk/EnvoyRequest'; export * from './sdk/EnvoyResponse'; export * from './sdk/filters'; export * from './sdk/handlers'; +export * from './sdk/loggers'; export * from './sdk/middleware'; export * from './util/EnvoySignatureVerifier'; From 1419f4ef442f4667a9a7b6f0020cbf350cd66947 Mon Sep 17 00:00:00 2001 From: Ryan Flynn Date: Thu, 19 Jan 2023 13:16:01 -0500 Subject: [PATCH 68/91] Need to export loggers --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 36b55ab..f4372b7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.20", + "version": "2.0.0-beta.21", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 7f771bd60615d84e30764eee88c52e4fd7c53fa1 Mon Sep 17 00:00:00 2001 From: Stephen-Arsenault Date: Mon, 8 May 2023 11:16:04 -0700 Subject: [PATCH 69/91] Fix `EnvoyPluginStorage.ts` method failsafe typing --- package-lock.json | 2 +- package.json | 2 +- src/sdk/EnvoyPluginStorage.ts | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 152deee..757fb78 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.22", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index f4372b7..465295f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/sdk/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts index aade7ae..9e02890 100644 --- a/src/sdk/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -33,7 +33,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline get. */ get(key: string) { - return this.pipeline().get(key).executeSingle | null>(); + return this.pipeline().get(key).executeSingle | []>(); } /** @@ -51,7 +51,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline setUnique. */ setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}) { - return this.pipeline().setUnique(key, options).executeSingle | null>(); + return this.pipeline().setUnique(key, options).executeSingle | []>(); } /** @@ -60,7 +60,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline setUnique. */ setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}) { - return this.pipeline().setUniqueNum(key, options).executeSingle | null>(); + return this.pipeline().setUniqueNum(key, options).executeSingle | []>(); } /** @@ -69,7 +69,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline unset. */ unset(key: string) { - return this.pipeline().unset(key).executeSingle | null>(); + return this.pipeline().unset(key).executeSingle | []>(); } /** From 457478bc87bb01ca9c3d703f2a810a40e36920f5 Mon Sep 17 00:00:00 2001 From: Stephen-Arsenault Date: Mon, 8 May 2023 11:36:44 -0700 Subject: [PATCH 70/91] Update EnvoyPluginStorage.ts --- src/sdk/EnvoyPluginStorage.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/sdk/EnvoyPluginStorage.ts b/src/sdk/EnvoyPluginStorage.ts index 9e02890..828653f 100644 --- a/src/sdk/EnvoyPluginStorage.ts +++ b/src/sdk/EnvoyPluginStorage.ts @@ -33,7 +33,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline get. */ get(key: string) { - return this.pipeline().get(key).executeSingle | []>(); + return this.pipeline().get(key).executeSingle | { key: string, 'value': undefined }>(); } /** @@ -51,7 +51,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline setUnique. */ setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}) { - return this.pipeline().setUnique(key, options).executeSingle | []>(); + return this.pipeline().setUnique(key, options).executeSingle | { key: string, 'value': undefined }>(); } /** @@ -60,7 +60,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline setUnique. */ setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}) { - return this.pipeline().setUniqueNum(key, options).executeSingle | []>(); + return this.pipeline().setUniqueNum(key, options).executeSingle | { key: string, 'value': undefined }>(); } /** @@ -69,7 +69,7 @@ export default class EnvoyPluginStorage { * Wrapper for single pipeline unset. */ unset(key: string) { - return this.pipeline().unset(key).executeSingle | []>(); + return this.pipeline().unset(key).executeSingle | { key: string, 'value': undefined }>(); } /** From 41bcc1a5f2a6c2ce1a12757cb764f8d6f374a14b Mon Sep 17 00:00:00 2001 From: Stephen-Arsenault Date: Mon, 8 May 2023 11:39:49 -0700 Subject: [PATCH 71/91] bump version --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 757fb78..e4ff55c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.22", + "version": "2.0.0-beta.23", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 465295f..971a778 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.22", + "version": "2.0.0-beta.23", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 9f13714d03256e934a2ba089b8901583a2f5799a Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Tue, 27 Jun 2023 16:33:26 -0400 Subject: [PATCH 72/91] fix(security): scrub AxiosError sensitive fields (#28) --- src/base/EnvoyAPI.ts | 4 ++-- src/util/axiosConstructor.ts | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 src/util/axiosConstructor.ts diff --git a/src/base/EnvoyAPI.ts b/src/base/EnvoyAPI.ts index d8e8991..4fef6f5 100644 --- a/src/base/EnvoyAPI.ts +++ b/src/base/EnvoyAPI.ts @@ -1,8 +1,8 @@ -import axios from 'axios'; import qs from 'qs'; import DataLoader from 'dataloader'; import JSONAPIData from '../util/json-api/JSONAPIData'; import { envoyBaseURL } from '../constants'; +import { createAxiosClient } from '../util/axiosConstructor'; interface EnvoyWebDataLoaderKey extends JSONAPIData { include?: string; @@ -29,7 +29,7 @@ export default class EnvoyAPI { /** * HTTP Client with Envoy's defaults. */ - readonly axios = axios.create({ + readonly axios = createAxiosClient({ baseURL: envoyBaseURL, headers: { 'Content-Type': 'application/vnd.api+json', diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts new file mode 100644 index 0000000..db7e021 --- /dev/null +++ b/src/util/axiosConstructor.ts @@ -0,0 +1,14 @@ +import axios, { AxiosInstance, CreateAxiosDefaults } from 'axios'; + +export function createAxiosClient(config?: CreateAxiosDefaults | undefined): AxiosInstance { + const client = axios.create(config); + client.interceptors.response.use((response) => { + return response; + }, (error) => { + delete error.config?.headers; + delete error.config?.proxy; + return Promise.reject(error); + }); + + return client; +} \ No newline at end of file From 860a06862451de4945fc2531949abb0fecffd072 Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Tue, 27 Jun 2023 16:54:31 -0400 Subject: [PATCH 73/91] fix: use correct axios config import (#29) --- .github/workflows/build.yaml | 16 + package-lock.json | 5453 +++++++++++++++++++++++++++++++++- package.json | 5 +- src/util/axiosConstructor.ts | 4 +- 4 files changed, 5469 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/build.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..613d882 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,16 @@ +name: Build + +on: + push: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + # Setup .npmrc file to publish to npm + - uses: actions/setup-node@v2 + with: + registry-url: 'https://npm.pkg.github.com' + - run: npm install + - run: npm run compile \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index e4ff55c..5c3f697 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,8 +1,5448 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.23", - "lockfileVersion": 1, + "version": "2.0.0-beta.25", + "lockfileVersion": 2, "requires": true, + "packages": { + "": { + "name": "@envoy/envoy-integrations-sdk", + "version": "2.0.0-beta.25", + "license": "ISC", + "dependencies": { + "@types/dotenv": "^8.2.0", + "@types/faker": "^5.5.6", + "@types/jsonwebtoken": "^8.5.1", + "@types/node": "^15.12.0", + "@types/qs": "^6.9.6", + "axios": "^0.21.1", + "body-parser": "^1.19.0", + "dataloader": "^2.0.0", + "dotenv-flow": "^3.2.0", + "factory.ts": "^0.5.2", + "faker": "^5.5.3", + "jsonwebtoken": "^8.5.1", + "lodash.ismatch": "^4.4.0", + "luxon": "^1.27.0", + "qs": "^6.10.1" + }, + "devDependencies": { + "@types/dotenv-flow": "^3.1.1", + "@types/express": "^4.17.12", + "@types/lodash.ismatch": "^4.4.6", + "@types/luxon": "^1.27.0", + "@typescript-eslint/eslint-plugin": "^4.26.0", + "@typescript-eslint/parser": "^4.26.0", + "chai": "^4.2.0", + "eslint": "^7.27.0", + "eslint-config-airbnb-typescript": "^12.3.1", + "eslint-plugin-import": "^2.23.4", + "jsdoc-to-markdown": "^5.0.0", + "mocha": "^6.1.4", + "proxyquire": "^2.1.0", + "sinon": "^7.3.2", + "typedoc": "^0.20.36", + "typedoc-github-wiki-theme": "^0.3.0", + "typedoc-plugin-markdown": "^3.9.0", + "typescript": "4.2" + }, + "peerDependencies": { + "@types/express": "^4" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "dependencies": { + "@babel/highlight": "^7.10.4" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.14.5.tgz", + "integrity": "sha512-5lsetuxCLilmVGyiLEfoHBRX8UCFD+1m2x3Rj97WrW3V7H3u4RWRXA4evMjImCsin2J2YT0QaVDGf+z8ondbAg==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.5.tgz", + "integrity": "sha512-qf9u2WFWVV0MppaL877j2dBtQIDgmidgjGk5VIMw3OadXvYaXn66U1BFlH2t4+t3i+8PhedppRv+i40ABzd+gg==", + "dev": true, + "dependencies": { + "@babel/helper-validator-identifier": "^7.14.5", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.14.5.tgz", + "integrity": "sha512-TM8C+xtH/9n1qzX+JNHi7AN2zHMTiPUtspO0ZdHflW8KaskkALhMmuMHb4bCmNdv9VAPzJX3/bXqkVLnAvsPfg==", + "dev": true, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.2.tgz", + "integrity": "sha512-8nmGq/4ycLpIwzvhI4tNDmQztZ8sp+hI7cyG8i1nQDhkAbRzHpXPidRAHlNvCZQpJTKw5ItIpMw9RSToGF00mg==", + "dev": true, + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/@eslint/eslintrc/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/@eslint/eslintrc/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.7.tgz", + "integrity": "sha512-BTIhocbPBSrRmHxOAJFtR18oLhxTtAFDAvL8hY1S3iU8k+E60W/YFs4jrixGzQjMpF4qPXxIQHcjVD9dz1C2QA==", + "dev": true, + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@sinonjs/commons": { + "version": "1.8.3", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", + "integrity": "sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==", + "dev": true, + "dependencies": { + "type-detect": "4.0.8" + } + }, + "node_modules/@sinonjs/formatio": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@sinonjs/formatio/-/formatio-3.2.2.tgz", + "integrity": "sha512-B8SEsgd8gArBLMD6zpRw3juQ2FVSsmdd7qlevyDqzS9WTCtvF55/gAL+h6gue8ZvPYcdiPdvueM/qm//9XzyTQ==", + "dev": true, + "dependencies": { + "@sinonjs/commons": "^1", + "@sinonjs/samsam": "^3.1.0" + } + }, + "node_modules/@sinonjs/samsam": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-3.3.3.tgz", + "integrity": "sha512-bKCMKZvWIjYD0BLGnNrxVuw4dkWCYsLqFOUWw8VgKF/+5Y+mE7LfHWPIYoDXowH+3a9LsWDMo0uAP8YDosPvHQ==", + "dev": true, + "dependencies": { + "@sinonjs/commons": "^1.3.0", + "array-from": "^2.1.1", + "lodash": "^4.17.15" + } + }, + "node_modules/@sinonjs/text-encoding": { + "version": "0.7.1", + "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz", + "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", + "dev": true + }, + "node_modules/@types/body-parser": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", + "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", + "dev": true, + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.34", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", + "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/dotenv": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/@types/dotenv/-/dotenv-8.2.0.tgz", + "integrity": "sha512-ylSC9GhfRH7m1EUXBXofhgx4lUWmFeQDINW5oLuS+gxWdfUeW4zJdeVTYVkexEW+e2VUvlZR2kGnGGipAWR7kw==", + "deprecated": "This is a stub types definition. dotenv provides its own type definitions, so you do not need this installed.", + "dependencies": { + "dotenv": "*" + } + }, + "node_modules/@types/dotenv-flow": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@types/dotenv-flow/-/dotenv-flow-3.1.1.tgz", + "integrity": "sha512-khxgP+KkHPL72SP0Wqn1gB6EHj6yk79OBGJEKW64XL13RbyDGTkRbbA47VICOLRrvgKOpZeun2uMsgO7pAsExQ==", + "dev": true + }, + "node_modules/@types/express": { + "version": "4.17.12", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", + "integrity": "sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==", + "dev": true, + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.18", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.21.tgz", + "integrity": "sha512-gwCiEZqW6f7EoR8TTEfalyEhb1zA5jQJnRngr97+3pzMaO1RKoI1w2bw07TK72renMUVWcWS5mLI6rk1NqN0nA==", + "dev": true, + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*" + } + }, + "node_modules/@types/faker": { + "version": "5.5.6", + "resolved": "https://registry.npmjs.org/@types/faker/-/faker-5.5.6.tgz", + "integrity": "sha512-UCRj0kLg4sXs2XFVm48OU/wIjyJZkpRkwxhRGVQb5l5GmemkeW22WTz9iiDhYPBUqTzDsIWzhFRuF/4DD5+q2Q==" + }, + "node_modules/@types/json-schema": { + "version": "7.0.7", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", + "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", + "dev": true + }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", + "dev": true + }, + "node_modules/@types/jsonwebtoken": { + "version": "8.5.1", + "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", + "integrity": "sha512-rNAPdomlIUX0i0cg2+I+Q1wOUr531zHBQ+cV/28PJ39bSPKjahatZZ2LMuhiguETkCgLVzfruw/ZvNMNkKoSzw==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/lodash": { + "version": "4.14.171", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.171.tgz", + "integrity": "sha512-7eQ2xYLLI/LsicL2nejW9Wyko3lcpN6O/z0ZLHrEQsg280zIdCv1t/0m6UtBjUHokCGBQ3gYTbHzDkZ1xOBwwg==", + "dev": true + }, + "node_modules/@types/lodash.ismatch": { + "version": "4.4.6", + "resolved": "https://registry.npmjs.org/@types/lodash.ismatch/-/lodash.ismatch-4.4.6.tgz", + "integrity": "sha512-Qy6R9c+LOc3M+kBTDgQGAWxzcrXFKznXuIyg8tbw2/Ct3D3lBmQd3yMTD+NjGzIATgUr0v4uWzW3+ALid+LXsQ==", + "dev": true, + "dependencies": { + "@types/lodash": "*" + } + }, + "node_modules/@types/luxon": { + "version": "1.27.0", + "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-1.27.0.tgz", + "integrity": "sha512-rr2lNXsErnA/ARtgFn46NtQjUa66cuwZYeo/2K7oqqxhJErhXgHBPyNKCo+pfOC3L7HFwtao8ebViiU9h4iAxA==", + "dev": true + }, + "node_modules/@types/mime": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", + "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", + "dev": true + }, + "node_modules/@types/node": { + "version": "15.12.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.2.tgz", + "integrity": "sha512-zjQ69G564OCIWIOHSXyQEEDpdpGl+G348RAKY0XXy9Z5kU9Vzv1GMNnkar/ZJ8dzXB3COzD9Mo9NtRZ4xfgUww==" + }, + "node_modules/@types/qs": { + "version": "6.9.6", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", + "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==" + }, + "node_modules/@types/range-parser": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", + "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", + "dev": true + }, + "node_modules/@types/serve-static": { + "version": "1.13.9", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", + "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", + "dev": true, + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.26.1.tgz", + "integrity": "sha512-aoIusj/8CR+xDWmZxARivZjbMBQTT9dImUtdZ8tVCVRXgBUuuZyM5Of5A9D9arQPxbi/0rlJLcuArclz/rCMJw==", + "dev": true, + "dependencies": { + "@typescript-eslint/experimental-utils": "4.26.1", + "@typescript-eslint/scope-manager": "4.26.1", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "lodash": "^4.17.21", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/experimental-utils": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.26.1.tgz", + "integrity": "sha512-sQHBugRhrXzRCs9PaGg6rowie4i8s/iD/DpTB+EXte8OMDfdCG5TvO73XlO9Wc/zi0uyN4qOmX9hIjQEyhnbmQ==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.26.1", + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/typescript-estree": "4.26.1", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "*" + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.26.1.tgz", + "integrity": "sha512-q7F3zSo/nU6YJpPJvQveVlIIzx9/wu75lr6oDbDzoeIRWxpoc/HQ43G4rmMoCc5my/3uSj2VEpg/D83LYZF5HQ==", + "dev": true, + "dependencies": { + "@typescript-eslint/scope-manager": "4.26.1", + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/typescript-estree": "4.26.1", + "debug": "^4.3.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/parser/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/parser/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.26.1.tgz", + "integrity": "sha512-TW1X2p62FQ8Rlne+WEShyd7ac2LA6o27S9i131W4NwDSfyeVlQWhw8ylldNNS8JG6oJB9Ha9Xyc+IUcqipvheQ==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/visitor-keys": "4.26.1" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/types": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.26.1.tgz", + "integrity": "sha512-STyMPxR3cS+LaNvS8yK15rb8Y0iL0tFXq0uyl6gY45glyI7w0CsyqyEXl/Fa0JlQy+pVANeK3sbwPneCbWE7yg==", + "dev": true, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.26.1.tgz", + "integrity": "sha512-l3ZXob+h0NQzz80lBGaykdScYaiEbFqznEs99uwzm8fPHhDjwaBFfQkjUC/slw6Sm7npFL8qrGEAMxcfBsBJUg==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.26.1", + "@typescript-eslint/visitor-keys": "4.26.1", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "4.26.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.26.1.tgz", + "integrity": "sha512-IGouNSSd+6x/fHtYRyLOM6/C+QxMDzWlDtN41ea+flWuSF9g02iqcIlX8wM53JkfljoIjP0U+yp7SiTS1onEkw==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.26.1", + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.1.tgz", + "integrity": "sha512-K0Ptm/47OKfQRpNQ2J/oIN/3QYiK6FwW+eJbILhsdxh2WTLdl+30o8aGdTbm5JbffpFFAg/g+zi1E+jvJha5ng==", + "dev": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-escape-sequences": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-escape-sequences/-/ansi-escape-sequences-4.1.0.tgz", + "integrity": "sha512-dzW9kHxH011uBsidTXd14JXgzye/YLb2LzeKZ4bsgl/Knwx8AtbSFkkGxagdNOoh0DlqHCmfiEjWKBaqjOanVw==", + "dev": true, + "dependencies": { + "array-back": "^3.0.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/ansi-escape-sequences/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/array-back": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-4.0.2.tgz", + "integrity": "sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/array-from": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/array-from/-/array-from-2.1.1.tgz", + "integrity": "sha1-z+nYwmYoudxa7MYqn12PHzUsEZU=", + "dev": true + }, + "node_modules/array-includes": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.3.tgz", + "integrity": "sha512-gcem1KlBU7c9rB+Rq8/3PPKsK2kjqeEBa3bD5kkQo4nYlOHQCJqIJFqBXDEfwaRuYTT4E+FxA9xez7Gf/e3Q7A==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.2", + "get-intrinsic": "^1.1.1", + "is-string": "^1.0.5" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.4.tgz", + "integrity": "sha512-4470Xi3GAPAjZqFcljX2xzckv1qeKPizoNkiS0+O4IoPR2ZNpcjE0pkhdihlDouK+x6QOast26B4Q/O9DJnwSg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/assertion-error": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", + "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/at-least-node": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", + "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/axios": { + "version": "0.21.1", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz", + "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==", + "dependencies": { + "follow-redirects": "^1.10.0" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/bluebird": { + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", + "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", + "dev": true + }, + "node_modules/body-parser": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz", + "integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==", + "dependencies": { + "bytes": "3.1.0", + "content-type": "~1.0.4", + "debug": "2.6.9", + "depd": "~1.1.2", + "http-errors": "1.7.2", + "iconv-lite": "0.4.24", + "on-finished": "~2.3.0", + "qs": "6.7.0", + "raw-body": "2.4.0", + "type-is": "~1.6.17" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/body-parser/node_modules/qs": { + "version": "6.7.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", + "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "dependencies": { + "fill-range": "^7.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browser-stdout": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", + "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", + "dev": true + }, + "node_modules/buffer-equal-constant-time": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", + "integrity": "sha1-+OcRMvf/5uAaXJaXpMbz5I1cyBk=" + }, + "node_modules/buffer-from": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", + "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==" + }, + "node_modules/bytes": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", + "integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/cache-point": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-1.0.0.tgz", + "integrity": "sha512-ZqrZp9Hi5Uq7vfSGmNP2bUT/9DzZC2Y/GXjHB8rUJN1a+KLmbV05+vxHipNsg8+CSVgjcVVzLV8VZms6w8ZeRw==", + "dev": true, + "dependencies": { + "array-back": "^4.0.0", + "fs-then-native": "^2.0.0", + "mkdirp2": "^1.0.4" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dependencies": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/catharsis": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", + "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", + "dev": true, + "dependencies": { + "lodash": "^4.17.15" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/chai": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.4.tgz", + "integrity": "sha512-yS5H68VYOCtN1cjfwumDSuzn/9c+yza4f3reKXlE5rUg7SFcCEy90gJvydNgOYtblyf4Zi6jIWRnXOgErta0KA==", + "dev": true, + "dependencies": { + "assertion-error": "^1.1.0", + "check-error": "^1.0.2", + "deep-eql": "^3.0.1", + "get-func-name": "^2.0.0", + "pathval": "^1.1.1", + "type-detect": "^4.0.5" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/chalk": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", + "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/chalk/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/chalk/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/chalk/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/chalk/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/chalk/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/check-error": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", + "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/cliui": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", + "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", + "dev": true, + "dependencies": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "node_modules/cliui/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/cliui/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/cliui/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/cliui/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/cliui/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/collect-all": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.4.tgz", + "integrity": "sha512-RKZhRwJtJEP5FWul+gkSMEnaK6H3AGPTTWOiRimCcs+rc/OmQE3Yhy1Q7A7KsdkG3ZXVdZq68Y6ONSdvkeEcKA==", + "dev": true, + "dependencies": { + "stream-connect": "^1.0.2", + "stream-via": "^1.0.4" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/command-line-args": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.1.1.tgz", + "integrity": "sha512-hL/eG8lrll1Qy1ezvkant+trihbGnaKaeEjj6Scyr3DN+RC7iQ5Rz84IeLERfAWDGo0HBSNAakczwgCilDXnWg==", + "dev": true, + "dependencies": { + "array-back": "^3.0.1", + "find-replace": "^3.0.0", + "lodash.camelcase": "^4.3.0", + "typical": "^4.0.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-args/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/command-line-args/node_modules/typical": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/typical/-/typical-4.0.0.tgz", + "integrity": "sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/command-line-tool": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/command-line-tool/-/command-line-tool-0.8.0.tgz", + "integrity": "sha512-Xw18HVx/QzQV3Sc5k1vy3kgtOeGmsKIqwtFFoyjI4bbcpSgnw2CWVULvtakyw4s6fhyAdI6soQQhXc2OzJy62g==", + "dev": true, + "dependencies": { + "ansi-escape-sequences": "^4.0.0", + "array-back": "^2.0.0", + "command-line-args": "^5.0.0", + "command-line-usage": "^4.1.0", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-tool/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/command-line-usage": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-4.1.0.tgz", + "integrity": "sha512-MxS8Ad995KpdAC0Jopo/ovGIroV/m0KHwzKfXxKag6FHOkGsH8/lv5yjgablcRxCJJC0oJeUMuO/gmaq+Wq46g==", + "dev": true, + "dependencies": { + "ansi-escape-sequences": "^4.0.0", + "array-back": "^2.0.0", + "table-layout": "^0.4.2", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-usage/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/common-sequence": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-2.0.2.tgz", + "integrity": "sha512-jAg09gkdkrDO9EWTdXfv80WWH3yeZl5oT69fGfedBNS9pXUKYInVJ1bJ+/ht2+Moeei48TmSbQDYMc8EOx9G0g==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "node_modules/config-master": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/config-master/-/config-master-3.1.0.tgz", + "integrity": "sha1-ZnZjWQUFooO/JqSE1oSJ10xUhdo=", + "dev": true, + "dependencies": { + "walk-back": "^2.0.1" + } + }, + "node_modules/config-master/node_modules/walk-back": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz", + "integrity": "sha1-VU4qnYdPrEeoywBr9EwvDEmYoKQ=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/confusing-browser-globals": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", + "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", + "dev": true + }, + "node_modules/content-type": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", + "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/dataloader": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-2.0.0.tgz", + "integrity": "sha512-YzhyDAwA4TaQIhM5go+vCLmU0UikghC/t9DTQYZR2M/UvZ1MdOhPezSDZcjj9uqQJOMqjLcpWtyW2iNINdlatQ==" + }, + "node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/decamelize": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", + "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/deep-eql": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-3.0.1.tgz", + "integrity": "sha512-+QeIQyN5ZuO+3Uk5DYh6/1eKO0m0YmJFGNmFHGACpf1ClL1nmlV/p4gNgbl2pJGxgXb4faqo6UE+M5ACEMyVcw==", + "dev": true, + "dependencies": { + "type-detect": "^4.0.0" + }, + "engines": { + "node": ">=0.12" + } + }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/deep-is": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", + "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", + "dev": true + }, + "node_modules/define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "dependencies": { + "object-keys": "^1.0.12" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/depd": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", + "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/diff": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", + "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/dmd": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/dmd/-/dmd-4.0.6.tgz", + "integrity": "sha512-7ZYAnFQ6jGm4SICArwqNPylJ83PaOdPTAkds3Z/s1ueFqSc5ilJ2F0b7uP+35W1PUbemH++gn5/VlC3KwEgiHQ==", + "dev": true, + "dependencies": { + "array-back": "^4.0.1", + "cache-point": "^1.0.0", + "common-sequence": "^2.0.0", + "file-set": "^3.0.0", + "handlebars": "^4.5.3", + "marked": "^0.7.0", + "object-get": "^2.1.0", + "reduce-flatten": "^3.0.0", + "reduce-unique": "^2.0.1", + "reduce-without": "^1.0.1", + "test-value": "^3.0.0", + "walk-back": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/dmd/node_modules/reduce-flatten": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-3.0.1.tgz", + "integrity": "sha512-bYo+97BmUUOzg09XwfkwALt4PQH1M5L0wzKerBt6WLm3Fhdd43mMS89HiT1B9pJIqko/6lWx3OnV4J9f2Kqp5Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/dotenv": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz", + "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==", + "engines": { + "node": ">=10" + } + }, + "node_modules/dotenv-flow": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/dotenv-flow/-/dotenv-flow-3.2.0.tgz", + "integrity": "sha512-GEB6RrR4AbqDJvNSFrYHqZ33IKKbzkvLYiD5eo4+9aFXr4Y4G+QaFrB/fNp0y6McWBmvaPn3ZNjIufnj8irCtg==", + "dependencies": { + "dotenv": "^8.0.0" + }, + "engines": { + "node": ">= 8.0.0" + } + }, + "node_modules/dotenv-flow/node_modules/dotenv": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", + "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==", + "engines": { + "node": ">=10" + } + }, + "node_modules/ecdsa-sig-formatter": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", + "integrity": "sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==", + "dependencies": { + "safe-buffer": "^5.0.1" + } + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "node_modules/enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "dependencies": { + "ansi-colors": "^4.1.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/entities": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", + "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", + "dev": true + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.28.0.tgz", + "integrity": "sha512-UMfH0VSjP0G4p3EWirscJEQ/cHqnT/iuH6oNZOB94nBjWbMnhGEPxsZm1eyIW0C/9jLI0Fow4W5DXLjEI7mn1g==", + "dev": true, + "dependencies": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.2", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-config-airbnb": { + "version": "18.2.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb/-/eslint-config-airbnb-18.2.1.tgz", + "integrity": "sha512-glZNDEZ36VdlZWoxn/bUR1r/sdFKPd1mHPbqUtkctgNG4yT2DLLtJ3D+yCV+jzZCc2V1nBVkmdknOJBZ5Hc0fg==", + "dev": true, + "dependencies": { + "eslint-config-airbnb-base": "^14.2.1", + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", + "eslint-plugin-import": "^2.22.1", + "eslint-plugin-jsx-a11y": "^6.4.1", + "eslint-plugin-react": "^7.21.5", + "eslint-plugin-react-hooks": "^4 || ^3 || ^2.3.0 || ^1.7.0" + } + }, + "node_modules/eslint-config-airbnb-base": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", + "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", + "dev": true, + "dependencies": { + "confusing-browser-globals": "^1.0.10", + "object.assign": "^4.1.2", + "object.entries": "^1.1.2" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", + "eslint-plugin-import": "^2.22.1" + } + }, + "node_modules/eslint-config-airbnb-typescript": { + "version": "12.3.1", + "resolved": "https://registry.npmjs.org/eslint-config-airbnb-typescript/-/eslint-config-airbnb-typescript-12.3.1.tgz", + "integrity": "sha512-ql/Pe6/hppYuRp4m3iPaHJqkBB7dgeEmGPQ6X0UNmrQOfTF+dXw29/ZjU2kQ6RDoLxaxOA+Xqv07Vbef6oVTWw==", + "dev": true, + "dependencies": { + "@typescript-eslint/parser": "^4.4.1", + "eslint-config-airbnb": "^18.2.0", + "eslint-config-airbnb-base": "^14.2.0" + } + }, + "node_modules/eslint-import-resolver-node": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.4.tgz", + "integrity": "sha512-ogtf+5AB/O+nM6DIeBUNr2fuT7ot9Qg/1harBfBtaP13ekEWFQEEMP94BCB7zaNW3gyY+8SHYF00rnqYwXKWOA==", + "dev": true, + "dependencies": { + "debug": "^2.6.9", + "resolve": "^1.13.1" + } + }, + "node_modules/eslint-module-utils": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.6.1.tgz", + "integrity": "sha512-ZXI9B8cxAJIH4nfkhTwcRTEAnrVfobYqwjWy/QMCZ8rHkZHFjf9yO4BzpiF9kCSfNlMG54eKigISHpX0+AaT4A==", + "dev": true, + "dependencies": { + "debug": "^3.2.7", + "pkg-dir": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-module-utils/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true + }, + "node_modules/eslint-plugin-import": { + "version": "2.23.4", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.23.4.tgz", + "integrity": "sha512-6/wP8zZRsnQFiR3iaPFgh5ImVRM1WN5NUWfTIRqwOdeiGJlBcSk82o1FEVq8yXmy4lkIzTo7YhHCIxlU/2HyEQ==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.3", + "array.prototype.flat": "^1.2.4", + "debug": "^2.6.9", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.4", + "eslint-module-utils": "^2.6.1", + "find-up": "^2.0.0", + "has": "^1.0.3", + "is-core-module": "^2.4.0", + "minimatch": "^3.0.4", + "object.values": "^1.1.3", + "pkg-up": "^2.0.0", + "read-pkg-up": "^3.0.0", + "resolve": "^1.20.0", + "tsconfig-paths": "^3.9.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/eslint/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint/node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/eslint/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/eslint/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "dependencies": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/espree/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esquery/node_modules/estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/factory.ts": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/factory.ts/-/factory.ts-0.5.2.tgz", + "integrity": "sha512-I4YDKuyMW+s2PocnWh/Ekv9wSStt/MNN1ZRb1qhy0Kv056ndlzbLHDsW9KEmTAqMpLI3BtjSqEdZ7ZfdnaXn9w==", + "dependencies": { + "clone-deep": "^4.0.1", + "source-map-support": "^0.5.19" + }, + "engines": { + "node": ">= 14" + } + }, + "node_modules/faker": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/faker/-/faker-5.5.3.tgz", + "integrity": "sha512-wLTv2a28wjUyWkbnX7u/ABZBkUkIF2fCd73V6P2oFqEGEktDfzWx4UxrSqtPRw0xPRAcjeAOIiJWqZm3pP4u3g==" + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true + }, + "node_modules/fast-glob": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.5.tgz", + "integrity": "sha512-2DtFcgT68wiTTiwZ2hNdJfcHNke9XOfnwmBRWXhmeKM8rF0TGwmC/Qto3S7RoZKp5cilZbxzO5iTNTQsJ+EeDg==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.0", + "merge2": "^1.3.0", + "micromatch": "^4.0.2", + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true + }, + "node_modules/fastq": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.11.0.tgz", + "integrity": "sha512-7Eczs8gIPDrVzT+EksYBcupqMyxSHXXrHOLRRxU2/DicV8789MRBRR8+Hc2uWzUupOs4YS4JzBmBxjjCVBxD/g==", + "dev": true, + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/file-set": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/file-set/-/file-set-3.0.0.tgz", + "integrity": "sha512-B/SdeSIeRv7VlOgIjtH3dkxMI+tEy5m+OeCXfAUsirBoVoY+bGtsmvmmTFPm/G23TBY4RiTtjpcgePCfwXRjqA==", + "dev": true, + "dependencies": { + "array-back": "^4.0.0", + "glob": "^7.1.5" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/fill-keys": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/fill-keys/-/fill-keys-1.0.2.tgz", + "integrity": "sha1-mo+jb06K1jTjv2tPPIiCVRRS6yA=", + "dev": true, + "dependencies": { + "is-object": "~1.0.1", + "merge-descriptors": "~1.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-replace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-3.0.0.tgz", + "integrity": "sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ==", + "dev": true, + "dependencies": { + "array-back": "^3.0.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/find-replace/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/find-up": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", + "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", + "dev": true, + "dependencies": { + "locate-path": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/flat": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.1.tgz", + "integrity": "sha512-FmTtBsHskrU6FJ2VxCnsDb84wu9zhmO3cUX2kGFb5tuwhfXxGciiT0oRY+cck35QmG+NmGh5eLz6lLCpWTqwpA==", + "dev": true, + "dependencies": { + "is-buffer": "~2.0.3" + }, + "bin": { + "flat": "cli.js" + } + }, + "node_modules/flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "dependencies": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flatted": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.1.1.tgz", + "integrity": "sha512-zAoAQiudy+r5SvnSw3KJy5os/oRJYHzrzja/tBDqrZtNhUw8bt6y8OBzMWcjWr+8liV8Eb6yOhw8WZ7VFZ5ZzA==", + "dev": true + }, + "node_modules/follow-redirects": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.1.tgz", + "integrity": "sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/fs-extra": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", + "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "dev": true, + "dependencies": { + "at-least-node": "^1.0.0", + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/fs-then-native": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fs-then-native/-/fs-then-native-2.0.0.tgz", + "integrity": "sha1-GaEk2U2QwiyOBF8ujdbr6jbUjGc=", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "node_modules/function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" + }, + "node_modules/functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-func-name": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", + "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "dependencies": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/glob": { + "version": "7.1.7", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.7.tgz", + "integrity": "sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/globals": { + "version": "13.9.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.9.0.tgz", + "integrity": "sha512-74/FduwI/JaIrr1H8e71UbDE+5x7pIPs1C2rrwC52SszOo043CsWOZEMW7o2Y58xwm9b+0RBKDxY5n2sUpEFxA==", + "dev": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globby": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", + "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==", + "dev": true, + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.1.1", + "ignore": "^5.1.4", + "merge2": "^1.3.0", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.6", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.6.tgz", + "integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ==", + "dev": true + }, + "node_modules/growl": { + "version": "1.10.5", + "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", + "integrity": "sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==", + "dev": true, + "engines": { + "node": ">=4.x" + } + }, + "node_modules/handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "dependencies": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "wordwrap": "^1.0.0" + }, + "bin": { + "handlebars": "bin/handlebars" + }, + "engines": { + "node": ">=0.4.7" + }, + "optionalDependencies": { + "uglify-js": "^3.1.4" + } + }, + "node_modules/has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/he": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", + "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", + "dev": true, + "bin": { + "he": "bin/he" + } + }, + "node_modules/hosted-git-info": { + "version": "2.8.9", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", + "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", + "dev": true + }, + "node_modules/http-errors": { + "version": "1.7.2", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.7.2.tgz", + "integrity": "sha512-uUQBt3H/cSIVfch6i1EuPNy/YsRSOUBXTVfZ+yR7Zjez3qjBz6i9+i4zjNaoqcoFVI4lQJ5plg63TvGfRSDCRg==", + "dependencies": { + "depd": "~1.1.2", + "inherits": "2.0.3", + "setprototypeof": "1.1.1", + "statuses": ">= 1.5.0 < 2", + "toidentifier": "1.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/ignore": { + "version": "5.1.8", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", + "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", + "dev": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" + }, + "node_modules/interpret": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", + "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "node_modules/is-bigint": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", + "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", + "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-buffer": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz", + "integrity": "sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "engines": { + "node": ">=4" + } + }, + "node_modules/is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-core-module": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.4.0.tgz", + "integrity": "sha512-6A2fkfq1rfeQZjxrZJGerpLCTHRNEBiSgnu0+obeJpEPZRUooHgsizvzv0ZjJwOz3iWIHdJtVWJ/tmPr3D21/A==", + "dev": true, + "dependencies": { + "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.4.tgz", + "integrity": "sha512-/b4ZVsG7Z5XVtIxs/h9W8nvfLgSAyKYdtGWQLbqy6jA1icmgjf8WCoTKgeS4wy5tYaPePouzFMANbnj94c2Z+A==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", + "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", + "dev": true, + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-negative-zero": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.1.tgz", + "integrity": "sha512-2z6JzQvZRa9A2Y7xC6dQQm4FSTSTNWjKIYYTt4246eMTJmIo0Q+ZyOsU66X8lxK1AbB92dFeglPLrhwpeRKO6w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-number-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", + "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-object": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.2.tgz", + "integrity": "sha512-2rRIahhZr2UWb45fIOuvZGpFtz0TyOZLf32KxBbSoUCeZR495zCKlWUKKUByk3geS2eAs7ZAABt0Y/Rx0GiQGA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "dependencies": { + "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", + "integrity": "sha512-2gdzbKUuqtQ3lYNrUTQYoClPhm7oQu4UdpSZMp1/DGgkHBT8E2Z1l0yMdb6D4zNAxwDiMv8MdulKROJGNl0Q0w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", + "dev": true + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true + }, + "node_modules/isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/js2xmlparser": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz", + "integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==", + "dev": true, + "dependencies": { + "xmlcreate": "^2.0.3" + } + }, + "node_modules/jsdoc": { + "version": "3.6.7", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.7.tgz", + "integrity": "sha512-sxKt7h0vzCd+3Y81Ey2qinupL6DpRSZJclS04ugHDNmRUXGzqicMJ6iwayhSA0S0DwwX30c5ozyUthr1QKF6uw==", + "dev": true, + "dependencies": { + "@babel/parser": "^7.9.4", + "bluebird": "^3.7.2", + "catharsis": "^0.9.0", + "escape-string-regexp": "^2.0.0", + "js2xmlparser": "^4.0.1", + "klaw": "^3.0.0", + "markdown-it": "^10.0.0", + "markdown-it-anchor": "^5.2.7", + "marked": "^2.0.3", + "mkdirp": "^1.0.4", + "requizzle": "^0.2.3", + "strip-json-comments": "^3.1.0", + "taffydb": "2.6.2", + "underscore": "~1.13.1" + }, + "bin": { + "jsdoc": "jsdoc.js" + }, + "engines": { + "node": ">=8.15.0" + } + }, + "node_modules/jsdoc-api": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-5.0.4.tgz", + "integrity": "sha512-1KMwLnfo0FyhF06TQKzqIm8BiY1yoMIGICxRdJHUjzskaHMzHMmpLlmNFgzoa4pAC8t1CDPK5jWuQTvv1pBsEQ==", + "dev": true, + "dependencies": { + "array-back": "^4.0.0", + "cache-point": "^1.0.0", + "collect-all": "^1.0.3", + "file-set": "^2.0.1", + "fs-then-native": "^2.0.0", + "jsdoc": "^3.6.3", + "object-to-spawn-args": "^1.1.1", + "temp-path": "^1.0.0", + "walk-back": "^3.0.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/jsdoc-api/node_modules/file-set": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz", + "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==", + "dev": true, + "dependencies": { + "array-back": "^2.0.0", + "glob": "^7.1.3" + } + }, + "node_modules/jsdoc-api/node_modules/file-set/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/jsdoc-api/node_modules/walk-back": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.1.tgz", + "integrity": "sha512-umiNB2qLO731Sxbp6cfZ9pwURJzTnftxE4Gc7hq8n/ehkuXC//s9F65IEIJA2ZytQZ1ZOsm/Fju4IWx0bivkUQ==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/jsdoc-parse": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-4.0.1.tgz", + "integrity": "sha512-qIObw8yqYZjrP2qxWROB5eLQFLTUX2jRGLhW9hjo2CC2fQVlskidCIzjCoctwsDvauBp2a/lR31jkSleczSo8Q==", + "dev": true, + "dependencies": { + "array-back": "^4.0.0", + "lodash.omit": "^4.5.0", + "lodash.pick": "^4.4.0", + "reduce-extract": "^1.0.0", + "sort-array": "^2.0.0", + "test-value": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/jsdoc-to-markdown": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-5.0.3.tgz", + "integrity": "sha512-tQv5tBV0fTYidRQtE60lJKxE98mmuLcYuITFDKQiDPE9hGccpeEGUNFcVkInq1vigyuPnZmt79bQ8wv2GKjY0Q==", + "dev": true, + "dependencies": { + "array-back": "^4.0.1", + "command-line-tool": "^0.8.0", + "config-master": "^3.1.0", + "dmd": "^4.0.5", + "jsdoc-api": "^5.0.4", + "jsdoc-parse": "^4.0.1", + "walk-back": "^4.0.0" + }, + "bin": { + "jsdoc2md": "bin/cli.js" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/jsdoc/node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/jsdoc/node_modules/marked": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", + "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">= 8.16.2" + } + }, + "node_modules/json-parse-better-errors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", + "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", + "dev": true + }, + "node_modules/json5": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", + "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "dev": true, + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsonwebtoken": { + "version": "8.5.1", + "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", + "integrity": "sha512-XjwVfRS6jTMsqYs0EsuJ4LGxXV14zQybNd4L2r0UvbVnSF9Af8x7p5MzbJ90Ioz/9TI41/hTCvznF/loiSzn8w==", + "dependencies": { + "jws": "^3.2.2", + "lodash.includes": "^4.3.0", + "lodash.isboolean": "^3.0.3", + "lodash.isinteger": "^4.0.4", + "lodash.isnumber": "^3.0.3", + "lodash.isplainobject": "^4.0.6", + "lodash.isstring": "^4.0.1", + "lodash.once": "^4.0.0", + "ms": "^2.1.1", + "semver": "^5.6.0" + }, + "engines": { + "node": ">=4", + "npm": ">=1.4.28" + } + }, + "node_modules/jsonwebtoken/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + }, + "node_modules/just-extend": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", + "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", + "dev": true + }, + "node_modules/jwa": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.4.1.tgz", + "integrity": "sha512-qiLX/xhEEFKUAJ6FiBMbes3w9ATzyk5W7Hvzpa/SLYdxNtng+gcurvrI7TbACjIXlsJyr05/S1oUhZrc63evQA==", + "dependencies": { + "buffer-equal-constant-time": "1.0.1", + "ecdsa-sig-formatter": "1.0.11", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/jws": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/jws/-/jws-3.2.2.tgz", + "integrity": "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA==", + "dependencies": { + "jwa": "^1.4.1", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/klaw": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", + "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.9" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/linkify-it": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz", + "integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==", + "dev": true, + "dependencies": { + "uc.micro": "^1.0.1" + } + }, + "node_modules/load-json-file": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", + "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "parse-json": "^4.0.0", + "pify": "^3.0.0", + "strip-bom": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/locate-path": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", + "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", + "dev": true, + "dependencies": { + "p-locate": "^2.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "node_modules/lodash.camelcase": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", + "integrity": "sha1-soqmKIorn8ZRA1x3EfZathkDMaY=", + "dev": true + }, + "node_modules/lodash.clonedeep": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", + "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", + "dev": true + }, + "node_modules/lodash.includes": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", + "integrity": "sha1-YLuYqHy5I8aMoeUTJUgzFISfVT8=" + }, + "node_modules/lodash.isboolean": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/lodash.isboolean/-/lodash.isboolean-3.0.3.tgz", + "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=" + }, + "node_modules/lodash.isinteger": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", + "integrity": "sha1-YZwK89A/iwTDH1iChAt3sRzWg0M=" + }, + "node_modules/lodash.ismatch": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz", + "integrity": "sha1-dWy1FQyjum8RCFp4hJZF8Yj4Xzc=" + }, + "node_modules/lodash.isnumber": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/lodash.isnumber/-/lodash.isnumber-3.0.3.tgz", + "integrity": "sha1-POdoEMWSjQM1IwGsKHMX8RwLH/w=" + }, + "node_modules/lodash.isplainobject": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/lodash.isplainobject/-/lodash.isplainobject-4.0.6.tgz", + "integrity": "sha1-fFJqUtibRcRcxpC4gWO+BJf1UMs=" + }, + "node_modules/lodash.isstring": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/lodash.isstring/-/lodash.isstring-4.0.1.tgz", + "integrity": "sha1-1SfftUVuynzJu5XV2ur4i6VKVFE=" + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "node_modules/lodash.omit": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz", + "integrity": "sha1-brGa5aHuHdnfC5aeZs4Lf6MLXmA=", + "dev": true + }, + "node_modules/lodash.once": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz", + "integrity": "sha1-DdOXEhPHxW34gJd9UEyI+0cal6w=" + }, + "node_modules/lodash.padend": { + "version": "4.6.1", + "resolved": "https://registry.npmjs.org/lodash.padend/-/lodash.padend-4.6.1.tgz", + "integrity": "sha1-U8y6BH0G4VjTEfRdpiX05J5vFm4=", + "dev": true + }, + "node_modules/lodash.pick": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz", + "integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=", + "dev": true + }, + "node_modules/lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true + }, + "node_modules/log-symbols": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", + "integrity": "sha512-VeIAFslyIerEJLXHziedo2basKbMKtTw3vfn5IzG0XTjhAVEJyNHnL2p7vc+wBDSdQuUpNw3M2u6xb9QsAY5Eg==", + "dev": true, + "dependencies": { + "chalk": "^2.0.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/log-symbols/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/log-symbols/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/lolex": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/lolex/-/lolex-4.2.0.tgz", + "integrity": "sha512-gKO5uExCXvSm6zbF562EvM+rd1kQDnB9AZBbiQVzf1ZmdDpxUSvpnAaVOP83N/31mRK8Ml8/VE8DMvsAZQ+7wg==", + "dev": true + }, + "node_modules/lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "node_modules/luxon": { + "version": "1.27.0", + "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.27.0.tgz", + "integrity": "sha512-VKsFsPggTA0DvnxtJdiExAucKdAnwbCCNlMM5ENvHlxubqWd0xhZcdb4XgZ7QFNhaRhilXCFxHuoObP5BNA4PA==", + "engines": { + "node": "*" + } + }, + "node_modules/markdown-it": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", + "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "entities": "~2.0.0", + "linkify-it": "^2.0.0", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + }, + "bin": { + "markdown-it": "bin/markdown-it.js" + } + }, + "node_modules/markdown-it-anchor": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", + "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", + "dev": true, + "peerDependencies": { + "markdown-it": "*" + } + }, + "node_modules/marked": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", + "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", + "dev": true + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", + "integrity": "sha1-sAqqVW3YtEVoFQ7J0blT8/kMu2E=", + "dev": true + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dev": true, + "dependencies": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime-db": { + "version": "1.48.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.48.0.tgz", + "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.31", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.31.tgz", + "integrity": "sha512-XGZnNzm3QvgKxa8dpzyhFTHmpP3l5YNusmne07VUOXxou9CqUqYa/HBy124RqtVh/O2pECas/MOcsDgpilPOPg==", + "dependencies": { + "mime-db": "1.48.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/mkdirp2": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp2/-/mkdirp2-1.0.4.tgz", + "integrity": "sha512-Q2PKB4ZR4UPtjLl76JfzlgSCUZhSV1AXQgAZa1qt5RiaALFjP/CDrGvFBrOz7Ck6McPcwMAxTsJvWOUjOU8XMw==", + "dev": true + }, + "node_modules/mocha": { + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.3.tgz", + "integrity": "sha512-0R/3FvjIGH3eEuG17ccFPk117XL2rWxatr81a57D+r/x2uTYZRbdZ4oVidEUMh2W2TJDa7MdAb12Lm2/qrKajg==", + "dev": true, + "dependencies": { + "ansi-colors": "3.2.3", + "browser-stdout": "1.3.1", + "debug": "3.2.6", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "find-up": "3.0.0", + "glob": "7.1.3", + "growl": "1.10.5", + "he": "1.2.0", + "js-yaml": "3.13.1", + "log-symbols": "2.2.0", + "minimatch": "3.0.4", + "mkdirp": "0.5.4", + "ms": "2.1.1", + "node-environment-flags": "1.0.5", + "object.assign": "4.1.0", + "strip-json-comments": "2.0.1", + "supports-color": "6.0.0", + "which": "1.3.1", + "wide-align": "1.1.3", + "yargs": "13.3.2", + "yargs-parser": "13.1.2", + "yargs-unparser": "1.6.0" + }, + "bin": { + "_mocha": "bin/_mocha", + "mocha": "bin/mocha" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/mocha/node_modules/ansi-colors": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", + "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/debug": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", + "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", + "deprecated": "Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/mocha/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/mocha/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + } + }, + "node_modules/mocha/node_modules/js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/mocha/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/mkdirp": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.4.tgz", + "integrity": "sha512-iG9AK/dJLtJ0XNgTuDbSyNS3zECqDlAhnQW4CsNxBG3LQJBbHmRX1egw39DmtOdCAqY+dKXV+sgPgilNWUKMVw==", + "deprecated": "Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)", + "dev": true, + "dependencies": { + "minimist": "^1.2.5" + }, + "bin": { + "mkdirp": "bin/cmd.js" + } + }, + "node_modules/mocha/node_modules/ms": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", + "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", + "dev": true + }, + "node_modules/mocha/node_modules/object.assign": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", + "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/mocha/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mocha/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/mocha/node_modules/supports-color": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", + "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "which": "bin/which" + } + }, + "node_modules/module-not-found-error": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/module-not-found-error/-/module-not-found-error-1.0.1.tgz", + "integrity": "sha1-z4tP9PKWQGdNbN0CsOO8UjwrvcA=", + "dev": true + }, + "node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", + "dev": true + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "dev": true + }, + "node_modules/nise": { + "version": "1.5.3", + "resolved": "https://registry.npmjs.org/nise/-/nise-1.5.3.tgz", + "integrity": "sha512-Ymbac/94xeIrMf59REBPOv0thr+CJVFMhrlAkW/gjCIE58BGQdCj0x7KRCb3yz+Ga2Rz3E9XXSvUyyxqqhjQAQ==", + "dev": true, + "dependencies": { + "@sinonjs/formatio": "^3.2.1", + "@sinonjs/text-encoding": "^0.7.1", + "just-extend": "^4.0.2", + "lolex": "^5.0.1", + "path-to-regexp": "^1.7.0" + } + }, + "node_modules/nise/node_modules/lolex": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/lolex/-/lolex-5.1.2.tgz", + "integrity": "sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A==", + "dev": true, + "dependencies": { + "@sinonjs/commons": "^1.7.0" + } + }, + "node_modules/node-environment-flags": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz", + "integrity": "sha512-VNYPRfGfmZLx0Ye20jWzHUjyTW/c+6Wq+iLhDzUI4XmhrDd9l/FozXV3F2xOaXjvp0co0+v1YSR3CMP6g+VvLQ==", + "dev": true, + "dependencies": { + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" + } + }, + "node_modules/normalize-package-data": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", + "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", + "dev": true, + "dependencies": { + "hosted-git-info": "^2.1.4", + "resolve": "^1.10.0", + "semver": "2 || 3 || 4 || 5", + "validate-npm-package-license": "^3.0.1" + } + }, + "node_modules/object-get": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.1.tgz", + "integrity": "sha512-7n4IpLMzGGcLEMiQKsNR7vCe+N5E9LORFrtNUVy4sO3dj9a3HedZCxEL2T7QuLhcHN1NBuBsMOKaOsAYI9IIvg==", + "dev": true + }, + "node_modules/object-inspect": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.10.3.tgz", + "integrity": "sha512-e5mCJlSH7poANfC8z8S9s9S2IN5/4Zb3aZ33f5s8YqoazCFzNLloLU8r5VCG+G7WoqLvAAZoVMcy3tp/3X0Plw==", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object-to-spawn-args": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-to-spawn-args/-/object-to-spawn-args-1.1.1.tgz", + "integrity": "sha1-d9qIJ/Bz0BHJ4bFz+JV4FHAkZ4U=", + "dev": true + }, + "node_modules/object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.entries": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", + "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.getownpropertydescriptors": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.2.tgz", + "integrity": "sha512-WtxeKSzfBjlzL+F9b7M7hewDzMwy+C8NRssHd1YrNlzHzIDrXcXiNOMrezdAEM4UXixgV+vvnyBeN7Rygl2ttQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.2" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.values": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.4.tgz", + "integrity": "sha512-TnGo7j4XSnKQoK3MfvkzqKCi0nVe/D9I9IjwTNYdb/fxYHpjrluHVOgw0AF6jrRFGMPHdfuidR09tIDiIvnaSg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/on-finished": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", + "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "dependencies": { + "lru-cache": "^5.1.1" + } + }, + "node_modules/onigasm/node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/onigasm/node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + }, + "node_modules/optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/p-limit": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", + "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", + "dev": true, + "dependencies": { + "p-try": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/p-locate": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", + "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", + "dev": true, + "dependencies": { + "p-limit": "^1.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/p-try": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", + "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", + "dev": true, + "dependencies": { + "error-ex": "^1.3.1", + "json-parse-better-errors": "^1.0.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, + "node_modules/path-to-regexp": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", + "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", + "dev": true, + "dependencies": { + "isarray": "0.0.1" + } + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/pathval": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", + "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/picomatch": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", + "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", + "dev": true, + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pify": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", + "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/pkg-dir": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-2.0.0.tgz", + "integrity": "sha1-9tXREJ4Z1j7fQo4L1X4Sd3YVM0s=", + "dev": true, + "dependencies": { + "find-up": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/pkg-up": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/pkg-up/-/pkg-up-2.0.0.tgz", + "integrity": "sha1-yBmscoBZpGHKscOImivjxJoATX8=", + "dev": true, + "dependencies": { + "find-up": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/proxyquire": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/proxyquire/-/proxyquire-2.1.3.tgz", + "integrity": "sha512-BQWfCqYM+QINd+yawJz23tbBM40VIGXOdDw3X344KcclI/gtBbdWF6SlQ4nK/bYhF9d27KYug9WzljHC6B9Ysg==", + "dev": true, + "dependencies": { + "fill-keys": "^1.0.2", + "module-not-found-error": "^1.0.1", + "resolve": "^1.11.1" + } + }, + "node_modules/punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/qs": { + "version": "6.10.1", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.10.1.tgz", + "integrity": "sha512-M528Hph6wsSVOBiYUnGf+K/7w0hNshs/duGsNXPUCLH5XAqjEtiPGwNONLV0tBH8NoGb0mvD5JubnUTrujKDTg==", + "dependencies": { + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/raw-body": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.4.0.tgz", + "integrity": "sha512-4Oz8DUIwdvoa5qMJelxipzi/iJIi40O5cGV1wNYp5hvZP8ZN0T+jiNkL0QepXs+EsQ9XJ8ipEDoiH70ySUJP3Q==", + "dependencies": { + "bytes": "3.1.0", + "http-errors": "1.7.2", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/read-pkg": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", + "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", + "dev": true, + "dependencies": { + "load-json-file": "^4.0.0", + "normalize-package-data": "^2.3.2", + "path-type": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/read-pkg-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", + "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", + "dev": true, + "dependencies": { + "find-up": "^2.0.0", + "read-pkg": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/read-pkg/node_modules/path-type": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", + "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", + "dev": true, + "dependencies": { + "pify": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/rechoir": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", + "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", + "dev": true, + "dependencies": { + "resolve": "^1.1.6" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/reduce-extract": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz", + "integrity": "sha1-Z/I4W+2mUGG19fQxJmLosIDKFSU=", + "dev": true, + "dependencies": { + "test-value": "^1.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-extract/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/reduce-extract/node_modules/test-value": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz", + "integrity": "sha1-oJE29y7AQ9J8iTcHwrFZv6196T8=", + "dev": true, + "dependencies": { + "array-back": "^1.0.2", + "typical": "^2.4.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-flatten": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-1.0.1.tgz", + "integrity": "sha1-JYx479FT3fk8tWEjf2EYTzaW4yc=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-unique": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/reduce-unique/-/reduce-unique-2.0.1.tgz", + "integrity": "sha512-x4jH/8L1eyZGR785WY+ePtyMNhycl1N2XOLxhCbzZFaqF4AXjLzqSxa2UHgJ2ZVR/HHyPOvl1L7xRnW8ye5MdA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/reduce-without": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/reduce-without/-/reduce-without-1.0.1.tgz", + "integrity": "sha1-aK0OrRGFXJo31OglbBW7+Hly/Iw=", + "dev": true, + "dependencies": { + "test-value": "^2.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-without/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/reduce-without/node_modules/test-value": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz", + "integrity": "sha1-Edpv9nDzRxpztiXKTz/c97t0gpE=", + "dev": true, + "dependencies": { + "array-back": "^1.0.3", + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/regexpp": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.1.0.tgz", + "integrity": "sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-main-filename": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", + "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", + "dev": true + }, + "node_modules/requizzle": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz", + "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==", + "dev": true, + "dependencies": { + "lodash": "^4.17.14" + } + }, + "node_modules/resolve": { + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", + "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", + "dev": true, + "dependencies": { + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + }, + "node_modules/semver": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/set-blocking": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", + "dev": true + }, + "node_modules/setprototypeof": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz", + "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==" + }, + "node_modules/shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "dependencies": { + "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/shelljs": { + "version": "0.8.4", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz", + "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==", + "dev": true, + "dependencies": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + }, + "bin": { + "shjs": "bin/shjs" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/shiki": { + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz", + "integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==", + "dev": true, + "dependencies": { + "onigasm": "^2.2.5", + "vscode-textmate": "^5.2.0" + } + }, + "node_modules/side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "dependencies": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/sinon": { + "version": "7.5.0", + "resolved": "https://registry.npmjs.org/sinon/-/sinon-7.5.0.tgz", + "integrity": "sha512-AoD0oJWerp0/rY9czP/D6hDTTUYGpObhZjMpd7Cl/A6+j0xBE+ayL/ldfggkBXUs0IkvIiM1ljM8+WkOc5k78Q==", + "dev": true, + "dependencies": { + "@sinonjs/commons": "^1.4.0", + "@sinonjs/formatio": "^3.2.1", + "@sinonjs/samsam": "^3.3.3", + "diff": "^3.5.0", + "lolex": "^4.2.0", + "nise": "^1.5.2", + "supports-color": "^5.5.0" + } + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/slice-ansi/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/slice-ansi/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/slice-ansi/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/sort-array": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/sort-array/-/sort-array-2.0.0.tgz", + "integrity": "sha1-OKnG2if9fRR7QuYFVPKBGHtN9HI=", + "dev": true, + "dependencies": { + "array-back": "^1.0.4", + "object-get": "^2.1.0", + "typical": "^2.6.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/sort-array/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.19", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", + "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/spdx-correct": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", + "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", + "dev": true, + "dependencies": { + "spdx-expression-parse": "^3.0.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-exceptions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", + "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", + "dev": true + }, + "node_modules/spdx-expression-parse": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", + "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "dev": true, + "dependencies": { + "spdx-exceptions": "^2.1.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-license-ids": { + "version": "3.0.9", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.9.tgz", + "integrity": "sha512-Ki212dKK4ogX+xDo4CtOZBVIwhsKBEfsEEcwmJfLQzirgc2jIWdzg40Unxz/HzEUqM1WFzVlQSMF9kZZ2HboLQ==", + "dev": true + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true + }, + "node_modules/statuses": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", + "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/stream-connect": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz", + "integrity": "sha1-GLyB8u2zW4tdmoAJIAqYUxRCipc=", + "dev": true, + "dependencies": { + "array-back": "^1.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stream-connect/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/stream-via": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/stream-via/-/stream-via-1.0.4.tgz", + "integrity": "sha512-DBp0lSvX5G9KGRDTkR/R+a29H+Wk2xItOF+MpZLLNDWbEV9tGPnqLPxHEYjmiz8xGtJHRIqmI+hCjmNzqoA4nQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/string-width": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.2.tgz", + "integrity": "sha512-XBJbT3N4JhVumXE0eoLU9DCjcaF92KLNqTmFCnG1pf8duUxFGwtP6AD6nkjw9a3IdiRtL3E2w3JDiE/xi3vOeA==", + "dev": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/table": { + "version": "6.7.1", + "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", + "integrity": "sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg==", + "dev": true, + "dependencies": { + "ajv": "^8.0.1", + "lodash.clonedeep": "^4.5.0", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/table-layout": { + "version": "0.4.5", + "resolved": "https://registry.npmjs.org/table-layout/-/table-layout-0.4.5.tgz", + "integrity": "sha512-zTvf0mcggrGeTe/2jJ6ECkJHAQPIYEwDoqsiqBjI24mvRmQbInK5jq33fyypaCBxX08hMkfmdOqj6haT33EqWw==", + "dev": true, + "dependencies": { + "array-back": "^2.0.0", + "deep-extend": "~0.6.0", + "lodash.padend": "^4.6.1", + "typical": "^2.6.1", + "wordwrapjs": "^3.0.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/table-layout/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/table/node_modules/ajv": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.0.tgz", + "integrity": "sha512-cnUG4NSBiM4YFBxgZIj/In3/6KX+rQ2l2YPRVcvAMQGWEPKuXoPIhxzwqh31jA3IPbI4qEOp/5ILI4ynioXsGQ==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/table/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + }, + "node_modules/taffydb": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz", + "integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=", + "dev": true + }, + "node_modules/temp-path": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/temp-path/-/temp-path-1.0.0.tgz", + "integrity": "sha1-JLFUOXOrRCiW2a02fdnL2/r+kYs=", + "dev": true + }, + "node_modules/test-value": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-3.0.0.tgz", + "integrity": "sha512-sVACdAWcZkSU9x7AOmJo5TqE+GyNJknHaHsMrR6ZnhjVlVN9Yx6FjHrsKZ3BjIpPCT68zYesPWkakrNupwfOTQ==", + "dev": true, + "dependencies": { + "array-back": "^2.0.0", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/test-value/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/toidentifier": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", + "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/tsconfig-paths": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", + "integrity": "sha512-dRcuzokWhajtZWkQsDVKbWyY+jgcLC5sqJhg2PSgf4ZkH2aHPvaOY8YWGhmjb68b5qqTfasSsDO9k7RUiEmZAw==", + "dev": true, + "dependencies": { + "@types/json5": "^0.0.29", + "json5": "^1.0.1", + "minimist": "^1.2.0", + "strip-bom": "^3.0.0" + } + }, + "node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "dependencies": { + "tslib": "^1.8.1" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" + } + }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/typedoc": { + "version": "0.20.36", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.36.tgz", + "integrity": "sha512-qFU+DWMV/hifQ9ZAlTjdFO9wbUIHuUBpNXzv68ZyURAP9pInjZiO4+jCPeAzHVcaBCHER9WL/+YzzTt6ZlN/Nw==", + "dev": true, + "dependencies": { + "colors": "^1.4.0", + "fs-extra": "^9.1.0", + "handlebars": "^4.7.7", + "lodash": "^4.17.21", + "lunr": "^2.3.9", + "marked": "^2.0.3", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "shelljs": "^0.8.4", + "shiki": "^0.9.3", + "typedoc-default-themes": "^0.12.10" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 10.8.0" + }, + "peerDependencies": { + "typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x" + } + }, + "node_modules/typedoc-default-themes": { + "version": "0.12.10", + "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", + "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/typedoc-github-wiki-theme": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/typedoc-github-wiki-theme/-/typedoc-github-wiki-theme-0.3.0.tgz", + "integrity": "sha512-YMnpahBvsk0FlmHM3Djq+U25YZgiXSXdNzPRqu/mQY9QXHHzIKJmLm6r3Qz2U2NfD7xWyfoODpX/UY5Zz9434g==", + "dev": true, + "peerDependencies": { + "typedoc": ">=0.20.0", + "typedoc-plugin-markdown": ">=3.4.0" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.9.0.tgz", + "integrity": "sha512-s445YeUe8bH7me15T+hsHZgNmAvvF7QIpX02vFgseLGtghAwmtdZYVOqPneWoKqRv/JNpPSuyZb3CeblML9jOg==", + "dev": true, + "dependencies": { + "handlebars": "^4.7.7" + }, + "engines": { + "node": ">= 10.8.0" + }, + "peerDependencies": { + "typedoc": ">=0.20.0" + } + }, + "node_modules/typedoc/node_modules/marked": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", + "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">= 8.16.2" + } + }, + "node_modules/typescript": { + "version": "4.2.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz", + "integrity": "sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/typical": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz", + "integrity": "sha1-XAgOXWYcu+OCWdLnCjxyU+hziB0=", + "dev": true + }, + "node_modules/uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", + "dev": true + }, + "node_modules/uglify-js": { + "version": "3.13.9", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.9.tgz", + "integrity": "sha512-wZbyTQ1w6Y7fHdt8sJnHfSIuWeDgk6B5rCb4E/AM6QNNPbOMIZph21PW5dRB3h7Df0GszN+t7RuUH6sWK5bF0g==", + "dev": true, + "optional": true, + "bin": { + "uglifyjs": "bin/uglifyjs" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/underscore": { + "version": "1.13.1", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.1.tgz", + "integrity": "sha512-hzSoAVtJF+3ZtiFX0VgfFPHEDRm7Y/QPjGyNo4TVdnDTdft3tr8hEkD25a1jC+TjTuE7tkHGKkhwCgs9dgBB2g==", + "dev": true + }, + "node_modules/universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "dev": true, + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true + }, + "node_modules/validate-npm-package-license": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", + "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", + "dev": true, + "dependencies": { + "spdx-correct": "^3.0.0", + "spdx-expression-parse": "^3.0.0" + } + }, + "node_modules/vscode-textmate": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.4.0.tgz", + "integrity": "sha512-c0Q4zYZkcLizeYJ3hNyaVUM2AA8KDhNCA3JvXY8CeZSJuBdAy3bAvSbv46RClC4P3dSO9BdwhnKEx2zOo6vP/w==", + "dev": true + }, + "node_modules/walk-back": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-4.0.0.tgz", + "integrity": "sha512-kudCA8PXVQfrqv2mFTG72vDBRi8BKWxGgFLwPpzHcpZnSwZk93WMwUDVcLHWNsnm+Y0AC4Vb6MUNRgaHfyV2DQ==", + "dev": true, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-module": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", + "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", + "dev": true + }, + "node_modules/wide-align": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", + "integrity": "sha512-QGkOQc8XL6Bt5PwnsExKBPuMKBxnGxWWW3fU55Xt4feHozMUhdUMaBCk290qpm/wG5u/RSKzwdAC4i51YigihA==", + "dev": true, + "dependencies": { + "string-width": "^1.0.2 || 2" + } + }, + "node_modules/wide-align/node_modules/ansi-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", + "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/string-width": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", + "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", + "dev": true, + "dependencies": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/strip-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", + "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", + "dev": true, + "dependencies": { + "ansi-regex": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true + }, + "node_modules/wordwrapjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-3.0.0.tgz", + "integrity": "sha512-mO8XtqyPvykVCsrwj5MlOVWvSnCdT+C+QVbm6blradR7JExAhbkZ7hZ9A+9NUtwzSqrlUo9a67ws0EiILrvRpw==", + "dev": true, + "dependencies": { + "reduce-flatten": "^1.0.1", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/wrap-ansi": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", + "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/wrap-ansi/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/wrap-ansi/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "node_modules/xmlcreate": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz", + "integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==", + "dev": true + }, + "node_modules/y18n": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", + "dev": true + }, + "node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/yargs": { + "version": "13.3.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", + "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", + "dev": true, + "dependencies": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" + } + }, + "node_modules/yargs-parser": { + "version": "13.1.2", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", + "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", + "dev": true, + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + }, + "node_modules/yargs-unparser": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.6.0.tgz", + "integrity": "sha512-W9tKgmSn0DpSatfri0nx52Joq5hVXgeLiqR/5G0sZNDoLZFOr/xjBUDcShCOGNsBnEMNo1KAMBkTej1Hm62HTw==", + "dev": true, + "dependencies": { + "flat": "^4.1.0", + "lodash": "^4.17.15", + "yargs": "^13.3.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/yargs/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/yargs/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yargs/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + } + }, "dependencies": { "@babel/code-frame": { "version": "7.12.11", @@ -453,7 +5893,8 @@ "version": "5.3.1", "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.1.tgz", "integrity": "sha512-K0Ptm/47OKfQRpNQ2J/oIN/3QYiK6FwW+eJbILhsdxh2WTLdl+30o8aGdTbm5JbffpFFAg/g+zi1E+jvJha5ng==", - "dev": true + "dev": true, + "requires": {} }, "ajv": { "version": "6.12.6", @@ -2448,7 +7889,8 @@ "version": "5.3.0", "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", - "dev": true + "dev": true, + "requires": {} }, "marked": { "version": "0.7.0", @@ -3762,7 +9204,8 @@ "version": "0.3.0", "resolved": "https://registry.npmjs.org/typedoc-github-wiki-theme/-/typedoc-github-wiki-theme-0.3.0.tgz", "integrity": "sha512-YMnpahBvsk0FlmHM3Djq+U25YZgiXSXdNzPRqu/mQY9QXHHzIKJmLm6r3Qz2U2NfD7xWyfoODpX/UY5Zz9434g==", - "dev": true + "dev": true, + "requires": {} }, "typedoc-plugin-markdown": { "version": "3.9.0", diff --git a/package.json b/package.json index 971a778..1c78c0b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.23", + "version": "2.0.0-beta.25", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -17,7 +17,8 @@ "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "docs:generate": "typedoc", - "prepublishOnly": "tsc" + "prepublishOnly": "tsc", + "compile": "tsc" }, "repository": { "type": "git", diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts index db7e021..efaf533 100644 --- a/src/util/axiosConstructor.ts +++ b/src/util/axiosConstructor.ts @@ -1,6 +1,6 @@ -import axios, { AxiosInstance, CreateAxiosDefaults } from 'axios'; +import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'; -export function createAxiosClient(config?: CreateAxiosDefaults | undefined): AxiosInstance { +export function createAxiosClient(config?: AxiosRequestConfig | undefined): AxiosInstance { const client = axios.create(config); client.interceptors.response.use((response) => { return response; From 162234fa1675b33fb5e6147e119445958130aa91 Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Tue, 27 Jun 2023 17:54:51 -0400 Subject: [PATCH 74/91] fix: export createAxiosclient (#30) --- package.json | 2 +- src/index.ts | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 1c78c0b..19e4264 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.25", + "version": "2.0.0-beta.26", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/index.ts b/src/index.ts index d3ac1b1..86b66ee 100644 --- a/src/index.ts +++ b/src/index.ts @@ -58,6 +58,7 @@ export * from './sdk/loggers'; export * from './sdk/middleware'; export * from './util/EnvoySignatureVerifier'; +export * from './util/axiosConstructor'; export { EntryPayload, From 5721bec309ce2478ae5ca437a10b5df0264cf0a2 Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Thu, 29 Jun 2023 16:11:35 -0400 Subject: [PATCH 75/91] fix: return safe error (#34) --- package.json | 2 +- src/util/axiosConstructor.ts | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 19e4264..64b0529 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.26", + "version": "2.0.0-beta.27", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts index efaf533..cd5774a 100644 --- a/src/util/axiosConstructor.ts +++ b/src/util/axiosConstructor.ts @@ -5,9 +5,15 @@ export function createAxiosClient(config?: AxiosRequestConfig | undefined): Axio client.interceptors.response.use((response) => { return response; }, (error) => { - delete error.config?.headers; - delete error.config?.proxy; - return Promise.reject(error); + const safeError = { + code: error.code, + message: error.message, + name: error.name, + baseURL: error.request?.baseURL ?? error.config?.baseURL, + url: error.request?.url ?? error.config?.url, + method: error.request?.method ?? error.config?.method, + } + return Promise.reject(safeError); }); return client; From 18d17f666d52c90ff7d93476b57f2fb09556e6a6 Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Mon, 10 Jul 2023 17:40:01 -0400 Subject: [PATCH 76/91] fix: return some fields for response (#38) --- package.json | 2 +- src/util/axiosConstructor.ts | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 64b0529..f570b61 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.27", + "version": "2.0.0-beta.28", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts index cd5774a..e3d086f 100644 --- a/src/util/axiosConstructor.ts +++ b/src/util/axiosConstructor.ts @@ -7,11 +7,19 @@ export function createAxiosClient(config?: AxiosRequestConfig | undefined): Axio }, (error) => { const safeError = { code: error.code, + response: { + code: error.response?.code, + status: error.response?.status, + statusText: error.response?.statusText, + data: error.response?.data, + }, message: error.message, name: error.name, baseURL: error.request?.baseURL ?? error.config?.baseURL, url: error.request?.url ?? error.config?.url, method: error.request?.method ?? error.config?.method, + stack: error.stack, + data: error.data, } return Promise.reject(safeError); }); From 250107432623a6af54db12bb005a091ba7ea2a2f Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Tue, 11 Jul 2023 14:49:20 -0400 Subject: [PATCH 77/91] fix: include some error.request fields (#39) --- package.json | 2 +- src/util/axiosConstructor.ts | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index f570b61..694c3b7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.28", + "version": "2.0.0-beta.29", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts index e3d086f..5dc8cd0 100644 --- a/src/util/axiosConstructor.ts +++ b/src/util/axiosConstructor.ts @@ -7,6 +7,11 @@ export function createAxiosClient(config?: AxiosRequestConfig | undefined): Axio }, (error) => { const safeError = { code: error.code, + request: { + baseURL: error.request?.baseURL, + url: error.request?.url, + method: error.request?.method, + }, response: { code: error.response?.code, status: error.response?.status, From 240c43d73bd3aaa1930e895abb1177e9654cd8b6 Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Thu, 13 Jul 2023 14:11:31 -0400 Subject: [PATCH 78/91] fix: add sanitize axios err func (#40) --- package.json | 2 +- src/sdk/EnvoyPluginAPI.ts | 37 +++++++------ src/sdk/EnvoyUserAPI.ts | 103 ++++++++++++++++++++--------------- src/util/axiosConstructor.ts | 48 ++++++++-------- 4 files changed, 106 insertions(+), 84 deletions(-) diff --git a/package.json b/package.json index 694c3b7..efda1b1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.29", + "version": "2.0.0-beta.30", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/sdk/EnvoyPluginAPI.ts b/src/sdk/EnvoyPluginAPI.ts index db5c580..aa14adc 100644 --- a/src/sdk/EnvoyPluginAPI.ts +++ b/src/sdk/EnvoyPluginAPI.ts @@ -5,6 +5,7 @@ import EnvoyStorageCommand from '../internal/EnvoyStorageCommand'; import EnvoyStorageResult from '../internal/EnvoyStorageResult'; import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; +import { sanitizeAxiosError } from '../util/axiosConstructor'; /** * API endpoints for *plugin-scoped* tokens. @@ -70,21 +71,25 @@ export default class EnvoyPluginAPI extends EnvoyAPI { * Gets a plugin access token using `client_credentials` as the grant type. */ static async loginAsPlugin(id = envoyClientId, secret = envoyClientSecret): Promise { - const { data } = await axios({ - auth: { - username: id, - password: secret, - }, - method: 'POST', - data: { - grant_type: 'client_credentials', - client_id: id, - client_secret: secret, - scope: 'plugin,token.refresh', - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; + try { + const { data } = await axios({ + auth: { + username: id, + password: secret, + }, + method: 'POST', + data: { + grant_type: 'client_credentials', + client_id: id, + client_secret: secret, + scope: 'plugin,token.refresh', + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } catch (error) { + throw sanitizeAxiosError(error); + } } } diff --git a/src/sdk/EnvoyUserAPI.ts b/src/sdk/EnvoyUserAPI.ts index b212afd..095a099 100644 --- a/src/sdk/EnvoyUserAPI.ts +++ b/src/sdk/EnvoyUserAPI.ts @@ -16,6 +16,7 @@ import { import { UserModel } from '../resources/UserResource'; import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; +import { sanitizeAxiosError } from '../util/axiosConstructor'; export type EnvoyUserAPIScope = 'flows.read' | @@ -256,22 +257,26 @@ export default class EnvoyUserAPI extends EnvoyAPI { clientId = envoyClientId, clientSecret = envoyClientSecret, ): Promise { - const { data } = await axios({ - auth: { - username: clientId, - password: clientSecret, - }, - method: 'POST', - data: { - grant_type: 'password', - scope, - username, - password, - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; + try { + const { data } = await axios({ + auth: { + username: clientId, + password: clientSecret, + }, + method: 'POST', + data: { + grant_type: 'password', + scope, + username, + password, + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } catch (error) { + throw sanitizeAxiosError(error); + } } /** @@ -283,21 +288,25 @@ export default class EnvoyUserAPI extends EnvoyAPI { clientId = envoyClientId, clientSecret = envoyClientSecret, ): Promise { - const { data } = await axios({ - auth: { - username: clientId, - password: clientSecret, - }, - method: 'POST', - data: { - grant_type: 'authorization_code', - scope, - code, - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; + try { + const { data } = await axios({ + auth: { + username: clientId, + password: clientSecret, + }, + method: 'POST', + data: { + grant_type: 'authorization_code', + scope, + code, + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } catch (error) { + throw sanitizeAxiosError(error); + } } /** @@ -308,19 +317,23 @@ export default class EnvoyUserAPI extends EnvoyAPI { clientId = envoyClientId, clientSecret = envoyClientSecret, ): Promise { - const { data } = await axios({ - auth: { - username: clientId, - password: clientSecret, - }, - method: 'POST', - data: { - grant_type: 'plugin_install', - install_id: installId, - }, - url: '/a/auth/v0/token', - baseURL: envoyBaseURL, - }); - return data; + try { + const { data } = await axios({ + auth: { + username: clientId, + password: clientSecret, + }, + method: 'POST', + data: { + grant_type: 'plugin_install', + install_id: installId, + }, + url: '/a/auth/v0/token', + baseURL: envoyBaseURL, + }); + return data; + } catch (error) { + throw sanitizeAxiosError(error); + } } } diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts index 5dc8cd0..b27dc1c 100644 --- a/src/util/axiosConstructor.ts +++ b/src/util/axiosConstructor.ts @@ -5,29 +5,33 @@ export function createAxiosClient(config?: AxiosRequestConfig | undefined): Axio client.interceptors.response.use((response) => { return response; }, (error) => { - const safeError = { - code: error.code, - request: { - baseURL: error.request?.baseURL, - url: error.request?.url, - method: error.request?.method, - }, - response: { - code: error.response?.code, - status: error.response?.status, - statusText: error.response?.statusText, - data: error.response?.data, - }, - message: error.message, - name: error.name, - baseURL: error.request?.baseURL ?? error.config?.baseURL, - url: error.request?.url ?? error.config?.url, - method: error.request?.method ?? error.config?.method, - stack: error.stack, - data: error.data, - } - return Promise.reject(safeError); + return Promise.reject(sanitizeAxiosError(error)); }); return client; +} + +export function sanitizeAxiosError(error: any) { + const safeError = { + code: error.code, + request: { + baseURL: error.request?.baseURL, + url: error.request?.url, + method: error.request?.method, + }, + response: { + code: error.response?.code, + status: error.response?.status, + statusText: error.response?.statusText, + data: error.response?.data, + }, + message: error.message, + name: error.name, + baseURL: error.request?.baseURL ?? error.config?.baseURL, + url: error.request?.url ?? error.config?.url, + method: error.request?.method ?? error.config?.method, + stack: error.stack, + data: error.data, + }; + return safeError; } \ No newline at end of file From db176ac97b2a45d09e131d5297a63e5ce1b7e2e5 Mon Sep 17 00:00:00 2001 From: Ryan Flynn Date: Mon, 17 Jul 2023 10:31:50 -0400 Subject: [PATCH 79/91] fix: upgrade axios --- package-lock.json | 5502 +-------------------------------------------- package.json | 4 +- 2 files changed, 49 insertions(+), 5457 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5c3f697..b37e01f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5448 +1,8 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.25", - "lockfileVersion": 2, + "version": "2.0.0-beta.31", + "lockfileVersion": 1, "requires": true, - "packages": { - "": { - "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.25", - "license": "ISC", - "dependencies": { - "@types/dotenv": "^8.2.0", - "@types/faker": "^5.5.6", - "@types/jsonwebtoken": "^8.5.1", - "@types/node": "^15.12.0", - "@types/qs": "^6.9.6", - "axios": "^0.21.1", - "body-parser": "^1.19.0", - "dataloader": "^2.0.0", - "dotenv-flow": "^3.2.0", - "factory.ts": "^0.5.2", - "faker": "^5.5.3", - "jsonwebtoken": "^8.5.1", - "lodash.ismatch": "^4.4.0", - "luxon": "^1.27.0", - "qs": "^6.10.1" - }, - "devDependencies": { - "@types/dotenv-flow": "^3.1.1", - "@types/express": "^4.17.12", - "@types/lodash.ismatch": "^4.4.6", - "@types/luxon": "^1.27.0", - "@typescript-eslint/eslint-plugin": "^4.26.0", - "@typescript-eslint/parser": "^4.26.0", - "chai": "^4.2.0", - "eslint": "^7.27.0", - "eslint-config-airbnb-typescript": "^12.3.1", - "eslint-plugin-import": "^2.23.4", - "jsdoc-to-markdown": "^5.0.0", - "mocha": "^6.1.4", - "proxyquire": "^2.1.0", - "sinon": "^7.3.2", - "typedoc": "^0.20.36", - "typedoc-github-wiki-theme": "^0.3.0", - "typedoc-plugin-markdown": "^3.9.0", - "typescript": "4.2" - }, - "peerDependencies": { - "@types/express": "^4" - } - }, - "node_modules/@babel/code-frame": { - "version": "7.12.11", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", - "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", - "dev": true, - "dependencies": { - "@babel/highlight": "^7.10.4" - } - }, - "node_modules/@babel/helper-validator-identifier": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.14.5.tgz", - "integrity": "sha512-5lsetuxCLilmVGyiLEfoHBRX8UCFD+1m2x3Rj97WrW3V7H3u4RWRXA4evMjImCsin2J2YT0QaVDGf+z8ondbAg==", - "dev": true, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/highlight": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.5.tgz", - "integrity": "sha512-qf9u2WFWVV0MppaL877j2dBtQIDgmidgjGk5VIMw3OadXvYaXn66U1BFlH2t4+t3i+8PhedppRv+i40ABzd+gg==", - "dev": true, - "dependencies": { - "@babel/helper-validator-identifier": "^7.14.5", - "chalk": "^2.0.0", - "js-tokens": "^4.0.0" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/highlight/node_modules/chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "dependencies": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@babel/highlight/node_modules/escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/@babel/parser": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.14.5.tgz", - "integrity": "sha512-TM8C+xtH/9n1qzX+JNHi7AN2zHMTiPUtspO0ZdHflW8KaskkALhMmuMHb4bCmNdv9VAPzJX3/bXqkVLnAvsPfg==", - "dev": true, - "bin": { - "parser": "bin/babel-parser.js" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@eslint/eslintrc": { - "version": "0.4.2", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.2.tgz", - "integrity": "sha512-8nmGq/4ycLpIwzvhI4tNDmQztZ8sp+hI7cyG8i1nQDhkAbRzHpXPidRAHlNvCZQpJTKw5ItIpMw9RSToGF00mg==", - "dev": true, - "dependencies": { - "ajv": "^6.12.4", - "debug": "^4.1.1", - "espree": "^7.3.0", - "globals": "^13.9.0", - "ignore": "^4.0.6", - "import-fresh": "^3.2.1", - "js-yaml": "^3.13.1", - "minimatch": "^3.0.4", - "strip-json-comments": "^3.1.1" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - } - }, - "node_modules/@eslint/eslintrc/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/@eslint/eslintrc/node_modules/ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true, - "engines": { - "node": ">= 4" - } - }, - "node_modules/@eslint/eslintrc/node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "dev": true, - "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dev": true, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.7", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.7.tgz", - "integrity": "sha512-BTIhocbPBSrRmHxOAJFtR18oLhxTtAFDAvL8hY1S3iU8k+E60W/YFs4jrixGzQjMpF4qPXxIQHcjVD9dz1C2QA==", - "dev": true, - "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@sinonjs/commons": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", - "integrity": "sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==", - "dev": true, - "dependencies": { - "type-detect": "4.0.8" - } - }, - "node_modules/@sinonjs/formatio": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/@sinonjs/formatio/-/formatio-3.2.2.tgz", - "integrity": "sha512-B8SEsgd8gArBLMD6zpRw3juQ2FVSsmdd7qlevyDqzS9WTCtvF55/gAL+h6gue8ZvPYcdiPdvueM/qm//9XzyTQ==", - "dev": true, - "dependencies": { - "@sinonjs/commons": "^1", - "@sinonjs/samsam": "^3.1.0" - } - }, - "node_modules/@sinonjs/samsam": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-3.3.3.tgz", - "integrity": "sha512-bKCMKZvWIjYD0BLGnNrxVuw4dkWCYsLqFOUWw8VgKF/+5Y+mE7LfHWPIYoDXowH+3a9LsWDMo0uAP8YDosPvHQ==", - "dev": true, - "dependencies": { - "@sinonjs/commons": "^1.3.0", - "array-from": "^2.1.1", - "lodash": "^4.17.15" - } - }, - "node_modules/@sinonjs/text-encoding": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz", - "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", - "dev": true - }, - "node_modules/@types/body-parser": { - "version": "1.19.0", - "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", - "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", - "dev": true, - "dependencies": { - "@types/connect": "*", - "@types/node": "*" - } - }, - "node_modules/@types/connect": { - "version": "3.4.34", - "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", - "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/dotenv": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/@types/dotenv/-/dotenv-8.2.0.tgz", - "integrity": "sha512-ylSC9GhfRH7m1EUXBXofhgx4lUWmFeQDINW5oLuS+gxWdfUeW4zJdeVTYVkexEW+e2VUvlZR2kGnGGipAWR7kw==", - "deprecated": "This is a stub types definition. dotenv provides its own type definitions, so you do not need this installed.", - "dependencies": { - "dotenv": "*" - } - }, - "node_modules/@types/dotenv-flow": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/@types/dotenv-flow/-/dotenv-flow-3.1.1.tgz", - "integrity": "sha512-khxgP+KkHPL72SP0Wqn1gB6EHj6yk79OBGJEKW64XL13RbyDGTkRbbA47VICOLRrvgKOpZeun2uMsgO7pAsExQ==", - "dev": true - }, - "node_modules/@types/express": { - "version": "4.17.12", - "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", - "integrity": "sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==", - "dev": true, - "dependencies": { - "@types/body-parser": "*", - "@types/express-serve-static-core": "^4.17.18", - "@types/qs": "*", - "@types/serve-static": "*" - } - }, - "node_modules/@types/express-serve-static-core": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.21.tgz", - "integrity": "sha512-gwCiEZqW6f7EoR8TTEfalyEhb1zA5jQJnRngr97+3pzMaO1RKoI1w2bw07TK72renMUVWcWS5mLI6rk1NqN0nA==", - "dev": true, - "dependencies": { - "@types/node": "*", - "@types/qs": "*", - "@types/range-parser": "*" - } - }, - "node_modules/@types/faker": { - "version": "5.5.6", - "resolved": "https://registry.npmjs.org/@types/faker/-/faker-5.5.6.tgz", - "integrity": "sha512-UCRj0kLg4sXs2XFVm48OU/wIjyJZkpRkwxhRGVQb5l5GmemkeW22WTz9iiDhYPBUqTzDsIWzhFRuF/4DD5+q2Q==" - }, - "node_modules/@types/json-schema": { - "version": "7.0.7", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", - "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", - "dev": true - }, - "node_modules/@types/json5": { - "version": "0.0.29", - "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", - "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", - "dev": true - }, - "node_modules/@types/jsonwebtoken": { - "version": "8.5.1", - "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", - "integrity": "sha512-rNAPdomlIUX0i0cg2+I+Q1wOUr531zHBQ+cV/28PJ39bSPKjahatZZ2LMuhiguETkCgLVzfruw/ZvNMNkKoSzw==", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/lodash": { - "version": "4.14.171", - "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.171.tgz", - "integrity": "sha512-7eQ2xYLLI/LsicL2nejW9Wyko3lcpN6O/z0ZLHrEQsg280zIdCv1t/0m6UtBjUHokCGBQ3gYTbHzDkZ1xOBwwg==", - "dev": true - }, - "node_modules/@types/lodash.ismatch": { - "version": "4.4.6", - "resolved": "https://registry.npmjs.org/@types/lodash.ismatch/-/lodash.ismatch-4.4.6.tgz", - "integrity": "sha512-Qy6R9c+LOc3M+kBTDgQGAWxzcrXFKznXuIyg8tbw2/Ct3D3lBmQd3yMTD+NjGzIATgUr0v4uWzW3+ALid+LXsQ==", - "dev": true, - "dependencies": { - "@types/lodash": "*" - } - }, - "node_modules/@types/luxon": { - "version": "1.27.0", - "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-1.27.0.tgz", - "integrity": "sha512-rr2lNXsErnA/ARtgFn46NtQjUa66cuwZYeo/2K7oqqxhJErhXgHBPyNKCo+pfOC3L7HFwtao8ebViiU9h4iAxA==", - "dev": true - }, - "node_modules/@types/mime": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", - "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", - "dev": true - }, - "node_modules/@types/node": { - "version": "15.12.2", - "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.2.tgz", - "integrity": "sha512-zjQ69G564OCIWIOHSXyQEEDpdpGl+G348RAKY0XXy9Z5kU9Vzv1GMNnkar/ZJ8dzXB3COzD9Mo9NtRZ4xfgUww==" - }, - "node_modules/@types/qs": { - "version": "6.9.6", - "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", - "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==" - }, - "node_modules/@types/range-parser": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", - "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", - "dev": true - }, - "node_modules/@types/serve-static": { - "version": "1.13.9", - "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", - "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", - "dev": true, - "dependencies": { - "@types/mime": "^1", - "@types/node": "*" - } - }, - "node_modules/@typescript-eslint/eslint-plugin": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.26.1.tgz", - "integrity": "sha512-aoIusj/8CR+xDWmZxARivZjbMBQTT9dImUtdZ8tVCVRXgBUuuZyM5Of5A9D9arQPxbi/0rlJLcuArclz/rCMJw==", - "dev": true, - "dependencies": { - "@typescript-eslint/experimental-utils": "4.26.1", - "@typescript-eslint/scope-manager": "4.26.1", - "debug": "^4.3.1", - "functional-red-black-tree": "^1.0.1", - "lodash": "^4.17.21", - "regexpp": "^3.1.0", - "semver": "^7.3.5", - "tsutils": "^3.21.0" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "@typescript-eslint/parser": "^4.0.0", - "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } - } - }, - "node_modules/@typescript-eslint/eslint-plugin/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/@typescript-eslint/eslint-plugin/node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "node_modules/@typescript-eslint/eslint-plugin/node_modules/semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@typescript-eslint/experimental-utils": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.26.1.tgz", - "integrity": "sha512-sQHBugRhrXzRCs9PaGg6rowie4i8s/iD/DpTB+EXte8OMDfdCG5TvO73XlO9Wc/zi0uyN4qOmX9hIjQEyhnbmQ==", - "dev": true, - "dependencies": { - "@types/json-schema": "^7.0.7", - "@typescript-eslint/scope-manager": "4.26.1", - "@typescript-eslint/types": "4.26.1", - "@typescript-eslint/typescript-estree": "4.26.1", - "eslint-scope": "^5.1.1", - "eslint-utils": "^3.0.0" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "*" - } - }, - "node_modules/@typescript-eslint/parser": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.26.1.tgz", - "integrity": "sha512-q7F3zSo/nU6YJpPJvQveVlIIzx9/wu75lr6oDbDzoeIRWxpoc/HQ43G4rmMoCc5my/3uSj2VEpg/D83LYZF5HQ==", - "dev": true, - "dependencies": { - "@typescript-eslint/scope-manager": "4.26.1", - "@typescript-eslint/types": "4.26.1", - "@typescript-eslint/typescript-estree": "4.26.1", - "debug": "^4.3.1" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } - } - }, - "node_modules/@typescript-eslint/parser/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/@typescript-eslint/parser/node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "node_modules/@typescript-eslint/scope-manager": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.26.1.tgz", - "integrity": "sha512-TW1X2p62FQ8Rlne+WEShyd7ac2LA6o27S9i131W4NwDSfyeVlQWhw8ylldNNS8JG6oJB9Ha9Xyc+IUcqipvheQ==", - "dev": true, - "dependencies": { - "@typescript-eslint/types": "4.26.1", - "@typescript-eslint/visitor-keys": "4.26.1" - }, - "engines": { - "node": "^8.10.0 || ^10.13.0 || >=11.10.1" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/types": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.26.1.tgz", - "integrity": "sha512-STyMPxR3cS+LaNvS8yK15rb8Y0iL0tFXq0uyl6gY45glyI7w0CsyqyEXl/Fa0JlQy+pVANeK3sbwPneCbWE7yg==", - "dev": true, - "engines": { - "node": "^8.10.0 || ^10.13.0 || >=11.10.1" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/typescript-estree": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.26.1.tgz", - "integrity": "sha512-l3ZXob+h0NQzz80lBGaykdScYaiEbFqznEs99uwzm8fPHhDjwaBFfQkjUC/slw6Sm7npFL8qrGEAMxcfBsBJUg==", - "dev": true, - "dependencies": { - "@typescript-eslint/types": "4.26.1", - "@typescript-eslint/visitor-keys": "4.26.1", - "debug": "^4.3.1", - "globby": "^11.0.3", - "is-glob": "^4.0.1", - "semver": "^7.3.5", - "tsutils": "^3.21.0" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } - } - }, - "node_modules/@typescript-eslint/typescript-estree/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/@typescript-eslint/typescript-estree/node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@typescript-eslint/visitor-keys": { - "version": "4.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.26.1.tgz", - "integrity": "sha512-IGouNSSd+6x/fHtYRyLOM6/C+QxMDzWlDtN41ea+flWuSF9g02iqcIlX8wM53JkfljoIjP0U+yp7SiTS1onEkw==", - "dev": true, - "dependencies": { - "@typescript-eslint/types": "4.26.1", - "eslint-visitor-keys": "^2.0.0" - }, - "engines": { - "node": "^8.10.0 || ^10.13.0 || >=11.10.1" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/acorn": { - "version": "7.4.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", - "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", - "dev": true, - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/acorn-jsx": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.1.tgz", - "integrity": "sha512-K0Ptm/47OKfQRpNQ2J/oIN/3QYiK6FwW+eJbILhsdxh2WTLdl+30o8aGdTbm5JbffpFFAg/g+zi1E+jvJha5ng==", - "dev": true, - "peerDependencies": { - "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" - } - }, - "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ansi-colors": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", - "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/ansi-escape-sequences": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-escape-sequences/-/ansi-escape-sequences-4.1.0.tgz", - "integrity": "sha512-dzW9kHxH011uBsidTXd14JXgzye/YLb2LzeKZ4bsgl/Knwx8AtbSFkkGxagdNOoh0DlqHCmfiEjWKBaqjOanVw==", - "dev": true, - "dependencies": { - "array-back": "^3.0.1" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/ansi-escape-sequences/node_modules/array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/ansi-styles": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", - "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, - "dependencies": { - "color-convert": "^1.9.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, - "node_modules/array-back": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-4.0.2.tgz", - "integrity": "sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/array-from": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/array-from/-/array-from-2.1.1.tgz", - "integrity": "sha1-z+nYwmYoudxa7MYqn12PHzUsEZU=", - "dev": true - }, - "node_modules/array-includes": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.3.tgz", - "integrity": "sha512-gcem1KlBU7c9rB+Rq8/3PPKsK2kjqeEBa3bD5kkQo4nYlOHQCJqIJFqBXDEfwaRuYTT4E+FxA9xez7Gf/e3Q7A==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.0-next.2", - "get-intrinsic": "^1.1.1", - "is-string": "^1.0.5" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/array-union": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", - "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/array.prototype.flat": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.4.tgz", - "integrity": "sha512-4470Xi3GAPAjZqFcljX2xzckv1qeKPizoNkiS0+O4IoPR2ZNpcjE0pkhdihlDouK+x6QOast26B4Q/O9DJnwSg==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.0-next.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/assertion-error": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", - "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", - "dev": true, - "engines": { - "node": "*" - } - }, - "node_modules/astral-regex": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", - "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/at-least-node": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", - "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", - "dev": true, - "engines": { - "node": ">= 4.0.0" - } - }, - "node_modules/axios": { - "version": "0.21.1", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz", - "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==", - "dependencies": { - "follow-redirects": "^1.10.0" - } - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true - }, - "node_modules/bluebird": { - "version": "3.7.2", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", - "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", - "dev": true - }, - "node_modules/body-parser": { - "version": "1.19.0", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz", - "integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==", - "dependencies": { - "bytes": "3.1.0", - "content-type": "~1.0.4", - "debug": "2.6.9", - "depd": "~1.1.2", - "http-errors": "1.7.2", - "iconv-lite": "0.4.24", - "on-finished": "~2.3.0", - "qs": "6.7.0", - "raw-body": "2.4.0", - "type-is": "~1.6.17" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/body-parser/node_modules/qs": { - "version": "6.7.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", - "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==", - "engines": { - "node": ">=0.6" - } - }, - "node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dev": true, - "dependencies": { - "fill-range": "^7.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/browser-stdout": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", - "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", - "dev": true - }, - "node_modules/buffer-equal-constant-time": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", - "integrity": "sha1-+OcRMvf/5uAaXJaXpMbz5I1cyBk=" - }, - "node_modules/buffer-from": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", - "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==" - }, - "node_modules/bytes": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", - "integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/cache-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-1.0.0.tgz", - "integrity": "sha512-ZqrZp9Hi5Uq7vfSGmNP2bUT/9DzZC2Y/GXjHB8rUJN1a+KLmbV05+vxHipNsg8+CSVgjcVVzLV8VZms6w8ZeRw==", - "dev": true, - "dependencies": { - "array-back": "^4.0.0", - "fs-then-native": "^2.0.0", - "mkdirp2": "^1.0.4" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/call-bind": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", - "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", - "dependencies": { - "function-bind": "^1.1.1", - "get-intrinsic": "^1.0.2" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/camelcase": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/catharsis": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", - "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", - "dev": true, - "dependencies": { - "lodash": "^4.17.15" - }, - "engines": { - "node": ">= 10" - } - }, - "node_modules/chai": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.4.tgz", - "integrity": "sha512-yS5H68VYOCtN1cjfwumDSuzn/9c+yza4f3reKXlE5rUg7SFcCEy90gJvydNgOYtblyf4Zi6jIWRnXOgErta0KA==", - "dev": true, - "dependencies": { - "assertion-error": "^1.1.0", - "check-error": "^1.0.2", - "deep-eql": "^3.0.1", - "get-func-name": "^2.0.0", - "pathval": "^1.1.1", - "type-detect": "^4.0.5" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/chalk": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", - "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/chalk/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/chalk/node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/chalk/node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - }, - "node_modules/chalk/node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/chalk/node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/check-error": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", - "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", - "dev": true, - "engines": { - "node": "*" - } - }, - "node_modules/cliui": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", - "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", - "dev": true, - "dependencies": { - "string-width": "^3.1.0", - "strip-ansi": "^5.2.0", - "wrap-ansi": "^5.1.0" - } - }, - "node_modules/cliui/node_modules/ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/cliui/node_modules/emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "node_modules/cliui/node_modules/is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/cliui/node_modules/string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "dependencies": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/cliui/node_modules/strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "dependencies": { - "ansi-regex": "^4.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/clone-deep": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", - "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", - "dependencies": { - "is-plain-object": "^2.0.4", - "kind-of": "^6.0.2", - "shallow-clone": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/collect-all": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.4.tgz", - "integrity": "sha512-RKZhRwJtJEP5FWul+gkSMEnaK6H3AGPTTWOiRimCcs+rc/OmQE3Yhy1Q7A7KsdkG3ZXVdZq68Y6ONSdvkeEcKA==", - "dev": true, - "dependencies": { - "stream-connect": "^1.0.2", - "stream-via": "^1.0.4" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/color-convert": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", - "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, - "dependencies": { - "color-name": "1.1.3" - } - }, - "node_modules/color-name": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", - "dev": true - }, - "node_modules/colors": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", - "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", - "dev": true, - "engines": { - "node": ">=0.1.90" - } - }, - "node_modules/command-line-args": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.1.1.tgz", - "integrity": "sha512-hL/eG8lrll1Qy1ezvkant+trihbGnaKaeEjj6Scyr3DN+RC7iQ5Rz84IeLERfAWDGo0HBSNAakczwgCilDXnWg==", - "dev": true, - "dependencies": { - "array-back": "^3.0.1", - "find-replace": "^3.0.0", - "lodash.camelcase": "^4.3.0", - "typical": "^4.0.0" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/command-line-args/node_modules/array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/command-line-args/node_modules/typical": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/typical/-/typical-4.0.0.tgz", - "integrity": "sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/command-line-tool": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/command-line-tool/-/command-line-tool-0.8.0.tgz", - "integrity": "sha512-Xw18HVx/QzQV3Sc5k1vy3kgtOeGmsKIqwtFFoyjI4bbcpSgnw2CWVULvtakyw4s6fhyAdI6soQQhXc2OzJy62g==", - "dev": true, - "dependencies": { - "ansi-escape-sequences": "^4.0.0", - "array-back": "^2.0.0", - "command-line-args": "^5.0.0", - "command-line-usage": "^4.1.0", - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/command-line-tool/node_modules/array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "dependencies": { - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/command-line-usage": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-4.1.0.tgz", - "integrity": "sha512-MxS8Ad995KpdAC0Jopo/ovGIroV/m0KHwzKfXxKag6FHOkGsH8/lv5yjgablcRxCJJC0oJeUMuO/gmaq+Wq46g==", - "dev": true, - "dependencies": { - "ansi-escape-sequences": "^4.0.0", - "array-back": "^2.0.0", - "table-layout": "^0.4.2", - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/command-line-usage/node_modules/array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "dependencies": { - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/common-sequence": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-2.0.2.tgz", - "integrity": "sha512-jAg09gkdkrDO9EWTdXfv80WWH3yeZl5oT69fGfedBNS9pXUKYInVJ1bJ+/ht2+Moeei48TmSbQDYMc8EOx9G0g==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", - "dev": true - }, - "node_modules/config-master": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/config-master/-/config-master-3.1.0.tgz", - "integrity": "sha1-ZnZjWQUFooO/JqSE1oSJ10xUhdo=", - "dev": true, - "dependencies": { - "walk-back": "^2.0.1" - } - }, - "node_modules/config-master/node_modules/walk-back": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz", - "integrity": "sha1-VU4qnYdPrEeoywBr9EwvDEmYoKQ=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/confusing-browser-globals": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", - "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", - "dev": true - }, - "node_modules/content-type": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", - "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/dataloader": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-2.0.0.tgz", - "integrity": "sha512-YzhyDAwA4TaQIhM5go+vCLmU0UikghC/t9DTQYZR2M/UvZ1MdOhPezSDZcjj9uqQJOMqjLcpWtyW2iNINdlatQ==" - }, - "node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/decamelize": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/deep-eql": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-3.0.1.tgz", - "integrity": "sha512-+QeIQyN5ZuO+3Uk5DYh6/1eKO0m0YmJFGNmFHGACpf1ClL1nmlV/p4gNgbl2pJGxgXb4faqo6UE+M5ACEMyVcw==", - "dev": true, - "dependencies": { - "type-detect": "^4.0.0" - }, - "engines": { - "node": ">=0.12" - } - }, - "node_modules/deep-extend": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/deep-is": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", - "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", - "dev": true - }, - "node_modules/define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", - "dev": true, - "dependencies": { - "object-keys": "^1.0.12" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/depd": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", - "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/diff": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", - "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", - "dev": true, - "engines": { - "node": ">=0.3.1" - } - }, - "node_modules/dir-glob": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", - "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", - "dev": true, - "dependencies": { - "path-type": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/dmd": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/dmd/-/dmd-4.0.6.tgz", - "integrity": "sha512-7ZYAnFQ6jGm4SICArwqNPylJ83PaOdPTAkds3Z/s1ueFqSc5ilJ2F0b7uP+35W1PUbemH++gn5/VlC3KwEgiHQ==", - "dev": true, - "dependencies": { - "array-back": "^4.0.1", - "cache-point": "^1.0.0", - "common-sequence": "^2.0.0", - "file-set": "^3.0.0", - "handlebars": "^4.5.3", - "marked": "^0.7.0", - "object-get": "^2.1.0", - "reduce-flatten": "^3.0.0", - "reduce-unique": "^2.0.1", - "reduce-without": "^1.0.1", - "test-value": "^3.0.0", - "walk-back": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/dmd/node_modules/reduce-flatten": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-3.0.1.tgz", - "integrity": "sha512-bYo+97BmUUOzg09XwfkwALt4PQH1M5L0wzKerBt6WLm3Fhdd43mMS89HiT1B9pJIqko/6lWx3OnV4J9f2Kqp5Q==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/doctrine": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", - "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", - "dev": true, - "dependencies": { - "esutils": "^2.0.2" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/dotenv": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz", - "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==", - "engines": { - "node": ">=10" - } - }, - "node_modules/dotenv-flow": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/dotenv-flow/-/dotenv-flow-3.2.0.tgz", - "integrity": "sha512-GEB6RrR4AbqDJvNSFrYHqZ33IKKbzkvLYiD5eo4+9aFXr4Y4G+QaFrB/fNp0y6McWBmvaPn3ZNjIufnj8irCtg==", - "dependencies": { - "dotenv": "^8.0.0" - }, - "engines": { - "node": ">= 8.0.0" - } - }, - "node_modules/dotenv-flow/node_modules/dotenv": { - "version": "8.6.0", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", - "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==", - "engines": { - "node": ">=10" - } - }, - "node_modules/ecdsa-sig-formatter": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", - "integrity": "sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==", - "dependencies": { - "safe-buffer": "^5.0.1" - } - }, - "node_modules/ee-first": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", - "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" - }, - "node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/enquirer": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", - "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", - "dev": true, - "dependencies": { - "ansi-colors": "^4.1.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/entities": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", - "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", - "dev": true - }, - "node_modules/error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", - "dev": true, - "dependencies": { - "is-arrayish": "^0.2.1" - } - }, - "node_modules/es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", - "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "dependencies": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.28.0.tgz", - "integrity": "sha512-UMfH0VSjP0G4p3EWirscJEQ/cHqnT/iuH6oNZOB94nBjWbMnhGEPxsZm1eyIW0C/9jLI0Fow4W5DXLjEI7mn1g==", - "dev": true, - "dependencies": { - "@babel/code-frame": "7.12.11", - "@eslint/eslintrc": "^0.4.2", - "ajv": "^6.10.0", - "chalk": "^4.0.0", - "cross-spawn": "^7.0.2", - "debug": "^4.0.1", - "doctrine": "^3.0.0", - "enquirer": "^2.3.5", - "escape-string-regexp": "^4.0.0", - "eslint-scope": "^5.1.1", - "eslint-utils": "^2.1.0", - "eslint-visitor-keys": "^2.0.0", - "espree": "^7.3.1", - "esquery": "^1.4.0", - "esutils": "^2.0.2", - "fast-deep-equal": "^3.1.3", - "file-entry-cache": "^6.0.1", - "functional-red-black-tree": "^1.0.1", - "glob-parent": "^5.1.2", - "globals": "^13.6.0", - "ignore": "^4.0.6", - "import-fresh": "^3.0.0", - "imurmurhash": "^0.1.4", - "is-glob": "^4.0.0", - "js-yaml": "^3.13.1", - "json-stable-stringify-without-jsonify": "^1.0.1", - "levn": "^0.4.1", - "lodash.merge": "^4.6.2", - "minimatch": "^3.0.4", - "natural-compare": "^1.4.0", - "optionator": "^0.9.1", - "progress": "^2.0.0", - "regexpp": "^3.1.0", - "semver": "^7.2.1", - "strip-ansi": "^6.0.0", - "strip-json-comments": "^3.1.0", - "table": "^6.0.9", - "text-table": "^0.2.0", - "v8-compile-cache": "^2.0.3" - }, - "bin": { - "eslint": "bin/eslint.js" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint-config-airbnb": { - "version": "18.2.1", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb/-/eslint-config-airbnb-18.2.1.tgz", - "integrity": "sha512-glZNDEZ36VdlZWoxn/bUR1r/sdFKPd1mHPbqUtkctgNG4yT2DLLtJ3D+yCV+jzZCc2V1nBVkmdknOJBZ5Hc0fg==", - "dev": true, - "dependencies": { - "eslint-config-airbnb-base": "^14.2.1", - "object.assign": "^4.1.2", - "object.entries": "^1.1.2" - }, - "engines": { - "node": ">= 6" - }, - "peerDependencies": { - "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", - "eslint-plugin-import": "^2.22.1", - "eslint-plugin-jsx-a11y": "^6.4.1", - "eslint-plugin-react": "^7.21.5", - "eslint-plugin-react-hooks": "^4 || ^3 || ^2.3.0 || ^1.7.0" - } - }, - "node_modules/eslint-config-airbnb-base": { - "version": "14.2.1", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", - "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", - "dev": true, - "dependencies": { - "confusing-browser-globals": "^1.0.10", - "object.assign": "^4.1.2", - "object.entries": "^1.1.2" - }, - "engines": { - "node": ">= 6" - }, - "peerDependencies": { - "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", - "eslint-plugin-import": "^2.22.1" - } - }, - "node_modules/eslint-config-airbnb-typescript": { - "version": "12.3.1", - "resolved": "https://registry.npmjs.org/eslint-config-airbnb-typescript/-/eslint-config-airbnb-typescript-12.3.1.tgz", - "integrity": "sha512-ql/Pe6/hppYuRp4m3iPaHJqkBB7dgeEmGPQ6X0UNmrQOfTF+dXw29/ZjU2kQ6RDoLxaxOA+Xqv07Vbef6oVTWw==", - "dev": true, - "dependencies": { - "@typescript-eslint/parser": "^4.4.1", - "eslint-config-airbnb": "^18.2.0", - "eslint-config-airbnb-base": "^14.2.0" - } - }, - "node_modules/eslint-import-resolver-node": { - "version": "0.3.4", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.4.tgz", - "integrity": "sha512-ogtf+5AB/O+nM6DIeBUNr2fuT7ot9Qg/1harBfBtaP13ekEWFQEEMP94BCB7zaNW3gyY+8SHYF00rnqYwXKWOA==", - "dev": true, - "dependencies": { - "debug": "^2.6.9", - "resolve": "^1.13.1" - } - }, - "node_modules/eslint-module-utils": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.6.1.tgz", - "integrity": "sha512-ZXI9B8cxAJIH4nfkhTwcRTEAnrVfobYqwjWy/QMCZ8rHkZHFjf9yO4BzpiF9kCSfNlMG54eKigISHpX0+AaT4A==", - "dev": true, - "dependencies": { - "debug": "^3.2.7", - "pkg-dir": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/eslint-module-utils/node_modules/debug": { - "version": "3.2.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", - "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", - "dev": true, - "dependencies": { - "ms": "^2.1.1" - } - }, - "node_modules/eslint-module-utils/node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true - }, - "node_modules/eslint-plugin-import": { - "version": "2.23.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.23.4.tgz", - "integrity": "sha512-6/wP8zZRsnQFiR3iaPFgh5ImVRM1WN5NUWfTIRqwOdeiGJlBcSk82o1FEVq8yXmy4lkIzTo7YhHCIxlU/2HyEQ==", - "dev": true, - "dependencies": { - "array-includes": "^3.1.3", - "array.prototype.flat": "^1.2.4", - "debug": "^2.6.9", - "doctrine": "^2.1.0", - "eslint-import-resolver-node": "^0.3.4", - "eslint-module-utils": "^2.6.1", - "find-up": "^2.0.0", - "has": "^1.0.3", - "is-core-module": "^2.4.0", - "minimatch": "^3.0.4", - "object.values": "^1.1.3", - "pkg-up": "^2.0.0", - "read-pkg-up": "^3.0.0", - "resolve": "^1.20.0", - "tsconfig-paths": "^3.9.0" - }, - "engines": { - "node": ">=4" - }, - "peerDependencies": { - "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0" - } - }, - "node_modules/eslint-plugin-import/node_modules/doctrine": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", - "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", - "dev": true, - "dependencies": { - "esutils": "^2.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint-scope": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", - "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", - "dev": true, - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^4.1.1" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/eslint-utils": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", - "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", - "dev": true, - "dependencies": { - "eslint-visitor-keys": "^2.0.0" - }, - "engines": { - "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/mysticatea" - }, - "peerDependencies": { - "eslint": ">=5" - } - }, - "node_modules/eslint-visitor-keys": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", - "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", - "dev": true, - "engines": { - "node": ">=10" - } - }, - "node_modules/eslint/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/eslint/node_modules/eslint-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", - "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", - "dev": true, - "dependencies": { - "eslint-visitor-keys": "^1.1.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/mysticatea" - } - }, - "node_modules/eslint/node_modules/eslint-utils/node_modules/eslint-visitor-keys": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", - "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/eslint/node_modules/ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true, - "engines": { - "node": ">= 4" - } - }, - "node_modules/eslint/node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "node_modules/eslint/node_modules/semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/espree": { - "version": "7.3.1", - "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", - "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", - "dev": true, - "dependencies": { - "acorn": "^7.4.0", - "acorn-jsx": "^5.3.1", - "eslint-visitor-keys": "^1.3.0" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - } - }, - "node_modules/espree/node_modules/eslint-visitor-keys": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", - "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/esprima": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", - "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", - "dev": true, - "bin": { - "esparse": "bin/esparse.js", - "esvalidate": "bin/esvalidate.js" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/esquery": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", - "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", - "dev": true, - "dependencies": { - "estraverse": "^5.1.0" - }, - "engines": { - "node": ">=0.10" - } - }, - "node_modules/esquery/node_modules/estraverse": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", - "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", - "dev": true, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esrecurse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", - "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "dev": true, - "dependencies": { - "estraverse": "^5.2.0" - }, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esrecurse/node_modules/estraverse": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", - "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", - "dev": true, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/estraverse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", - "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", - "dev": true, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esutils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/factory.ts": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/factory.ts/-/factory.ts-0.5.2.tgz", - "integrity": "sha512-I4YDKuyMW+s2PocnWh/Ekv9wSStt/MNN1ZRb1qhy0Kv056ndlzbLHDsW9KEmTAqMpLI3BtjSqEdZ7ZfdnaXn9w==", - "dependencies": { - "clone-deep": "^4.0.1", - "source-map-support": "^0.5.19" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/faker": { - "version": "5.5.3", - "resolved": "https://registry.npmjs.org/faker/-/faker-5.5.3.tgz", - "integrity": "sha512-wLTv2a28wjUyWkbnX7u/ABZBkUkIF2fCd73V6P2oFqEGEktDfzWx4UxrSqtPRw0xPRAcjeAOIiJWqZm3pP4u3g==" - }, - "node_modules/fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true - }, - "node_modules/fast-glob": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.5.tgz", - "integrity": "sha512-2DtFcgT68wiTTiwZ2hNdJfcHNke9XOfnwmBRWXhmeKM8rF0TGwmC/Qto3S7RoZKp5cilZbxzO5iTNTQsJ+EeDg==", - "dev": true, - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.0", - "merge2": "^1.3.0", - "micromatch": "^4.0.2", - "picomatch": "^2.2.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true - }, - "node_modules/fast-levenshtein": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", - "dev": true - }, - "node_modules/fastq": { - "version": "1.11.0", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.11.0.tgz", - "integrity": "sha512-7Eczs8gIPDrVzT+EksYBcupqMyxSHXXrHOLRRxU2/DicV8789MRBRR8+Hc2uWzUupOs4YS4JzBmBxjjCVBxD/g==", - "dev": true, - "dependencies": { - "reusify": "^1.0.4" - } - }, - "node_modules/file-entry-cache": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", - "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", - "dev": true, - "dependencies": { - "flat-cache": "^3.0.4" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - } - }, - "node_modules/file-set": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/file-set/-/file-set-3.0.0.tgz", - "integrity": "sha512-B/SdeSIeRv7VlOgIjtH3dkxMI+tEy5m+OeCXfAUsirBoVoY+bGtsmvmmTFPm/G23TBY4RiTtjpcgePCfwXRjqA==", - "dev": true, - "dependencies": { - "array-back": "^4.0.0", - "glob": "^7.1.5" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/fill-keys": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/fill-keys/-/fill-keys-1.0.2.tgz", - "integrity": "sha1-mo+jb06K1jTjv2tPPIiCVRRS6yA=", - "dev": true, - "dependencies": { - "is-object": "~1.0.1", - "merge-descriptors": "~1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "dev": true, - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/find-replace": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-3.0.0.tgz", - "integrity": "sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ==", - "dev": true, - "dependencies": { - "array-back": "^3.0.1" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/find-replace/node_modules/array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dev": true, - "dependencies": { - "locate-path": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/flat": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.1.tgz", - "integrity": "sha512-FmTtBsHskrU6FJ2VxCnsDb84wu9zhmO3cUX2kGFb5tuwhfXxGciiT0oRY+cck35QmG+NmGh5eLz6lLCpWTqwpA==", - "dev": true, - "dependencies": { - "is-buffer": "~2.0.3" - }, - "bin": { - "flat": "cli.js" - } - }, - "node_modules/flat-cache": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", - "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", - "dev": true, - "dependencies": { - "flatted": "^3.1.0", - "rimraf": "^3.0.2" - }, - "engines": { - "node": "^10.12.0 || >=12.0.0" - } - }, - "node_modules/flatted": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.1.1.tgz", - "integrity": "sha512-zAoAQiudy+r5SvnSw3KJy5os/oRJYHzrzja/tBDqrZtNhUw8bt6y8OBzMWcjWr+8liV8Eb6yOhw8WZ7VFZ5ZzA==", - "dev": true - }, - "node_modules/follow-redirects": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.1.tgz", - "integrity": "sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg==", - "funding": [ - { - "type": "individual", - "url": "https://github.com/sponsors/RubenVerborgh" - } - ], - "engines": { - "node": ">=4.0" - }, - "peerDependenciesMeta": { - "debug": { - "optional": true - } - } - }, - "node_modules/fs-extra": { - "version": "9.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", - "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", - "dev": true, - "dependencies": { - "at-least-node": "^1.0.0", - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/fs-then-native": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fs-then-native/-/fs-then-native-2.0.0.tgz", - "integrity": "sha1-GaEk2U2QwiyOBF8ujdbr6jbUjGc=", - "dev": true, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/fs.realpath": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", - "dev": true - }, - "node_modules/function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" - }, - "node_modules/functional-red-black-tree": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", - "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", - "dev": true - }, - "node_modules/get-caller-file": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", - "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", - "dev": true, - "engines": { - "node": "6.* || 8.* || >= 10.*" - } - }, - "node_modules/get-func-name": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", - "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", - "dev": true, - "engines": { - "node": "*" - } - }, - "node_modules/get-intrinsic": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", - "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", - "dependencies": { - "function-bind": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/glob": { - "version": "7.1.7", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.7.tgz", - "integrity": "sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ==", - "dev": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/globals": { - "version": "13.9.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.9.0.tgz", - "integrity": "sha512-74/FduwI/JaIrr1H8e71UbDE+5x7pIPs1C2rrwC52SszOo043CsWOZEMW7o2Y58xwm9b+0RBKDxY5n2sUpEFxA==", - "dev": true, - "dependencies": { - "type-fest": "^0.20.2" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/globby": { - "version": "11.0.3", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", - "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==", - "dev": true, - "dependencies": { - "array-union": "^2.1.0", - "dir-glob": "^3.0.1", - "fast-glob": "^3.1.1", - "ignore": "^5.1.4", - "merge2": "^1.3.0", - "slash": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/graceful-fs": { - "version": "4.2.6", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.6.tgz", - "integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ==", - "dev": true - }, - "node_modules/growl": { - "version": "1.10.5", - "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", - "integrity": "sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==", - "dev": true, - "engines": { - "node": ">=4.x" - } - }, - "node_modules/handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "dependencies": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "wordwrap": "^1.0.0" - }, - "bin": { - "handlebars": "bin/handlebars" - }, - "engines": { - "node": ">=0.4.7" - }, - "optionalDependencies": { - "uglify-js": "^3.1.4" - } - }, - "node_modules/has": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", - "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", - "dependencies": { - "function-bind": "^1.1.1" - }, - "engines": { - "node": ">= 0.4.0" - } - }, - "node_modules/has-bigints": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", - "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", - "dev": true, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/has-flag": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", - "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/has-symbols": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/he": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", - "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", - "dev": true, - "bin": { - "he": "bin/he" - } - }, - "node_modules/hosted-git-info": { - "version": "2.8.9", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", - "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", - "dev": true - }, - "node_modules/http-errors": { - "version": "1.7.2", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.7.2.tgz", - "integrity": "sha512-uUQBt3H/cSIVfch6i1EuPNy/YsRSOUBXTVfZ+yR7Zjez3qjBz6i9+i4zjNaoqcoFVI4lQJ5plg63TvGfRSDCRg==", - "dependencies": { - "depd": "~1.1.2", - "inherits": "2.0.3", - "setprototypeof": "1.1.1", - "statuses": ">= 1.5.0 < 2", - "toidentifier": "1.0.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/ignore": { - "version": "5.1.8", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", - "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", - "dev": true, - "engines": { - "node": ">= 4" - } - }, - "node_modules/import-fresh": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", - "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", - "dev": true, - "dependencies": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", - "dev": true, - "engines": { - "node": ">=0.8.19" - } - }, - "node_modules/inflight": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", - "dev": true, - "dependencies": { - "once": "^1.3.0", - "wrappy": "1" - } - }, - "node_modules/inherits": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", - "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" - }, - "node_modules/interpret": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", - "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", - "dev": true, - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/is-arrayish": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", - "dev": true - }, - "node_modules/is-bigint": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", - "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", - "dev": true, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-boolean-object": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", - "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-buffer": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz", - "integrity": "sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "engines": { - "node": ">=4" - } - }, - "node_modules/is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-core-module": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.4.0.tgz", - "integrity": "sha512-6A2fkfq1rfeQZjxrZJGerpLCTHRNEBiSgnu0+obeJpEPZRUooHgsizvzv0ZjJwOz3iWIHdJtVWJ/tmPr3D21/A==", - "dev": true, - "dependencies": { - "has": "^1.0.3" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-date-object": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.4.tgz", - "integrity": "sha512-/b4ZVsG7Z5XVtIxs/h9W8nvfLgSAyKYdtGWQLbqy6jA1icmgjf8WCoTKgeS4wy5tYaPePouzFMANbnj94c2Z+A==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/is-glob": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", - "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", - "dev": true, - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-negative-zero": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.1.tgz", - "integrity": "sha512-2z6JzQvZRa9A2Y7xC6dQQm4FSTSTNWjKIYYTt4246eMTJmIo0Q+ZyOsU66X8lxK1AbB92dFeglPLrhwpeRKO6w==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/is-number-object": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", - "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-object": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.2.tgz", - "integrity": "sha512-2rRIahhZr2UWb45fIOuvZGpFtz0TyOZLf32KxBbSoUCeZR495zCKlWUKKUByk3geS2eAs7ZAABt0Y/Rx0GiQGA==", - "dev": true, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "dependencies": { - "isobject": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-string": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", - "integrity": "sha512-2gdzbKUuqtQ3lYNrUTQYoClPhm7oQu4UdpSZMp1/DGgkHBT8E2Z1l0yMdb6D4zNAxwDiMv8MdulKROJGNl0Q0w==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-symbol": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", - "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", - "dev": true, - "dependencies": { - "has-symbols": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", - "dev": true - }, - "node_modules/isobject": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", - "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/js-tokens": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", - "dev": true - }, - "node_modules/js-yaml": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", - "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", - "dev": true, - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/js2xmlparser": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz", - "integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==", - "dev": true, - "dependencies": { - "xmlcreate": "^2.0.3" - } - }, - "node_modules/jsdoc": { - "version": "3.6.7", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.7.tgz", - "integrity": "sha512-sxKt7h0vzCd+3Y81Ey2qinupL6DpRSZJclS04ugHDNmRUXGzqicMJ6iwayhSA0S0DwwX30c5ozyUthr1QKF6uw==", - "dev": true, - "dependencies": { - "@babel/parser": "^7.9.4", - "bluebird": "^3.7.2", - "catharsis": "^0.9.0", - "escape-string-regexp": "^2.0.0", - "js2xmlparser": "^4.0.1", - "klaw": "^3.0.0", - "markdown-it": "^10.0.0", - "markdown-it-anchor": "^5.2.7", - "marked": "^2.0.3", - "mkdirp": "^1.0.4", - "requizzle": "^0.2.3", - "strip-json-comments": "^3.1.0", - "taffydb": "2.6.2", - "underscore": "~1.13.1" - }, - "bin": { - "jsdoc": "jsdoc.js" - }, - "engines": { - "node": ">=8.15.0" - } - }, - "node_modules/jsdoc-api": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-5.0.4.tgz", - "integrity": "sha512-1KMwLnfo0FyhF06TQKzqIm8BiY1yoMIGICxRdJHUjzskaHMzHMmpLlmNFgzoa4pAC8t1CDPK5jWuQTvv1pBsEQ==", - "dev": true, - "dependencies": { - "array-back": "^4.0.0", - "cache-point": "^1.0.0", - "collect-all": "^1.0.3", - "file-set": "^2.0.1", - "fs-then-native": "^2.0.0", - "jsdoc": "^3.6.3", - "object-to-spawn-args": "^1.1.1", - "temp-path": "^1.0.0", - "walk-back": "^3.0.1" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/jsdoc-api/node_modules/file-set": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz", - "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==", - "dev": true, - "dependencies": { - "array-back": "^2.0.0", - "glob": "^7.1.3" - } - }, - "node_modules/jsdoc-api/node_modules/file-set/node_modules/array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "dependencies": { - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/jsdoc-api/node_modules/walk-back": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.1.tgz", - "integrity": "sha512-umiNB2qLO731Sxbp6cfZ9pwURJzTnftxE4Gc7hq8n/ehkuXC//s9F65IEIJA2ZytQZ1ZOsm/Fju4IWx0bivkUQ==", - "dev": true, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/jsdoc-parse": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-4.0.1.tgz", - "integrity": "sha512-qIObw8yqYZjrP2qxWROB5eLQFLTUX2jRGLhW9hjo2CC2fQVlskidCIzjCoctwsDvauBp2a/lR31jkSleczSo8Q==", - "dev": true, - "dependencies": { - "array-back": "^4.0.0", - "lodash.omit": "^4.5.0", - "lodash.pick": "^4.4.0", - "reduce-extract": "^1.0.0", - "sort-array": "^2.0.0", - "test-value": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/jsdoc-to-markdown": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-5.0.3.tgz", - "integrity": "sha512-tQv5tBV0fTYidRQtE60lJKxE98mmuLcYuITFDKQiDPE9hGccpeEGUNFcVkInq1vigyuPnZmt79bQ8wv2GKjY0Q==", - "dev": true, - "dependencies": { - "array-back": "^4.0.1", - "command-line-tool": "^0.8.0", - "config-master": "^3.1.0", - "dmd": "^4.0.5", - "jsdoc-api": "^5.0.4", - "jsdoc-parse": "^4.0.1", - "walk-back": "^4.0.0" - }, - "bin": { - "jsdoc2md": "bin/cli.js" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/jsdoc/node_modules/escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/jsdoc/node_modules/marked": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", - "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", - "dev": true, - "bin": { - "marked": "bin/marked" - }, - "engines": { - "node": ">= 8.16.2" - } - }, - "node_modules/json-parse-better-errors": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", - "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", - "dev": true - }, - "node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true - }, - "node_modules/json-stable-stringify-without-jsonify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", - "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", - "dev": true - }, - "node_modules/json5": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", - "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", - "dev": true, - "dependencies": { - "minimist": "^1.2.0" - }, - "bin": { - "json5": "lib/cli.js" - } - }, - "node_modules/jsonfile": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", - "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", - "dev": true, - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } - }, - "node_modules/jsonwebtoken": { - "version": "8.5.1", - "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", - "integrity": "sha512-XjwVfRS6jTMsqYs0EsuJ4LGxXV14zQybNd4L2r0UvbVnSF9Af8x7p5MzbJ90Ioz/9TI41/hTCvznF/loiSzn8w==", - "dependencies": { - "jws": "^3.2.2", - "lodash.includes": "^4.3.0", - "lodash.isboolean": "^3.0.3", - "lodash.isinteger": "^4.0.4", - "lodash.isnumber": "^3.0.3", - "lodash.isplainobject": "^4.0.6", - "lodash.isstring": "^4.0.1", - "lodash.once": "^4.0.0", - "ms": "^2.1.1", - "semver": "^5.6.0" - }, - "engines": { - "node": ">=4", - "npm": ">=1.4.28" - } - }, - "node_modules/jsonwebtoken/node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" - }, - "node_modules/just-extend": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", - "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", - "dev": true - }, - "node_modules/jwa": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.4.1.tgz", - "integrity": "sha512-qiLX/xhEEFKUAJ6FiBMbes3w9ATzyk5W7Hvzpa/SLYdxNtng+gcurvrI7TbACjIXlsJyr05/S1oUhZrc63evQA==", - "dependencies": { - "buffer-equal-constant-time": "1.0.1", - "ecdsa-sig-formatter": "1.0.11", - "safe-buffer": "^5.0.1" - } - }, - "node_modules/jws": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/jws/-/jws-3.2.2.tgz", - "integrity": "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA==", - "dependencies": { - "jwa": "^1.4.1", - "safe-buffer": "^5.0.1" - } - }, - "node_modules/kind-of": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", - "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/klaw": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", - "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==", - "dev": true, - "dependencies": { - "graceful-fs": "^4.1.9" - } - }, - "node_modules/levn": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", - "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", - "dev": true, - "dependencies": { - "prelude-ls": "^1.2.1", - "type-check": "~0.4.0" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/linkify-it": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz", - "integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==", - "dev": true, - "dependencies": { - "uc.micro": "^1.0.1" - } - }, - "node_modules/load-json-file": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", - "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", - "dev": true, - "dependencies": { - "graceful-fs": "^4.1.2", - "parse-json": "^4.0.0", - "pify": "^3.0.0", - "strip-bom": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dev": true, - "dependencies": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "dev": true - }, - "node_modules/lodash.camelcase": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", - "integrity": "sha1-soqmKIorn8ZRA1x3EfZathkDMaY=", - "dev": true - }, - "node_modules/lodash.clonedeep": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", - "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", - "dev": true - }, - "node_modules/lodash.includes": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", - "integrity": "sha1-YLuYqHy5I8aMoeUTJUgzFISfVT8=" - }, - "node_modules/lodash.isboolean": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/lodash.isboolean/-/lodash.isboolean-3.0.3.tgz", - "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=" - }, - "node_modules/lodash.isinteger": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", - "integrity": "sha1-YZwK89A/iwTDH1iChAt3sRzWg0M=" - }, - "node_modules/lodash.ismatch": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz", - "integrity": "sha1-dWy1FQyjum8RCFp4hJZF8Yj4Xzc=" - }, - "node_modules/lodash.isnumber": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/lodash.isnumber/-/lodash.isnumber-3.0.3.tgz", - "integrity": "sha1-POdoEMWSjQM1IwGsKHMX8RwLH/w=" - }, - "node_modules/lodash.isplainobject": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/lodash.isplainobject/-/lodash.isplainobject-4.0.6.tgz", - "integrity": "sha1-fFJqUtibRcRcxpC4gWO+BJf1UMs=" - }, - "node_modules/lodash.isstring": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/lodash.isstring/-/lodash.isstring-4.0.1.tgz", - "integrity": "sha1-1SfftUVuynzJu5XV2ur4i6VKVFE=" - }, - "node_modules/lodash.merge": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", - "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true - }, - "node_modules/lodash.omit": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz", - "integrity": "sha1-brGa5aHuHdnfC5aeZs4Lf6MLXmA=", - "dev": true - }, - "node_modules/lodash.once": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz", - "integrity": "sha1-DdOXEhPHxW34gJd9UEyI+0cal6w=" - }, - "node_modules/lodash.padend": { - "version": "4.6.1", - "resolved": "https://registry.npmjs.org/lodash.padend/-/lodash.padend-4.6.1.tgz", - "integrity": "sha1-U8y6BH0G4VjTEfRdpiX05J5vFm4=", - "dev": true - }, - "node_modules/lodash.pick": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz", - "integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=", - "dev": true - }, - "node_modules/lodash.truncate": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", - "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", - "dev": true - }, - "node_modules/log-symbols": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", - "integrity": "sha512-VeIAFslyIerEJLXHziedo2basKbMKtTw3vfn5IzG0XTjhAVEJyNHnL2p7vc+wBDSdQuUpNw3M2u6xb9QsAY5Eg==", - "dev": true, - "dependencies": { - "chalk": "^2.0.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/log-symbols/node_modules/chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "dependencies": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/log-symbols/node_modules/escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/lolex": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/lolex/-/lolex-4.2.0.tgz", - "integrity": "sha512-gKO5uExCXvSm6zbF562EvM+rd1kQDnB9AZBbiQVzf1ZmdDpxUSvpnAaVOP83N/31mRK8Ml8/VE8DMvsAZQ+7wg==", - "dev": true - }, - "node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/lunr": { - "version": "2.3.9", - "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", - "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true - }, - "node_modules/luxon": { - "version": "1.27.0", - "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.27.0.tgz", - "integrity": "sha512-VKsFsPggTA0DvnxtJdiExAucKdAnwbCCNlMM5ENvHlxubqWd0xhZcdb4XgZ7QFNhaRhilXCFxHuoObP5BNA4PA==", - "engines": { - "node": "*" - } - }, - "node_modules/markdown-it": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", - "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==", - "dev": true, - "dependencies": { - "argparse": "^1.0.7", - "entities": "~2.0.0", - "linkify-it": "^2.0.0", - "mdurl": "^1.0.1", - "uc.micro": "^1.0.5" - }, - "bin": { - "markdown-it": "bin/markdown-it.js" - } - }, - "node_modules/markdown-it-anchor": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", - "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", - "dev": true, - "peerDependencies": { - "markdown-it": "*" - } - }, - "node_modules/marked": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", - "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", - "dev": true, - "bin": { - "marked": "bin/marked" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/mdurl": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", - "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", - "dev": true - }, - "node_modules/media-typer": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", - "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/merge-descriptors": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", - "integrity": "sha1-sAqqVW3YtEVoFQ7J0blT8/kMu2E=", - "dev": true - }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true, - "engines": { - "node": ">= 8" - } - }, - "node_modules/micromatch": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", - "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", - "dev": true, - "dependencies": { - "braces": "^3.0.1", - "picomatch": "^2.2.3" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/mime-db": { - "version": "1.48.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.48.0.tgz", - "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/mime-types": { - "version": "2.1.31", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.31.tgz", - "integrity": "sha512-XGZnNzm3QvgKxa8dpzyhFTHmpP3l5YNusmne07VUOXxou9CqUqYa/HBy124RqtVh/O2pECas/MOcsDgpilPOPg==", - "dependencies": { - "mime-db": "1.48.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/minimatch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", - "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", - "dev": true, - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - }, - "node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/mkdirp2": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp2/-/mkdirp2-1.0.4.tgz", - "integrity": "sha512-Q2PKB4ZR4UPtjLl76JfzlgSCUZhSV1AXQgAZa1qt5RiaALFjP/CDrGvFBrOz7Ck6McPcwMAxTsJvWOUjOU8XMw==", - "dev": true - }, - "node_modules/mocha": { - "version": "6.2.3", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.3.tgz", - "integrity": "sha512-0R/3FvjIGH3eEuG17ccFPk117XL2rWxatr81a57D+r/x2uTYZRbdZ4oVidEUMh2W2TJDa7MdAb12Lm2/qrKajg==", - "dev": true, - "dependencies": { - "ansi-colors": "3.2.3", - "browser-stdout": "1.3.1", - "debug": "3.2.6", - "diff": "3.5.0", - "escape-string-regexp": "1.0.5", - "find-up": "3.0.0", - "glob": "7.1.3", - "growl": "1.10.5", - "he": "1.2.0", - "js-yaml": "3.13.1", - "log-symbols": "2.2.0", - "minimatch": "3.0.4", - "mkdirp": "0.5.4", - "ms": "2.1.1", - "node-environment-flags": "1.0.5", - "object.assign": "4.1.0", - "strip-json-comments": "2.0.1", - "supports-color": "6.0.0", - "which": "1.3.1", - "wide-align": "1.1.3", - "yargs": "13.3.2", - "yargs-parser": "13.1.2", - "yargs-unparser": "1.6.0" - }, - "bin": { - "_mocha": "bin/_mocha", - "mocha": "bin/mocha" - }, - "engines": { - "node": ">= 6.0.0" - } - }, - "node_modules/mocha/node_modules/ansi-colors": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", - "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/mocha/node_modules/debug": { - "version": "3.2.6", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", - "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", - "deprecated": "Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)", - "dev": true, - "dependencies": { - "ms": "^2.1.1" - } - }, - "node_modules/mocha/node_modules/escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/mocha/node_modules/find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "dependencies": { - "locate-path": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/mocha/node_modules/glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", - "dev": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - } - }, - "node_modules/mocha/node_modules/js-yaml": { - "version": "3.13.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", - "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", - "dev": true, - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/mocha/node_modules/locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "dependencies": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/mocha/node_modules/mkdirp": { - "version": "0.5.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.4.tgz", - "integrity": "sha512-iG9AK/dJLtJ0XNgTuDbSyNS3zECqDlAhnQW4CsNxBG3LQJBbHmRX1egw39DmtOdCAqY+dKXV+sgPgilNWUKMVw==", - "deprecated": "Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)", - "dev": true, - "dependencies": { - "minimist": "^1.2.5" - }, - "bin": { - "mkdirp": "bin/cmd.js" - } - }, - "node_modules/mocha/node_modules/ms": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", - "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", - "dev": true - }, - "node_modules/mocha/node_modules/object.assign": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", - "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", - "dev": true, - "dependencies": { - "define-properties": "^1.1.2", - "function-bind": "^1.1.1", - "has-symbols": "^1.0.0", - "object-keys": "^1.0.11" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/mocha/node_modules/p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "dev": true, - "dependencies": { - "p-try": "^2.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/mocha/node_modules/p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "dependencies": { - "p-limit": "^2.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/mocha/node_modules/p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/mocha/node_modules/strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/mocha/node_modules/supports-color": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", - "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", - "dev": true, - "dependencies": { - "has-flag": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/mocha/node_modules/which": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", - "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", - "dev": true, - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "which": "bin/which" - } - }, - "node_modules/module-not-found-error": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/module-not-found-error/-/module-not-found-error-1.0.1.tgz", - "integrity": "sha1-z4tP9PKWQGdNbN0CsOO8UjwrvcA=", - "dev": true - }, - "node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" - }, - "node_modules/natural-compare": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", - "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", - "dev": true - }, - "node_modules/neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true - }, - "node_modules/nise": { - "version": "1.5.3", - "resolved": "https://registry.npmjs.org/nise/-/nise-1.5.3.tgz", - "integrity": "sha512-Ymbac/94xeIrMf59REBPOv0thr+CJVFMhrlAkW/gjCIE58BGQdCj0x7KRCb3yz+Ga2Rz3E9XXSvUyyxqqhjQAQ==", - "dev": true, - "dependencies": { - "@sinonjs/formatio": "^3.2.1", - "@sinonjs/text-encoding": "^0.7.1", - "just-extend": "^4.0.2", - "lolex": "^5.0.1", - "path-to-regexp": "^1.7.0" - } - }, - "node_modules/nise/node_modules/lolex": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/lolex/-/lolex-5.1.2.tgz", - "integrity": "sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A==", - "dev": true, - "dependencies": { - "@sinonjs/commons": "^1.7.0" - } - }, - "node_modules/node-environment-flags": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz", - "integrity": "sha512-VNYPRfGfmZLx0Ye20jWzHUjyTW/c+6Wq+iLhDzUI4XmhrDd9l/FozXV3F2xOaXjvp0co0+v1YSR3CMP6g+VvLQ==", - "dev": true, - "dependencies": { - "object.getownpropertydescriptors": "^2.0.3", - "semver": "^5.7.0" - } - }, - "node_modules/normalize-package-data": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", - "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", - "dev": true, - "dependencies": { - "hosted-git-info": "^2.1.4", - "resolve": "^1.10.0", - "semver": "2 || 3 || 4 || 5", - "validate-npm-package-license": "^3.0.1" - } - }, - "node_modules/object-get": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.1.tgz", - "integrity": "sha512-7n4IpLMzGGcLEMiQKsNR7vCe+N5E9LORFrtNUVy4sO3dj9a3HedZCxEL2T7QuLhcHN1NBuBsMOKaOsAYI9IIvg==", - "dev": true - }, - "node_modules/object-inspect": { - "version": "1.10.3", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.10.3.tgz", - "integrity": "sha512-e5mCJlSH7poANfC8z8S9s9S2IN5/4Zb3aZ33f5s8YqoazCFzNLloLU8r5VCG+G7WoqLvAAZoVMcy3tp/3X0Plw==", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/object-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", - "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "dev": true, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/object-to-spawn-args": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-to-spawn-args/-/object-to-spawn-args-1.1.1.tgz", - "integrity": "sha1-d9qIJ/Bz0BHJ4bFz+JV4FHAkZ4U=", - "dev": true - }, - "node_modules/object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/object.entries": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", - "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/object.getownpropertydescriptors": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.2.tgz", - "integrity": "sha512-WtxeKSzfBjlzL+F9b7M7hewDzMwy+C8NRssHd1YrNlzHzIDrXcXiNOMrezdAEM4UXixgV+vvnyBeN7Rygl2ttQ==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.0-next.2" - }, - "engines": { - "node": ">= 0.8" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/object.values": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.4.tgz", - "integrity": "sha512-TnGo7j4XSnKQoK3MfvkzqKCi0nVe/D9I9IjwTNYdb/fxYHpjrluHVOgw0AF6jrRFGMPHdfuidR09tIDiIvnaSg==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/on-finished": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", - "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", - "dependencies": { - "ee-first": "1.1.1" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", - "dev": true, - "dependencies": { - "wrappy": "1" - } - }, - "node_modules/onigasm": { - "version": "2.2.5", - "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", - "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", - "dev": true, - "dependencies": { - "lru-cache": "^5.1.1" - } - }, - "node_modules/onigasm/node_modules/lru-cache": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", - "dev": true, - "dependencies": { - "yallist": "^3.0.2" - } - }, - "node_modules/onigasm/node_modules/yallist": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", - "dev": true - }, - "node_modules/optionator": { - "version": "0.9.1", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", - "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", - "dev": true, - "dependencies": { - "deep-is": "^0.1.3", - "fast-levenshtein": "^2.0.6", - "levn": "^0.4.1", - "prelude-ls": "^1.2.1", - "type-check": "^0.4.0", - "word-wrap": "^1.2.3" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "dev": true, - "dependencies": { - "p-try": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dev": true, - "dependencies": { - "p-limit": "^1.1.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", - "dev": true, - "dependencies": { - "callsites": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/parse-json": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", - "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", - "dev": true, - "dependencies": { - "error-ex": "^1.3.1", - "json-parse-better-errors": "^1.0.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/path-is-absolute": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/path-parse": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", - "dev": true - }, - "node_modules/path-to-regexp": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", - "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", - "dev": true, - "dependencies": { - "isarray": "0.0.1" - } - }, - "node_modules/path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/pathval": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", - "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", - "dev": true, - "engines": { - "node": "*" - } - }, - "node_modules/picomatch": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", - "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", - "dev": true, - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/pify": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", - "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/pkg-dir": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-2.0.0.tgz", - "integrity": "sha1-9tXREJ4Z1j7fQo4L1X4Sd3YVM0s=", - "dev": true, - "dependencies": { - "find-up": "^2.1.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/pkg-up": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/pkg-up/-/pkg-up-2.0.0.tgz", - "integrity": "sha1-yBmscoBZpGHKscOImivjxJoATX8=", - "dev": true, - "dependencies": { - "find-up": "^2.1.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/prelude-ls": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", - "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", - "dev": true, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/progress": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", - "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", - "dev": true, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/proxyquire": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/proxyquire/-/proxyquire-2.1.3.tgz", - "integrity": "sha512-BQWfCqYM+QINd+yawJz23tbBM40VIGXOdDw3X344KcclI/gtBbdWF6SlQ4nK/bYhF9d27KYug9WzljHC6B9Ysg==", - "dev": true, - "dependencies": { - "fill-keys": "^1.0.2", - "module-not-found-error": "^1.0.1", - "resolve": "^1.11.1" - } - }, - "node_modules/punycode": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/qs": { - "version": "6.10.1", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.10.1.tgz", - "integrity": "sha512-M528Hph6wsSVOBiYUnGf+K/7w0hNshs/duGsNXPUCLH5XAqjEtiPGwNONLV0tBH8NoGb0mvD5JubnUTrujKDTg==", - "dependencies": { - "side-channel": "^1.0.4" - }, - "engines": { - "node": ">=0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/queue-microtask": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ] - }, - "node_modules/raw-body": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.4.0.tgz", - "integrity": "sha512-4Oz8DUIwdvoa5qMJelxipzi/iJIi40O5cGV1wNYp5hvZP8ZN0T+jiNkL0QepXs+EsQ9XJ8ipEDoiH70ySUJP3Q==", - "dependencies": { - "bytes": "3.1.0", - "http-errors": "1.7.2", - "iconv-lite": "0.4.24", - "unpipe": "1.0.0" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/read-pkg": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", - "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", - "dev": true, - "dependencies": { - "load-json-file": "^4.0.0", - "normalize-package-data": "^2.3.2", - "path-type": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/read-pkg-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", - "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", - "dev": true, - "dependencies": { - "find-up": "^2.0.0", - "read-pkg": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/read-pkg/node_modules/path-type": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", - "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", - "dev": true, - "dependencies": { - "pify": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/rechoir": { - "version": "0.6.2", - "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", - "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", - "dev": true, - "dependencies": { - "resolve": "^1.1.6" - }, - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/reduce-extract": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz", - "integrity": "sha1-Z/I4W+2mUGG19fQxJmLosIDKFSU=", - "dev": true, - "dependencies": { - "test-value": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/reduce-extract/node_modules/array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "dependencies": { - "typical": "^2.6.0" - }, - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/reduce-extract/node_modules/test-value": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz", - "integrity": "sha1-oJE29y7AQ9J8iTcHwrFZv6196T8=", - "dev": true, - "dependencies": { - "array-back": "^1.0.2", - "typical": "^2.4.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/reduce-flatten": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-1.0.1.tgz", - "integrity": "sha1-JYx479FT3fk8tWEjf2EYTzaW4yc=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/reduce-unique": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/reduce-unique/-/reduce-unique-2.0.1.tgz", - "integrity": "sha512-x4jH/8L1eyZGR785WY+ePtyMNhycl1N2XOLxhCbzZFaqF4AXjLzqSxa2UHgJ2ZVR/HHyPOvl1L7xRnW8ye5MdA==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/reduce-without": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/reduce-without/-/reduce-without-1.0.1.tgz", - "integrity": "sha1-aK0OrRGFXJo31OglbBW7+Hly/Iw=", - "dev": true, - "dependencies": { - "test-value": "^2.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/reduce-without/node_modules/array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "dependencies": { - "typical": "^2.6.0" - }, - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/reduce-without/node_modules/test-value": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz", - "integrity": "sha1-Edpv9nDzRxpztiXKTz/c97t0gpE=", - "dev": true, - "dependencies": { - "array-back": "^1.0.3", - "typical": "^2.6.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/regexpp": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.1.0.tgz", - "integrity": "sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q==", - "dev": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/mysticatea" - } - }, - "node_modules/require-directory": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", - "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-from-string": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-main-filename": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", - "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", - "dev": true - }, - "node_modules/requizzle": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz", - "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==", - "dev": true, - "dependencies": { - "lodash": "^4.17.14" - } - }, - "node_modules/resolve": { - "version": "1.20.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", - "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", - "dev": true, - "dependencies": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/reusify": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dev": true, - "engines": { - "iojs": ">=1.0.0", - "node": ">=0.10.0" - } - }, - "node_modules/rimraf": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", - "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", - "dev": true, - "dependencies": { - "glob": "^7.1.3" - }, - "bin": { - "rimraf": "bin.js" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/run-parallel": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "dependencies": { - "queue-microtask": "^1.2.2" - } - }, - "node_modules/safe-buffer": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ] - }, - "node_modules/safer-buffer": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" - }, - "node_modules/semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "bin": { - "semver": "bin/semver" - } - }, - "node_modules/set-blocking": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", - "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", - "dev": true - }, - "node_modules/setprototypeof": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz", - "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==" - }, - "node_modules/shallow-clone": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", - "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", - "dependencies": { - "kind-of": "^6.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/shelljs": { - "version": "0.8.4", - "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz", - "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==", - "dev": true, - "dependencies": { - "glob": "^7.0.0", - "interpret": "^1.0.0", - "rechoir": "^0.6.2" - }, - "bin": { - "shjs": "bin/shjs" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/shiki": { - "version": "0.9.3", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz", - "integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==", - "dev": true, - "dependencies": { - "onigasm": "^2.2.5", - "vscode-textmate": "^5.2.0" - } - }, - "node_modules/side-channel": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", - "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", - "dependencies": { - "call-bind": "^1.0.0", - "get-intrinsic": "^1.0.2", - "object-inspect": "^1.9.0" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/sinon": { - "version": "7.5.0", - "resolved": "https://registry.npmjs.org/sinon/-/sinon-7.5.0.tgz", - "integrity": "sha512-AoD0oJWerp0/rY9czP/D6hDTTUYGpObhZjMpd7Cl/A6+j0xBE+ayL/ldfggkBXUs0IkvIiM1ljM8+WkOc5k78Q==", - "dev": true, - "dependencies": { - "@sinonjs/commons": "^1.4.0", - "@sinonjs/formatio": "^3.2.1", - "@sinonjs/samsam": "^3.3.3", - "diff": "^3.5.0", - "lolex": "^4.2.0", - "nise": "^1.5.2", - "supports-color": "^5.5.0" - } - }, - "node_modules/slash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/slice-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", - "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.0.0", - "astral-regex": "^2.0.0", - "is-fullwidth-code-point": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/slice-ansi?sponsor=1" - } - }, - "node_modules/slice-ansi/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/slice-ansi/node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/slice-ansi/node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - }, - "node_modules/sort-array": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/sort-array/-/sort-array-2.0.0.tgz", - "integrity": "sha1-OKnG2if9fRR7QuYFVPKBGHtN9HI=", - "dev": true, - "dependencies": { - "array-back": "^1.0.4", - "object-get": "^2.1.0", - "typical": "^2.6.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/sort-array/node_modules/array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "dependencies": { - "typical": "^2.6.0" - }, - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/source-map-support": { - "version": "0.5.19", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", - "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", - "dependencies": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, - "node_modules/spdx-correct": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", - "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", - "dev": true, - "dependencies": { - "spdx-expression-parse": "^3.0.0", - "spdx-license-ids": "^3.0.0" - } - }, - "node_modules/spdx-exceptions": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", - "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", - "dev": true - }, - "node_modules/spdx-expression-parse": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", - "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", - "dev": true, - "dependencies": { - "spdx-exceptions": "^2.1.0", - "spdx-license-ids": "^3.0.0" - } - }, - "node_modules/spdx-license-ids": { - "version": "3.0.9", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.9.tgz", - "integrity": "sha512-Ki212dKK4ogX+xDo4CtOZBVIwhsKBEfsEEcwmJfLQzirgc2jIWdzg40Unxz/HzEUqM1WFzVlQSMF9kZZ2HboLQ==", - "dev": true - }, - "node_modules/sprintf-js": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", - "dev": true - }, - "node_modules/statuses": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", - "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/stream-connect": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz", - "integrity": "sha1-GLyB8u2zW4tdmoAJIAqYUxRCipc=", - "dev": true, - "dependencies": { - "array-back": "^1.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/stream-connect/node_modules/array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "dependencies": { - "typical": "^2.6.0" - }, - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/stream-via": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/stream-via/-/stream-via-1.0.4.tgz", - "integrity": "sha512-DBp0lSvX5G9KGRDTkR/R+a29H+Wk2xItOF+MpZLLNDWbEV9tGPnqLPxHEYjmiz8xGtJHRIqmI+hCjmNzqoA4nQ==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/string-width": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.2.tgz", - "integrity": "sha512-XBJbT3N4JhVumXE0eoLU9DCjcaF92KLNqTmFCnG1pf8duUxFGwtP6AD6nkjw9a3IdiRtL3E2w3JDiE/xi3vOeA==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/string.prototype.trimend": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", - "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/string.prototype.trimstart": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", - "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/strip-ansi": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", - "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", - "dev": true, - "dependencies": { - "ansi-regex": "^5.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-bom": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", - "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/supports-color": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", - "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, - "dependencies": { - "has-flag": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/table": { - "version": "6.7.1", - "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", - "integrity": "sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg==", - "dev": true, - "dependencies": { - "ajv": "^8.0.1", - "lodash.clonedeep": "^4.5.0", - "lodash.truncate": "^4.4.2", - "slice-ansi": "^4.0.0", - "string-width": "^4.2.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10.0.0" - } - }, - "node_modules/table-layout": { - "version": "0.4.5", - "resolved": "https://registry.npmjs.org/table-layout/-/table-layout-0.4.5.tgz", - "integrity": "sha512-zTvf0mcggrGeTe/2jJ6ECkJHAQPIYEwDoqsiqBjI24mvRmQbInK5jq33fyypaCBxX08hMkfmdOqj6haT33EqWw==", - "dev": true, - "dependencies": { - "array-back": "^2.0.0", - "deep-extend": "~0.6.0", - "lodash.padend": "^4.6.1", - "typical": "^2.6.1", - "wordwrapjs": "^3.0.0" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/table-layout/node_modules/array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "dependencies": { - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/table/node_modules/ajv": { - "version": "8.6.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.0.tgz", - "integrity": "sha512-cnUG4NSBiM4YFBxgZIj/In3/6KX+rQ2l2YPRVcvAMQGWEPKuXoPIhxzwqh31jA3IPbI4qEOp/5ILI4ynioXsGQ==", - "dev": true, - "dependencies": { - "fast-deep-equal": "^3.1.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/table/node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "dev": true - }, - "node_modules/taffydb": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz", - "integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=", - "dev": true - }, - "node_modules/temp-path": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/temp-path/-/temp-path-1.0.0.tgz", - "integrity": "sha1-JLFUOXOrRCiW2a02fdnL2/r+kYs=", - "dev": true - }, - "node_modules/test-value": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/test-value/-/test-value-3.0.0.tgz", - "integrity": "sha512-sVACdAWcZkSU9x7AOmJo5TqE+GyNJknHaHsMrR6ZnhjVlVN9Yx6FjHrsKZ3BjIpPCT68zYesPWkakrNupwfOTQ==", - "dev": true, - "dependencies": { - "array-back": "^2.0.0", - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/test-value/node_modules/array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "dependencies": { - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/text-table": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", - "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", - "dev": true - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, - "node_modules/toidentifier": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", - "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==", - "engines": { - "node": ">=0.6" - } - }, - "node_modules/tsconfig-paths": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", - "integrity": "sha512-dRcuzokWhajtZWkQsDVKbWyY+jgcLC5sqJhg2PSgf4ZkH2aHPvaOY8YWGhmjb68b5qqTfasSsDO9k7RUiEmZAw==", - "dev": true, - "dependencies": { - "@types/json5": "^0.0.29", - "json5": "^1.0.1", - "minimist": "^1.2.0", - "strip-bom": "^3.0.0" - } - }, - "node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true - }, - "node_modules/tsutils": { - "version": "3.21.0", - "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", - "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", - "dev": true, - "dependencies": { - "tslib": "^1.8.1" - }, - "engines": { - "node": ">= 6" - }, - "peerDependencies": { - "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" - } - }, - "node_modules/type-check": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", - "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", - "dev": true, - "dependencies": { - "prelude-ls": "^1.2.1" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/type-detect": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", - "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/type-is": { - "version": "1.6.18", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", - "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", - "dependencies": { - "media-typer": "0.3.0", - "mime-types": "~2.1.24" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/typedoc": { - "version": "0.20.36", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.36.tgz", - "integrity": "sha512-qFU+DWMV/hifQ9ZAlTjdFO9wbUIHuUBpNXzv68ZyURAP9pInjZiO4+jCPeAzHVcaBCHER9WL/+YzzTt6ZlN/Nw==", - "dev": true, - "dependencies": { - "colors": "^1.4.0", - "fs-extra": "^9.1.0", - "handlebars": "^4.7.7", - "lodash": "^4.17.21", - "lunr": "^2.3.9", - "marked": "^2.0.3", - "minimatch": "^3.0.0", - "progress": "^2.0.3", - "shelljs": "^0.8.4", - "shiki": "^0.9.3", - "typedoc-default-themes": "^0.12.10" - }, - "bin": { - "typedoc": "bin/typedoc" - }, - "engines": { - "node": ">= 10.8.0" - }, - "peerDependencies": { - "typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x" - } - }, - "node_modules/typedoc-default-themes": { - "version": "0.12.10", - "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", - "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", - "dev": true, - "engines": { - "node": ">= 8" - } - }, - "node_modules/typedoc-github-wiki-theme": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/typedoc-github-wiki-theme/-/typedoc-github-wiki-theme-0.3.0.tgz", - "integrity": "sha512-YMnpahBvsk0FlmHM3Djq+U25YZgiXSXdNzPRqu/mQY9QXHHzIKJmLm6r3Qz2U2NfD7xWyfoODpX/UY5Zz9434g==", - "dev": true, - "peerDependencies": { - "typedoc": ">=0.20.0", - "typedoc-plugin-markdown": ">=3.4.0" - } - }, - "node_modules/typedoc-plugin-markdown": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.9.0.tgz", - "integrity": "sha512-s445YeUe8bH7me15T+hsHZgNmAvvF7QIpX02vFgseLGtghAwmtdZYVOqPneWoKqRv/JNpPSuyZb3CeblML9jOg==", - "dev": true, - "dependencies": { - "handlebars": "^4.7.7" - }, - "engines": { - "node": ">= 10.8.0" - }, - "peerDependencies": { - "typedoc": ">=0.20.0" - } - }, - "node_modules/typedoc/node_modules/marked": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", - "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", - "dev": true, - "bin": { - "marked": "bin/marked" - }, - "engines": { - "node": ">= 8.16.2" - } - }, - "node_modules/typescript": { - "version": "4.2.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz", - "integrity": "sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==", - "dev": true, - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=4.2.0" - } - }, - "node_modules/typical": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz", - "integrity": "sha1-XAgOXWYcu+OCWdLnCjxyU+hziB0=", - "dev": true - }, - "node_modules/uc.micro": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", - "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", - "dev": true - }, - "node_modules/uglify-js": { - "version": "3.13.9", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.9.tgz", - "integrity": "sha512-wZbyTQ1w6Y7fHdt8sJnHfSIuWeDgk6B5rCb4E/AM6QNNPbOMIZph21PW5dRB3h7Df0GszN+t7RuUH6sWK5bF0g==", - "dev": true, - "optional": true, - "bin": { - "uglifyjs": "bin/uglifyjs" - }, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/unbox-primitive": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", - "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", - "dev": true, - "dependencies": { - "function-bind": "^1.1.1", - "has-bigints": "^1.0.1", - "has-symbols": "^1.0.2", - "which-boxed-primitive": "^1.0.2" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/underscore": { - "version": "1.13.1", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.1.tgz", - "integrity": "sha512-hzSoAVtJF+3ZtiFX0VgfFPHEDRm7Y/QPjGyNo4TVdnDTdft3tr8hEkD25a1jC+TjTuE7tkHGKkhwCgs9dgBB2g==", - "dev": true - }, - "node_modules/universalify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", - "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", - "dev": true, - "engines": { - "node": ">= 10.0.0" - } - }, - "node_modules/unpipe": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", - "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/uri-js": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, - "dependencies": { - "punycode": "^2.1.0" - } - }, - "node_modules/v8-compile-cache": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", - "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", - "dev": true - }, - "node_modules/validate-npm-package-license": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", - "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", - "dev": true, - "dependencies": { - "spdx-correct": "^3.0.0", - "spdx-expression-parse": "^3.0.0" - } - }, - "node_modules/vscode-textmate": { - "version": "5.4.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.4.0.tgz", - "integrity": "sha512-c0Q4zYZkcLizeYJ3hNyaVUM2AA8KDhNCA3JvXY8CeZSJuBdAy3bAvSbv46RClC4P3dSO9BdwhnKEx2zOo6vP/w==", - "dev": true - }, - "node_modules/walk-back": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-4.0.0.tgz", - "integrity": "sha512-kudCA8PXVQfrqv2mFTG72vDBRi8BKWxGgFLwPpzHcpZnSwZk93WMwUDVcLHWNsnm+Y0AC4Vb6MUNRgaHfyV2DQ==", - "dev": true, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/which-boxed-primitive": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", - "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", - "dev": true, - "dependencies": { - "is-bigint": "^1.0.1", - "is-boolean-object": "^1.1.0", - "is-number-object": "^1.0.4", - "is-string": "^1.0.5", - "is-symbol": "^1.0.3" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/which-module": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", - "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", - "dev": true - }, - "node_modules/wide-align": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", - "integrity": "sha512-QGkOQc8XL6Bt5PwnsExKBPuMKBxnGxWWW3fU55Xt4feHozMUhdUMaBCk290qpm/wG5u/RSKzwdAC4i51YigihA==", - "dev": true, - "dependencies": { - "string-width": "^1.0.2 || 2" - } - }, - "node_modules/wide-align/node_modules/ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/wide-align/node_modules/is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/wide-align/node_modules/string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "dependencies": { - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/wide-align/node_modules/strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "dependencies": { - "ansi-regex": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/word-wrap": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", - "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", - "dev": true - }, - "node_modules/wordwrapjs": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-3.0.0.tgz", - "integrity": "sha512-mO8XtqyPvykVCsrwj5MlOVWvSnCdT+C+QVbm6blradR7JExAhbkZ7hZ9A+9NUtwzSqrlUo9a67ws0EiILrvRpw==", - "dev": true, - "dependencies": { - "reduce-flatten": "^1.0.1", - "typical": "^2.6.1" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/wrap-ansi": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", - "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", - "dev": true, - "dependencies": { - "ansi-styles": "^3.2.0", - "string-width": "^3.0.0", - "strip-ansi": "^5.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/wrap-ansi/node_modules/ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/wrap-ansi/node_modules/emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "node_modules/wrap-ansi/node_modules/is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/wrap-ansi/node_modules/string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "dependencies": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/wrap-ansi/node_modules/strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "dependencies": { - "ansi-regex": "^4.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/wrappy": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", - "dev": true - }, - "node_modules/xmlcreate": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz", - "integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==", - "dev": true - }, - "node_modules/y18n": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", - "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", - "dev": true - }, - "node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, - "node_modules/yargs": { - "version": "13.3.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", - "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", - "dev": true, - "dependencies": { - "cliui": "^5.0.0", - "find-up": "^3.0.0", - "get-caller-file": "^2.0.1", - "require-directory": "^2.1.1", - "require-main-filename": "^2.0.0", - "set-blocking": "^2.0.0", - "string-width": "^3.0.0", - "which-module": "^2.0.0", - "y18n": "^4.0.0", - "yargs-parser": "^13.1.2" - } - }, - "node_modules/yargs-parser": { - "version": "13.1.2", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", - "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", - "dev": true, - "dependencies": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" - } - }, - "node_modules/yargs-unparser": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.6.0.tgz", - "integrity": "sha512-W9tKgmSn0DpSatfri0nx52Joq5hVXgeLiqR/5G0sZNDoLZFOr/xjBUDcShCOGNsBnEMNo1KAMBkTej1Hm62HTw==", - "dev": true, - "dependencies": { - "flat": "^4.1.0", - "lodash": "^4.17.15", - "yargs": "^13.3.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "node_modules/yargs/node_modules/find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "dependencies": { - "locate-path": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true, - "engines": { - "node": ">=4" - } - }, - "node_modules/yargs/node_modules/locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "dependencies": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "dev": true, - "dependencies": { - "p-try": "^2.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/yargs/node_modules/p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "dependencies": { - "p-limit": "^2.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "dependencies": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/yargs/node_modules/strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "dependencies": { - "ansi-regex": "^4.1.0" - }, - "engines": { - "node": ">=6" - } - } - }, "dependencies": { "@babel/code-frame": { "version": "7.12.11", @@ -5893,8 +453,7 @@ "version": "5.3.1", "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.1.tgz", "integrity": "sha512-K0Ptm/47OKfQRpNQ2J/oIN/3QYiK6FwW+eJbILhsdxh2WTLdl+30o8aGdTbm5JbffpFFAg/g+zi1E+jvJha5ng==", - "dev": true, - "requires": {} + "dev": true }, "ajv": { "version": "6.12.6", @@ -6009,6 +568,11 @@ "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", "dev": true }, + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" + }, "at-least-node": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", @@ -6016,11 +580,13 @@ "dev": true }, "axios": { - "version": "0.21.1", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz", - "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.4.0.tgz", + "integrity": "sha512-S4XCWMEmzvo64T9GfvQDOXgYRDJ/wsSZc7Jvdgx5u1sd0JwsuPLqb3SYmusag+edF6ziyMensPVqLTSc1PiSEA==", "requires": { - "follow-redirects": "^1.10.0" + "follow-redirects": "^1.15.0", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" } }, "balanced-match": { @@ -6303,6 +869,14 @@ "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", "dev": true }, + "combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "requires": { + "delayed-stream": "~1.0.0" + } + }, "command-line-args": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.1.1.tgz", @@ -6476,6 +1050,11 @@ "object-keys": "^1.0.12" } }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==" + }, "depd": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", @@ -7078,9 +1657,19 @@ "dev": true }, "follow-redirects": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.1.tgz", - "integrity": "sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg==" + "version": "1.15.2", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", + "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==" + }, + "form-data": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", + "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==", + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + } }, "fs-extra": { "version": "9.1.0", @@ -7889,8 +2478,7 @@ "version": "5.3.0", "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", - "dev": true, - "requires": {} + "dev": true }, "marked": { "version": "0.7.0", @@ -8467,6 +3055,11 @@ "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", "dev": true }, + "proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==" + }, "proxyquire": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/proxyquire/-/proxyquire-2.1.3.tgz", @@ -9204,8 +3797,7 @@ "version": "0.3.0", "resolved": "https://registry.npmjs.org/typedoc-github-wiki-theme/-/typedoc-github-wiki-theme-0.3.0.tgz", "integrity": "sha512-YMnpahBvsk0FlmHM3Djq+U25YZgiXSXdNzPRqu/mQY9QXHHzIKJmLm6r3Qz2U2NfD7xWyfoODpX/UY5Zz9434g==", - "dev": true, - "requires": {} + "dev": true }, "typedoc-plugin-markdown": { "version": "3.9.0", diff --git a/package.json b/package.json index efda1b1..c5e7ba5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.30", + "version": "2.0.0-beta.31", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -36,7 +36,7 @@ "@types/jsonwebtoken": "^8.5.1", "@types/node": "^15.12.0", "@types/qs": "^6.9.6", - "axios": "^0.21.1", + "axios": "^1.4.0", "body-parser": "^1.19.0", "dataloader": "^2.0.0", "dotenv-flow": "^3.2.0", From f4ad04513d1f59a8db6a76ac8103de83c06643f4 Mon Sep 17 00:00:00 2001 From: Ryan Flynn Date: Wed, 11 Oct 2023 15:58:46 -0400 Subject: [PATCH 80/91] fix: need to throw err --- package.json | 2 +- src/sdk/loggers.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index c5e7ba5..73ce5f6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.31", + "version": "2.0.0-beta.32", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/sdk/loggers.ts b/src/sdk/loggers.ts index 33159ae..09193b3 100644 --- a/src/sdk/loggers.ts +++ b/src/sdk/loggers.ts @@ -159,7 +159,7 @@ function envoyAxiosErrorLogger(error: AxiosError) { log('------------ End Of Axios Error ------------\n'); - return error; + throw error; } export { envoyAxiosRequestLogger, envoyAxiosResponseLogger, envoyAxiosErrorLogger }; \ No newline at end of file From ab304f82e2a1b1427e4c69441925684c5e98ee03 Mon Sep 17 00:00:00 2001 From: Manu Singh Date: Tue, 9 Apr 2024 12:02:39 -0700 Subject: [PATCH 81/91] add scope --- src/sdk/EnvoyPluginAPI.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/sdk/EnvoyPluginAPI.ts b/src/sdk/EnvoyPluginAPI.ts index aa14adc..951e93d 100644 --- a/src/sdk/EnvoyPluginAPI.ts +++ b/src/sdk/EnvoyPluginAPI.ts @@ -70,7 +70,7 @@ export default class EnvoyPluginAPI extends EnvoyAPI { /** * Gets a plugin access token using `client_credentials` as the grant type. */ - static async loginAsPlugin(id = envoyClientId, secret = envoyClientSecret): Promise { + static async loginAsPlugin(id = envoyClientId, secret = envoyClientSecret, scope: string[] = ['plugin', 'token.refresh']): Promise { try { const { data } = await axios({ auth: { @@ -82,7 +82,7 @@ export default class EnvoyPluginAPI extends EnvoyAPI { grant_type: 'client_credentials', client_id: id, client_secret: secret, - scope: 'plugin,token.refresh', + scope: scope.join(','), }, url: '/a/auth/v0/token', baseURL: envoyBaseURL, From 34ed7fb33c38bcb94ca79653d414f7b5d862c17f Mon Sep 17 00:00:00 2001 From: Alex Leigh Date: Tue, 4 Jun 2024 17:40:23 -0700 Subject: [PATCH 82/91] sanitizeAxiosError should return another AxiosError so it doesn't break axios.isAxiosError() (#56) --- .eslintrc.js | 2 + .prettierrc.json | 8 + package-lock.json | 4431 ++++++++++++++++++++++------------ package.json | 2 +- src/util/axiosConstructor.ts | 75 +- src/util/errorHandling.ts | 15 + 6 files changed, 2935 insertions(+), 1598 deletions(-) create mode 100644 .prettierrc.json create mode 100644 src/util/errorHandling.ts diff --git a/.eslintrc.js b/.eslintrc.js index 731d9fc..4b14616 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -13,6 +13,8 @@ module.exports = { 'no-void': 'off', 'max-len': ["error", { "code": 150 }], 'consistent-return': 'off', + 'object-curly-newline': 'off', + 'import/prefer-default-export': 'off', '@typescript-eslint/no-unsafe-assignment': 'off', '@typescript-eslint/no-unsafe-return': 'off', '@typescript-eslint/no-unsafe-call': 'off', diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 0000000..cba6153 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,8 @@ +{ + "printWidth": 120, + "bracketSameLine": false, + "htmlWhitespaceSensitivity": "ignore", + "singleQuote": true, + "jsxSingleQuote": false, + "trailingComma": "all" +} diff --git a/package-lock.json b/package-lock.json index b37e01f..fcfbb67 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,66 +1,127 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.31", - "lockfileVersion": 1, + "version": "2.0.1", + "lockfileVersion": 3, "requires": true, - "dependencies": { - "@babel/code-frame": { + "packages": { + "": { + "name": "@envoy/envoy-integrations-sdk", + "version": "2.0.1", + "license": "ISC", + "dependencies": { + "@types/dotenv": "^8.2.0", + "@types/faker": "^5.5.6", + "@types/jsonwebtoken": "^8.5.1", + "@types/node": "^15.12.0", + "@types/qs": "^6.9.6", + "axios": "^1.4.0", + "body-parser": "^1.19.0", + "dataloader": "^2.0.0", + "dotenv-flow": "^3.2.0", + "factory.ts": "^0.5.2", + "faker": "^5.5.3", + "jsonwebtoken": "^8.5.1", + "lodash.ismatch": "^4.4.0", + "luxon": "^1.27.0", + "qs": "^6.10.1" + }, + "devDependencies": { + "@types/dotenv-flow": "^3.1.1", + "@types/express": "^4.17.12", + "@types/lodash.ismatch": "^4.4.6", + "@types/luxon": "^1.27.0", + "@typescript-eslint/eslint-plugin": "^4.26.0", + "@typescript-eslint/parser": "^4.26.0", + "chai": "^4.2.0", + "eslint": "^7.27.0", + "eslint-config-airbnb-typescript": "^12.3.1", + "eslint-plugin-import": "^2.23.4", + "jsdoc-to-markdown": "^5.0.0", + "mocha": "^6.1.4", + "proxyquire": "^2.1.0", + "sinon": "^7.3.2", + "typedoc": "^0.20.36", + "typedoc-github-wiki-theme": "^0.3.0", + "typedoc-plugin-markdown": "^3.9.0", + "typescript": "4.2" + }, + "peerDependencies": { + "@types/express": "^4" + } + }, + "node_modules/@babel/code-frame": { "version": "7.12.11", "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", "dev": true, - "requires": { + "dependencies": { "@babel/highlight": "^7.10.4" } }, - "@babel/helper-validator-identifier": { + "node_modules/@babel/helper-validator-identifier": { "version": "7.14.5", "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.14.5.tgz", "integrity": "sha512-5lsetuxCLilmVGyiLEfoHBRX8UCFD+1m2x3Rj97WrW3V7H3u4RWRXA4evMjImCsin2J2YT0QaVDGf+z8ondbAg==", - "dev": true + "dev": true, + "engines": { + "node": ">=6.9.0" + } }, - "@babel/highlight": { + "node_modules/@babel/highlight": { "version": "7.14.5", "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.5.tgz", "integrity": "sha512-qf9u2WFWVV0MppaL877j2dBtQIDgmidgjGk5VIMw3OadXvYaXn66U1BFlH2t4+t3i+8PhedppRv+i40ABzd+gg==", "dev": true, - "requires": { + "dependencies": { "@babel/helper-validator-identifier": "^7.14.5", "chalk": "^2.0.0", "js-tokens": "^4.0.0" }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, "dependencies": { - "chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "requires": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - } - }, - "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true - } + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" } }, - "@babel/parser": { + "node_modules/@babel/parser": { "version": "7.14.5", "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.14.5.tgz", "integrity": "sha512-TM8C+xtH/9n1qzX+JNHi7AN2zHMTiPUtspO0ZdHflW8KaskkALhMmuMHb4bCmNdv9VAPzJX3/bXqkVLnAvsPfg==", - "dev": true + "dev": true, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } }, - "@eslint/eslintrc": { + "node_modules/@eslint/eslintrc": { "version": "0.4.2", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.2.tgz", "integrity": "sha512-8nmGq/4ycLpIwzvhI4tNDmQztZ8sp+hI7cyG8i1nQDhkAbRzHpXPidRAHlNvCZQpJTKw5ItIpMw9RSToGF00mg==", "dev": true, - "requires": { + "dependencies": { "ajv": "^6.12.4", "debug": "^4.1.1", "espree": "^7.3.0", @@ -71,232 +132,254 @@ "minimatch": "^3.0.4", "strip-json-comments": "^3.1.1" }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true - }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true } } }, - "@nodelib/fs.scandir": { + "node_modules/@eslint/eslintrc/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/@eslint/eslintrc/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", "dev": true, - "requires": { + "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" } }, - "@nodelib/fs.stat": { + "node_modules/@nodelib/fs.stat": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dev": true + "dev": true, + "engines": { + "node": ">= 8" + } }, - "@nodelib/fs.walk": { + "node_modules/@nodelib/fs.walk": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.7.tgz", "integrity": "sha512-BTIhocbPBSrRmHxOAJFtR18oLhxTtAFDAvL8hY1S3iU8k+E60W/YFs4jrixGzQjMpF4qPXxIQHcjVD9dz1C2QA==", "dev": true, - "requires": { + "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" } }, - "@sinonjs/commons": { + "node_modules/@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", "integrity": "sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==", "dev": true, - "requires": { + "dependencies": { "type-detect": "4.0.8" } }, - "@sinonjs/formatio": { + "node_modules/@sinonjs/formatio": { "version": "3.2.2", "resolved": "https://registry.npmjs.org/@sinonjs/formatio/-/formatio-3.2.2.tgz", "integrity": "sha512-B8SEsgd8gArBLMD6zpRw3juQ2FVSsmdd7qlevyDqzS9WTCtvF55/gAL+h6gue8ZvPYcdiPdvueM/qm//9XzyTQ==", "dev": true, - "requires": { + "dependencies": { "@sinonjs/commons": "^1", "@sinonjs/samsam": "^3.1.0" } }, - "@sinonjs/samsam": { + "node_modules/@sinonjs/samsam": { "version": "3.3.3", "resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-3.3.3.tgz", "integrity": "sha512-bKCMKZvWIjYD0BLGnNrxVuw4dkWCYsLqFOUWw8VgKF/+5Y+mE7LfHWPIYoDXowH+3a9LsWDMo0uAP8YDosPvHQ==", "dev": true, - "requires": { + "dependencies": { "@sinonjs/commons": "^1.3.0", "array-from": "^2.1.1", "lodash": "^4.17.15" } }, - "@sinonjs/text-encoding": { + "node_modules/@sinonjs/text-encoding": { "version": "0.7.1", "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz", "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", "dev": true }, - "@types/body-parser": { + "node_modules/@types/body-parser": { "version": "1.19.0", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", "dev": true, - "requires": { + "dependencies": { "@types/connect": "*", "@types/node": "*" } }, - "@types/connect": { + "node_modules/@types/connect": { "version": "3.4.34", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", "dev": true, - "requires": { + "dependencies": { "@types/node": "*" } }, - "@types/dotenv": { + "node_modules/@types/dotenv": { "version": "8.2.0", "resolved": "https://registry.npmjs.org/@types/dotenv/-/dotenv-8.2.0.tgz", "integrity": "sha512-ylSC9GhfRH7m1EUXBXofhgx4lUWmFeQDINW5oLuS+gxWdfUeW4zJdeVTYVkexEW+e2VUvlZR2kGnGGipAWR7kw==", - "requires": { + "deprecated": "This is a stub types definition. dotenv provides its own type definitions, so you do not need this installed.", + "dependencies": { "dotenv": "*" } }, - "@types/dotenv-flow": { + "node_modules/@types/dotenv-flow": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/@types/dotenv-flow/-/dotenv-flow-3.1.1.tgz", "integrity": "sha512-khxgP+KkHPL72SP0Wqn1gB6EHj6yk79OBGJEKW64XL13RbyDGTkRbbA47VICOLRrvgKOpZeun2uMsgO7pAsExQ==", "dev": true }, - "@types/express": { + "node_modules/@types/express": { "version": "4.17.12", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.12.tgz", "integrity": "sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==", "dev": true, - "requires": { + "dependencies": { "@types/body-parser": "*", "@types/express-serve-static-core": "^4.17.18", "@types/qs": "*", "@types/serve-static": "*" } }, - "@types/express-serve-static-core": { + "node_modules/@types/express-serve-static-core": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.21.tgz", "integrity": "sha512-gwCiEZqW6f7EoR8TTEfalyEhb1zA5jQJnRngr97+3pzMaO1RKoI1w2bw07TK72renMUVWcWS5mLI6rk1NqN0nA==", "dev": true, - "requires": { + "dependencies": { "@types/node": "*", "@types/qs": "*", "@types/range-parser": "*" } }, - "@types/faker": { + "node_modules/@types/faker": { "version": "5.5.6", "resolved": "https://registry.npmjs.org/@types/faker/-/faker-5.5.6.tgz", "integrity": "sha512-UCRj0kLg4sXs2XFVm48OU/wIjyJZkpRkwxhRGVQb5l5GmemkeW22WTz9iiDhYPBUqTzDsIWzhFRuF/4DD5+q2Q==" }, - "@types/json-schema": { + "node_modules/@types/json-schema": { "version": "7.0.7", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", "dev": true }, - "@types/json5": { + "node_modules/@types/json5": { "version": "0.0.29", "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", "dev": true }, - "@types/jsonwebtoken": { + "node_modules/@types/jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", "integrity": "sha512-rNAPdomlIUX0i0cg2+I+Q1wOUr531zHBQ+cV/28PJ39bSPKjahatZZ2LMuhiguETkCgLVzfruw/ZvNMNkKoSzw==", - "requires": { + "dependencies": { "@types/node": "*" } }, - "@types/lodash": { + "node_modules/@types/lodash": { "version": "4.14.171", "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.171.tgz", "integrity": "sha512-7eQ2xYLLI/LsicL2nejW9Wyko3lcpN6O/z0ZLHrEQsg280zIdCv1t/0m6UtBjUHokCGBQ3gYTbHzDkZ1xOBwwg==", "dev": true }, - "@types/lodash.ismatch": { + "node_modules/@types/lodash.ismatch": { "version": "4.4.6", "resolved": "https://registry.npmjs.org/@types/lodash.ismatch/-/lodash.ismatch-4.4.6.tgz", "integrity": "sha512-Qy6R9c+LOc3M+kBTDgQGAWxzcrXFKznXuIyg8tbw2/Ct3D3lBmQd3yMTD+NjGzIATgUr0v4uWzW3+ALid+LXsQ==", "dev": true, - "requires": { + "dependencies": { "@types/lodash": "*" } }, - "@types/luxon": { + "node_modules/@types/luxon": { "version": "1.27.0", "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-1.27.0.tgz", "integrity": "sha512-rr2lNXsErnA/ARtgFn46NtQjUa66cuwZYeo/2K7oqqxhJErhXgHBPyNKCo+pfOC3L7HFwtao8ebViiU9h4iAxA==", "dev": true }, - "@types/mime": { + "node_modules/@types/mime": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", "dev": true }, - "@types/node": { + "node_modules/@types/node": { "version": "15.12.2", "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.2.tgz", "integrity": "sha512-zjQ69G564OCIWIOHSXyQEEDpdpGl+G348RAKY0XXy9Z5kU9Vzv1GMNnkar/ZJ8dzXB3COzD9Mo9NtRZ4xfgUww==" }, - "@types/qs": { + "node_modules/@types/qs": { "version": "6.9.6", "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==" }, - "@types/range-parser": { + "node_modules/@types/range-parser": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", "dev": true }, - "@types/serve-static": { + "node_modules/@types/serve-static": { "version": "1.13.9", "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", "dev": true, - "requires": { + "dependencies": { "@types/mime": "^1", "@types/node": "*" } }, - "@typescript-eslint/eslint-plugin": { + "node_modules/@typescript-eslint/eslint-plugin": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.26.1.tgz", "integrity": "sha512-aoIusj/8CR+xDWmZxARivZjbMBQTT9dImUtdZ8tVCVRXgBUuuZyM5Of5A9D9arQPxbi/0rlJLcuArclz/rCMJw==", "dev": true, - "requires": { + "dependencies": { "@typescript-eslint/experimental-utils": "4.26.1", "@typescript-eslint/scope-manager": "4.26.1", "debug": "^4.3.1", @@ -306,98 +389,171 @@ "semver": "^7.3.5", "tsutils": "^3.21.0" }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "requires": { - "lru-cache": "^6.0.0" - } + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true } } }, - "@typescript-eslint/experimental-utils": { + "node_modules/@typescript-eslint/eslint-plugin/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/experimental-utils": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.26.1.tgz", "integrity": "sha512-sQHBugRhrXzRCs9PaGg6rowie4i8s/iD/DpTB+EXte8OMDfdCG5TvO73XlO9Wc/zi0uyN4qOmX9hIjQEyhnbmQ==", "dev": true, - "requires": { + "dependencies": { "@types/json-schema": "^7.0.7", "@typescript-eslint/scope-manager": "4.26.1", "@typescript-eslint/types": "4.26.1", "@typescript-eslint/typescript-estree": "4.26.1", "eslint-scope": "^5.1.1", "eslint-utils": "^3.0.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "*" } }, - "@typescript-eslint/parser": { + "node_modules/@typescript-eslint/parser": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.26.1.tgz", "integrity": "sha512-q7F3zSo/nU6YJpPJvQveVlIIzx9/wu75lr6oDbDzoeIRWxpoc/HQ43G4rmMoCc5my/3uSj2VEpg/D83LYZF5HQ==", "dev": true, - "requires": { + "dependencies": { "@typescript-eslint/scope-manager": "4.26.1", "@typescript-eslint/types": "4.26.1", "@typescript-eslint/typescript-estree": "4.26.1", "debug": "^4.3.1" }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/parser/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true } } }, - "@typescript-eslint/scope-manager": { + "node_modules/@typescript-eslint/parser/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@typescript-eslint/scope-manager": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.26.1.tgz", "integrity": "sha512-TW1X2p62FQ8Rlne+WEShyd7ac2LA6o27S9i131W4NwDSfyeVlQWhw8ylldNNS8JG6oJB9Ha9Xyc+IUcqipvheQ==", "dev": true, - "requires": { + "dependencies": { "@typescript-eslint/types": "4.26.1", "@typescript-eslint/visitor-keys": "4.26.1" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" } }, - "@typescript-eslint/types": { + "node_modules/@typescript-eslint/types": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.26.1.tgz", "integrity": "sha512-STyMPxR3cS+LaNvS8yK15rb8Y0iL0tFXq0uyl6gY45glyI7w0CsyqyEXl/Fa0JlQy+pVANeK3sbwPneCbWE7yg==", - "dev": true + "dev": true, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } }, - "@typescript-eslint/typescript-estree": { + "node_modules/@typescript-eslint/typescript-estree": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.26.1.tgz", "integrity": "sha512-l3ZXob+h0NQzz80lBGaykdScYaiEbFqznEs99uwzm8fPHhDjwaBFfQkjUC/slw6Sm7npFL8qrGEAMxcfBsBJUg==", "dev": true, - "requires": { + "dependencies": { "@typescript-eslint/types": "4.26.1", "@typescript-eslint/visitor-keys": "4.26.1", "debug": "^4.3.1", @@ -406,206 +562,290 @@ "semver": "^7.3.5", "tsutils": "^3.21.0" }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "requires": { - "lru-cache": "^6.0.0" - } + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true } } }, - "@typescript-eslint/visitor-keys": { + "node_modules/@typescript-eslint/typescript-estree/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { "version": "4.26.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.26.1.tgz", "integrity": "sha512-IGouNSSd+6x/fHtYRyLOM6/C+QxMDzWlDtN41ea+flWuSF9g02iqcIlX8wM53JkfljoIjP0U+yp7SiTS1onEkw==", "dev": true, - "requires": { + "dependencies": { "@typescript-eslint/types": "4.26.1", "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" } }, - "acorn": { + "node_modules/acorn": { "version": "7.4.1", "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", - "dev": true + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } }, - "acorn-jsx": { + "node_modules/acorn-jsx": { "version": "5.3.1", "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.1.tgz", "integrity": "sha512-K0Ptm/47OKfQRpNQ2J/oIN/3QYiK6FwW+eJbILhsdxh2WTLdl+30o8aGdTbm5JbffpFFAg/g+zi1E+jvJha5ng==", - "dev": true + "dev": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } }, - "ajv": { + "node_modules/ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "dev": true, - "requires": { + "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "ansi-colors": { + "node_modules/ansi-colors": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", - "dev": true + "dev": true, + "engines": { + "node": ">=6" + } }, - "ansi-escape-sequences": { + "node_modules/ansi-escape-sequences": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/ansi-escape-sequences/-/ansi-escape-sequences-4.1.0.tgz", "integrity": "sha512-dzW9kHxH011uBsidTXd14JXgzye/YLb2LzeKZ4bsgl/Knwx8AtbSFkkGxagdNOoh0DlqHCmfiEjWKBaqjOanVw==", "dev": true, - "requires": { + "dependencies": { "array-back": "^3.0.1" }, - "dependencies": { - "array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", - "dev": true - } + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/ansi-escape-sequences/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" } }, - "ansi-regex": { + "node_modules/ansi-regex": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "ansi-styles": { + "node_modules/ansi-styles": { "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", "dev": true, - "requires": { + "dependencies": { "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" } }, - "argparse": { + "node_modules/argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", "dev": true, - "requires": { + "dependencies": { "sprintf-js": "~1.0.2" } }, - "array-back": { + "node_modules/array-back": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/array-back/-/array-back-4.0.2.tgz", "integrity": "sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "array-from": { + "node_modules/array-from": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/array-from/-/array-from-2.1.1.tgz", "integrity": "sha1-z+nYwmYoudxa7MYqn12PHzUsEZU=", "dev": true }, - "array-includes": { + "node_modules/array-includes": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.3.tgz", "integrity": "sha512-gcem1KlBU7c9rB+Rq8/3PPKsK2kjqeEBa3bD5kkQo4nYlOHQCJqIJFqBXDEfwaRuYTT4E+FxA9xez7Gf/e3Q7A==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "define-properties": "^1.1.3", "es-abstract": "^1.18.0-next.2", "get-intrinsic": "^1.1.1", "is-string": "^1.0.5" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "array-union": { + "node_modules/array-union": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "array.prototype.flat": { + "node_modules/array.prototype.flat": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.4.tgz", "integrity": "sha512-4470Xi3GAPAjZqFcljX2xzckv1qeKPizoNkiS0+O4IoPR2ZNpcjE0pkhdihlDouK+x6QOast26B4Q/O9DJnwSg==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.0", "define-properties": "^1.1.3", "es-abstract": "^1.18.0-next.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "assertion-error": { + "node_modules/assertion-error": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", - "dev": true + "dev": true, + "engines": { + "node": "*" + } }, - "astral-regex": { + "node_modules/astral-regex": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "asynckit": { + "node_modules/asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, - "at-least-node": { + "node_modules/at-least-node": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", - "dev": true + "dev": true, + "engines": { + "node": ">= 4.0.0" + } }, - "axios": { + "node_modules/axios": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/axios/-/axios-1.4.0.tgz", "integrity": "sha512-S4XCWMEmzvo64T9GfvQDOXgYRDJ/wsSZc7Jvdgx5u1sd0JwsuPLqb3SYmusag+edF6ziyMensPVqLTSc1PiSEA==", - "requires": { + "dependencies": { "follow-redirects": "^1.15.0", "form-data": "^4.0.0", "proxy-from-env": "^1.1.0" } }, - "balanced-match": { + "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true }, - "bluebird": { + "node_modules/bluebird": { "version": "3.7.2", "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", "dev": true }, - "body-parser": { + "node_modules/body-parser": { "version": "1.19.0", "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz", "integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==", - "requires": { + "dependencies": { "bytes": "3.1.0", "content-type": "~1.0.4", "debug": "2.6.9", @@ -617,470 +857,591 @@ "raw-body": "2.4.0", "type-is": "~1.6.17" }, - "dependencies": { - "qs": { - "version": "6.7.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", - "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==" - } + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/body-parser/node_modules/qs": { + "version": "6.7.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", + "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==", + "engines": { + "node": ">=0.6" } }, - "brace-expansion": { + "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, - "requires": { + "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, - "braces": { + "node_modules/braces": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", "dev": true, - "requires": { + "dependencies": { "fill-range": "^7.0.1" + }, + "engines": { + "node": ">=8" } }, - "browser-stdout": { + "node_modules/browser-stdout": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", "dev": true }, - "buffer-equal-constant-time": { + "node_modules/buffer-equal-constant-time": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", "integrity": "sha1-+OcRMvf/5uAaXJaXpMbz5I1cyBk=" }, - "buffer-from": { + "node_modules/buffer-from": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==" }, - "bytes": { + "node_modules/bytes": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", - "integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==" + "integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==", + "engines": { + "node": ">= 0.8" + } }, - "cache-point": { + "node_modules/cache-point": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-1.0.0.tgz", "integrity": "sha512-ZqrZp9Hi5Uq7vfSGmNP2bUT/9DzZC2Y/GXjHB8rUJN1a+KLmbV05+vxHipNsg8+CSVgjcVVzLV8VZms6w8ZeRw==", "dev": true, - "requires": { + "dependencies": { "array-back": "^4.0.0", "fs-then-native": "^2.0.0", "mkdirp2": "^1.0.4" + }, + "engines": { + "node": ">=8" } }, - "call-bind": { + "node_modules/call-bind": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", - "requires": { + "dependencies": { "function-bind": "^1.1.1", "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "callsites": { + "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "dev": true + "dev": true, + "engines": { + "node": ">=6" + } }, - "camelcase": { + "node_modules/camelcase": { "version": "5.3.1", "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", - "dev": true + "dev": true, + "engines": { + "node": ">=6" + } }, - "catharsis": { + "node_modules/catharsis": { "version": "0.9.0", "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", "dev": true, - "requires": { + "dependencies": { "lodash": "^4.17.15" + }, + "engines": { + "node": ">= 10" } }, - "chai": { + "node_modules/chai": { "version": "4.3.4", "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.4.tgz", "integrity": "sha512-yS5H68VYOCtN1cjfwumDSuzn/9c+yza4f3reKXlE5rUg7SFcCEy90gJvydNgOYtblyf4Zi6jIWRnXOgErta0KA==", "dev": true, - "requires": { + "dependencies": { "assertion-error": "^1.1.0", "check-error": "^1.0.2", "deep-eql": "^3.0.1", "get-func-name": "^2.0.0", "pathval": "^1.1.1", "type-detect": "^4.0.5" + }, + "engines": { + "node": ">=4" } }, - "chalk": { + "node_modules/chalk": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", "dev": true, - "requires": { + "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/chalk/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/chalk/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, "dependencies": { - "ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "requires": { - "color-convert": "^2.0.1" - } - }, - "color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "requires": { - "color-name": "~1.1.4" - } - }, - "color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - }, - "has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true - }, - "supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "requires": { - "has-flag": "^4.0.0" - } - } + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/chalk/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/chalk/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" } }, - "check-error": { + "node_modules/chalk/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/check-error": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", - "dev": true + "dev": true, + "engines": { + "node": "*" + } }, - "cliui": { + "node_modules/cliui": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", "dev": true, - "requires": { + "dependencies": { "string-width": "^3.1.0", "strip-ansi": "^5.2.0", "wrap-ansi": "^5.1.0" - }, - "dependencies": { - "ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", - "dev": true - }, - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - } - }, - "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "requires": { - "ansi-regex": "^4.1.0" - } - } } }, - "clone-deep": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", - "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", - "requires": { - "is-plain-object": "^2.0.4", - "kind-of": "^6.0.2", - "shallow-clone": "^3.0.0" + "node_modules/cliui/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" } }, - "collect-all": { + "node_modules/cliui/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/cliui/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/cliui/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/cliui/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/collect-all": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.4.tgz", "integrity": "sha512-RKZhRwJtJEP5FWul+gkSMEnaK6H3AGPTTWOiRimCcs+rc/OmQE3Yhy1Q7A7KsdkG3ZXVdZq68Y6ONSdvkeEcKA==", "dev": true, - "requires": { + "dependencies": { "stream-connect": "^1.0.2", "stream-via": "^1.0.4" + }, + "engines": { + "node": ">=0.10.0" } }, - "color-convert": { + "node_modules/color-convert": { "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", "dev": true, - "requires": { + "dependencies": { "color-name": "1.1.3" } }, - "color-name": { + "node_modules/color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", "dev": true }, - "colors": { + "node_modules/colors": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.1.90" + } }, - "combined-stream": { + "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", - "requires": { + "dependencies": { "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" } }, - "command-line-args": { + "node_modules/command-line-args": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.1.1.tgz", "integrity": "sha512-hL/eG8lrll1Qy1ezvkant+trihbGnaKaeEjj6Scyr3DN+RC7iQ5Rz84IeLERfAWDGo0HBSNAakczwgCilDXnWg==", "dev": true, - "requires": { + "dependencies": { "array-back": "^3.0.1", "find-replace": "^3.0.0", "lodash.camelcase": "^4.3.0", "typical": "^4.0.0" }, - "dependencies": { - "array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", - "dev": true - }, - "typical": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/typical/-/typical-4.0.0.tgz", - "integrity": "sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw==", - "dev": true - } + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-args/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/command-line-args/node_modules/typical": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/typical/-/typical-4.0.0.tgz", + "integrity": "sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw==", + "dev": true, + "engines": { + "node": ">=8" } }, - "command-line-tool": { + "node_modules/command-line-tool": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/command-line-tool/-/command-line-tool-0.8.0.tgz", "integrity": "sha512-Xw18HVx/QzQV3Sc5k1vy3kgtOeGmsKIqwtFFoyjI4bbcpSgnw2CWVULvtakyw4s6fhyAdI6soQQhXc2OzJy62g==", "dev": true, - "requires": { + "dependencies": { "ansi-escape-sequences": "^4.0.0", "array-back": "^2.0.0", "command-line-args": "^5.0.0", "command-line-usage": "^4.1.0", "typical": "^2.6.1" }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-tool/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" } }, - "command-line-usage": { + "node_modules/command-line-usage": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-4.1.0.tgz", "integrity": "sha512-MxS8Ad995KpdAC0Jopo/ovGIroV/m0KHwzKfXxKag6FHOkGsH8/lv5yjgablcRxCJJC0oJeUMuO/gmaq+Wq46g==", "dev": true, - "requires": { + "dependencies": { "ansi-escape-sequences": "^4.0.0", "array-back": "^2.0.0", "table-layout": "^0.4.2", "typical": "^2.6.1" }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-usage/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" } }, - "common-sequence": { + "node_modules/common-sequence": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-2.0.2.tgz", "integrity": "sha512-jAg09gkdkrDO9EWTdXfv80WWH3yeZl5oT69fGfedBNS9pXUKYInVJ1bJ+/ht2+Moeei48TmSbQDYMc8EOx9G0g==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "concat-map": { + "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", "dev": true }, - "config-master": { + "node_modules/config-master": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/config-master/-/config-master-3.1.0.tgz", "integrity": "sha1-ZnZjWQUFooO/JqSE1oSJ10xUhdo=", "dev": true, - "requires": { - "walk-back": "^2.0.1" - }, "dependencies": { - "walk-back": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz", - "integrity": "sha1-VU4qnYdPrEeoywBr9EwvDEmYoKQ=", - "dev": true - } + "walk-back": "^2.0.1" + } + }, + "node_modules/config-master/node_modules/walk-back": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz", + "integrity": "sha1-VU4qnYdPrEeoywBr9EwvDEmYoKQ=", + "dev": true, + "engines": { + "node": ">=0.10.0" } }, - "confusing-browser-globals": { + "node_modules/confusing-browser-globals": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.10.tgz", "integrity": "sha512-gNld/3lySHwuhaVluJUKLePYirM3QNCKzVxqAdhJII9/WXKVX5PURzMVJspS1jTslSqjeuG4KMVTSouit5YPHA==", "dev": true }, - "content-type": { + "node_modules/content-type": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", - "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==" + "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==", + "engines": { + "node": ">= 0.6" + } }, - "cross-spawn": { + "node_modules/cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", "dev": true, - "requires": { + "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" } }, - "dataloader": { + "node_modules/dataloader": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-2.0.0.tgz", "integrity": "sha512-YzhyDAwA4TaQIhM5go+vCLmU0UikghC/t9DTQYZR2M/UvZ1MdOhPezSDZcjj9uqQJOMqjLcpWtyW2iNINdlatQ==" }, - "debug": { + "node_modules/debug": { "version": "2.6.9", "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "requires": { + "dependencies": { "ms": "2.0.0" } }, - "decamelize": { + "node_modules/decamelize": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "deep-eql": { + "node_modules/deep-eql": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-3.0.1.tgz", "integrity": "sha512-+QeIQyN5ZuO+3Uk5DYh6/1eKO0m0YmJFGNmFHGACpf1ClL1nmlV/p4gNgbl2pJGxgXb4faqo6UE+M5ACEMyVcw==", "dev": true, - "requires": { + "dependencies": { "type-detect": "^4.0.0" + }, + "engines": { + "node": ">=0.12" } }, - "deep-extend": { + "node_modules/deep-extend": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true + "dev": true, + "engines": { + "node": ">=4.0.0" + } }, - "deep-is": { + "node_modules/deep-is": { "version": "0.1.3", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", "dev": true }, - "define-properties": { + "node_modules/define-properties": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", "dev": true, - "requires": { + "dependencies": { "object-keys": "^1.0.12" + }, + "engines": { + "node": ">= 0.4" } }, - "delayed-stream": { + "node_modules/delayed-stream": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", - "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==" + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "engines": { + "node": ">=0.4.0" + } }, - "depd": { + "node_modules/depd": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", - "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=" + "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=", + "engines": { + "node": ">= 0.6" + } }, - "diff": { + "node_modules/diff": { "version": "3.5.0", "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.3.1" + } }, - "dir-glob": { + "node_modules/dir-glob": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", "dev": true, - "requires": { + "dependencies": { "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" } }, - "dmd": { + "node_modules/dmd": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/dmd/-/dmd-4.0.6.tgz", "integrity": "sha512-7ZYAnFQ6jGm4SICArwqNPylJ83PaOdPTAkds3Z/s1ueFqSc5ilJ2F0b7uP+35W1PUbemH++gn5/VlC3KwEgiHQ==", "dev": true, - "requires": { + "dependencies": { "array-back": "^4.0.1", "cache-point": "^1.0.0", "common-sequence": "^2.0.0", @@ -1094,93 +1455,110 @@ "test-value": "^3.0.0", "walk-back": "^4.0.0" }, - "dependencies": { - "reduce-flatten": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-3.0.1.tgz", - "integrity": "sha512-bYo+97BmUUOzg09XwfkwALt4PQH1M5L0wzKerBt6WLm3Fhdd43mMS89HiT1B9pJIqko/6lWx3OnV4J9f2Kqp5Q==", - "dev": true - } + "engines": { + "node": ">=8" + } + }, + "node_modules/dmd/node_modules/reduce-flatten": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-3.0.1.tgz", + "integrity": "sha512-bYo+97BmUUOzg09XwfkwALt4PQH1M5L0wzKerBt6WLm3Fhdd43mMS89HiT1B9pJIqko/6lWx3OnV4J9f2Kqp5Q==", + "dev": true, + "engines": { + "node": ">=8" } }, - "doctrine": { + "node_modules/doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", "dev": true, - "requires": { + "dependencies": { "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" } }, - "dotenv": { + "node_modules/dotenv": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz", - "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==" + "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==", + "engines": { + "node": ">=10" + } }, - "dotenv-flow": { + "node_modules/dotenv-flow": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/dotenv-flow/-/dotenv-flow-3.2.0.tgz", "integrity": "sha512-GEB6RrR4AbqDJvNSFrYHqZ33IKKbzkvLYiD5eo4+9aFXr4Y4G+QaFrB/fNp0y6McWBmvaPn3ZNjIufnj8irCtg==", - "requires": { + "dependencies": { "dotenv": "^8.0.0" }, - "dependencies": { - "dotenv": { - "version": "8.6.0", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", - "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==" - } + "engines": { + "node": ">= 8.0.0" + } + }, + "node_modules/dotenv-flow/node_modules/dotenv": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", + "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==", + "engines": { + "node": ">=10" } }, - "ecdsa-sig-formatter": { + "node_modules/ecdsa-sig-formatter": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", "integrity": "sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==", - "requires": { + "dependencies": { "safe-buffer": "^5.0.1" } }, - "ee-first": { + "node_modules/ee-first": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" }, - "emoji-regex": { + "node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, - "enquirer": { + "node_modules/enquirer": { "version": "2.3.6", "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", "dev": true, - "requires": { + "dependencies": { "ansi-colors": "^4.1.1" + }, + "engines": { + "node": ">=8.6" } }, - "entities": { + "node_modules/entities": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", "dev": true }, - "error-ex": { + "node_modules/error-ex": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", "dev": true, - "requires": { + "dependencies": { "is-arrayish": "^0.2.1" } }, - "es-abstract": { + "node_modules/es-abstract": { "version": "1.18.3", "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "es-to-primitive": "^1.2.1", "function-bind": "^1.1.1", @@ -1197,31 +1575,49 @@ "string.prototype.trimend": "^1.0.4", "string.prototype.trimstart": "^1.0.4", "unbox-primitive": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "es-to-primitive": { + "node_modules/es-to-primitive": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", "dev": true, - "requires": { + "dependencies": { "is-callable": "^1.1.4", "is-date-object": "^1.0.1", "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "escape-string-regexp": { + "node_modules/escape-string-regexp": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } }, - "eslint": { + "node_modules/eslint": { "version": "7.28.0", "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.28.0.tgz", "integrity": "sha512-UMfH0VSjP0G4p3EWirscJEQ/cHqnT/iuH6oNZOB94nBjWbMnhGEPxsZm1eyIW0C/9jLI0Fow4W5DXLjEI7mn1g==", "dev": true, - "requires": { + "dependencies": { "@babel/code-frame": "7.12.11", "@eslint/eslintrc": "^0.4.2", "ajv": "^6.10.0", @@ -1262,132 +1658,110 @@ "text-table": "^0.2.0", "v8-compile-cache": "^2.0.3" }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "eslint-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", - "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", - "dev": true, - "requires": { - "eslint-visitor-keys": "^1.1.0" - }, - "dependencies": { - "eslint-visitor-keys": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", - "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", - "dev": true - } - } - }, - "ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true - }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "requires": { - "lru-cache": "^6.0.0" - } - } + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" } }, - "eslint-config-airbnb": { + "node_modules/eslint-config-airbnb": { "version": "18.2.1", "resolved": "https://registry.npmjs.org/eslint-config-airbnb/-/eslint-config-airbnb-18.2.1.tgz", "integrity": "sha512-glZNDEZ36VdlZWoxn/bUR1r/sdFKPd1mHPbqUtkctgNG4yT2DLLtJ3D+yCV+jzZCc2V1nBVkmdknOJBZ5Hc0fg==", "dev": true, - "requires": { + "dependencies": { "eslint-config-airbnb-base": "^14.2.1", "object.assign": "^4.1.2", "object.entries": "^1.1.2" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", + "eslint-plugin-import": "^2.22.1", + "eslint-plugin-jsx-a11y": "^6.4.1", + "eslint-plugin-react": "^7.21.5", + "eslint-plugin-react-hooks": "^4 || ^3 || ^2.3.0 || ^1.7.0" } }, - "eslint-config-airbnb-base": { + "node_modules/eslint-config-airbnb-base": { "version": "14.2.1", "resolved": "https://registry.npmjs.org/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz", "integrity": "sha512-GOrQyDtVEc1Xy20U7vsB2yAoB4nBlfH5HZJeatRXHleO+OS5Ot+MWij4Dpltw4/DyIkqUfqz1epfhVR5XWWQPA==", "dev": true, - "requires": { + "dependencies": { "confusing-browser-globals": "^1.0.10", "object.assign": "^4.1.2", "object.entries": "^1.1.2" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", + "eslint-plugin-import": "^2.22.1" } }, - "eslint-config-airbnb-typescript": { + "node_modules/eslint-config-airbnb-typescript": { "version": "12.3.1", "resolved": "https://registry.npmjs.org/eslint-config-airbnb-typescript/-/eslint-config-airbnb-typescript-12.3.1.tgz", "integrity": "sha512-ql/Pe6/hppYuRp4m3iPaHJqkBB7dgeEmGPQ6X0UNmrQOfTF+dXw29/ZjU2kQ6RDoLxaxOA+Xqv07Vbef6oVTWw==", "dev": true, - "requires": { + "dependencies": { "@typescript-eslint/parser": "^4.4.1", "eslint-config-airbnb": "^18.2.0", "eslint-config-airbnb-base": "^14.2.0" } }, - "eslint-import-resolver-node": { + "node_modules/eslint-import-resolver-node": { "version": "0.3.4", "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.4.tgz", "integrity": "sha512-ogtf+5AB/O+nM6DIeBUNr2fuT7ot9Qg/1harBfBtaP13ekEWFQEEMP94BCB7zaNW3gyY+8SHYF00rnqYwXKWOA==", "dev": true, - "requires": { + "dependencies": { "debug": "^2.6.9", "resolve": "^1.13.1" } }, - "eslint-module-utils": { + "node_modules/eslint-module-utils": { "version": "2.6.1", "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.6.1.tgz", "integrity": "sha512-ZXI9B8cxAJIH4nfkhTwcRTEAnrVfobYqwjWy/QMCZ8rHkZHFjf9yO4BzpiF9kCSfNlMG54eKigISHpX0+AaT4A==", "dev": true, - "requires": { + "dependencies": { "debug": "^3.2.7", "pkg-dir": "^2.0.0" }, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, "dependencies": { - "debug": { - "version": "3.2.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", - "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - }, - "ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true - } + "ms": "^2.1.1" } }, - "eslint-plugin-import": { + "node_modules/eslint-module-utils/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true + }, + "node_modules/eslint-plugin-import": { "version": "2.23.4", "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.23.4.tgz", "integrity": "sha512-6/wP8zZRsnQFiR3iaPFgh5ImVRM1WN5NUWfTIRqwOdeiGJlBcSk82o1FEVq8yXmy4lkIzTo7YhHCIxlU/2HyEQ==", "dev": true, - "requires": { + "dependencies": { "array-includes": "^3.1.3", "array.prototype.flat": "^1.2.4", "debug": "^2.6.9", @@ -1404,675 +1778,1024 @@ "resolve": "^1.20.0", "tsconfig-paths": "^3.9.0" }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, "dependencies": { - "doctrine": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", - "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", - "dev": true, - "requires": { - "esutils": "^2.0.2" - } - } + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" } }, - "eslint-scope": { + "node_modules/eslint-scope": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", "dev": true, - "requires": { + "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" } }, - "eslint-utils": { + "node_modules/eslint-utils": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", "dev": true, - "requires": { + "dependencies": { "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" } }, - "eslint-visitor-keys": { + "node_modules/eslint-visitor-keys": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/eslint/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint/node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/eslint/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true }, - "espree": { + "node_modules/eslint/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/espree": { "version": "7.3.1", "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", "dev": true, - "requires": { + "dependencies": { "acorn": "^7.4.0", "acorn-jsx": "^5.3.1", "eslint-visitor-keys": "^1.3.0" }, - "dependencies": { - "eslint-visitor-keys": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", - "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", - "dev": true - } + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/espree/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" } }, - "esprima": { + "node_modules/esprima": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", - "dev": true + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } }, - "esquery": { + "node_modules/esquery": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", "dev": true, - "requires": { + "dependencies": { "estraverse": "^5.1.0" }, - "dependencies": { - "estraverse": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", - "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", - "dev": true - } + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esquery/node_modules/estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true, + "engines": { + "node": ">=4.0" } }, - "esrecurse": { + "node_modules/esrecurse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", "dev": true, - "requires": { + "dependencies": { "estraverse": "^5.2.0" }, - "dependencies": { - "estraverse": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", - "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", - "dev": true - } + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true, + "engines": { + "node": ">=4.0" } }, - "estraverse": { + "node_modules/estraverse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", - "dev": true + "dev": true, + "engines": { + "node": ">=4.0" + } }, - "esutils": { + "node_modules/esutils": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "factory.ts": { + "node_modules/factory.ts": { "version": "0.5.2", "resolved": "https://registry.npmjs.org/factory.ts/-/factory.ts-0.5.2.tgz", "integrity": "sha512-I4YDKuyMW+s2PocnWh/Ekv9wSStt/MNN1ZRb1qhy0Kv056ndlzbLHDsW9KEmTAqMpLI3BtjSqEdZ7ZfdnaXn9w==", - "requires": { + "dependencies": { "clone-deep": "^4.0.1", "source-map-support": "^0.5.19" + }, + "engines": { + "node": ">= 14" } }, - "faker": { + "node_modules/faker": { "version": "5.5.3", "resolved": "https://registry.npmjs.org/faker/-/faker-5.5.3.tgz", "integrity": "sha512-wLTv2a28wjUyWkbnX7u/ABZBkUkIF2fCd73V6P2oFqEGEktDfzWx4UxrSqtPRw0xPRAcjeAOIiJWqZm3pP4u3g==" }, - "fast-deep-equal": { + "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true }, - "fast-glob": { + "node_modules/fast-glob": { "version": "3.2.5", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.5.tgz", "integrity": "sha512-2DtFcgT68wiTTiwZ2hNdJfcHNke9XOfnwmBRWXhmeKM8rF0TGwmC/Qto3S7RoZKp5cilZbxzO5iTNTQsJ+EeDg==", "dev": true, - "requires": { + "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.0", "merge2": "^1.3.0", "micromatch": "^4.0.2", "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8" } }, - "fast-json-stable-stringify": { + "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", "dev": true }, - "fast-levenshtein": { + "node_modules/fast-levenshtein": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", "dev": true }, - "fastq": { + "node_modules/fastq": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.11.0.tgz", "integrity": "sha512-7Eczs8gIPDrVzT+EksYBcupqMyxSHXXrHOLRRxU2/DicV8789MRBRR8+Hc2uWzUupOs4YS4JzBmBxjjCVBxD/g==", "dev": true, - "requires": { + "dependencies": { "reusify": "^1.0.4" } }, - "file-entry-cache": { + "node_modules/file-entry-cache": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", "dev": true, - "requires": { + "dependencies": { "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" } }, - "file-set": { + "node_modules/file-set": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/file-set/-/file-set-3.0.0.tgz", "integrity": "sha512-B/SdeSIeRv7VlOgIjtH3dkxMI+tEy5m+OeCXfAUsirBoVoY+bGtsmvmmTFPm/G23TBY4RiTtjpcgePCfwXRjqA==", "dev": true, - "requires": { + "dependencies": { "array-back": "^4.0.0", "glob": "^7.1.5" + }, + "engines": { + "node": ">=8" } }, - "fill-keys": { + "node_modules/fill-keys": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/fill-keys/-/fill-keys-1.0.2.tgz", "integrity": "sha1-mo+jb06K1jTjv2tPPIiCVRRS6yA=", "dev": true, - "requires": { + "dependencies": { "is-object": "~1.0.1", "merge-descriptors": "~1.0.0" + }, + "engines": { + "node": ">=0.10.0" } }, - "fill-range": { + "node_modules/fill-range": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", "dev": true, - "requires": { + "dependencies": { "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" } }, - "find-replace": { + "node_modules/find-replace": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-3.0.0.tgz", "integrity": "sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ==", "dev": true, - "requires": { + "dependencies": { "array-back": "^3.0.1" }, - "dependencies": { - "array-back": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", - "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", - "dev": true - } + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/find-replace/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" } }, - "find-up": { + "node_modules/find-up": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", "dev": true, - "requires": { + "dependencies": { "locate-path": "^2.0.0" + }, + "engines": { + "node": ">=4" } }, - "flat": { + "node_modules/flat": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.1.tgz", "integrity": "sha512-FmTtBsHskrU6FJ2VxCnsDb84wu9zhmO3cUX2kGFb5tuwhfXxGciiT0oRY+cck35QmG+NmGh5eLz6lLCpWTqwpA==", "dev": true, - "requires": { + "dependencies": { "is-buffer": "~2.0.3" + }, + "bin": { + "flat": "cli.js" } }, - "flat-cache": { + "node_modules/flat-cache": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", "dev": true, - "requires": { + "dependencies": { "flatted": "^3.1.0", "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" } }, - "flatted": { + "node_modules/flatted": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.1.1.tgz", "integrity": "sha512-zAoAQiudy+r5SvnSw3KJy5os/oRJYHzrzja/tBDqrZtNhUw8bt6y8OBzMWcjWr+8liV8Eb6yOhw8WZ7VFZ5ZzA==", "dev": true }, - "follow-redirects": { + "node_modules/follow-redirects": { "version": "1.15.2", "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", - "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==" + "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } }, - "form-data": { + "node_modules/form-data": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==", - "requires": { + "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" } }, - "fs-extra": { + "node_modules/fs-extra": { "version": "9.1.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", "dev": true, - "requires": { + "dependencies": { "at-least-node": "^1.0.0", "graceful-fs": "^4.2.0", "jsonfile": "^6.0.1", "universalify": "^2.0.0" + }, + "engines": { + "node": ">=10" } }, - "fs-then-native": { + "node_modules/fs-then-native": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/fs-then-native/-/fs-then-native-2.0.0.tgz", "integrity": "sha1-GaEk2U2QwiyOBF8ujdbr6jbUjGc=", - "dev": true + "dev": true, + "engines": { + "node": ">=4.0.0" + } }, - "fs.realpath": { + "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", "dev": true }, - "function-bind": { + "node_modules/function-bind": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" }, - "functional-red-black-tree": { + "node_modules/functional-red-black-tree": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, - "get-caller-file": { + "node_modules/get-caller-file": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", - "dev": true + "dev": true, + "engines": { + "node": "6.* || 8.* || >= 10.*" + } }, - "get-func-name": { + "node_modules/get-func-name": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", - "dev": true + "dev": true, + "engines": { + "node": "*" + } }, - "get-intrinsic": { + "node_modules/get-intrinsic": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", - "requires": { + "dependencies": { "function-bind": "^1.1.1", "has": "^1.0.3", "has-symbols": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "glob": { + "node_modules/glob": { "version": "7.1.7", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.7.tgz", "integrity": "sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ==", + "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, - "requires": { + "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", "inherits": "2", "minimatch": "^3.0.4", "once": "^1.3.0", "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, - "glob-parent": { + "node_modules/glob-parent": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, - "requires": { + "dependencies": { "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" } }, - "globals": { + "node_modules/globals": { "version": "13.9.0", "resolved": "https://registry.npmjs.org/globals/-/globals-13.9.0.tgz", "integrity": "sha512-74/FduwI/JaIrr1H8e71UbDE+5x7pIPs1C2rrwC52SszOo043CsWOZEMW7o2Y58xwm9b+0RBKDxY5n2sUpEFxA==", "dev": true, - "requires": { + "dependencies": { "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "globby": { + "node_modules/globby": { "version": "11.0.3", "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==", "dev": true, - "requires": { + "dependencies": { "array-union": "^2.1.0", "dir-glob": "^3.0.1", "fast-glob": "^3.1.1", "ignore": "^5.1.4", "merge2": "^1.3.0", "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "graceful-fs": { + "node_modules/graceful-fs": { "version": "4.2.6", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.6.tgz", "integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ==", "dev": true }, - "growl": { + "node_modules/growl": { "version": "1.10.5", "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", "integrity": "sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==", - "dev": true + "dev": true, + "engines": { + "node": ">=4.x" + } }, - "handlebars": { + "node_modules/handlebars": { "version": "4.7.7", "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", "dev": true, - "requires": { + "dependencies": { "minimist": "^1.2.5", "neo-async": "^2.6.0", "source-map": "^0.6.1", - "uglify-js": "^3.1.4", "wordwrap": "^1.0.0" + }, + "bin": { + "handlebars": "bin/handlebars" + }, + "engines": { + "node": ">=0.4.7" + }, + "optionalDependencies": { + "uglify-js": "^3.1.4" } }, - "has": { + "node_modules/has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", - "requires": { + "dependencies": { "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" } }, - "has-bigints": { + "node_modules/has-bigints": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", - "dev": true + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "has-flag": { + "node_modules/has-flag": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "has-symbols": { + "node_modules/has-symbols": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==" + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "he": { + "node_modules/he": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", - "dev": true + "dev": true, + "bin": { + "he": "bin/he" + } }, - "hosted-git-info": { + "node_modules/hosted-git-info": { "version": "2.8.9", "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", "dev": true }, - "http-errors": { + "node_modules/http-errors": { "version": "1.7.2", "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.7.2.tgz", "integrity": "sha512-uUQBt3H/cSIVfch6i1EuPNy/YsRSOUBXTVfZ+yR7Zjez3qjBz6i9+i4zjNaoqcoFVI4lQJ5plg63TvGfRSDCRg==", - "requires": { + "dependencies": { "depd": "~1.1.2", "inherits": "2.0.3", "setprototypeof": "1.1.1", "statuses": ">= 1.5.0 < 2", "toidentifier": "1.0.0" + }, + "engines": { + "node": ">= 0.6" } }, - "iconv-lite": { + "node_modules/iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "requires": { + "dependencies": { "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" } }, - "ignore": { + "node_modules/ignore": { "version": "5.1.8", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", - "dev": true + "dev": true, + "engines": { + "node": ">= 4" + } }, - "import-fresh": { + "node_modules/import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", "dev": true, - "requires": { + "dependencies": { "parent-module": "^1.0.0", "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "imurmurhash": { + "node_modules/imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", - "dev": true + "dev": true, + "engines": { + "node": ">=0.8.19" + } }, - "inflight": { + "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", "dev": true, - "requires": { + "dependencies": { "once": "^1.3.0", "wrappy": "1" } }, - "inherits": { + "node_modules/inherits": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" }, - "interpret": { + "node_modules/interpret": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.10" + } }, - "is-arrayish": { + "node_modules/is-arrayish": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", "dev": true }, - "is-bigint": { + "node_modules/is-bigint": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", - "dev": true + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-boolean-object": { + "node_modules/is-boolean-object": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "is-buffer": { + "node_modules/is-buffer": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz", "integrity": "sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==", - "dev": true + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "engines": { + "node": ">=4" + } }, - "is-callable": { + "node_modules/is-callable": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-core-module": { + "node_modules/is-core-module": { "version": "2.4.0", "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.4.0.tgz", "integrity": "sha512-6A2fkfq1rfeQZjxrZJGerpLCTHRNEBiSgnu0+obeJpEPZRUooHgsizvzv0ZjJwOz3iWIHdJtVWJ/tmPr3D21/A==", "dev": true, - "requires": { + "dependencies": { "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "is-date-object": { + "node_modules/is-date-object": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.4.tgz", "integrity": "sha512-/b4ZVsG7Z5XVtIxs/h9W8nvfLgSAyKYdtGWQLbqy6jA1icmgjf8WCoTKgeS4wy5tYaPePouzFMANbnj94c2Z+A==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-extglob": { + "node_modules/is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "is-fullwidth-code-point": { + "node_modules/is-fullwidth-code-point": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "is-glob": { + "node_modules/is-glob": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", "dev": true, - "requires": { + "dependencies": { "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" } }, - "is-negative-zero": { + "node_modules/is-negative-zero": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.1.tgz", "integrity": "sha512-2z6JzQvZRa9A2Y7xC6dQQm4FSTSTNWjKIYYTt4246eMTJmIo0Q+ZyOsU66X8lxK1AbB92dFeglPLrhwpeRKO6w==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-number": { + "node_modules/is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.12.0" + } }, - "is-number-object": { + "node_modules/is-number-object": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-object": { + "node_modules/is-object": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.2.tgz", "integrity": "sha512-2rRIahhZr2UWb45fIOuvZGpFtz0TyOZLf32KxBbSoUCeZR495zCKlWUKKUByk3geS2eAs7ZAABt0Y/Rx0GiQGA==", - "dev": true + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-plain-object": { + "node_modules/is-plain-object": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "requires": { + "dependencies": { "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" } }, - "is-regex": { + "node_modules/is-regex": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "is-string": { + "node_modules/is-string": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", "integrity": "sha512-2gdzbKUuqtQ3lYNrUTQYoClPhm7oQu4UdpSZMp1/DGgkHBT8E2Z1l0yMdb6D4zNAxwDiMv8MdulKROJGNl0Q0w==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "is-symbol": { + "node_modules/is-symbol": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", "dev": true, - "requires": { + "dependencies": { "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "isarray": { + "node_modules/isarray": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", "dev": true }, - "isexe": { + "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", "dev": true }, - "isobject": { + "node_modules/isobject": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", - "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=" + "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", + "engines": { + "node": ">=0.10.0" + } }, - "js-tokens": { + "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", "dev": true }, - "js-yaml": { + "node_modules/js-yaml": { "version": "3.14.1", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", "dev": true, - "requires": { + "dependencies": { "argparse": "^1.0.7", "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" } }, - "js2xmlparser": { + "node_modules/js2xmlparser": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz", "integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==", "dev": true, - "requires": { + "dependencies": { "xmlcreate": "^2.0.3" } }, - "jsdoc": { + "node_modules/jsdoc": { "version": "3.6.7", "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.7.tgz", "integrity": "sha512-sxKt7h0vzCd+3Y81Ey2qinupL6DpRSZJclS04ugHDNmRUXGzqicMJ6iwayhSA0S0DwwX30c5ozyUthr1QKF6uw==", "dev": true, - "requires": { + "dependencies": { "@babel/parser": "^7.9.4", "bluebird": "^3.7.2", "catharsis": "^0.9.0", @@ -2088,27 +2811,19 @@ "taffydb": "2.6.2", "underscore": "~1.13.1" }, - "dependencies": { - "escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "dev": true - }, - "marked": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", - "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", - "dev": true - } + "bin": { + "jsdoc": "jsdoc.js" + }, + "engines": { + "node": ">=8.15.0" } }, - "jsdoc-api": { + "node_modules/jsdoc-api": { "version": "5.0.4", "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-5.0.4.tgz", "integrity": "sha512-1KMwLnfo0FyhF06TQKzqIm8BiY1yoMIGICxRdJHUjzskaHMzHMmpLlmNFgzoa4pAC8t1CDPK5jWuQTvv1pBsEQ==", "dev": true, - "requires": { + "dependencies": { "array-back": "^4.0.0", "cache-point": "^1.0.0", "collect-all": "^1.0.3", @@ -2119,56 +2834,64 @@ "temp-path": "^1.0.0", "walk-back": "^3.0.1" }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/jsdoc-api/node_modules/file-set": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz", + "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==", + "dev": true, "dependencies": { - "file-set": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz", - "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==", - "dev": true, - "requires": { - "array-back": "^2.0.0", - "glob": "^7.1.3" - }, - "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } - } - }, - "walk-back": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.1.tgz", - "integrity": "sha512-umiNB2qLO731Sxbp6cfZ9pwURJzTnftxE4Gc7hq8n/ehkuXC//s9F65IEIJA2ZytQZ1ZOsm/Fju4IWx0bivkUQ==", - "dev": true - } + "array-back": "^2.0.0", + "glob": "^7.1.3" + } + }, + "node_modules/jsdoc-api/node_modules/file-set/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/jsdoc-api/node_modules/walk-back": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.1.tgz", + "integrity": "sha512-umiNB2qLO731Sxbp6cfZ9pwURJzTnftxE4Gc7hq8n/ehkuXC//s9F65IEIJA2ZytQZ1ZOsm/Fju4IWx0bivkUQ==", + "dev": true, + "engines": { + "node": ">=4.0.0" } }, - "jsdoc-parse": { + "node_modules/jsdoc-parse": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-4.0.1.tgz", "integrity": "sha512-qIObw8yqYZjrP2qxWROB5eLQFLTUX2jRGLhW9hjo2CC2fQVlskidCIzjCoctwsDvauBp2a/lR31jkSleczSo8Q==", "dev": true, - "requires": { + "dependencies": { "array-back": "^4.0.0", "lodash.omit": "^4.5.0", "lodash.pick": "^4.4.0", "reduce-extract": "^1.0.0", "sort-array": "^2.0.0", "test-value": "^3.0.0" + }, + "engines": { + "node": ">=8" } }, - "jsdoc-to-markdown": { + "node_modules/jsdoc-to-markdown": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-5.0.3.tgz", "integrity": "sha512-tQv5tBV0fTYidRQtE60lJKxE98mmuLcYuITFDKQiDPE9hGccpeEGUNFcVkInq1vigyuPnZmt79bQ8wv2GKjY0Q==", "dev": true, - "requires": { + "dependencies": { "array-back": "^4.0.1", "command-line-tool": "^0.8.0", "config-master": "^3.1.0", @@ -2176,50 +2899,82 @@ "jsdoc-api": "^5.0.4", "jsdoc-parse": "^4.0.1", "walk-back": "^4.0.0" + }, + "bin": { + "jsdoc2md": "bin/cli.js" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/jsdoc/node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/jsdoc/node_modules/marked": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", + "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">= 8.16.2" } }, - "json-parse-better-errors": { + "node_modules/json-parse-better-errors": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", "dev": true }, - "json-schema-traverse": { + "node_modules/json-schema-traverse": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", "dev": true }, - "json-stable-stringify-without-jsonify": { + "node_modules/json-stable-stringify-without-jsonify": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", "dev": true }, - "json5": { + "node_modules/json5": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", "dev": true, - "requires": { + "dependencies": { "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" } }, - "jsonfile": { + "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", "dev": true, - "requires": { - "graceful-fs": "^4.1.6", + "dependencies": { "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" } }, - "jsonwebtoken": { + "node_modules/jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", "integrity": "sha512-XjwVfRS6jTMsqYs0EsuJ4LGxXV14zQybNd4L2r0UvbVnSF9Af8x7p5MzbJ90Ioz/9TI41/hTCvznF/loiSzn8w==", - "requires": { + "dependencies": { "jws": "^3.2.2", "lodash.includes": "^4.3.0", "lodash.isboolean": "^3.0.3", @@ -2231,340 +2986,403 @@ "ms": "^2.1.1", "semver": "^5.6.0" }, - "dependencies": { - "ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" - } + "engines": { + "node": ">=4", + "npm": ">=1.4.28" } }, - "just-extend": { + "node_modules/jsonwebtoken/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + }, + "node_modules/just-extend": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", "dev": true }, - "jwa": { + "node_modules/jwa": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.4.1.tgz", "integrity": "sha512-qiLX/xhEEFKUAJ6FiBMbes3w9ATzyk5W7Hvzpa/SLYdxNtng+gcurvrI7TbACjIXlsJyr05/S1oUhZrc63evQA==", - "requires": { + "dependencies": { "buffer-equal-constant-time": "1.0.1", "ecdsa-sig-formatter": "1.0.11", "safe-buffer": "^5.0.1" } }, - "jws": { + "node_modules/jws": { "version": "3.2.2", "resolved": "https://registry.npmjs.org/jws/-/jws-3.2.2.tgz", "integrity": "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA==", - "requires": { + "dependencies": { "jwa": "^1.4.1", "safe-buffer": "^5.0.1" } }, - "kind-of": { + "node_modules/kind-of": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", - "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==" + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "engines": { + "node": ">=0.10.0" + } }, - "klaw": { + "node_modules/klaw": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==", "dev": true, - "requires": { + "dependencies": { "graceful-fs": "^4.1.9" } }, - "levn": { + "node_modules/levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", "dev": true, - "requires": { + "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" } }, - "linkify-it": { + "node_modules/linkify-it": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz", "integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==", "dev": true, - "requires": { + "dependencies": { "uc.micro": "^1.0.1" } }, - "load-json-file": { + "node_modules/load-json-file": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", "dev": true, - "requires": { + "dependencies": { "graceful-fs": "^4.1.2", "parse-json": "^4.0.0", "pify": "^3.0.0", "strip-bom": "^3.0.0" + }, + "engines": { + "node": ">=4" } }, - "locate-path": { + "node_modules/locate-path": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", "dev": true, - "requires": { + "dependencies": { "p-locate": "^2.0.0", "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=4" } }, - "lodash": { + "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, - "lodash.camelcase": { + "node_modules/lodash.camelcase": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", "integrity": "sha1-soqmKIorn8ZRA1x3EfZathkDMaY=", "dev": true }, - "lodash.clonedeep": { + "node_modules/lodash.clonedeep": { "version": "4.5.0", "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", "dev": true }, - "lodash.includes": { + "node_modules/lodash.includes": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", "integrity": "sha1-YLuYqHy5I8aMoeUTJUgzFISfVT8=" }, - "lodash.isboolean": { + "node_modules/lodash.isboolean": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/lodash.isboolean/-/lodash.isboolean-3.0.3.tgz", "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=" }, - "lodash.isinteger": { + "node_modules/lodash.isinteger": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", "integrity": "sha1-YZwK89A/iwTDH1iChAt3sRzWg0M=" }, - "lodash.ismatch": { + "node_modules/lodash.ismatch": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz", "integrity": "sha1-dWy1FQyjum8RCFp4hJZF8Yj4Xzc=" }, - "lodash.isnumber": { + "node_modules/lodash.isnumber": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/lodash.isnumber/-/lodash.isnumber-3.0.3.tgz", "integrity": "sha1-POdoEMWSjQM1IwGsKHMX8RwLH/w=" }, - "lodash.isplainobject": { + "node_modules/lodash.isplainobject": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/lodash.isplainobject/-/lodash.isplainobject-4.0.6.tgz", "integrity": "sha1-fFJqUtibRcRcxpC4gWO+BJf1UMs=" }, - "lodash.isstring": { + "node_modules/lodash.isstring": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/lodash.isstring/-/lodash.isstring-4.0.1.tgz", "integrity": "sha1-1SfftUVuynzJu5XV2ur4i6VKVFE=" }, - "lodash.merge": { + "node_modules/lodash.merge": { "version": "4.6.2", "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", "dev": true }, - "lodash.omit": { + "node_modules/lodash.omit": { "version": "4.5.0", "resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz", "integrity": "sha1-brGa5aHuHdnfC5aeZs4Lf6MLXmA=", "dev": true }, - "lodash.once": { + "node_modules/lodash.once": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz", "integrity": "sha1-DdOXEhPHxW34gJd9UEyI+0cal6w=" }, - "lodash.padend": { + "node_modules/lodash.padend": { "version": "4.6.1", "resolved": "https://registry.npmjs.org/lodash.padend/-/lodash.padend-4.6.1.tgz", "integrity": "sha1-U8y6BH0G4VjTEfRdpiX05J5vFm4=", "dev": true }, - "lodash.pick": { + "node_modules/lodash.pick": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz", "integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=", "dev": true }, - "lodash.truncate": { + "node_modules/lodash.truncate": { "version": "4.4.2", "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", "dev": true }, - "log-symbols": { + "node_modules/log-symbols": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", "integrity": "sha512-VeIAFslyIerEJLXHziedo2basKbMKtTw3vfn5IzG0XTjhAVEJyNHnL2p7vc+wBDSdQuUpNw3M2u6xb9QsAY5Eg==", "dev": true, - "requires": { + "dependencies": { "chalk": "^2.0.1" }, + "engines": { + "node": ">=4" + } + }, + "node_modules/log-symbols/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, "dependencies": { - "chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "requires": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - } - }, - "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true - } + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/log-symbols/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" } }, - "lolex": { + "node_modules/lolex": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/lolex/-/lolex-4.2.0.tgz", "integrity": "sha512-gKO5uExCXvSm6zbF562EvM+rd1kQDnB9AZBbiQVzf1ZmdDpxUSvpnAaVOP83N/31mRK8Ml8/VE8DMvsAZQ+7wg==", "dev": true }, - "lru-cache": { + "node_modules/lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", "dev": true, - "requires": { + "dependencies": { "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" } }, - "lunr": { + "node_modules/lunr": { "version": "2.3.9", "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", "dev": true }, - "luxon": { + "node_modules/luxon": { "version": "1.27.0", "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.27.0.tgz", - "integrity": "sha512-VKsFsPggTA0DvnxtJdiExAucKdAnwbCCNlMM5ENvHlxubqWd0xhZcdb4XgZ7QFNhaRhilXCFxHuoObP5BNA4PA==" + "integrity": "sha512-VKsFsPggTA0DvnxtJdiExAucKdAnwbCCNlMM5ENvHlxubqWd0xhZcdb4XgZ7QFNhaRhilXCFxHuoObP5BNA4PA==", + "engines": { + "node": "*" + } }, - "markdown-it": { + "node_modules/markdown-it": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==", "dev": true, - "requires": { + "dependencies": { "argparse": "^1.0.7", "entities": "~2.0.0", "linkify-it": "^2.0.0", "mdurl": "^1.0.1", "uc.micro": "^1.0.5" + }, + "bin": { + "markdown-it": "bin/markdown-it.js" } }, - "markdown-it-anchor": { + "node_modules/markdown-it-anchor": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", - "dev": true + "dev": true, + "peerDependencies": { + "markdown-it": "*" + } }, - "marked": { + "node_modules/marked": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", - "dev": true + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">=0.10.0" + } }, - "mdurl": { + "node_modules/mdurl": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", "dev": true }, - "media-typer": { + "node_modules/media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", - "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=" + "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=", + "engines": { + "node": ">= 0.6" + } }, - "merge-descriptors": { + "node_modules/merge-descriptors": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", "integrity": "sha1-sAqqVW3YtEVoFQ7J0blT8/kMu2E=", "dev": true }, - "merge2": { + "node_modules/merge2": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true + "dev": true, + "engines": { + "node": ">= 8" + } }, - "micromatch": { + "node_modules/micromatch": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", "dev": true, - "requires": { + "dependencies": { "braces": "^3.0.1", "picomatch": "^2.2.3" + }, + "engines": { + "node": ">=8.6" } }, - "mime-db": { + "node_modules/mime-db": { "version": "1.48.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.48.0.tgz", - "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==" + "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==", + "engines": { + "node": ">= 0.6" + } }, - "mime-types": { + "node_modules/mime-types": { "version": "2.1.31", "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.31.tgz", "integrity": "sha512-XGZnNzm3QvgKxa8dpzyhFTHmpP3l5YNusmne07VUOXxou9CqUqYa/HBy124RqtVh/O2pECas/MOcsDgpilPOPg==", - "requires": { + "dependencies": { "mime-db": "1.48.0" + }, + "engines": { + "node": ">= 0.6" } }, - "minimatch": { + "node_modules/minimatch": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, - "requires": { + "dependencies": { "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" } }, - "minimist": { + "node_modules/minimist": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", "dev": true }, - "mkdirp": { + "node_modules/mkdirp": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true + "dev": true, + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } }, - "mkdirp2": { + "node_modules/mkdirp2": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/mkdirp2/-/mkdirp2-1.0.4.tgz", "integrity": "sha512-Q2PKB4ZR4UPtjLl76JfzlgSCUZhSV1AXQgAZa1qt5RiaALFjP/CDrGvFBrOz7Ck6McPcwMAxTsJvWOUjOU8XMw==", "dev": true }, - "mocha": { + "node_modules/mocha": { "version": "6.2.3", "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.3.tgz", "integrity": "sha512-0R/3FvjIGH3eEuG17ccFPk117XL2rWxatr81a57D+r/x2uTYZRbdZ4oVidEUMh2W2TJDa7MdAb12Lm2/qrKajg==", "dev": true, - "requires": { + "dependencies": { "ansi-colors": "3.2.3", "browser-stdout": "1.3.1", "debug": "3.2.6", @@ -2589,791 +3407,1059 @@ "yargs-parser": "13.1.2", "yargs-unparser": "1.6.0" }, - "dependencies": { - "ansi-colors": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", - "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", - "dev": true - }, - "debug": { - "version": "3.2.6", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", - "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - }, - "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true - }, - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", - "dev": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "js-yaml": { - "version": "3.13.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", - "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", - "dev": true, - "requires": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - } - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "mkdirp": { - "version": "0.5.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.4.tgz", - "integrity": "sha512-iG9AK/dJLtJ0XNgTuDbSyNS3zECqDlAhnQW4CsNxBG3LQJBbHmRX1egw39DmtOdCAqY+dKXV+sgPgilNWUKMVw==", - "dev": true, - "requires": { - "minimist": "^1.2.5" - } - }, - "ms": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", - "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", - "dev": true - }, - "object.assign": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", - "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", - "dev": true, - "requires": { - "define-properties": "^1.1.2", - "function-bind": "^1.1.1", - "has-symbols": "^1.0.0", - "object-keys": "^1.0.11" - } - }, - "p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - }, - "strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", - "dev": true - }, - "supports-color": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", - "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } - }, - "which": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", - "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } + "bin": { + "_mocha": "bin/_mocha", + "mocha": "bin/mocha" + }, + "engines": { + "node": ">= 6.0.0" } }, - "module-not-found-error": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/module-not-found-error/-/module-not-found-error-1.0.1.tgz", - "integrity": "sha1-z4tP9PKWQGdNbN0CsOO8UjwrvcA=", - "dev": true - }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + "node_modules/mocha/node_modules/ansi-colors": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", + "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "dev": true, + "engines": { + "node": ">=6" + } }, - "natural-compare": { - "version": "1.4.0", + "node_modules/mocha/node_modules/debug": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", + "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", + "deprecated": "Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/mocha/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/mocha/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + } + }, + "node_modules/mocha/node_modules/js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/mocha/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/mkdirp": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.4.tgz", + "integrity": "sha512-iG9AK/dJLtJ0XNgTuDbSyNS3zECqDlAhnQW4CsNxBG3LQJBbHmRX1egw39DmtOdCAqY+dKXV+sgPgilNWUKMVw==", + "deprecated": "Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)", + "dev": true, + "dependencies": { + "minimist": "^1.2.5" + }, + "bin": { + "mkdirp": "bin/cmd.js" + } + }, + "node_modules/mocha/node_modules/ms": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", + "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", + "dev": true + }, + "node_modules/mocha/node_modules/object.assign": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", + "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/mocha/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mocha/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/mocha/node_modules/supports-color": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", + "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "which": "bin/which" + } + }, + "node_modules/module-not-found-error": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/module-not-found-error/-/module-not-found-error-1.0.1.tgz", + "integrity": "sha1-z4tP9PKWQGdNbN0CsOO8UjwrvcA=", + "dev": true + }, + "node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + }, + "node_modules/natural-compare": { + "version": "1.4.0", "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", "dev": true }, - "neo-async": { + "node_modules/neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", "dev": true }, - "nise": { + "node_modules/nise": { "version": "1.5.3", "resolved": "https://registry.npmjs.org/nise/-/nise-1.5.3.tgz", "integrity": "sha512-Ymbac/94xeIrMf59REBPOv0thr+CJVFMhrlAkW/gjCIE58BGQdCj0x7KRCb3yz+Ga2Rz3E9XXSvUyyxqqhjQAQ==", "dev": true, - "requires": { + "dependencies": { "@sinonjs/formatio": "^3.2.1", "@sinonjs/text-encoding": "^0.7.1", "just-extend": "^4.0.2", "lolex": "^5.0.1", "path-to-regexp": "^1.7.0" - }, + } + }, + "node_modules/nise/node_modules/lolex": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/lolex/-/lolex-5.1.2.tgz", + "integrity": "sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A==", + "dev": true, "dependencies": { - "lolex": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/lolex/-/lolex-5.1.2.tgz", - "integrity": "sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A==", - "dev": true, - "requires": { - "@sinonjs/commons": "^1.7.0" - } - } + "@sinonjs/commons": "^1.7.0" } }, - "node-environment-flags": { + "node_modules/node-environment-flags": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz", "integrity": "sha512-VNYPRfGfmZLx0Ye20jWzHUjyTW/c+6Wq+iLhDzUI4XmhrDd9l/FozXV3F2xOaXjvp0co0+v1YSR3CMP6g+VvLQ==", "dev": true, - "requires": { + "dependencies": { "object.getownpropertydescriptors": "^2.0.3", "semver": "^5.7.0" } }, - "normalize-package-data": { + "node_modules/normalize-package-data": { "version": "2.5.0", "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", "dev": true, - "requires": { + "dependencies": { "hosted-git-info": "^2.1.4", "resolve": "^1.10.0", "semver": "2 || 3 || 4 || 5", "validate-npm-package-license": "^3.0.1" } }, - "object-get": { + "node_modules/object-get": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.1.tgz", "integrity": "sha512-7n4IpLMzGGcLEMiQKsNR7vCe+N5E9LORFrtNUVy4sO3dj9a3HedZCxEL2T7QuLhcHN1NBuBsMOKaOsAYI9IIvg==", "dev": true }, - "object-inspect": { + "node_modules/object-inspect": { "version": "1.10.3", "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.10.3.tgz", - "integrity": "sha512-e5mCJlSH7poANfC8z8S9s9S2IN5/4Zb3aZ33f5s8YqoazCFzNLloLU8r5VCG+G7WoqLvAAZoVMcy3tp/3X0Plw==" + "integrity": "sha512-e5mCJlSH7poANfC8z8S9s9S2IN5/4Zb3aZ33f5s8YqoazCFzNLloLU8r5VCG+G7WoqLvAAZoVMcy3tp/3X0Plw==", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, - "object-keys": { + "node_modules/object-keys": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.4" + } }, - "object-to-spawn-args": { + "node_modules/object-to-spawn-args": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-to-spawn-args/-/object-to-spawn-args-1.1.1.tgz", "integrity": "sha1-d9qIJ/Bz0BHJ4bFz+JV4FHAkZ4U=", "dev": true }, - "object.assign": { + "node_modules/object.assign": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.0", "define-properties": "^1.1.3", "has-symbols": "^1.0.1", "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "object.entries": { + "node_modules/object.entries": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "define-properties": "^1.1.3", "es-abstract": "^1.18.2" + }, + "engines": { + "node": ">= 0.4" } }, - "object.getownpropertydescriptors": { + "node_modules/object.getownpropertydescriptors": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.2.tgz", "integrity": "sha512-WtxeKSzfBjlzL+F9b7M7hewDzMwy+C8NRssHd1YrNlzHzIDrXcXiNOMrezdAEM4UXixgV+vvnyBeN7Rygl2ttQ==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "define-properties": "^1.1.3", "es-abstract": "^1.18.0-next.2" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "object.values": { + "node_modules/object.values": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.4.tgz", "integrity": "sha512-TnGo7j4XSnKQoK3MfvkzqKCi0nVe/D9I9IjwTNYdb/fxYHpjrluHVOgw0AF6jrRFGMPHdfuidR09tIDiIvnaSg==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "define-properties": "^1.1.3", "es-abstract": "^1.18.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "on-finished": { + "node_modules/on-finished": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", - "requires": { + "dependencies": { "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" } }, - "once": { + "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, - "requires": { + "dependencies": { "wrappy": "1" } }, - "onigasm": { + "node_modules/onigasm": { "version": "2.2.5", "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", "dev": true, - "requires": { + "dependencies": { "lru-cache": "^5.1.1" - }, + } + }, + "node_modules/onigasm/node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, "dependencies": { - "lru-cache": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", - "dev": true, - "requires": { - "yallist": "^3.0.2" - } - }, - "yallist": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", - "dev": true - } + "yallist": "^3.0.2" } }, - "optionator": { + "node_modules/onigasm/node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + }, + "node_modules/optionator": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", "dev": true, - "requires": { + "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", "type-check": "^0.4.0", "word-wrap": "^1.2.3" + }, + "engines": { + "node": ">= 0.8.0" } }, - "p-limit": { + "node_modules/p-limit": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", "dev": true, - "requires": { + "dependencies": { "p-try": "^1.0.0" + }, + "engines": { + "node": ">=4" } }, - "p-locate": { + "node_modules/p-locate": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", "dev": true, - "requires": { + "dependencies": { "p-limit": "^1.1.0" + }, + "engines": { + "node": ">=4" } }, - "p-try": { + "node_modules/p-try": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "parent-module": { + "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", "dev": true, - "requires": { + "dependencies": { "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" } }, - "parse-json": { + "node_modules/parse-json": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", "dev": true, - "requires": { + "dependencies": { "error-ex": "^1.3.1", "json-parse-better-errors": "^1.0.1" + }, + "engines": { + "node": ">=4" } }, - "path-exists": { + "node_modules/path-exists": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "path-is-absolute": { + "node_modules/path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "path-key": { + "node_modules/path-key": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "path-parse": { + "node_modules/path-parse": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, - "path-to-regexp": { + "node_modules/path-to-regexp": { "version": "1.8.0", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", "dev": true, - "requires": { + "dependencies": { "isarray": "0.0.1" } }, - "path-type": { + "node_modules/path-type": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "pathval": { + "node_modules/pathval": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", - "dev": true + "dev": true, + "engines": { + "node": "*" + } }, - "picomatch": { + "node_modules/picomatch": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", - "dev": true + "dev": true, + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } }, - "pify": { + "node_modules/pify": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "pkg-dir": { + "node_modules/pkg-dir": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-2.0.0.tgz", "integrity": "sha1-9tXREJ4Z1j7fQo4L1X4Sd3YVM0s=", "dev": true, - "requires": { + "dependencies": { "find-up": "^2.1.0" + }, + "engines": { + "node": ">=4" } }, - "pkg-up": { + "node_modules/pkg-up": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/pkg-up/-/pkg-up-2.0.0.tgz", "integrity": "sha1-yBmscoBZpGHKscOImivjxJoATX8=", "dev": true, - "requires": { + "dependencies": { "find-up": "^2.1.0" + }, + "engines": { + "node": ">=4" } }, - "prelude-ls": { + "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", - "dev": true + "dev": true, + "engines": { + "node": ">= 0.8.0" + } }, - "progress": { + "node_modules/progress": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.4.0" + } }, - "proxy-from-env": { + "node_modules/proxy-from-env": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==" }, - "proxyquire": { + "node_modules/proxyquire": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/proxyquire/-/proxyquire-2.1.3.tgz", "integrity": "sha512-BQWfCqYM+QINd+yawJz23tbBM40VIGXOdDw3X344KcclI/gtBbdWF6SlQ4nK/bYhF9d27KYug9WzljHC6B9Ysg==", "dev": true, - "requires": { + "dependencies": { "fill-keys": "^1.0.2", "module-not-found-error": "^1.0.1", "resolve": "^1.11.1" } }, - "punycode": { + "node_modules/punycode": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", - "dev": true + "dev": true, + "engines": { + "node": ">=6" + } }, - "qs": { + "node_modules/qs": { "version": "6.10.1", "resolved": "https://registry.npmjs.org/qs/-/qs-6.10.1.tgz", "integrity": "sha512-M528Hph6wsSVOBiYUnGf+K/7w0hNshs/duGsNXPUCLH5XAqjEtiPGwNONLV0tBH8NoGb0mvD5JubnUTrujKDTg==", - "requires": { + "dependencies": { "side-channel": "^1.0.4" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "queue-microtask": { + "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dev": true + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] }, - "raw-body": { + "node_modules/raw-body": { "version": "2.4.0", "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.4.0.tgz", "integrity": "sha512-4Oz8DUIwdvoa5qMJelxipzi/iJIi40O5cGV1wNYp5hvZP8ZN0T+jiNkL0QepXs+EsQ9XJ8ipEDoiH70ySUJP3Q==", - "requires": { + "dependencies": { "bytes": "3.1.0", "http-errors": "1.7.2", "iconv-lite": "0.4.24", "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" } }, - "read-pkg": { + "node_modules/read-pkg": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", "dev": true, - "requires": { + "dependencies": { "load-json-file": "^4.0.0", "normalize-package-data": "^2.3.2", "path-type": "^3.0.0" }, - "dependencies": { - "path-type": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", - "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", - "dev": true, - "requires": { - "pify": "^3.0.0" - } - } + "engines": { + "node": ">=4" } }, - "read-pkg-up": { + "node_modules/read-pkg-up": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", "dev": true, - "requires": { + "dependencies": { "find-up": "^2.0.0", "read-pkg": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/read-pkg/node_modules/path-type": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", + "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", + "dev": true, + "dependencies": { + "pify": "^3.0.0" + }, + "engines": { + "node": ">=4" } }, - "rechoir": { + "node_modules/rechoir": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", "dev": true, - "requires": { + "dependencies": { "resolve": "^1.1.6" + }, + "engines": { + "node": ">= 0.10" } }, - "reduce-extract": { + "node_modules/reduce-extract": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz", "integrity": "sha1-Z/I4W+2mUGG19fQxJmLosIDKFSU=", "dev": true, - "requires": { + "dependencies": { "test-value": "^1.0.1" }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-extract/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, "dependencies": { - "array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "requires": { - "typical": "^2.6.0" - } - }, - "test-value": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz", - "integrity": "sha1-oJE29y7AQ9J8iTcHwrFZv6196T8=", - "dev": true, - "requires": { - "array-back": "^1.0.2", - "typical": "^2.4.2" - } - } + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" } }, - "reduce-flatten": { + "node_modules/reduce-extract/node_modules/test-value": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz", + "integrity": "sha1-oJE29y7AQ9J8iTcHwrFZv6196T8=", + "dev": true, + "dependencies": { + "array-back": "^1.0.2", + "typical": "^2.4.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-flatten": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-1.0.1.tgz", "integrity": "sha1-JYx479FT3fk8tWEjf2EYTzaW4yc=", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "reduce-unique": { + "node_modules/reduce-unique": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/reduce-unique/-/reduce-unique-2.0.1.tgz", "integrity": "sha512-x4jH/8L1eyZGR785WY+ePtyMNhycl1N2XOLxhCbzZFaqF4AXjLzqSxa2UHgJ2ZVR/HHyPOvl1L7xRnW8ye5MdA==", - "dev": true + "dev": true, + "engines": { + "node": ">=6" + } }, - "reduce-without": { + "node_modules/reduce-without": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/reduce-without/-/reduce-without-1.0.1.tgz", "integrity": "sha1-aK0OrRGFXJo31OglbBW7+Hly/Iw=", "dev": true, - "requires": { + "dependencies": { "test-value": "^2.0.0" }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-without/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, "dependencies": { - "array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "requires": { - "typical": "^2.6.0" - } - }, - "test-value": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz", - "integrity": "sha1-Edpv9nDzRxpztiXKTz/c97t0gpE=", - "dev": true, - "requires": { - "array-back": "^1.0.3", - "typical": "^2.6.0" - } - } + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/reduce-without/node_modules/test-value": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz", + "integrity": "sha1-Edpv9nDzRxpztiXKTz/c97t0gpE=", + "dev": true, + "dependencies": { + "array-back": "^1.0.3", + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.10.0" } }, - "regexpp": { + "node_modules/regexpp": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.1.0.tgz", "integrity": "sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } }, - "require-directory": { + "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "require-from-string": { + "node_modules/require-from-string": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "require-main-filename": { + "node_modules/require-main-filename": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, - "requizzle": { + "node_modules/requizzle": { "version": "0.2.3", "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz", "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==", "dev": true, - "requires": { + "dependencies": { "lodash": "^4.17.14" } }, - "resolve": { + "node_modules/resolve": { "version": "1.20.0", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", "dev": true, - "requires": { + "dependencies": { "is-core-module": "^2.2.0", "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "resolve-from": { + "node_modules/resolve-from": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "reusify": { + "node_modules/reusify": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dev": true + "dev": true, + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } }, - "rimraf": { + "node_modules/rimraf": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", "dev": true, - "requires": { + "dependencies": { "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, - "run-parallel": { + "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", "dev": true, - "requires": { + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { "queue-microtask": "^1.2.2" } }, - "safe-buffer": { + "node_modules/safe-buffer": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==" + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] }, - "safer-buffer": { + "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" }, - "semver": { + "node_modules/semver": { "version": "5.7.1", "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==" + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "bin": { + "semver": "bin/semver" + } }, - "set-blocking": { + "node_modules/set-blocking": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", "dev": true }, - "setprototypeof": { + "node_modules/setprototypeof": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz", "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==" }, - "shallow-clone": { + "node_modules/shallow-clone": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", - "requires": { + "dependencies": { "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" } }, - "shebang-command": { + "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", "dev": true, - "requires": { + "dependencies": { "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" } }, - "shebang-regex": { + "node_modules/shebang-regex": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "shelljs": { + "node_modules/shelljs": { "version": "0.8.4", "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz", "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==", "dev": true, - "requires": { + "dependencies": { "glob": "^7.0.0", "interpret": "^1.0.0", "rechoir": "^0.6.2" + }, + "bin": { + "shjs": "bin/shjs" + }, + "engines": { + "node": ">=4" } }, - "shiki": { + "node_modules/shiki": { "version": "0.9.3", "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz", "integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==", "dev": true, - "requires": { + "dependencies": { "onigasm": "^2.2.5", "vscode-textmate": "^5.2.0" } }, - "side-channel": { + "node_modules/side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", - "requires": { + "dependencies": { "call-bind": "^1.0.0", "get-intrinsic": "^1.0.2", "object-inspect": "^1.9.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "sinon": { + "node_modules/sinon": { "version": "7.5.0", "resolved": "https://registry.npmjs.org/sinon/-/sinon-7.5.0.tgz", "integrity": "sha512-AoD0oJWerp0/rY9czP/D6hDTTUYGpObhZjMpd7Cl/A6+j0xBE+ayL/ldfggkBXUs0IkvIiM1ljM8+WkOc5k78Q==", + "deprecated": "16.1.1", "dev": true, - "requires": { + "dependencies": { "@sinonjs/commons": "^1.4.0", "@sinonjs/formatio": "^3.2.1", "@sinonjs/samsam": "^3.3.3", @@ -3383,221 +4469,278 @@ "supports-color": "^5.5.0" } }, - "slash": { + "node_modules/slash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + } }, - "slice-ansi": { + "node_modules/slice-ansi": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", "dev": true, - "requires": { + "dependencies": { "ansi-styles": "^4.0.0", "astral-regex": "^2.0.0", "is-fullwidth-code-point": "^3.0.0" }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/slice-ansi/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, "dependencies": { - "ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "requires": { - "color-convert": "^2.0.1" - } - }, - "color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "requires": { - "color-name": "~1.1.4" - } - }, - "color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - } + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/slice-ansi/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" } }, - "sort-array": { + "node_modules/slice-ansi/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/sort-array": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/sort-array/-/sort-array-2.0.0.tgz", "integrity": "sha1-OKnG2if9fRR7QuYFVPKBGHtN9HI=", "dev": true, - "requires": { + "dependencies": { "array-back": "^1.0.4", "object-get": "^2.1.0", "typical": "^2.6.0" }, + "engines": { + "node": ">=4" + } + }, + "node_modules/sort-array/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, "dependencies": { - "array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "requires": { - "typical": "^2.6.0" - } - } + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" } }, - "source-map": { + "node_modules/source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "engines": { + "node": ">=0.10.0" + } }, - "source-map-support": { + "node_modules/source-map-support": { "version": "0.5.19", "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", - "requires": { + "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" } }, - "spdx-correct": { + "node_modules/spdx-correct": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", "dev": true, - "requires": { + "dependencies": { "spdx-expression-parse": "^3.0.0", "spdx-license-ids": "^3.0.0" } }, - "spdx-exceptions": { + "node_modules/spdx-exceptions": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", "dev": true }, - "spdx-expression-parse": { + "node_modules/spdx-expression-parse": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", "dev": true, - "requires": { + "dependencies": { "spdx-exceptions": "^2.1.0", "spdx-license-ids": "^3.0.0" } }, - "spdx-license-ids": { + "node_modules/spdx-license-ids": { "version": "3.0.9", "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.9.tgz", "integrity": "sha512-Ki212dKK4ogX+xDo4CtOZBVIwhsKBEfsEEcwmJfLQzirgc2jIWdzg40Unxz/HzEUqM1WFzVlQSMF9kZZ2HboLQ==", "dev": true }, - "sprintf-js": { + "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, - "statuses": { + "node_modules/statuses": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", - "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=" + "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=", + "engines": { + "node": ">= 0.6" + } }, - "stream-connect": { + "node_modules/stream-connect": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz", "integrity": "sha1-GLyB8u2zW4tdmoAJIAqYUxRCipc=", "dev": true, - "requires": { + "dependencies": { "array-back": "^1.0.2" }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stream-connect/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", + "dev": true, "dependencies": { - "array-back": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", - "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=", - "dev": true, - "requires": { - "typical": "^2.6.0" - } - } + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" } }, - "stream-via": { + "node_modules/stream-via": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/stream-via/-/stream-via-1.0.4.tgz", "integrity": "sha512-DBp0lSvX5G9KGRDTkR/R+a29H+Wk2xItOF+MpZLLNDWbEV9tGPnqLPxHEYjmiz8xGtJHRIqmI+hCjmNzqoA4nQ==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "string-width": { + "node_modules/string-width": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.2.tgz", "integrity": "sha512-XBJbT3N4JhVumXE0eoLU9DCjcaF92KLNqTmFCnG1pf8duUxFGwtP6AD6nkjw9a3IdiRtL3E2w3JDiE/xi3vOeA==", "dev": true, - "requires": { + "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=8" } }, - "string.prototype.trimend": { + "node_modules/string.prototype.trimend": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "string.prototype.trimstart": { + "node_modules/string.prototype.trimstart": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", "dev": true, - "requires": { + "dependencies": { "call-bind": "^1.0.2", "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "strip-ansi": { + "node_modules/strip-ansi": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", "dev": true, - "requires": { + "dependencies": { "ansi-regex": "^5.0.0" + }, + "engines": { + "node": ">=8" } }, - "strip-bom": { + "node_modules/strip-bom": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "strip-json-comments": { + "node_modules/strip-json-comments": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } }, - "supports-color": { + "node_modules/supports-color": { "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", "dev": true, - "requires": { + "dependencies": { "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" } }, - "table": { + "node_modules/table": { "version": "6.7.1", "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", "integrity": "sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg==", "dev": true, - "requires": { + "dependencies": { "ajv": "^8.0.1", "lodash.clonedeep": "^4.5.0", "lodash.truncate": "^4.4.2", @@ -3605,167 +4748,207 @@ "string-width": "^4.2.0", "strip-ansi": "^6.0.0" }, - "dependencies": { - "ajv": { - "version": "8.6.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.0.tgz", - "integrity": "sha512-cnUG4NSBiM4YFBxgZIj/In3/6KX+rQ2l2YPRVcvAMQGWEPKuXoPIhxzwqh31jA3IPbI4qEOp/5ILI4ynioXsGQ==", - "dev": true, - "requires": { - "fast-deep-equal": "^3.1.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.2.2" - } - }, - "json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "dev": true - } + "engines": { + "node": ">=10.0.0" } }, - "table-layout": { + "node_modules/table-layout": { "version": "0.4.5", "resolved": "https://registry.npmjs.org/table-layout/-/table-layout-0.4.5.tgz", "integrity": "sha512-zTvf0mcggrGeTe/2jJ6ECkJHAQPIYEwDoqsiqBjI24mvRmQbInK5jq33fyypaCBxX08hMkfmdOqj6haT33EqWw==", "dev": true, - "requires": { + "dependencies": { "array-back": "^2.0.0", "deep-extend": "~0.6.0", "lodash.padend": "^4.6.1", "typical": "^2.6.1", "wordwrapjs": "^3.0.0" }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/table-layout/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/table/node_modules/ajv": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.0.tgz", + "integrity": "sha512-cnUG4NSBiM4YFBxgZIj/In3/6KX+rQ2l2YPRVcvAMQGWEPKuXoPIhxzwqh31jA3IPbI4qEOp/5ILI4ynioXsGQ==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "taffydb": { + "node_modules/table/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + }, + "node_modules/taffydb": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz", "integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=", "dev": true }, - "temp-path": { + "node_modules/temp-path": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/temp-path/-/temp-path-1.0.0.tgz", "integrity": "sha1-JLFUOXOrRCiW2a02fdnL2/r+kYs=", "dev": true }, - "test-value": { + "node_modules/test-value": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/test-value/-/test-value-3.0.0.tgz", "integrity": "sha512-sVACdAWcZkSU9x7AOmJo5TqE+GyNJknHaHsMrR6ZnhjVlVN9Yx6FjHrsKZ3BjIpPCT68zYesPWkakrNupwfOTQ==", "dev": true, - "requires": { + "dependencies": { "array-back": "^2.0.0", "typical": "^2.6.1" }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/test-value/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, "dependencies": { - "array-back": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", - "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", - "dev": true, - "requires": { - "typical": "^2.6.1" - } - } + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" } }, - "text-table": { + "node_modules/text-table": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, - "to-regex-range": { + "node_modules/to-regex-range": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", "dev": true, - "requires": { + "dependencies": { "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" } }, - "toidentifier": { + "node_modules/toidentifier": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", - "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==" + "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==", + "engines": { + "node": ">=0.6" + } }, - "tsconfig-paths": { + "node_modules/tsconfig-paths": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", "integrity": "sha512-dRcuzokWhajtZWkQsDVKbWyY+jgcLC5sqJhg2PSgf4ZkH2aHPvaOY8YWGhmjb68b5qqTfasSsDO9k7RUiEmZAw==", "dev": true, - "requires": { + "dependencies": { "@types/json5": "^0.0.29", "json5": "^1.0.1", "minimist": "^1.2.0", "strip-bom": "^3.0.0" } }, - "tslib": { + "node_modules/tslib": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", "dev": true }, - "tsutils": { + "node_modules/tsutils": { "version": "3.21.0", "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", "dev": true, - "requires": { + "dependencies": { "tslib": "^1.8.1" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" } }, - "type-check": { + "node_modules/type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, - "requires": { + "dependencies": { "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" } }, - "type-detect": { + "node_modules/type-detect": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", - "dev": true + "dev": true, + "engines": { + "node": ">=4" + } }, - "type-fest": { + "node_modules/type-fest": { "version": "0.20.2", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } }, - "type-is": { + "node_modules/type-is": { "version": "1.6.18", "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", - "requires": { + "dependencies": { "media-typer": "0.3.0", "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" } }, - "typedoc": { + "node_modules/typedoc": { "version": "0.20.36", "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.36.tgz", "integrity": "sha512-qFU+DWMV/hifQ9ZAlTjdFO9wbUIHuUBpNXzv68ZyURAP9pInjZiO4+jCPeAzHVcaBCHER9WL/+YzzTt6ZlN/Nw==", "dev": true, - "requires": { + "dependencies": { "colors": "^1.4.0", "fs-extra": "^9.1.0", "handlebars": "^4.7.7", @@ -3778,300 +4961,389 @@ "shiki": "^0.9.3", "typedoc-default-themes": "^0.12.10" }, - "dependencies": { - "marked": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", - "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", - "dev": true - } + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 10.8.0" + }, + "peerDependencies": { + "typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x" } }, - "typedoc-default-themes": { + "node_modules/typedoc-default-themes": { "version": "0.12.10", "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", - "dev": true + "dev": true, + "engines": { + "node": ">= 8" + } }, - "typedoc-github-wiki-theme": { + "node_modules/typedoc-github-wiki-theme": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/typedoc-github-wiki-theme/-/typedoc-github-wiki-theme-0.3.0.tgz", "integrity": "sha512-YMnpahBvsk0FlmHM3Djq+U25YZgiXSXdNzPRqu/mQY9QXHHzIKJmLm6r3Qz2U2NfD7xWyfoODpX/UY5Zz9434g==", - "dev": true + "dev": true, + "peerDependencies": { + "typedoc": ">=0.20.0", + "typedoc-plugin-markdown": ">=3.4.0" + } }, - "typedoc-plugin-markdown": { + "node_modules/typedoc-plugin-markdown": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.9.0.tgz", "integrity": "sha512-s445YeUe8bH7me15T+hsHZgNmAvvF7QIpX02vFgseLGtghAwmtdZYVOqPneWoKqRv/JNpPSuyZb3CeblML9jOg==", "dev": true, - "requires": { + "dependencies": { "handlebars": "^4.7.7" + }, + "engines": { + "node": ">= 10.8.0" + }, + "peerDependencies": { + "typedoc": ">=0.20.0" + } + }, + "node_modules/typedoc/node_modules/marked": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.7.tgz", + "integrity": "sha512-BJXxkuIfJchcXOJWTT2DOL+yFWifFv2yGYOUzvXg8Qz610QKw+sHCvTMYwA+qWGhlA2uivBezChZ/pBy1tWdkQ==", + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">= 8.16.2" } }, - "typescript": { + "node_modules/typescript": { "version": "4.2.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz", "integrity": "sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==", - "dev": true + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } }, - "typical": { + "node_modules/typical": { "version": "2.6.1", "resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz", "integrity": "sha1-XAgOXWYcu+OCWdLnCjxyU+hziB0=", "dev": true }, - "uc.micro": { + "node_modules/uc.micro": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", "dev": true }, - "uglify-js": { + "node_modules/uglify-js": { "version": "3.13.9", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.9.tgz", "integrity": "sha512-wZbyTQ1w6Y7fHdt8sJnHfSIuWeDgk6B5rCb4E/AM6QNNPbOMIZph21PW5dRB3h7Df0GszN+t7RuUH6sWK5bF0g==", "dev": true, - "optional": true + "optional": true, + "bin": { + "uglifyjs": "bin/uglifyjs" + }, + "engines": { + "node": ">=0.8.0" + } }, - "unbox-primitive": { + "node_modules/unbox-primitive": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", "dev": true, - "requires": { + "dependencies": { "function-bind": "^1.1.1", "has-bigints": "^1.0.1", "has-symbols": "^1.0.2", "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "underscore": { + "node_modules/underscore": { "version": "1.13.1", "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.1.tgz", "integrity": "sha512-hzSoAVtJF+3ZtiFX0VgfFPHEDRm7Y/QPjGyNo4TVdnDTdft3tr8hEkD25a1jC+TjTuE7tkHGKkhwCgs9dgBB2g==", "dev": true }, - "universalify": { + "node_modules/universalify": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", - "dev": true + "dev": true, + "engines": { + "node": ">= 10.0.0" + } }, - "unpipe": { + "node_modules/unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", - "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" + "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=", + "engines": { + "node": ">= 0.8" + } }, - "uri-js": { + "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", "dev": true, - "requires": { + "dependencies": { "punycode": "^2.1.0" } }, - "v8-compile-cache": { + "node_modules/v8-compile-cache": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", "dev": true }, - "validate-npm-package-license": { + "node_modules/validate-npm-package-license": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", "dev": true, - "requires": { + "dependencies": { "spdx-correct": "^3.0.0", "spdx-expression-parse": "^3.0.0" } }, - "vscode-textmate": { + "node_modules/vscode-textmate": { "version": "5.4.0", "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.4.0.tgz", "integrity": "sha512-c0Q4zYZkcLizeYJ3hNyaVUM2AA8KDhNCA3JvXY8CeZSJuBdAy3bAvSbv46RClC4P3dSO9BdwhnKEx2zOo6vP/w==", "dev": true }, - "walk-back": { + "node_modules/walk-back": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-4.0.0.tgz", "integrity": "sha512-kudCA8PXVQfrqv2mFTG72vDBRi8BKWxGgFLwPpzHcpZnSwZk93WMwUDVcLHWNsnm+Y0AC4Vb6MUNRgaHfyV2DQ==", - "dev": true + "dev": true, + "engines": { + "node": ">=8.0.0" + } }, - "which": { + "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", "dev": true, - "requires": { + "dependencies": { "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" } }, - "which-boxed-primitive": { + "node_modules/which-boxed-primitive": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", "dev": true, - "requires": { + "dependencies": { "is-bigint": "^1.0.1", "is-boolean-object": "^1.1.0", "is-number-object": "^1.0.4", "is-string": "^1.0.5", "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "which-module": { + "node_modules/which-module": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", "dev": true }, - "wide-align": { + "node_modules/wide-align": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", "integrity": "sha512-QGkOQc8XL6Bt5PwnsExKBPuMKBxnGxWWW3fU55Xt4feHozMUhdUMaBCk290qpm/wG5u/RSKzwdAC4i51YigihA==", "dev": true, - "requires": { + "dependencies": { "string-width": "^1.0.2 || 2" + } + }, + "node_modules/wide-align/node_modules/ansi-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", + "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/string-width": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", + "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", + "dev": true, + "dependencies": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" }, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/strip-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", + "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", + "dev": true, "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "requires": { - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" - } - }, - "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "requires": { - "ansi-regex": "^3.0.0" - } - } + "ansi-regex": "^3.0.0" + }, + "engines": { + "node": ">=4" } }, - "word-wrap": { + "node_modules/word-wrap": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", - "dev": true + "dev": true, + "engines": { + "node": ">=0.10.0" + } }, - "wordwrap": { + "node_modules/wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", "dev": true }, - "wordwrapjs": { + "node_modules/wordwrapjs": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-3.0.0.tgz", "integrity": "sha512-mO8XtqyPvykVCsrwj5MlOVWvSnCdT+C+QVbm6blradR7JExAhbkZ7hZ9A+9NUtwzSqrlUo9a67ws0EiILrvRpw==", "dev": true, - "requires": { + "dependencies": { "reduce-flatten": "^1.0.1", "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" } }, - "wrap-ansi": { + "node_modules/wrap-ansi": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", "dev": true, - "requires": { + "dependencies": { "ansi-styles": "^3.2.0", "string-width": "^3.0.0", "strip-ansi": "^5.0.0" }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/wrap-ansi/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/wrap-ansi/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, "dependencies": { - "ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", - "dev": true - }, - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - } - }, - "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "requires": { - "ansi-regex": "^4.1.0" - } - } + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" } }, - "wrappy": { + "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", "dev": true }, - "xmlcreate": { + "node_modules/xmlcreate": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz", "integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==", "dev": true }, - "y18n": { + "node_modules/y18n": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", "dev": true }, - "yallist": { + "node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, - "yargs": { + "node_modules/yargs": { "version": "13.3.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", "dev": true, - "requires": { + "dependencies": { "cliui": "^5.0.0", "find-up": "^3.0.0", "get-caller-file": "^2.0.1", @@ -4082,110 +5354,141 @@ "which-module": "^2.0.0", "y18n": "^4.0.0", "yargs-parser": "^13.1.2" - }, - "dependencies": { - "ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", - "dev": true - }, - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - }, - "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - } - }, - "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "requires": { - "ansi-regex": "^4.1.0" - } - } } }, - "yargs-parser": { + "node_modules/yargs-parser": { "version": "13.1.2", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", "dev": true, - "requires": { + "dependencies": { "camelcase": "^5.0.0", "decamelize": "^1.2.0" } }, - "yargs-unparser": { + "node_modules/yargs-unparser": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.6.0.tgz", "integrity": "sha512-W9tKgmSn0DpSatfri0nx52Joq5hVXgeLiqR/5G0sZNDoLZFOr/xjBUDcShCOGNsBnEMNo1KAMBkTej1Hm62HTw==", "dev": true, - "requires": { + "dependencies": { "flat": "^4.1.0", "lodash": "^4.17.15", "yargs": "^13.3.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/yargs/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/yargs/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yargs/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" } } } diff --git a/package.json b/package.json index 73ce5f6..82aed66 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.0-beta.32", + "version": "2.0.1", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/util/axiosConstructor.ts b/src/util/axiosConstructor.ts index b27dc1c..c0ba3e1 100644 --- a/src/util/axiosConstructor.ts +++ b/src/util/axiosConstructor.ts @@ -1,37 +1,46 @@ -import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'; +import axios, { AxiosError, AxiosHeaders, AxiosInstance, AxiosRequestConfig } from 'axios'; +import { ensureError } from './errorHandling'; -export function createAxiosClient(config?: AxiosRequestConfig | undefined): AxiosInstance { - const client = axios.create(config); - client.interceptors.response.use((response) => { - return response; - }, (error) => { - return Promise.reject(sanitizeAxiosError(error)); - }); +export function sanitizeAxiosError(error: unknown): Error { + if (!axios.isAxiosError(error)) { + return ensureError(error); + } - return client; + const safeError = new AxiosError( + error.message, + error.code, + { + url: error.config?.url, + method: error.config?.method, + baseURL: error.config?.baseURL, + headers: new AxiosHeaders(), + }, + { + url: error.request?.url, + method: error.request?.method, + baseURL: error.request?.baseURL, + data: error.request?.data, + }, + { + data: error.response?.data, + status: error.response?.status ?? 0, + statusText: error.response?.statusText ?? '', + headers: new AxiosHeaders(), + config: { + headers: new AxiosHeaders(), + }, + }, + ); + safeError.stack = error.stack; + return safeError; } -export function sanitizeAxiosError(error: any) { - const safeError = { - code: error.code, - request: { - baseURL: error.request?.baseURL, - url: error.request?.url, - method: error.request?.method, - }, - response: { - code: error.response?.code, - status: error.response?.status, - statusText: error.response?.statusText, - data: error.response?.data, - }, - message: error.message, - name: error.name, - baseURL: error.request?.baseURL ?? error.config?.baseURL, - url: error.request?.url ?? error.config?.url, - method: error.request?.method ?? error.config?.method, - stack: error.stack, - data: error.data, - }; - return safeError; -} \ No newline at end of file +export function createAxiosClient(config?: AxiosRequestConfig | undefined): AxiosInstance { + const client = axios.create(config); + client.interceptors.response.use( + (response) => response, + (error) => Promise.reject(sanitizeAxiosError(error)), + ); + + return client; +} diff --git a/src/util/errorHandling.ts b/src/util/errorHandling.ts new file mode 100644 index 0000000..1f940fa --- /dev/null +++ b/src/util/errorHandling.ts @@ -0,0 +1,15 @@ +export function ensureError(value: unknown): Error { + if (value instanceof Error) { + return value; + } + + let stringified = '[Unable to stringify the thrown value]'; + try { + stringified = JSON.stringify(value); + } catch { + // ignore + } + + const error = new Error(`This value was thrown as is, not through an Error: ${stringified}`); + return error; +} From 591936e56846d78afe861e963dc8aee5aa37112e Mon Sep 17 00:00:00 2001 From: ahmed-envoy <96131446+ahmed-envoy@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:52:19 -0400 Subject: [PATCH 83/91] fix: bump jsonwebtoken to address vulnerability (#57) * fix: bump jsonwebtoken to address vulnerability * fix: bump patch version --- package-lock.json | 1745 +++++++++++++++++++++++++++++++++++++++++---- package.json | 6 +- 2 files changed, 1593 insertions(+), 158 deletions(-) diff --git a/package-lock.json b/package-lock.json index fcfbb67..53f2124 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,7 +11,7 @@ "dependencies": { "@types/dotenv": "^8.2.0", "@types/faker": "^5.5.6", - "@types/jsonwebtoken": "^8.5.1", + "@types/jsonwebtoken": "^9.0.0", "@types/node": "^15.12.0", "@types/qs": "^6.9.6", "axios": "^1.4.0", @@ -20,7 +20,7 @@ "dotenv-flow": "^3.2.0", "factory.ts": "^0.5.2", "faker": "^5.5.3", - "jsonwebtoken": "^8.5.1", + "jsonwebtoken": "^9.0.0", "lodash.ismatch": "^4.4.0", "luxon": "^1.27.0", "qs": "^6.10.1" @@ -314,9 +314,9 @@ "dev": true }, "node_modules/@types/jsonwebtoken": { - "version": "8.5.1", - "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", - "integrity": "sha512-rNAPdomlIUX0i0cg2+I+Q1wOUr531zHBQ+cV/28PJ39bSPKjahatZZ2LMuhiguETkCgLVzfruw/ZvNMNkKoSzw==", + "version": "9.0.6", + "resolved": "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-9.0.6.tgz", + "integrity": "sha512-/5hndP5dCjloafCXns6SZyESp3Ldq7YjH3zwzwczYnjxIT0Fqzk5ROSYVGfFyczIue7IUEj8hkvLbPoLQ18vQw==", "dependencies": { "@types/node": "*" } @@ -727,6 +727,16 @@ "sprintf-js": "~1.0.2" } }, + "node_modules/aria-query": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", + "dev": true, + "peer": true, + "dependencies": { + "deep-equal": "^2.0.5" + } + }, "node_modules/array-back": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/array-back/-/array-back-4.0.2.tgz", @@ -736,6 +746,22 @@ "node": ">=8" } }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/array-from": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/array-from/-/array-from-2.1.1.tgz", @@ -743,16 +769,17 @@ "dev": true }, "node_modules/array-includes": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.3.tgz", - "integrity": "sha512-gcem1KlBU7c9rB+Rq8/3PPKsK2kjqeEBa3bD5kkQo4nYlOHQCJqIJFqBXDEfwaRuYTT4E+FxA9xez7Gf/e3Q7A==", + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.0-next.2", - "get-intrinsic": "^1.1.1", - "is-string": "^1.0.5" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", + "is-string": "^1.0.7" }, "engines": { "node": ">= 0.4" @@ -770,15 +797,95 @@ "node": ">=8" } }, + "node_modules/array.prototype.findlast": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlast/-/array.prototype.findlast-1.2.5.tgz", + "integrity": "sha512-CVvd6FHg1Z3POpBLxO6E6zr+rSKEQ9L6rZHAaY7lLfhKsWYUBBOuMs0e9o24oopj6H+geRCX0YJ+TJLBK2eHyQ==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/array.prototype.flat": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.4.tgz", - "integrity": "sha512-4470Xi3GAPAjZqFcljX2xzckv1qeKPizoNkiS0+O4IoPR2ZNpcjE0pkhdihlDouK+x6QOast26B4Q/O9DJnwSg==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", + "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", "dev": true, "dependencies": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.0-next.1" + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flatmap": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", + "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.tosorted": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/array.prototype.tosorted/-/array.prototype.tosorted-1.1.4.tgz", + "integrity": "sha512-p6Fx8B7b7ZhL/gmUsAy0D15WhvDccw3mnGNbZpi3pmeJdxtWsj2jEaI4Y6oo3XiHfzuSgPwKc04MYt6KgvC/wA==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.3", + "es-errors": "^1.3.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/arraybuffer.prototype.slice": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "dev": true, + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", + "is-shared-array-buffer": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -796,6 +903,13 @@ "node": "*" } }, + "node_modules/ast-types-flow": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.8.tgz", + "integrity": "sha512-OH/2E5Fg20h2aPrbe+QL8JZQFko0YZaF+j4mnQ7BGhfavO7OpSLa8a0y9sBwomHdSbkhTS8TQNayBfnW5DwbvQ==", + "dev": true, + "peer": true + }, "node_modules/astral-regex": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", @@ -819,6 +933,31 @@ "node": ">= 4.0.0" } }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/axe-core": { + "version": "4.10.0", + "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.10.0.tgz", + "integrity": "sha512-Mr2ZakwQ7XUAjp7pAwQWRhhK8mQQ6JAaNWSjmjxil0R8BPioMtQsTLOolGYkji1rcL++3dCqZA3zWqpT+9Ew6g==", + "dev": true, + "peer": true, + "engines": { + "node": ">=4" + } + }, "node_modules/axios": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/axios/-/axios-1.4.0.tgz", @@ -829,6 +968,16 @@ "proxy-from-env": "^1.1.0" } }, + "node_modules/axobject-query": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-3.1.1.tgz", + "integrity": "sha512-goKlv8DZrK9hUh975fnHzhNIO4jUnFCfv/dszV5VwUGDFjI6vQ2VwoyjYjYNEbBE8AH87TduWP5uyDR1D+Iteg==", + "dev": true, + "peer": true, + "dependencies": { + "deep-equal": "^2.0.5" + } + }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", @@ -930,12 +1079,18 @@ } }, "node_modules/call-bind": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", - "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", "dependencies": { - "function-bind": "^1.1.1", - "get-intrinsic": "^1.0.2" + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -1338,6 +1493,64 @@ "node": ">= 8" } }, + "node_modules/damerau-levenshtein": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/damerau-levenshtein/-/damerau-levenshtein-1.0.8.tgz", + "integrity": "sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==", + "dev": true, + "peer": true + }, + "node_modules/data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/dataloader": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-2.0.0.tgz", @@ -1372,6 +1585,46 @@ "node": ">=0.12" } }, + "node_modules/deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "peer": true, + "dependencies": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/deep-equal/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "peer": true + }, "node_modules/deep-extend": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", @@ -1387,16 +1640,37 @@ "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", "dev": true }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", "dev": true, "dependencies": { - "object-keys": "^1.0.12" + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" }, "engines": { "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/delayed-stream": { @@ -1554,35 +1828,173 @@ } }, "node_modules/es-abstract": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", - "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", - "dev": true, - "dependencies": { - "call-bind": "^1.0.2", + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "dev": true, + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "get-intrinsic": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.2", - "is-callable": "^1.2.3", - "is-negative-zero": "^2.0.1", - "is-regex": "^1.1.3", - "is-string": "^1.0.6", - "object-inspect": "^1.10.3", + "function.prototype.name": "^1.1.6", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", + "globalthis": "^1.0.3", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", + "has-symbols": "^1.0.3", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", + "is-callable": "^1.2.7", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.3", + "is-string": "^1.0.7", + "is-typed-array": "^1.1.13", + "is-weakref": "^1.0.2", + "object-inspect": "^1.13.1", "object-keys": "^1.1.1", - "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", + "unbox-primitive": "^1.0.2", + "which-typed-array": "^1.1.15" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dependencies": { + "get-intrinsic": "^1.2.4" }, "engines": { "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/es-get-iterator/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "peer": true + }, + "node_modules/es-iterator-helpers": { + "version": "1.0.19", + "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.0.19.tgz", + "integrity": "sha512-zoMwbCcH5hwUkKJkT8kDIBZSz9I6mVG//+lDCinLCGov4+r7NIy0ld8o03M0cJxl2spVf6ESYVS6/gpIfq1FFw==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.3", + "es-errors": "^1.3.0", + "es-set-tostringtag": "^2.0.3", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "globalthis": "^1.0.3", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", + "has-symbols": "^1.0.3", + "internal-slot": "^1.0.7", + "iterator.prototype": "^1.1.2", + "safe-array-concat": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-set-tostringtag": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-shim-unscopables": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", + "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "dev": true, + "dependencies": { + "hasown": "^2.0.0" + } + }, "node_modules/es-to-primitive": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", @@ -1797,53 +2209,214 @@ "node": ">=0.10.0" } }, - "node_modules/eslint-scope": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", - "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "node_modules/eslint-plugin-jsx-a11y": { + "version": "6.9.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsx-a11y/-/eslint-plugin-jsx-a11y-6.9.0.tgz", + "integrity": "sha512-nOFOCaJG2pYqORjK19lqPqxMO/JpvdCZdPtNdxY3kvom3jTvkAbOvQvD8wuD0G8BYR0IGAGYDlzqWJOh/ybn2g==", "dev": true, + "peer": true, "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^4.1.1" + "aria-query": "~5.1.3", + "array-includes": "^3.1.8", + "array.prototype.flatmap": "^1.3.2", + "ast-types-flow": "^0.0.8", + "axe-core": "^4.9.1", + "axobject-query": "~3.1.1", + "damerau-levenshtein": "^1.0.8", + "emoji-regex": "^9.2.2", + "es-iterator-helpers": "^1.0.19", + "hasown": "^2.0.2", + "jsx-ast-utils": "^3.3.5", + "language-tags": "^1.0.9", + "minimatch": "^3.1.2", + "object.fromentries": "^2.0.8", + "safe-regex-test": "^1.0.3", + "string.prototype.includes": "^2.0.0" }, "engines": { - "node": ">=8.0.0" + "node": ">=4.0" + }, + "peerDependencies": { + "eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8" } }, - "node_modules/eslint-utils": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", - "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "node_modules/eslint-plugin-jsx-a11y/node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "dev": true, + "peer": true + }, + "node_modules/eslint-plugin-jsx-a11y/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "peer": true, "dependencies": { - "eslint-visitor-keys": "^2.0.0" + "brace-expansion": "^1.1.7" }, "engines": { - "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + "node": "*" + } + }, + "node_modules/eslint-plugin-react": { + "version": "7.35.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.35.0.tgz", + "integrity": "sha512-v501SSMOWv8gerHkk+IIQBkcGRGrO2nfybfj5pLxuJNFTPxxA3PSryhXTK+9pNbtkggheDdsC0E9Q8CuPk6JKA==", + "dev": true, + "peer": true, + "dependencies": { + "array-includes": "^3.1.8", + "array.prototype.findlast": "^1.2.5", + "array.prototype.flatmap": "^1.3.2", + "array.prototype.tosorted": "^1.1.4", + "doctrine": "^2.1.0", + "es-iterator-helpers": "^1.0.19", + "estraverse": "^5.3.0", + "hasown": "^2.0.2", + "jsx-ast-utils": "^2.4.1 || ^3.0.0", + "minimatch": "^3.1.2", + "object.entries": "^1.1.8", + "object.fromentries": "^2.0.8", + "object.values": "^1.2.0", + "prop-types": "^15.8.1", + "resolve": "^2.0.0-next.5", + "semver": "^6.3.1", + "string.prototype.matchall": "^4.0.11", + "string.prototype.repeat": "^1.0.0" }, - "funding": { - "url": "https://github.com/sponsors/mysticatea" + "engines": { + "node": ">=4" }, "peerDependencies": { - "eslint": ">=5" + "eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7" } }, - "node_modules/eslint-visitor-keys": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", - "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "node_modules/eslint-plugin-react-hooks": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.6.2.tgz", + "integrity": "sha512-QzliNJq4GinDBcD8gPB5v0wh6g8q3SUi6EFF0x8N/BL9PoVs0atuGc47ozMRyOWAKdwaZ5OnbOEa3WR+dSGKuQ==", "dev": true, + "peer": true, "engines": { "node": ">=10" + }, + "peerDependencies": { + "eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0" } }, - "node_modules/eslint/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "node_modules/eslint-plugin-react/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", "dev": true, + "peer": true, "dependencies": { - "ms": "2.1.2" + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-plugin-react/node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "peer": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/eslint-plugin-react/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "peer": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/eslint-plugin-react/node_modules/resolve": { + "version": "2.0.0-next.5", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.5.tgz", + "integrity": "sha512-U7WjGVG9sH8tvjW5SmGbQuui75FiyjAX72HX15DwBBwF9dNiQZRQAg9nnPhYy+TUnE0+VcrttuvNI8oSxZcocA==", + "dev": true, + "peer": true, + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/eslint-plugin-react/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "peer": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" }, "engines": { "node": ">=6.0" @@ -2198,6 +2771,15 @@ } } }, + "node_modules/for-each": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", + "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.3" + } + }, "node_modules/form-data": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", @@ -2242,9 +2824,30 @@ "dev": true }, "node_modules/function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/function.prototype.name": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", + "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "functions-have-names": "^1.2.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/functional-red-black-tree": { "version": "1.0.1", @@ -2252,6 +2855,15 @@ "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/get-caller-file": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", @@ -2271,13 +2883,35 @@ } }, "node_modules/get-intrinsic": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", - "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", "dependencies": { - "function-bind": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.1" + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3", + "hasown": "^2.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-symbol-description": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -2331,6 +2965,22 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/globalthis": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", + "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "dev": true, + "dependencies": { + "define-properties": "^1.2.1", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/globby": { "version": "11.0.3", "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", @@ -2351,6 +3001,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/gopd": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", + "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "dependencies": { + "get-intrinsic": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/graceful-fs": { "version": "4.2.6", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.6.tgz", @@ -2391,6 +3052,7 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, "dependencies": { "function-bind": "^1.1.1" }, @@ -2399,9 +3061,9 @@ } }, "node_modules/has-bigints": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", - "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", "dev": true, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -2416,10 +3078,47 @@ "node": ">=4" } }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-proto": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", - "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.3" + }, "engines": { "node": ">= 0.4" }, @@ -2427,6 +3126,17 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/he": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", @@ -2518,6 +3228,20 @@ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" }, + "node_modules/internal-slot": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", + "dev": true, + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.0", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/interpret": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", @@ -2527,12 +3251,61 @@ "node": ">= 0.10" } }, + "node_modules/is-arguments": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.1.1.tgz", + "integrity": "sha512-8Q7EARjzEnKpt/PCD7e1cgUS0a6X8u5tdSiMqXhojOdoV9TsMsiO+9VLC5vAmO8N7/GmXn7yjR8qnA6bVAEzfA==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-arrayish": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", "dev": true }, + "node_modules/is-async-function": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-async-function/-/is-async-function-2.0.0.tgz", + "integrity": "sha512-Y1JXKrfykRJGdlDwdKlLpLyMIiWqWvuSd17TvZk68PLAOGOoF4Xyav1z0Xhoi+gCYjZVeC5SI+hYFOfvXmGRCA==", + "dev": true, + "peer": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-bigint": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", @@ -2581,9 +3354,9 @@ } }, "node_modules/is-callable": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", - "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", "dev": true, "engines": { "node": ">= 0.4" @@ -2593,22 +3366,43 @@ } }, "node_modules/is-core-module": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.4.0.tgz", - "integrity": "sha512-6A2fkfq1rfeQZjxrZJGerpLCTHRNEBiSgnu0+obeJpEPZRUooHgsizvzv0ZjJwOz3iWIHdJtVWJ/tmPr3D21/A==", + "version": "2.15.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.0.tgz", + "integrity": "sha512-Dd+Lb2/zvk9SKy1TGCt1wFJFo/MWBPMX5x7KcvLajWTGuomczdQX61PvY5yK6SVACwpoexWo81IfFyoKY2QnTA==", "dev": true, "dependencies": { - "has": "^1.0.3" + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "dev": true, + "dependencies": { + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/is-date-object": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.4.tgz", - "integrity": "sha512-/b4ZVsG7Z5XVtIxs/h9W8nvfLgSAyKYdtGWQLbqy6jA1icmgjf8WCoTKgeS4wy5tYaPePouzFMANbnj94c2Z+A==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, "engines": { "node": ">= 0.4" }, @@ -2625,6 +3419,19 @@ "node": ">=0.10.0" } }, + "node_modules/is-finalizationregistry": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.0.2.tgz", + "integrity": "sha512-0by5vtUJs8iFQb5TYUHHPudOR+qXYIMKtiUzvLIZITZUjknFmziyBJuLhVRc+Ds0dREFlskDNJKYIdIzu/9pfw==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-fullwidth-code-point": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", @@ -2634,6 +3441,22 @@ "node": ">=8" } }, + "node_modules/is-generator-function": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.0.10.tgz", + "integrity": "sha512-jsEjy9l3yiXEQ+PsXdmBwEPcOxaXWLspKdplFUVI9vq1iZgIekeC0L167qeu86czQaxed3q/Uzuw0swL0irL8A==", + "dev": true, + "peer": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-glob": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", @@ -2646,10 +3469,23 @@ "node": ">=0.10.0" } }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-negative-zero": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.1.tgz", - "integrity": "sha512-2z6JzQvZRa9A2Y7xC6dQQm4FSTSTNWjKIYYTt4246eMTJmIo0Q+ZyOsU66X8lxK1AbB92dFeglPLrhwpeRKO6w==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", "dev": true, "engines": { "node": ">= 0.4" @@ -2700,13 +3536,41 @@ } }, "node_modules/is-regex": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", - "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "has-symbols": "^1.0.2" + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7" }, "engines": { "node": ">= 0.4" @@ -2716,10 +3580,13 @@ } }, "node_modules/is-string": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", - "integrity": "sha512-2gdzbKUuqtQ3lYNrUTQYoClPhm7oQu4UdpSZMp1/DGgkHBT8E2Z1l0yMdb6D4zNAxwDiMv8MdulKROJGNl0Q0w==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, "engines": { "node": ">= 0.4" }, @@ -2742,6 +3609,63 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-typed-array": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", + "dev": true, + "dependencies": { + "which-typed-array": "^1.1.14" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakset": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.3.tgz", + "integrity": "sha512-LvIm3/KWzS9oRFHugab7d+M/GcBXuXX5xZkzPmN+NxihdQlZUQ4dWuSV1xR/sq6upL1TJEDrfBgRepHFdBtSNQ==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/isarray": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", @@ -2762,6 +3686,20 @@ "node": ">=0.10.0" } }, + "node_modules/iterator.prototype": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.2.tgz", + "integrity": "sha512-DR33HMMr8EzwuRL8Y9D3u2BMj8+RqSE850jfGu59kS7tbmPLzGkZmVSfyCFSDxuZiEY6Rzt3T2NA/qU+NwVj1w==", + "dev": true, + "peer": true, + "dependencies": { + "define-properties": "^1.2.1", + "get-intrinsic": "^1.2.1", + "has-symbols": "^1.0.3", + "reflect.getprototypeof": "^1.0.4", + "set-function-name": "^2.0.1" + } + }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -2971,9 +3909,9 @@ } }, "node_modules/jsonwebtoken": { - "version": "8.5.1", - "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", - "integrity": "sha512-XjwVfRS6jTMsqYs0EsuJ4LGxXV14zQybNd4L2r0UvbVnSF9Af8x7p5MzbJ90Ioz/9TI41/hTCvznF/loiSzn8w==", + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-9.0.2.tgz", + "integrity": "sha512-PRp66vJ865SSqOlgqS8hujT5U4AOgMfhrwYIuIhfKaoSCZcirrmASQr8CX7cUg+RMih+hgznrjp99o+W4pJLHQ==", "dependencies": { "jws": "^3.2.2", "lodash.includes": "^4.3.0", @@ -2984,11 +3922,11 @@ "lodash.isstring": "^4.0.1", "lodash.once": "^4.0.0", "ms": "^2.1.1", - "semver": "^5.6.0" + "semver": "^7.5.4" }, "engines": { - "node": ">=4", - "npm": ">=1.4.28" + "node": ">=12", + "npm": ">=6" } }, "node_modules/jsonwebtoken/node_modules/ms": { @@ -2996,6 +3934,33 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" }, + "node_modules/jsonwebtoken/node_modules/semver": { + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/jsx-ast-utils": { + "version": "3.3.5", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", + "integrity": "sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==", + "dev": true, + "peer": true, + "dependencies": { + "array-includes": "^3.1.6", + "array.prototype.flat": "^1.3.1", + "object.assign": "^4.1.4", + "object.values": "^1.1.6" + }, + "engines": { + "node": ">=4.0" + } + }, "node_modules/just-extend": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz", @@ -3038,6 +4003,26 @@ "graceful-fs": "^4.1.9" } }, + "node_modules/language-subtag-registry": { + "version": "0.3.23", + "resolved": "https://registry.npmjs.org/language-subtag-registry/-/language-subtag-registry-0.3.23.tgz", + "integrity": "sha512-0K65Lea881pHotoGEa5gDlMxt3pctLi2RplBb7Ezh4rRdLEOtgi7n4EwK9lamnUCkKBqaeKRVebTq6BAxSkpXQ==", + "dev": true, + "peer": true + }, + "node_modules/language-tags": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/language-tags/-/language-tags-1.0.9.tgz", + "integrity": "sha512-MbjN408fEndfiQXbFQ1vnd+1NoLDsnQW41410oQBXiyXDMYH5z505juWa4KUE1LqxRC7DgOgZDbKLxHIwm27hA==", + "dev": true, + "peer": true, + "dependencies": { + "language-subtag-registry": "^0.3.20" + }, + "engines": { + "node": ">=0.10" + } + }, "node_modules/levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", @@ -3217,6 +4202,19 @@ "integrity": "sha512-gKO5uExCXvSm6zbF562EvM+rd1kQDnB9AZBbiQVzf1ZmdDpxUSvpnAaVOP83N/31mRK8Ml8/VE8DMvsAZQ+7wg==", "dev": true }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "peer": true, + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, "node_modules/lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", @@ -3669,6 +4667,16 @@ "validate-npm-package-license": "^3.0.1" } }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "dev": true, + "peer": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/object-get": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.1.tgz", @@ -3676,9 +4684,29 @@ "dev": true }, "node_modules/object-inspect": { - "version": "1.10.3", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.10.3.tgz", - "integrity": "sha512-e5mCJlSH7poANfC8z8S9s9S2IN5/4Zb3aZ33f5s8YqoazCFzNLloLU8r5VCG+G7WoqLvAAZoVMcy3tp/3X0Plw==", + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.2.tgz", + "integrity": "sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -3699,14 +4727,14 @@ "dev": true }, "node_modules/object.assign": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", - "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.0", - "define-properties": "^1.1.3", - "has-symbols": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", "object-keys": "^1.1.1" }, "engines": { @@ -3717,17 +4745,36 @@ } }, "node_modules/object.entries": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.4.tgz", - "integrity": "sha512-h4LWKWE+wKQGhtMjZEBud7uLGhqyLwj8fpHOarZhD2uY3C9cRtk57VQ89ke3moByLXMedqs3XCHzyb4AmA2DjA==", + "version": "1.1.8", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.8.tgz", + "integrity": "sha512-cmopxi8VwRIAw/fkijJohSfpef5PdN0pMQJN6VC/ZKvn0LIknWD8KtgY6KlQdEc4tIjcQ3HxSMmnvtzIscdaYQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.2" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.fromentries": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/object.getownpropertydescriptors": { @@ -3748,14 +4795,14 @@ } }, "node_modules/object.values": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.4.tgz", - "integrity": "sha512-TnGo7j4XSnKQoK3MfvkzqKCi0nVe/D9I9IjwTNYdb/fxYHpjrluHVOgw0AF6jrRFGMPHdfuidR09tIDiIvnaSg==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.18.2" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -3988,6 +5035,15 @@ "node": ">=4" } }, + "node_modules/possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", @@ -4006,6 +5062,18 @@ "node": ">=0.4.0" } }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dev": true, + "peer": true, + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, "node_modules/proxy-from-env": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", @@ -4079,6 +5147,13 @@ "node": ">= 0.8" } }, + "node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "dev": true, + "peer": true + }, "node_modules/read-pkg": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", @@ -4222,6 +5297,46 @@ "node": ">=0.10.0" } }, + "node_modules/reflect.getprototypeof": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.6.tgz", + "integrity": "sha512-fmfw4XgoDke3kdI6h4xcUz1dG8uaiv5q9gcEwLS4Pnth2kxT+GZ7YehS1JTMGBQmtV7Y4GFGbs2re2NqhdozUg==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.1", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "globalthis": "^1.0.3", + "which-builtin-type": "^1.1.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", + "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/regexpp": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.1.0.tgz", @@ -4338,6 +5453,30 @@ "queue-microtask": "^1.2.2" } }, + "node_modules/safe-array-concat": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", + "has-symbols": "^1.0.3", + "isarray": "^2.0.5" + }, + "engines": { + "node": ">=0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safe-array-concat/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true + }, "node_modules/safe-buffer": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", @@ -4357,6 +5496,23 @@ } ] }, + "node_modules/safe-regex-test": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-regex": "^1.1.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", @@ -4366,6 +5522,7 @@ "version": "5.7.1", "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "dev": true, "bin": { "semver": "bin/semver" } @@ -4376,6 +5533,37 @@ "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", "dev": true }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/setprototypeof": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz", @@ -4441,13 +5629,17 @@ } }, "node_modules/side-channel": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", - "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", + "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", "dependencies": { - "call-bind": "^1.0.0", - "get-intrinsic": "^1.0.2", - "object-inspect": "^1.9.0" + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "object-inspect": "^1.13.1" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -4617,6 +5809,19 @@ "node": ">= 0.6" } }, + "node_modules/stop-iteration-iterator": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.0.0.tgz", + "integrity": "sha512-iCGQj+0l0HOdZ2AEeBADlsRC+vsnDsZsbdSiH1yNSjcfKM7fdpCMfqAL/dwF5BLiw/XhRft/Wax6zQbhq2BcjQ==", + "dev": true, + "peer": true, + "dependencies": { + "internal-slot": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/stream-connect": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz", @@ -4664,27 +5869,99 @@ "node": ">=8" } }, + "node_modules/string.prototype.includes": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/string.prototype.includes/-/string.prototype.includes-2.0.0.tgz", + "integrity": "sha512-E34CkBgyeqNDcrbU76cDjL5JLcVrtSdYq0MEh/B10r17pRP4ciHLwTgnuLV8Ay6cgEMLkcBkFCKyFZ43YldYzg==", + "dev": true, + "peer": true, + "dependencies": { + "define-properties": "^1.1.3", + "es-abstract": "^1.17.5" + } + }, + "node_modules/string.prototype.matchall": { + "version": "4.0.11", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.11.tgz", + "integrity": "sha512-NUdh0aDavY2og7IbBPenWqR9exH+E26Sv8e0/eTe1tltDGZL+GtBkDAnnyBtmekfK6/Dq3MkcGtzXFEd1LQrtg==", + "dev": true, + "peer": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-symbols": "^1.0.3", + "internal-slot": "^1.0.7", + "regexp.prototype.flags": "^1.5.2", + "set-function-name": "^2.0.2", + "side-channel": "^1.0.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.repeat": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-1.0.0.tgz", + "integrity": "sha512-0u/TldDbKD8bFCQ/4f5+mNRrXwZ8hg2w7ZR8wa16e8z9XpePWl3eGEcUD0OXpEH/VJH/2G3gjUtR3ZOiBe2S/w==", + "dev": true, + "peer": true, + "dependencies": { + "define-properties": "^1.1.3", + "es-abstract": "^1.17.5" + } + }, + "node_modules/string.prototype.trim": { + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/string.prototype.trimend": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", - "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/string.prototype.trimstart": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", - "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -4735,6 +6012,19 @@ "node": ">=4" } }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/table": { "version": "6.7.1", "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", @@ -4943,6 +6233,79 @@ "node": ">= 0.6" } }, + "node_modules/typed-array-buffer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/typed-array-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-byte-offset": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "dev": true, + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-length": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/typedoc": { "version": "0.20.36", "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.36.tgz", @@ -5056,14 +6419,14 @@ } }, "node_modules/unbox-primitive": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", - "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", "dev": true, "dependencies": { - "function-bind": "^1.1.1", - "has-bigints": "^1.0.1", - "has-symbols": "^1.0.2", + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", "which-boxed-primitive": "^1.0.2" }, "funding": { @@ -5164,12 +6527,84 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/which-builtin-type": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.1.4.tgz", + "integrity": "sha512-bppkmBSsHFmIMSl8BO9TbsyzsvGjVoppt8xUiGzwiu/bhDCGxnpOKCxgqj6GuyHE0mINMDecBFPlOm2hzY084w==", + "dev": true, + "peer": true, + "dependencies": { + "function.prototype.name": "^1.1.6", + "has-tostringtag": "^1.0.2", + "is-async-function": "^2.0.0", + "is-date-object": "^1.0.5", + "is-finalizationregistry": "^1.0.2", + "is-generator-function": "^1.0.10", + "is-regex": "^1.1.4", + "is-weakref": "^1.0.2", + "isarray": "^2.0.5", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.2", + "which-typed-array": "^1.1.15" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-builtin-type/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "peer": true + }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "peer": true, + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/which-module": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", "dev": true }, + "node_modules/which-typed-array": { + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", + "dev": true, + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/wide-align": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", diff --git a/package.json b/package.json index 82aed66..c192557 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.1", + "version": "2.0.2", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -33,7 +33,7 @@ "dependencies": { "@types/dotenv": "^8.2.0", "@types/faker": "^5.5.6", - "@types/jsonwebtoken": "^8.5.1", + "@types/jsonwebtoken": "^9.0.0", "@types/node": "^15.12.0", "@types/qs": "^6.9.6", "axios": "^1.4.0", @@ -42,7 +42,7 @@ "dotenv-flow": "^3.2.0", "factory.ts": "^0.5.2", "faker": "^5.5.3", - "jsonwebtoken": "^8.5.1", + "jsonwebtoken": "^9.0.0", "lodash.ismatch": "^4.4.0", "luxon": "^1.27.0", "qs": "^6.10.1" From 6b18dae22373352be3e8f7cedf4becc72cbfbb97 Mon Sep 17 00:00:00 2001 From: Brian Ko Date: Thu, 29 Aug 2024 09:03:08 -0700 Subject: [PATCH 84/91] Add EnvoyMetaZone (#58) --- docs/README.md | 19 +++++++++++++++++++ src/factories/eventBodyFactory.ts | 3 +++ src/factories/metaFactory.ts | 19 +++++++++++++++++++ src/factories/routeBodyFactory.ts | 3 +++ src/sdk/EnvoyMeta.ts | 16 ++++++++++++++++ 5 files changed, 60 insertions(+) diff --git a/docs/README.md b/docs/README.md index 64fd812..03421e8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -117,6 +117,7 @@ - [EnvoyMetaCompany](README.md#envoymetacompany) - [EnvoyMetaJob](README.md#envoymetajob) - [EnvoyMetaLocation](README.md#envoymetalocation) +- [EnvoyMetaZone](README.md#envoymetazone) - [EnvoyRouteMeta](README.md#envoyroutemeta) ### Request Type aliases @@ -910,6 +911,7 @@ Metadata that will be included in the request body for events. | `install_id` | `string` | | `job` | [EnvoyMetaJob](README.md#envoymetajob) | | `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `zone` | [EnvoyMetaZone](README.md#envoymetazone) | | `plugin_id` | `string` | #### Defined in @@ -1016,6 +1018,22 @@ ___ [sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L13) +### EnvoyMetaZone + +Ƭ **EnvoyMetaZone**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attributes` | `Object` | +| `attributes.address` | `string` \| ``null`` | +| `attributes.logo-url` | `string` \| ``null`` | +| `attributes.name` | `string` | +| `attributes.time-zone` | `string` | +| `id` | `string` | +| `type` | ``"zones"`` | + ___ ### EnvoyRouteMeta @@ -1042,6 +1060,7 @@ like validation URLs or options URLs. | `forwarded_bearer_token?` | `string` | | `install_id` | `string` | | `location` | [EnvoyMetaLocation](README.md#envoymetalocation) | +| `zone` | [EnvoyMetaZone](README.md#envoymetazone) | | `params` | `Params` | | `plugin_id` | `string` | | `route` | `string` | diff --git a/src/factories/eventBodyFactory.ts b/src/factories/eventBodyFactory.ts index b5e2f10..57f8024 100644 --- a/src/factories/eventBodyFactory.ts +++ b/src/factories/eventBodyFactory.ts @@ -4,6 +4,7 @@ import { eventMetaFactory } from './metaFactory'; export const eventBodyFactoryDefaultIds = { locationId: '1', companyId: '1', + zoneId: '1', }; export type EventBodyFactoryOptions = { @@ -13,6 +14,7 @@ export type EventBodyFactoryOptions = { scope: Array, locationId?: string, companyId?: string, + zoneId?: string, }; export default function eventBodyFactory< @@ -29,6 +31,7 @@ export default function eventBodyFactory< options.scope, options.locationId || eventBodyFactoryDefaultIds.locationId, options.companyId || eventBodyFactoryDefaultIds.companyId, + options.zoneId || eventBodyFactoryDefaultIds.zoneId, ).build(), payload: options.payload, }; diff --git a/src/factories/metaFactory.ts b/src/factories/metaFactory.ts index c2b3473..d593622 100644 --- a/src/factories/metaFactory.ts +++ b/src/factories/metaFactory.ts @@ -6,6 +6,7 @@ import { EnvoyMetaCompany, EnvoyMetaJob, EnvoyMetaLocation, + EnvoyMetaZone, EnvoyRouteMeta, } from '../sdk/EnvoyMeta'; import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI'; @@ -55,6 +56,20 @@ export function companyFactory(id: string): Sync.Factory { }); } +export function zoneFactory(id: string): Sync.Factory { + const street = faker.address.streetAddress(); + return Sync.makeFactory({ + id, + type: 'zones', + attributes: { + address: street, + 'logo-url': null, + name: faker.company.companyName(), + 'time-zone': faker.address.timeZone(), + }, + }); +} + export function authFactory(): Sync.Factory { return Sync.makeFactory({ token_type: 'Bearer', @@ -75,12 +90,14 @@ export function routeMetaFactory< scope: Array, locationId: string, companyId: string, + zoneId: string, ): Sync.Factory { return Sync.makeFactory({ plugin_id: faker.datatype.uuid(), install_id: Math.ceil(Math.abs(faker.datatype.number())).toString(), location: locationFactory(locationId).build(), company: companyFactory(companyId).build(), + zone: zoneFactory(zoneId).build(), auth: scope.length ? authFactory().build() : null, forwarded_bearer_token: faker.random.alphaNumeric(), route, @@ -95,6 +112,7 @@ export function eventMetaFactory = Record scope: Array, locationId: string, companyId: string, + zoneId: string, ): Sync.Factory { return Sync.makeFactory({ plugin_id: faker.datatype.uuid(), @@ -102,6 +120,7 @@ export function eventMetaFactory = Record job: jobFactory(event).build(), location: locationFactory(locationId).build(), company: companyFactory(companyId).build(), + zone: zoneFactory(zoneId).build(), auth: scope.length ? authFactory().build() : null, event, config, diff --git a/src/factories/routeBodyFactory.ts b/src/factories/routeBodyFactory.ts index 9bc7c97..322c2d6 100644 --- a/src/factories/routeBodyFactory.ts +++ b/src/factories/routeBodyFactory.ts @@ -4,6 +4,7 @@ import { routeMetaFactory } from './metaFactory'; export const routeBodyFactoryDefaultIds = { locationId: '1', companyId: '1', + zoneId: '1', }; export type RouteBodyFactoryOptions = { @@ -13,6 +14,7 @@ export type RouteBodyFactoryOptions = { scope?: Array, locationId?: string, companyId?: string, + zoneId?: string, route?: string, }; @@ -31,6 +33,7 @@ export default function routeBodyFactory< options.scope || [], options.locationId || routeBodyFactoryDefaultIds.locationId, options.companyId || routeBodyFactoryDefaultIds.companyId, + options.zoneId || routeBodyFactoryDefaultIds.zoneId, ).build(), payload: options.payload, }; diff --git a/src/sdk/EnvoyMeta.ts b/src/sdk/EnvoyMeta.ts index 2e501af..013bdd3 100644 --- a/src/sdk/EnvoyMeta.ts +++ b/src/sdk/EnvoyMeta.ts @@ -44,6 +44,20 @@ export type EnvoyMetaCompany = { } }; +/** + * @category Meta + */ +export type EnvoyMetaZone = { + id: string, + type: 'zones', + attributes: { + address: string | null, + 'logo-url': string | null, + name: string, + 'time-zone': string, + } +}; + /** * A short-lived `userAPI` token. * Will be used to construct the `userAPI` property found in `req.envoy.userAPI`. @@ -71,6 +85,7 @@ export type EnvoyEventMeta, location: EnvoyMetaLocation, company: EnvoyMetaCompany, + zone: EnvoyMetaZone, auth: EnvoyMetaAuth | null, }; @@ -88,6 +103,7 @@ export type EnvoyRouteMeta, Params = Record Date: Thu, 29 Aug 2024 09:09:19 -0700 Subject: [PATCH 85/91] Bump to 2.1.0 (#59) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 53f2124..3672781 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.1", + "version": "2.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.1", + "version": "2.1.0", "license": "ISC", "dependencies": { "@types/dotenv": "^8.2.0", diff --git a/package.json b/package.json index c192557..4856c31 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.0.2", + "version": "2.1.0", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From ae766ceedc276189740605cb2cf790fc27f9ee66 Mon Sep 17 00:00:00 2001 From: Kamal Fariz Mahyuddin Date: Mon, 9 Sep 2024 06:48:36 -0700 Subject: [PATCH 86/91] Filter flows by enabled attribute (#60) --- src/resources/FlowResource.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/resources/FlowResource.ts b/src/resources/FlowResource.ts index 067e5f9..705bb73 100644 --- a/src/resources/FlowResource.ts +++ b/src/resources/FlowResource.ts @@ -10,6 +10,7 @@ export type FlowSortFields = 'name' | 'created_at' | '-name' | '-created_at'; */ export interface FlowFilterFields { 'employee-centric'?: boolean; + enabled?: boolean; location?: string; } From fdbfef7e33fef949de472820eb5f447c693e9c26 Mon Sep 17 00:00:00 2001 From: Kamal Fariz Mahyuddin Date: Mon, 9 Sep 2024 06:48:47 -0700 Subject: [PATCH 87/91] Add missing chalk dependency (#61) --- package-lock.json | 15 +++++---------- package.json | 1 + 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3672781..0e277d0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,6 +16,7 @@ "@types/qs": "^6.9.6", "axios": "^1.4.0", "body-parser": "^1.19.0", + "chalk": "^4.1.2", "dataloader": "^2.0.0", "dotenv-flow": "^3.2.0", "factory.ts": "^0.5.2", @@ -1144,10 +1145,9 @@ } }, "node_modules/chalk": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", - "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", - "dev": true, + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -1163,7 +1163,6 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, "dependencies": { "color-convert": "^2.0.1" }, @@ -1178,7 +1177,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, "dependencies": { "color-name": "~1.1.4" }, @@ -1189,14 +1187,12 @@ "node_modules/chalk/node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, "node_modules/chalk/node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, "engines": { "node": ">=8" } @@ -1205,7 +1201,6 @@ "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, "dependencies": { "has-flag": "^4.0.0" }, diff --git a/package.json b/package.json index 4856c31..252da78 100644 --- a/package.json +++ b/package.json @@ -38,6 +38,7 @@ "@types/qs": "^6.9.6", "axios": "^1.4.0", "body-parser": "^1.19.0", + "chalk": "^4.1.2", "dataloader": "^2.0.0", "dotenv-flow": "^3.2.0", "factory.ts": "^0.5.2", From 15bd6029d2f3b35f2e4f4e0a1573c057e0b48204 Mon Sep 17 00:00:00 2001 From: Kamal Fariz Mahyuddin Date: Mon, 9 Sep 2024 06:54:02 -0700 Subject: [PATCH 88/91] 2.2.0 (#62) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 0e277d0..6cf7cb4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.1.0", + "version": "2.2.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@envoy/envoy-integrations-sdk", - "version": "2.1.0", + "version": "2.2.0", "license": "ISC", "dependencies": { "@types/dotenv": "^8.2.0", diff --git a/package.json b/package.json index 252da78..a62071d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.1.0", + "version": "2.2.0", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", From 56c67199562684a2414fbd4a8ff0516153fb3b00 Mon Sep 17 00:00:00 2001 From: Kamal Fariz Mahyuddin Date: Thu, 12 Sep 2024 08:17:51 -0700 Subject: [PATCH 89/91] Fix types relating to invite creation (#63) --- package.json | 2 +- src/resources/InviteResource.ts | 43 +++++++++++++++++++++++++------ src/util/json-api/JSONAPIModel.ts | 7 ++--- 3 files changed, 40 insertions(+), 12 deletions(-) diff --git a/package.json b/package.json index a62071d..fa2b239 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.2.0", + "version": "2.2.1", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/resources/InviteResource.ts b/src/resources/InviteResource.ts index a044617..648a400 100644 --- a/src/resources/InviteResource.ts +++ b/src/resources/InviteResource.ts @@ -1,3 +1,4 @@ +import JSONAPIData from '../util/json-api/JSONAPIData'; import JSONAPIModel from '../util/json-api/JSONAPIModel'; /** @@ -32,15 +33,15 @@ export interface InviteAttributes { auto_approved: boolean; report: Array<{ reason: string; - result: 'pass' | 'fail' | 'pending', - source: string, + result: 'pass' | 'fail' | 'pending'; + source: string; messages: { failure?: { - text: string, - header: string, - } - } - }> + text: string; + header: string; + }; + }; + }>; }; email?: string; 'expected-arrival-time'?: string; @@ -89,4 +90,30 @@ export type InviteModel = JSONAPIModel; +type InviteCreationRequiredRelationships = 'location'; // surprising, but flow is not required. if not provided, it will be defaulted +type InviteCreationProhibitedRelationships = 'creator'; +type InviteCreationOptionalRelationships = Exclude< + InviteRelationships, + InviteCreationRequiredRelationships | InviteCreationProhibitedRelationships +>; + +/** + * Here we are going to do a little surgery on JSONAPIModel to allow us to specify required and optional relationships. + * We do this by first omitting the relationships field from JSONAPIModel, then adding it back in with modified type. + */ +export type InviteCreationModel = Omit< + JSONAPIModel, + 'relationships' +> & { + relationships: { + [key in InviteCreationRequiredRelationships]: { + data: JSONAPIData | Array; + }; + } & { + [key in InviteCreationOptionalRelationships]?: { + data: JSONAPIData | Array | null; + }; + } & { + [key in InviteCreationProhibitedRelationships]?: never; + }; +}; diff --git a/src/util/json-api/JSONAPIModel.ts b/src/util/json-api/JSONAPIModel.ts index 1c2d707..e172bf5 100644 --- a/src/util/json-api/JSONAPIModel.ts +++ b/src/util/json-api/JSONAPIModel.ts @@ -1,10 +1,11 @@ import JSONAPIData from './JSONAPIData'; -export default interface JSONAPIModel extends JSONAPIData { +export default interface JSONAPIModel + extends JSONAPIData { attributes: Attributes; relationships: { [key in Relationships]: { - data: JSONAPIData & Array + data: JSONAPIData | Array | null; }; - } + }; } From c3525806f175741ec8336e8d31716dd39cbece23 Mon Sep 17 00:00:00 2001 From: Kamal Fariz Mahyuddin Date: Thu, 12 Sep 2024 09:28:27 -0700 Subject: [PATCH 90/91] 2.2.1 (#64) * back one * 2.2.1 --- package-lock.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6cf7cb4..edc326e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.2.0", + "version": "2.2.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@envoy/envoy-integrations-sdk", - "version": "2.2.0", + "version": "2.2.1", "license": "ISC", "dependencies": { "@types/dotenv": "^8.2.0", From f0f3f60a9052f410c2fa63e0a84edd7b8b7d9a2f Mon Sep 17 00:00:00 2001 From: Arvind Ramesh Date: Thu, 21 Nov 2024 14:08:04 -0800 Subject: [PATCH 91/91] feat: Adding `createReservations` function to the `EnvoyUserAPI` (#66) --- package-lock.json | 4 +-- package.json | 2 +- src/resources/ReservationResource.ts | 40 ++++++++++++++++++++++++++ src/sdk/EnvoyUserAPI.ts | 42 ++++++++++++++++++++++++++-- 4 files changed, 83 insertions(+), 5 deletions(-) create mode 100644 src/resources/ReservationResource.ts diff --git a/package-lock.json b/package-lock.json index edc326e..c7e2d6b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.2.1", + "version": "2.2.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@envoy/envoy-integrations-sdk", - "version": "2.2.1", + "version": "2.2.3", "license": "ISC", "dependencies": { "@types/dotenv": "^8.2.0", diff --git a/package.json b/package.json index fa2b239..c4b5d36 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@envoy/envoy-integrations-sdk", - "version": "2.2.1", + "version": "2.2.3", "description": "SDK for building Envoy integrations.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/resources/ReservationResource.ts b/src/resources/ReservationResource.ts new file mode 100644 index 0000000..39f537b --- /dev/null +++ b/src/resources/ReservationResource.ts @@ -0,0 +1,40 @@ +import JSONAPIModel from "../util/json-api/JSONAPIModel"; + +export interface ReservationAttributes { + 'is-partial-day': boolean; + 'updated-at': number; + 'is-assignable': boolean; + 'name': string; + 'assigned-to': string | null; + 'neighborhood-id': number; + 'created-at': number; + 'neighborhood': number | null; + 'parent-desk-id': string | null; + 'availability': string | null; + 'enabled': boolean; + 'x-pos': number | null; + 'y-pos': number | null; +} + +export interface ReservationCreationAttributes { + // Required fields + userId: number; + + // Optional fields + deskId?: number | null; + locationId?: number | null; + inviteId?: number | null; + entryId?: number | null; + startTime?: number | null; // Unix timestamp + endTime?: number | null; // Unix timestamp + + meta?: { + autoAssignDesk?: boolean; + }; +} + +export type ReservationRelationships = 'location' | 'desk' | 'company' | 'floor' | 'employee' | 'entry' | 'invite' | 'user'; + +export type ReservationModel = JSONAPIModel + + diff --git a/src/sdk/EnvoyUserAPI.ts b/src/sdk/EnvoyUserAPI.ts index 095a099..c867520 100644 --- a/src/sdk/EnvoyUserAPI.ts +++ b/src/sdk/EnvoyUserAPI.ts @@ -17,6 +17,7 @@ import { UserModel } from '../resources/UserResource'; import { envoyBaseURL, envoyClientId, envoyClientSecret } from '../constants'; import { EnvoyMetaAuth } from './EnvoyMeta'; import { sanitizeAxiosError } from '../util/axiosConstructor'; +import { ReservationCreationAttributes, ReservationModel } from "../resources/ReservationResource"; export type EnvoyUserAPIScope = 'flows.read' | @@ -195,6 +196,43 @@ export default class EnvoyUserAPI extends EnvoyAPI { return data.data; } + async createReservation(reservationDetails: ReservationCreationAttributes): Promise { + let createReservationBody = { + data: { + relationships: { + user: { + data: { + type: 'users', + id: reservationDetails.userId + }}, + ...(reservationDetails.locationId && { + location: { + data: { + type: 'locations', + id: reservationDetails.locationId + } + } + } + ) + }, + attributes: { + 'start-time': reservationDetails.startTime, + ...(reservationDetails.endTime && { + 'end-time': reservationDetails.endTime + }), + 'booking-source': 'EXTERNAL_API', + 'booking-type': 'visitor' + } + } + } + const { data } = await this.axios({ + method: 'POST', + url: '/a/rms/reservations', + data: createReservationBody, + }); + return data.data; + } + /** * Requires `invites.write` scope. */ @@ -305,7 +343,7 @@ export default class EnvoyUserAPI extends EnvoyAPI { }); return data; } catch (error) { - throw sanitizeAxiosError(error); + throw sanitizeAxiosError(error); } } @@ -333,7 +371,7 @@ export default class EnvoyUserAPI extends EnvoyAPI { }); return data; } catch (error) { - throw sanitizeAxiosError(error); + throw sanitizeAxiosError(error); } } }