@openstax/ts-utils 1.33.0 → 1.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.cfnlintrc +2 -0
- package/.github/CODEOWNERS +1 -0
- package/.github/workflows/ci.yml +36 -0
- package/.github/workflows/lint.yml +55 -0
- package/.nvmrc +1 -0
- package/.syncignore +4 -0
- package/.syncpackrc +18 -0
- package/CONTRIBUTING.md +96 -0
- package/LICENSE +661 -0
- package/Procfile +1 -0
- package/README.md +62 -90
- package/app.json +23 -0
- package/cspell.json +32 -0
- package/deploy/constants.env +21 -0
- package/deploy/deploy.bash +157 -0
- package/deploy/deployment-alt-region.cfn.yml +70 -0
- package/deploy/deployment.cfn.yml +650 -0
- package/deploy/destroy-deployment.bash +23 -0
- package/deploy/shared.cfn.yml +94 -0
- package/docs/lambda-build.md +35 -0
- package/package.json +12 -228
- package/packages/frontend/README.md +46 -0
- package/packages/frontend/package.json +101 -0
- package/packages/frontend/public/favicon.ico +0 -0
- package/packages/frontend/public/index.html +107 -0
- package/packages/frontend/public/maintenance.html +59 -0
- package/packages/frontend/public/manifest.json +15 -0
- package/packages/frontend/public/robots.txt +3 -0
- package/packages/frontend/script/make-certificate.bash +49 -0
- package/packages/frontend/script/server/cli.js +11 -0
- package/packages/frontend/script/server/index.js +47 -0
- package/packages/frontend/script/start.bash +22 -0
- package/packages/frontend/script/trust-localhost.bash +7 -0
- package/packages/frontend/src/auth/authProvider.ts +10 -0
- package/packages/frontend/src/auth/useAuth.ts +33 -0
- package/packages/frontend/src/components/Pagination.tsx +26 -0
- package/packages/frontend/src/configProvider/index.ts +53 -0
- package/packages/frontend/src/configProvider/use.ts +41 -0
- package/packages/frontend/src/core/context/services.spec.tsx +39 -0
- package/packages/frontend/src/core/context/services.tsx +16 -0
- package/packages/frontend/src/core/index.spec.ts +7 -0
- package/packages/frontend/src/core/index.ts +20 -0
- package/packages/frontend/src/core/services.tsx +14 -0
- package/packages/frontend/src/core/types.ts +3 -0
- package/packages/frontend/src/example/api.ts +28 -0
- package/packages/frontend/src/example/components/Layout.tsx +23 -0
- package/packages/frontend/src/example/screens/Home.spec.tsx +68 -0
- package/packages/frontend/src/example/screens/Home.tsx +78 -0
- package/packages/frontend/src/example/screens/ThingList.spec.tsx +60 -0
- package/packages/frontend/src/example/screens/ThingList.tsx +75 -0
- package/packages/frontend/src/example/screens/ThingView.spec.tsx +71 -0
- package/packages/frontend/src/example/screens/ThingView.tsx +47 -0
- package/packages/frontend/src/example/screens/index.ts +9 -0
- package/packages/frontend/src/index.css +159 -0
- package/packages/frontend/src/index.tsx +67 -0
- package/packages/frontend/src/react-app-env.d.ts +1 -0
- package/packages/frontend/src/routing/components/RouteLink.spec.tsx +55 -0
- package/packages/frontend/src/routing/components/RouteLink.tsx +35 -0
- package/packages/frontend/src/routing/middleware.ts +6 -0
- package/packages/frontend/src/routing/useQuery.ts +14 -0
- package/packages/frontend/src/setupProxy.js +19 -0
- package/packages/frontend/src/setupTests.ts +9 -0
- package/packages/frontend/src/tests/testServices.tsx +23 -0
- package/packages/frontend/tsconfig.json +27 -0
- package/packages/lambda/.eslintrc.js +64 -0
- package/packages/lambda/jest-global-setup.js +3 -0
- package/packages/lambda/jest-setup-after-env.js +1 -0
- package/packages/lambda/jest.config.js +31 -0
- package/packages/lambda/jest.resolver.js +17 -0
- package/packages/lambda/package.json +68 -0
- package/packages/lambda/script/build.bash +19 -0
- package/packages/lambda/script/bundle-functions.bash +10 -0
- package/packages/lambda/script/lambdaLocalProxy.js +16 -0
- package/packages/lambda/script/lambdaLocalProxy.spec.ts +147 -0
- package/packages/lambda/script/utils/getRouteData.ts +7 -0
- package/packages/lambda/script/utils/routeDataLoader.js +8 -0
- package/packages/lambda/script/utils/routeDataLoader.spec.ts +8 -0
- package/packages/lambda/src/functions/serviceApi/core/index.ts +7 -0
- package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +38 -0
- package/packages/lambda/src/functions/serviceApi/core/request.ts +42 -0
- package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +7 -0
- package/packages/lambda/src/functions/serviceApi/core/routes.ts +10 -0
- package/packages/lambda/src/functions/serviceApi/core/services.ts +9 -0
- package/packages/lambda/src/functions/serviceApi/core/types.ts +13 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +4 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +48 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +58 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +36 -0
- package/packages/lambda/src/functions/serviceApi/entry/local.ts +71 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +16 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +41 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +78 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +70 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +306 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +176 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +263 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +134 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +23 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +32 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +10 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +7 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +13 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +23 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +9 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +9 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +12 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +21 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +21 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +18 -0
- package/packages/lambda/tsconfig.json +30 -0
- package/packages/lambda/webpack.config.js +97 -0
- package/packages/utils/.eslintrc.js +64 -0
- package/packages/utils/README.md +118 -0
- package/packages/utils/jest-global-setup.js +3 -0
- package/packages/utils/jest.config.js +25 -0
- package/packages/utils/jest.resolver.js +17 -0
- package/packages/utils/package.json +238 -0
- package/packages/utils/src/assertions/index.spec.ts +126 -0
- package/{dist/esm/assertions/index.js → packages/utils/src/assertions/index.ts} +64 -49
- package/packages/utils/src/aws/ssmService.ts +7 -0
- package/packages/utils/src/config/awsParameterConfig.ts +24 -0
- package/packages/utils/src/config/envConfig.ts +58 -0
- package/packages/utils/src/config/index.spec.ts +165 -0
- package/{dist/esm/config/index.d.ts → packages/utils/src/config/index.ts} +29 -13
- package/packages/utils/src/config/lambdaParameterConfig.ts +49 -0
- package/{dist/esm/config/replaceConfig.js → packages/utils/src/config/replaceConfig.ts} +16 -6
- package/packages/utils/src/config/resolveConfigValue.ts +10 -0
- package/packages/utils/src/errors/index.spec.ts +35 -0
- package/{dist/esm/errors/index.js → packages/utils/src/errors/index.ts} +57 -41
- package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +197 -0
- package/packages/utils/src/fetch/fetchStatusRetry.ts +33 -0
- package/packages/utils/src/fetch/index.spec.ts +34 -0
- package/packages/utils/src/fetch/index.ts +87 -0
- package/packages/utils/src/guards/index.spec.ts +58 -0
- package/{dist/esm/guards/index.d.ts → packages/utils/src/guards/index.ts} +10 -7
- package/packages/utils/src/index.spec.ts +471 -0
- package/packages/utils/src/middleware/apiErrorHandler.spec.ts +65 -0
- package/packages/utils/src/middleware/apiErrorHandler.ts +67 -0
- package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +184 -0
- package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +71 -0
- package/packages/utils/src/middleware/index.spec.ts +99 -0
- package/{dist/cjs/middleware/index.d.ts → packages/utils/src/middleware/index.ts} +53 -5
- package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +103 -0
- package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +52 -0
- package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +20 -0
- package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +11 -0
- package/packages/utils/src/misc/hashValue.ts +18 -0
- package/packages/utils/src/misc/helpers.ts +259 -0
- package/packages/utils/src/misc/merge.ts +48 -0
- package/{dist/esm/misc/partitionSequence.js → packages/utils/src/misc/partitionSequence.ts} +23 -15
- package/packages/utils/src/pagination/index.spec.ts +150 -0
- package/packages/utils/src/pagination/index.ts +117 -0
- package/{dist/esm/routing/helpers.js → packages/utils/src/routing/helpers.ts} +42 -30
- package/packages/utils/src/routing/index.spec.ts +553 -0
- package/packages/utils/src/routing/index.ts +424 -0
- package/packages/utils/src/routing/validators/zod.spec.ts +16 -0
- package/packages/utils/src/routing/validators/zod.ts +14 -0
- package/packages/utils/src/services/accountsGateway/README.md +3 -0
- package/packages/utils/src/services/accountsGateway/index.spec.ts +518 -0
- package/packages/utils/src/services/accountsGateway/index.ts +251 -0
- package/packages/utils/src/services/apiGateway/README.md +93 -0
- package/packages/utils/src/services/apiGateway/index.spec.ts +254 -0
- package/packages/utils/src/services/apiGateway/index.ts +189 -0
- package/packages/utils/src/services/authProvider/README.md +21 -0
- package/packages/utils/src/services/authProvider/browser.spec.ts +391 -0
- package/packages/utils/src/services/authProvider/browser.ts +209 -0
- package/packages/utils/src/services/authProvider/decryption.spec.ts +337 -0
- package/packages/utils/src/services/authProvider/decryption.ts +98 -0
- package/packages/utils/src/services/authProvider/index.ts +93 -0
- package/packages/utils/src/services/authProvider/stub.spec.ts +29 -0
- package/packages/utils/src/services/authProvider/subrequest.spec.ts +105 -0
- package/packages/utils/src/services/authProvider/subrequest.ts +68 -0
- package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +128 -0
- package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +106 -0
- package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +26 -0
- package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +57 -0
- package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +135 -0
- package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +49 -0
- package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +26 -0
- package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +10 -0
- package/packages/utils/src/services/documentStore/dynamoEncoding.ts +57 -0
- package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +43 -0
- package/packages/utils/src/services/documentStore/fileSystemAssert.ts +10 -0
- package/{dist/cjs/services/documentStore/index.d.ts → packages/utils/src/services/documentStore/index.ts} +8 -8
- package/packages/utils/src/services/documentStore/unversioned/README.md +13 -0
- package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +859 -0
- package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +243 -0
- package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +629 -0
- package/packages/utils/src/services/documentStore/unversioned/file-system.ts +194 -0
- package/{dist/cjs/services/documentStore/unversioned/index.d.ts → packages/utils/src/services/documentStore/unversioned/index.ts} +2 -0
- package/packages/utils/src/services/documentStore/versioned/README.md +13 -0
- package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +376 -0
- package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +167 -0
- package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +262 -0
- package/packages/utils/src/services/documentStore/versioned/file-system.ts +90 -0
- package/packages/utils/src/services/documentStore/versioned/index.ts +25 -0
- package/packages/utils/src/services/exercisesGateway/README.md +5 -0
- package/packages/utils/src/services/exercisesGateway/index.spec.ts +326 -0
- package/packages/utils/src/services/exercisesGateway/index.ts +163 -0
- package/packages/utils/src/services/fileServer/index.spec.ts +88 -0
- package/packages/utils/src/services/fileServer/index.ts +43 -0
- package/packages/utils/src/services/fileServer/localFileServer.spec.ts +182 -0
- package/packages/utils/src/services/fileServer/localFileServer.ts +159 -0
- package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +266 -0
- package/packages/utils/src/services/fileServer/s3FileServer.ts +155 -0
- package/packages/utils/src/services/launchParams/index.spec.ts +366 -0
- package/packages/utils/src/services/launchParams/signer.ts +73 -0
- package/packages/utils/src/services/launchParams/verifier.ts +120 -0
- package/packages/utils/src/services/logger/console.spec.ts +29 -0
- package/{dist/esm/services/logger/console.js → packages/utils/src/services/logger/console.ts} +5 -2
- package/packages/utils/src/services/logger/index.spec.ts +65 -0
- package/{dist/esm/services/logger/index.d.ts → packages/utils/src/services/logger/index.ts} +23 -9
- package/packages/utils/src/services/lrsGateway/README.md +5 -0
- package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +22 -0
- package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +847 -0
- package/packages/utils/src/services/lrsGateway/attempt-utils.ts +358 -0
- package/packages/utils/src/services/lrsGateway/file-system.spec.ts +363 -0
- package/packages/utils/src/services/lrsGateway/file-system.ts +165 -0
- package/packages/utils/src/services/lrsGateway/index.spec.ts +194 -0
- package/packages/utils/src/services/lrsGateway/index.ts +257 -0
- package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +887 -0
- package/packages/utils/src/services/lrsGateway/xapiUtils.ts +262 -0
- package/packages/utils/src/services/postgresConnection/index.spec.ts +170 -0
- package/packages/utils/src/services/postgresConnection/index.ts +84 -0
- package/packages/utils/src/services/searchProvider/README.md +3 -0
- package/packages/utils/src/services/searchProvider/index.ts +59 -0
- package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +526 -0
- package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +223 -0
- package/packages/utils/src/services/searchProvider/openSearch.spec.ts +926 -0
- package/packages/utils/src/services/searchProvider/openSearch.ts +195 -0
- package/{dist/esm/types.d.ts → packages/utils/src/types.ts} +34 -6
- package/packages/utils/tsconfig.json +31 -0
- package/packages/utils/tsconfig.without-specs.cjs.json +7 -0
- package/packages/utils/tsconfig.without-specs.esm.json +7 -0
- package/packages/utils/tsconfig.without-specs.json +6 -0
- package/scripts/build.bash +24 -0
- package/scripts/ci.bash +10 -0
- package/scripts/start.bash +29 -0
- package/dist/cjs/assertions/index.d.ts +0 -89
- package/dist/cjs/assertions/index.js +0 -157
- package/dist/cjs/aws/ssmService.d.ts +0 -5
- package/dist/cjs/aws/ssmService.js +0 -9
- package/dist/cjs/config/awsParameterConfig.d.ts +0 -10
- package/dist/cjs/config/awsParameterConfig.js +0 -26
- package/dist/cjs/config/envConfig.d.ts +0 -24
- package/dist/cjs/config/envConfig.js +0 -57
- package/dist/cjs/config/index.d.ts +0 -48
- package/dist/cjs/config/index.js +0 -35
- package/dist/cjs/config/lambdaParameterConfig.d.ts +0 -12
- package/dist/cjs/config/lambdaParameterConfig.js +0 -45
- package/dist/cjs/config/replaceConfig.d.ts +0 -14
- package/dist/cjs/config/replaceConfig.js +0 -22
- package/dist/cjs/config/resolveConfigValue.d.ts +0 -5
- package/dist/cjs/config/resolveConfigValue.js +0 -12
- package/dist/cjs/errors/index.d.ts +0 -88
- package/dist/cjs/errors/index.js +0 -123
- package/dist/cjs/fetch/fetchStatusRetry.d.ts +0 -8
- package/dist/cjs/fetch/fetchStatusRetry.js +0 -27
- package/dist/cjs/fetch/index.d.ts +0 -64
- package/dist/cjs/fetch/index.js +0 -55
- package/dist/cjs/guards/index.d.ts +0 -38
- package/dist/cjs/guards/index.js +0 -44
- package/dist/cjs/index.js +0 -20
- package/dist/cjs/middleware/apiErrorHandler.d.ts +0 -24
- package/dist/cjs/middleware/apiErrorHandler.js +0 -42
- package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +0 -23
- package/dist/cjs/middleware/apiSlowResponseMiddleware.js +0 -54
- package/dist/cjs/middleware/index.js +0 -48
- package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
- package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +0 -44
- package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +0 -4
- package/dist/cjs/middleware/throwNotFoundMiddleware.js +0 -14
- package/dist/cjs/misc/hashValue.d.ts +0 -10
- package/dist/cjs/misc/hashValue.js +0 -17
- package/dist/cjs/misc/helpers.d.ts +0 -124
- package/dist/cjs/misc/helpers.js +0 -214
- package/dist/cjs/misc/merge.d.ts +0 -21
- package/dist/cjs/misc/merge.js +0 -45
- package/dist/cjs/misc/partitionSequence.d.ts +0 -35
- package/dist/cjs/misc/partitionSequence.js +0 -55
- package/dist/cjs/pagination/index.d.ts +0 -91
- package/dist/cjs/pagination/index.js +0 -83
- package/dist/cjs/routing/helpers.d.ts +0 -57
- package/dist/cjs/routing/helpers.js +0 -90
- package/dist/cjs/routing/index.d.ts +0 -290
- package/dist/cjs/routing/index.js +0 -295
- package/dist/cjs/routing/validators/zod.d.ts +0 -4
- package/dist/cjs/routing/validators/zod.js +0 -14
- package/dist/cjs/services/accountsGateway/index.d.ts +0 -92
- package/dist/cjs/services/accountsGateway/index.js +0 -138
- package/dist/cjs/services/apiGateway/index.d.ts +0 -68
- package/dist/cjs/services/apiGateway/index.js +0 -118
- package/dist/cjs/services/authProvider/browser.d.ts +0 -40
- package/dist/cjs/services/authProvider/browser.js +0 -155
- package/dist/cjs/services/authProvider/decryption.d.ts +0 -19
- package/dist/cjs/services/authProvider/decryption.js +0 -73
- package/dist/cjs/services/authProvider/index.d.ts +0 -63
- package/dist/cjs/services/authProvider/index.js +0 -34
- package/dist/cjs/services/authProvider/subrequest.d.ts +0 -13
- package/dist/cjs/services/authProvider/subrequest.js +0 -49
- package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
- package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +0 -91
- package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
- package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +0 -47
- package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +0 -13
- package/dist/cjs/services/authProvider/utils/userRoleValidator.js +0 -37
- package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +0 -3
- package/dist/cjs/services/authProvider/utils/userSubrequest.js +0 -13
- package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +0 -10
- package/dist/cjs/services/documentStore/dynamoEncoding.js +0 -52
- package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +0 -1
- package/dist/cjs/services/documentStore/fileSystemAssert.js +0 -14
- package/dist/cjs/services/documentStore/index.js +0 -2
- package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +0 -31
- package/dist/cjs/services/documentStore/unversioned/dynamodb.js +0 -233
- package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +0 -32
- package/dist/cjs/services/documentStore/unversioned/file-system.js +0 -214
- package/dist/cjs/services/documentStore/unversioned/index.js +0 -2
- package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +0 -25
- package/dist/cjs/services/documentStore/versioned/dynamodb.js +0 -143
- package/dist/cjs/services/documentStore/versioned/file-system.d.ts +0 -25
- package/dist/cjs/services/documentStore/versioned/file-system.js +0 -73
- package/dist/cjs/services/documentStore/versioned/index.d.ts +0 -17
- package/dist/cjs/services/documentStore/versioned/index.js +0 -2
- package/dist/cjs/services/exercisesGateway/index.d.ts +0 -67
- package/dist/cjs/services/exercisesGateway/index.js +0 -107
- package/dist/cjs/services/fileServer/index.d.ts +0 -30
- package/dist/cjs/services/fileServer/index.js +0 -19
- package/dist/cjs/services/fileServer/localFileServer.d.ts +0 -13
- package/dist/cjs/services/fileServer/localFileServer.js +0 -132
- package/dist/cjs/services/fileServer/s3FileServer.d.ts +0 -14
- package/dist/cjs/services/fileServer/s3FileServer.js +0 -131
- package/dist/cjs/services/launchParams/index.js +0 -7
- package/dist/cjs/services/launchParams/signer.d.ts +0 -23
- package/dist/cjs/services/launchParams/signer.js +0 -58
- package/dist/cjs/services/launchParams/verifier.d.ts +0 -21
- package/dist/cjs/services/launchParams/verifier.js +0 -129
- package/dist/cjs/services/logger/console.d.ts +0 -4
- package/dist/cjs/services/logger/console.js +0 -12
- package/dist/cjs/services/logger/index.d.ts +0 -39
- package/dist/cjs/services/logger/index.js +0 -31
- package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
- package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +0 -21
- package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +0 -70
- package/dist/cjs/services/lrsGateway/attempt-utils.js +0 -258
- package/dist/cjs/services/lrsGateway/file-system.d.ts +0 -15
- package/dist/cjs/services/lrsGateway/file-system.js +0 -150
- package/dist/cjs/services/lrsGateway/index.d.ts +0 -122
- package/dist/cjs/services/lrsGateway/index.js +0 -148
- package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +0 -68
- package/dist/cjs/services/lrsGateway/xapiUtils.js +0 -109
- package/dist/cjs/services/postgresConnection/index.d.ts +0 -28
- package/dist/cjs/services/postgresConnection/index.js +0 -65
- package/dist/cjs/services/searchProvider/index.d.ts +0 -67
- package/dist/cjs/services/searchProvider/index.js +0 -2
- package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
- package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +0 -191
- package/dist/cjs/services/searchProvider/openSearch.d.ts +0 -28
- package/dist/cjs/services/searchProvider/openSearch.js +0 -154
- package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +0 -1
- package/dist/cjs/types.d.ts +0 -31
- package/dist/cjs/types.js +0 -2
- package/dist/esm/assertions/index.d.ts +0 -89
- package/dist/esm/aws/ssmService.d.ts +0 -5
- package/dist/esm/aws/ssmService.js +0 -6
- package/dist/esm/config/awsParameterConfig.d.ts +0 -10
- package/dist/esm/config/awsParameterConfig.js +0 -22
- package/dist/esm/config/envConfig.d.ts +0 -24
- package/dist/esm/config/envConfig.js +0 -53
- package/dist/esm/config/index.js +0 -17
- package/dist/esm/config/lambdaParameterConfig.d.ts +0 -12
- package/dist/esm/config/lambdaParameterConfig.js +0 -38
- package/dist/esm/config/replaceConfig.d.ts +0 -14
- package/dist/esm/config/resolveConfigValue.d.ts +0 -5
- package/dist/esm/config/resolveConfigValue.js +0 -8
- package/dist/esm/errors/index.d.ts +0 -88
- package/dist/esm/fetch/fetchStatusRetry.d.ts +0 -8
- package/dist/esm/fetch/fetchStatusRetry.js +0 -23
- package/dist/esm/fetch/index.d.ts +0 -64
- package/dist/esm/fetch/index.js +0 -46
- package/dist/esm/guards/index.js +0 -36
- package/dist/esm/index.d.ts +0 -4
- package/dist/esm/index.js +0 -4
- package/dist/esm/middleware/apiErrorHandler.d.ts +0 -24
- package/dist/esm/middleware/apiErrorHandler.js +0 -38
- package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +0 -23
- package/dist/esm/middleware/apiSlowResponseMiddleware.js +0 -50
- package/dist/esm/middleware/index.d.ts +0 -47
- package/dist/esm/middleware/index.js +0 -44
- package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
- package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +0 -40
- package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +0 -4
- package/dist/esm/middleware/throwNotFoundMiddleware.js +0 -10
- package/dist/esm/misc/hashValue.d.ts +0 -10
- package/dist/esm/misc/hashValue.js +0 -13
- package/dist/esm/misc/helpers.d.ts +0 -124
- package/dist/esm/misc/helpers.js +0 -199
- package/dist/esm/misc/merge.d.ts +0 -21
- package/dist/esm/misc/merge.js +0 -40
- package/dist/esm/misc/partitionSequence.d.ts +0 -35
- package/dist/esm/pagination/index.d.ts +0 -91
- package/dist/esm/pagination/index.js +0 -77
- package/dist/esm/routing/helpers.d.ts +0 -57
- package/dist/esm/routing/index.d.ts +0 -290
- package/dist/esm/routing/index.js +0 -246
- package/dist/esm/routing/validators/zod.d.ts +0 -4
- package/dist/esm/routing/validators/zod.js +0 -10
- package/dist/esm/services/accountsGateway/index.d.ts +0 -92
- package/dist/esm/services/accountsGateway/index.js +0 -131
- package/dist/esm/services/apiGateway/index.d.ts +0 -68
- package/dist/esm/services/apiGateway/index.js +0 -77
- package/dist/esm/services/authProvider/browser.d.ts +0 -40
- package/dist/esm/services/authProvider/browser.js +0 -151
- package/dist/esm/services/authProvider/decryption.d.ts +0 -19
- package/dist/esm/services/authProvider/decryption.js +0 -69
- package/dist/esm/services/authProvider/index.d.ts +0 -63
- package/dist/esm/services/authProvider/index.js +0 -26
- package/dist/esm/services/authProvider/subrequest.d.ts +0 -13
- package/dist/esm/services/authProvider/subrequest.js +0 -45
- package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
- package/dist/esm/services/authProvider/utils/decryptAndVerify.js +0 -85
- package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
- package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +0 -40
- package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +0 -13
- package/dist/esm/services/authProvider/utils/userRoleValidator.js +0 -33
- package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +0 -3
- package/dist/esm/services/authProvider/utils/userSubrequest.js +0 -6
- package/dist/esm/services/documentStore/dynamoEncoding.d.ts +0 -10
- package/dist/esm/services/documentStore/dynamoEncoding.js +0 -45
- package/dist/esm/services/documentStore/fileSystemAssert.d.ts +0 -1
- package/dist/esm/services/documentStore/fileSystemAssert.js +0 -10
- package/dist/esm/services/documentStore/index.d.ts +0 -14
- package/dist/esm/services/documentStore/index.js +0 -1
- package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +0 -31
- package/dist/esm/services/documentStore/unversioned/dynamodb.js +0 -226
- package/dist/esm/services/documentStore/unversioned/file-system.d.ts +0 -32
- package/dist/esm/services/documentStore/unversioned/file-system.js +0 -174
- package/dist/esm/services/documentStore/unversioned/index.d.ts +0 -2
- package/dist/esm/services/documentStore/unversioned/index.js +0 -1
- package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +0 -25
- package/dist/esm/services/documentStore/versioned/dynamodb.js +0 -139
- package/dist/esm/services/documentStore/versioned/file-system.d.ts +0 -25
- package/dist/esm/services/documentStore/versioned/file-system.js +0 -69
- package/dist/esm/services/documentStore/versioned/index.d.ts +0 -17
- package/dist/esm/services/documentStore/versioned/index.js +0 -1
- package/dist/esm/services/exercisesGateway/index.d.ts +0 -67
- package/dist/esm/services/exercisesGateway/index.js +0 -70
- package/dist/esm/services/fileServer/index.d.ts +0 -30
- package/dist/esm/services/fileServer/index.js +0 -13
- package/dist/esm/services/fileServer/localFileServer.d.ts +0 -13
- package/dist/esm/services/fileServer/localFileServer.js +0 -125
- package/dist/esm/services/fileServer/s3FileServer.d.ts +0 -14
- package/dist/esm/services/fileServer/s3FileServer.js +0 -124
- package/dist/esm/services/launchParams/index.d.ts +0 -2
- package/dist/esm/services/launchParams/index.js +0 -2
- package/dist/esm/services/launchParams/signer.d.ts +0 -23
- package/dist/esm/services/launchParams/signer.js +0 -51
- package/dist/esm/services/launchParams/verifier.d.ts +0 -21
- package/dist/esm/services/launchParams/verifier.js +0 -92
- package/dist/esm/services/logger/console.d.ts +0 -4
- package/dist/esm/services/logger/index.js +0 -27
- package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
- package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +0 -14
- package/dist/esm/services/lrsGateway/attempt-utils.d.ts +0 -70
- package/dist/esm/services/lrsGateway/attempt-utils.js +0 -236
- package/dist/esm/services/lrsGateway/file-system.d.ts +0 -15
- package/dist/esm/services/lrsGateway/file-system.js +0 -110
- package/dist/esm/services/lrsGateway/index.d.ts +0 -122
- package/dist/esm/services/lrsGateway/index.js +0 -111
- package/dist/esm/services/lrsGateway/xapiUtils.d.ts +0 -68
- package/dist/esm/services/lrsGateway/xapiUtils.js +0 -99
- package/dist/esm/services/postgresConnection/index.d.ts +0 -28
- package/dist/esm/services/postgresConnection/index.js +0 -58
- package/dist/esm/services/searchProvider/index.d.ts +0 -67
- package/dist/esm/services/searchProvider/index.js +0 -1
- package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
- package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +0 -187
- package/dist/esm/services/searchProvider/openSearch.d.ts +0 -28
- package/dist/esm/services/searchProvider/openSearch.js +0 -150
- package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +0 -1
- package/dist/esm/types.js +0 -1
- /package/{script → packages/utils/script}/bin/copy-from-template.bash +0 -0
- /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
- /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
- /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
- /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
- /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
- /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
- /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
- /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
- /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
- /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
- /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
- /package/{script → packages/utils/script}/bin/which.bash +0 -0
- /package/{script → packages/utils/script}/bin-entry.bash +0 -0
- /package/{script → packages/utils/script}/build.bash +0 -0
- /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
- /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type { GetParameterCommandOutput } from '@aws-sdk/client-ssm';
|
|
2
|
+
import fetch from 'node-fetch';
|
|
3
|
+
import { assertDefined } from '../assertions';
|
|
4
|
+
import { retryWithDelay } from '../misc/helpers';
|
|
5
|
+
import { envConfig } from './envConfig';
|
|
6
|
+
import { ConfigValueProvider, resolveConfigValue } from '.';
|
|
7
|
+
|
|
8
|
+
const lambdaExtensionUrl = 'http://localhost:2773';
|
|
9
|
+
let lambdaExtensionReadyPromise: Promise<unknown>;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Returns a value from the AWS Parameter Store. Can only be used during in AWS Lambda, and
|
|
13
|
+
* requires that the AWS Parameters and Secrets Lambda Extension Layer be included in the Lambda.
|
|
14
|
+
* This extension has built-in caching for requested parameters.
|
|
15
|
+
*
|
|
16
|
+
* @param parameterName the name of the parameter; can be a literal name (string) or can itself
|
|
17
|
+
* be accessed via another parameter by giving a configuration value provider.
|
|
18
|
+
* @example const someValue = resolveConfig(lambdaParameterConfig('some-parameter-name'));
|
|
19
|
+
* @returns the configuration value provider for the value
|
|
20
|
+
*/
|
|
21
|
+
export const lambdaParameterConfig = (parameterName: ConfigValueProvider<string>): ConfigValueProvider<string> => async() => {
|
|
22
|
+
const token = await resolveConfigValue(envConfig('AWS_SESSION_TOKEN', 'runtime'));
|
|
23
|
+
const name = await resolveConfigValue(parameterName);
|
|
24
|
+
|
|
25
|
+
if (!lambdaExtensionReadyPromise) {
|
|
26
|
+
// This request will return 400 Bad Request,
|
|
27
|
+
// but we only care that it'll block until the extension is ready
|
|
28
|
+
lambdaExtensionReadyPromise = retryWithDelay(() => fetch(lambdaExtensionUrl));
|
|
29
|
+
}
|
|
30
|
+
await lambdaExtensionReadyPromise;
|
|
31
|
+
|
|
32
|
+
const resp = await retryWithDelay(() => fetch(
|
|
33
|
+
// Port 2773 is the default port for the extension
|
|
34
|
+
`${lambdaExtensionUrl}/systemsmanager/parameters/get?name=${name}&withDecryption=true`,
|
|
35
|
+
{ headers: { 'X-Aws-Parameters-Secrets-Token': token } }
|
|
36
|
+
));
|
|
37
|
+
|
|
38
|
+
if (resp.ok) {
|
|
39
|
+
const response = await resp.json() as GetParameterCommandOutput;
|
|
40
|
+
const parameter = assertDefined(
|
|
41
|
+
response.Parameter, `aws GetParameter response missing Parameter key for ${name}"`
|
|
42
|
+
);
|
|
43
|
+
return assertDefined(parameter.Value, `aws GetParameter response missing Parameter.Value key for ${name}"`);
|
|
44
|
+
} else {
|
|
45
|
+
throw new Error(
|
|
46
|
+
`HTTP Error Response ${resp.status} ${resp.statusText} while fetching parameter ${name}`
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
};
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { resolveConfigValue } from './resolveConfigValue';
|
|
2
|
+
import { ConfigValueProvider } from '.';
|
|
3
|
+
|
|
2
4
|
/**
|
|
3
5
|
* Substitutes configuration values into a provided string.
|
|
4
6
|
* Performs a string substitution using configuration values
|
|
@@ -9,10 +11,18 @@ import { resolveConfigValue } from './resolveConfigValue';
|
|
|
9
11
|
* @example replaceConfig('https://[host]', { '[host]': envConfig('HOST') })
|
|
10
12
|
* @returns the string after substitution is complete
|
|
11
13
|
*/
|
|
12
|
-
export const replaceConfig = (
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
14
|
+
export const replaceConfig = (
|
|
15
|
+
base: ConfigValueProvider<string>,
|
|
16
|
+
replacements: {[token: string]: ConfigValueProvider<string>}
|
|
17
|
+
): ConfigValueProvider<string> => {
|
|
18
|
+
|
|
19
|
+
return async() => {
|
|
20
|
+
const resolved = await Promise.all(Object.entries(replacements)
|
|
21
|
+
.map(async([token, replacement]) => [token, await resolveConfigValue(replacement)] as const)
|
|
22
|
+
);
|
|
23
|
+
|
|
24
|
+
return resolved.reduce(
|
|
25
|
+
(result, [token, replacement]) => result.replace(token, replacement)
|
|
26
|
+
, await resolveConfigValue(base));
|
|
27
|
+
};
|
|
18
28
|
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { ConfigValue, ConfigValueProvider } from '.';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* resolves a config value into a string, to be used inside of things that are provided configurations
|
|
5
|
+
*/
|
|
6
|
+
export const resolveConfigValue = async<V extends ConfigValue>(provider: ConfigValueProvider<V>): Promise<V> => {
|
|
7
|
+
return typeof provider === 'function'
|
|
8
|
+
? await provider()
|
|
9
|
+
: provider;
|
|
10
|
+
};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { ConflictError, ForbiddenError, InvalidRequestError, NotFoundError, SessionExpiredError, UnauthorizedError } from '.';
|
|
2
|
+
|
|
3
|
+
describe('errorIsType', () => {
|
|
4
|
+
it('returns true for same error type', () => {
|
|
5
|
+
expect(InvalidRequestError.matches(new InvalidRequestError())).toBe(true);
|
|
6
|
+
});
|
|
7
|
+
it('returns false for different error type', () => {
|
|
8
|
+
expect(InvalidRequestError.matches(new UnauthorizedError())).toBe(false);
|
|
9
|
+
});
|
|
10
|
+
it('returns false random input', () => {
|
|
11
|
+
expect(InvalidRequestError.matches(new Error())).toBe(false);
|
|
12
|
+
expect(InvalidRequestError.matches('asdf')).toBe(false);
|
|
13
|
+
});
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
describe('custom error constructors', () => {
|
|
17
|
+
it('use TYPE as default message', () => {
|
|
18
|
+
expect(new InvalidRequestError().message).toBe(InvalidRequestError.TYPE);
|
|
19
|
+
expect(new UnauthorizedError().message).toBe(UnauthorizedError.TYPE);
|
|
20
|
+
expect(new ForbiddenError().message).toBe(ForbiddenError.TYPE);
|
|
21
|
+
expect(new NotFoundError().message).toBe(NotFoundError.TYPE);
|
|
22
|
+
expect(new SessionExpiredError().message).toBe(SessionExpiredError.TYPE);
|
|
23
|
+
expect(new ConflictError().message).toBe(ConflictError.TYPE);
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it('allow custom messages', () => {
|
|
27
|
+
const customMessage = 'Some Error';
|
|
28
|
+
expect(new InvalidRequestError(customMessage).message).toBe(customMessage);
|
|
29
|
+
expect(new UnauthorizedError(customMessage).message).toBe(customMessage);
|
|
30
|
+
expect(new ForbiddenError(customMessage).message).toBe(customMessage);
|
|
31
|
+
expect(new NotFoundError(customMessage).message).toBe(customMessage);
|
|
32
|
+
expect(new SessionExpiredError(customMessage).message).toBe(customMessage);
|
|
33
|
+
expect(new ConflictError(customMessage).message).toBe(customMessage);
|
|
34
|
+
});
|
|
35
|
+
});
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { JsonCompatibleStruct } from '../routing';
|
|
2
|
+
|
|
1
3
|
/*
|
|
2
4
|
* if code is split into multiple bundles, sometimes each bundle
|
|
3
5
|
* will get its own definition of this module and then instanceof checks
|
|
@@ -10,13 +12,17 @@
|
|
|
10
12
|
* error instanceof InvalidRequestError
|
|
11
13
|
*
|
|
12
14
|
*/
|
|
13
|
-
const errorIsType = (t) => (e)
|
|
14
|
-
|
|
15
|
+
const errorIsType = <T extends {TYPE: string}>(t: T) => (e: any): e is T =>
|
|
16
|
+
e instanceof Error
|
|
17
|
+
&& (e as any).constructor.TYPE === t.TYPE;
|
|
18
|
+
|
|
15
19
|
/**
|
|
16
20
|
* Returns true if the error is defined in this library
|
|
17
21
|
*/
|
|
18
|
-
export const isAppError = (e)
|
|
19
|
-
|
|
22
|
+
export const isAppError = (e: any): e is Error & {constructor: {TYPE: string}} =>
|
|
23
|
+
e instanceof Error
|
|
24
|
+
&& typeof (e as any).constructor.TYPE === 'string';
|
|
25
|
+
|
|
20
26
|
/**
|
|
21
27
|
* Invalid request error
|
|
22
28
|
*
|
|
@@ -24,12 +30,13 @@ export const isAppError = (e) => e instanceof Error
|
|
|
24
30
|
* `InvalidRequestError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
25
31
|
*/
|
|
26
32
|
export class InvalidRequestError extends Error {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
33
|
+
static readonly TYPE = 'InvalidRequestError';
|
|
34
|
+
static matches = errorIsType(InvalidRequestError);
|
|
35
|
+
constructor(message?: string) {
|
|
36
|
+
super(message || InvalidRequestError.TYPE);
|
|
37
|
+
}
|
|
30
38
|
}
|
|
31
|
-
|
|
32
|
-
InvalidRequestError.matches = errorIsType(InvalidRequestError);
|
|
39
|
+
|
|
33
40
|
/**
|
|
34
41
|
* Validation Error
|
|
35
42
|
*
|
|
@@ -37,14 +44,19 @@ InvalidRequestError.matches = errorIsType(InvalidRequestError);
|
|
|
37
44
|
* `ValidationError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
38
45
|
*/
|
|
39
46
|
export class ValidationError extends Error {
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
47
|
+
static readonly TYPE = 'ValidationError';
|
|
48
|
+
static matches = errorIsType(ValidationError);
|
|
49
|
+
|
|
50
|
+
private data: JsonCompatibleStruct;
|
|
51
|
+
constructor(data: JsonCompatibleStruct) {
|
|
52
|
+
super(InvalidRequestError.TYPE);
|
|
53
|
+
|
|
54
|
+
this.data = data;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
getData() { return this.data; }
|
|
45
58
|
}
|
|
46
|
-
|
|
47
|
-
ValidationError.matches = errorIsType(ValidationError);
|
|
59
|
+
|
|
48
60
|
/**
|
|
49
61
|
* Unauthorized error
|
|
50
62
|
*
|
|
@@ -52,12 +64,13 @@ ValidationError.matches = errorIsType(ValidationError);
|
|
|
52
64
|
* `UnauthorizedError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
53
65
|
*/
|
|
54
66
|
export class UnauthorizedError extends Error {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
67
|
+
static readonly TYPE = 'UnauthorizedError';
|
|
68
|
+
static matches = errorIsType(UnauthorizedError);
|
|
69
|
+
constructor(message?: string) {
|
|
70
|
+
super(message || UnauthorizedError.TYPE);
|
|
71
|
+
}
|
|
58
72
|
}
|
|
59
|
-
|
|
60
|
-
UnauthorizedError.matches = errorIsType(UnauthorizedError);
|
|
73
|
+
|
|
61
74
|
/**
|
|
62
75
|
* Forbidden error
|
|
63
76
|
*
|
|
@@ -65,12 +78,13 @@ UnauthorizedError.matches = errorIsType(UnauthorizedError);
|
|
|
65
78
|
* `ForbiddenError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
66
79
|
*/
|
|
67
80
|
export class ForbiddenError extends Error {
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
81
|
+
static readonly TYPE = 'ForbiddenError';
|
|
82
|
+
static matches = errorIsType(ForbiddenError);
|
|
83
|
+
constructor(message?: string) {
|
|
84
|
+
super(message || ForbiddenError.TYPE);
|
|
85
|
+
}
|
|
71
86
|
}
|
|
72
|
-
|
|
73
|
-
ForbiddenError.matches = errorIsType(ForbiddenError);
|
|
87
|
+
|
|
74
88
|
/**
|
|
75
89
|
* Not found error
|
|
76
90
|
*
|
|
@@ -78,12 +92,13 @@ ForbiddenError.matches = errorIsType(ForbiddenError);
|
|
|
78
92
|
* `NotFoundError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
79
93
|
*/
|
|
80
94
|
export class NotFoundError extends Error {
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
95
|
+
static readonly TYPE = 'NotFoundError';
|
|
96
|
+
static matches = errorIsType(NotFoundError);
|
|
97
|
+
constructor(message?: string) {
|
|
98
|
+
super(message || NotFoundError.TYPE);
|
|
99
|
+
}
|
|
84
100
|
}
|
|
85
|
-
|
|
86
|
-
NotFoundError.matches = errorIsType(NotFoundError);
|
|
101
|
+
|
|
87
102
|
/**
|
|
88
103
|
* Session expired error
|
|
89
104
|
*
|
|
@@ -91,12 +106,13 @@ NotFoundError.matches = errorIsType(NotFoundError);
|
|
|
91
106
|
* `SessionExpiredError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
92
107
|
*/
|
|
93
108
|
export class SessionExpiredError extends Error {
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
109
|
+
static readonly TYPE = 'SessionExpiredError';
|
|
110
|
+
static matches = errorIsType(SessionExpiredError);
|
|
111
|
+
constructor(message?: string) {
|
|
112
|
+
super(message || SessionExpiredError.TYPE);
|
|
113
|
+
}
|
|
97
114
|
}
|
|
98
|
-
|
|
99
|
-
SessionExpiredError.matches = errorIsType(SessionExpiredError);
|
|
115
|
+
|
|
100
116
|
/**
|
|
101
117
|
* Conflict error
|
|
102
118
|
*
|
|
@@ -104,9 +120,9 @@ SessionExpiredError.matches = errorIsType(SessionExpiredError);
|
|
|
104
120
|
* `ConflictError`; `instanceof` checks may not work if code is split into multiple bundles
|
|
105
121
|
*/
|
|
106
122
|
export class ConflictError extends Error {
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
123
|
+
static readonly TYPE = 'ConflictError';
|
|
124
|
+
static matches = errorIsType(ConflictError);
|
|
125
|
+
constructor(message?: string) {
|
|
126
|
+
super(message || ConflictError.TYPE);
|
|
127
|
+
}
|
|
110
128
|
}
|
|
111
|
-
ConflictError.TYPE = 'ConflictError';
|
|
112
|
-
ConflictError.matches = errorIsType(ConflictError);
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { fetchStatusRetry } from './fetchStatusRetry';
|
|
2
|
+
import { Response } from '.';
|
|
3
|
+
|
|
4
|
+
describe('fetchStatusRetry', () => {
|
|
5
|
+
let setTimeoutSpy: jest.SpyInstance;
|
|
6
|
+
let timeouts: Array<number | undefined>;
|
|
7
|
+
|
|
8
|
+
const doBeforeEach = () => {
|
|
9
|
+
timeouts = [];
|
|
10
|
+
setTimeoutSpy = jest.spyOn(global, 'setTimeout')
|
|
11
|
+
.mockImplementation((fn, timeout) => {
|
|
12
|
+
timeouts.push(timeout);
|
|
13
|
+
fn();
|
|
14
|
+
return 1 as any;
|
|
15
|
+
});
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
const doAfterEach = () => {
|
|
19
|
+
setTimeoutSpy.mockReset();
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
beforeEach(doBeforeEach);
|
|
23
|
+
afterEach(doAfterEach);
|
|
24
|
+
|
|
25
|
+
it('fetches normally', async() => {
|
|
26
|
+
const base = jest.fn();
|
|
27
|
+
const withRetry = fetchStatusRetry(base, {status: [502], retries: 7});
|
|
28
|
+
|
|
29
|
+
const response: Response = {
|
|
30
|
+
status: 200,
|
|
31
|
+
headers: {get: () => 'application/json'},
|
|
32
|
+
json: () => Promise.resolve({}),
|
|
33
|
+
text: () => Promise.resolve('some error')
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
37
|
+
|
|
38
|
+
expect(await withRetry('/some/url')).toBe(response);
|
|
39
|
+
expect(base).toHaveBeenCalledTimes(1);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
it('fetches normally with no statuses', async() => {
|
|
43
|
+
const base = jest.fn();
|
|
44
|
+
const withRetry = fetchStatusRetry(base, {retries: 7});
|
|
45
|
+
|
|
46
|
+
const response: Response = {
|
|
47
|
+
status: 200,
|
|
48
|
+
headers: {get: () => 'application/json'},
|
|
49
|
+
json: () => Promise.resolve({}),
|
|
50
|
+
text: () => Promise.resolve('some error')
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
54
|
+
|
|
55
|
+
expect(await withRetry('/some/url')).toBe(response);
|
|
56
|
+
expect(base).toHaveBeenCalledTimes(1);
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('retries on bad status', async() => {
|
|
60
|
+
const base = jest.fn();
|
|
61
|
+
const withRetry = fetchStatusRetry(base, {status: [502], retries: 7});
|
|
62
|
+
|
|
63
|
+
base.mockReturnValueOnce(Promise.resolve({
|
|
64
|
+
status: 502,
|
|
65
|
+
headers: {get: () => 'application/json'},
|
|
66
|
+
json: () => Promise.resolve({}),
|
|
67
|
+
text: () => Promise.resolve('some error')
|
|
68
|
+
}));
|
|
69
|
+
|
|
70
|
+
const response: Response = {
|
|
71
|
+
status: 200,
|
|
72
|
+
headers: {get: () => 'application/json'},
|
|
73
|
+
json: () => Promise.resolve({}),
|
|
74
|
+
text: () => Promise.resolve('some error')
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
78
|
+
|
|
79
|
+
expect(await withRetry('/some/url')).toBe(response);
|
|
80
|
+
expect(base).toHaveBeenCalledTimes(2);
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
it('has limited retries', async() => {
|
|
84
|
+
const base = jest.fn();
|
|
85
|
+
const withRetry = fetchStatusRetry(base, {status: [502], retries: 1});
|
|
86
|
+
|
|
87
|
+
base.mockReturnValueOnce(Promise.resolve({
|
|
88
|
+
status: 502,
|
|
89
|
+
headers: {get: () => 'application/json'},
|
|
90
|
+
json: () => Promise.resolve({}),
|
|
91
|
+
text: () => Promise.resolve('some error')
|
|
92
|
+
}));
|
|
93
|
+
base.mockReturnValueOnce(Promise.resolve({
|
|
94
|
+
status: 502,
|
|
95
|
+
headers: {get: () => 'application/json'},
|
|
96
|
+
json: () => Promise.resolve({}),
|
|
97
|
+
text: () => Promise.resolve('some error')
|
|
98
|
+
}));
|
|
99
|
+
|
|
100
|
+
const response: Response = {
|
|
101
|
+
status: 200,
|
|
102
|
+
headers: {get: () => 'application/json'},
|
|
103
|
+
json: () => Promise.resolve({}),
|
|
104
|
+
text: () => Promise.resolve('some error')
|
|
105
|
+
};
|
|
106
|
+
|
|
107
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
108
|
+
|
|
109
|
+
await expect(withRetry('/some/url')).rejects.toThrowErrorMatchingInlineSnapshot('"fetch failed /some/url -- 502: some error"');
|
|
110
|
+
expect(base).toHaveBeenCalledTimes(2);
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
it('retries on failed fetch', async() => {
|
|
114
|
+
const base = jest.fn();
|
|
115
|
+
const withRetry = fetchStatusRetry(base, {status: [502], retries: 7});
|
|
116
|
+
|
|
117
|
+
base.mockReturnValueOnce(Promise.reject(new Error('type error failed to fetch or whatever')));
|
|
118
|
+
|
|
119
|
+
const response: Response = {
|
|
120
|
+
status: 200,
|
|
121
|
+
headers: {get: () => 'application/json'},
|
|
122
|
+
json: () => Promise.resolve({}),
|
|
123
|
+
text: () => Promise.resolve('some error')
|
|
124
|
+
};
|
|
125
|
+
|
|
126
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
127
|
+
|
|
128
|
+
expect(await withRetry('/some/url')).toBe(response);
|
|
129
|
+
expect(base).toHaveBeenCalledTimes(2);
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
it('has limited retries on failed to fetch', async() => {
|
|
133
|
+
const base = jest.fn();
|
|
134
|
+
const withRetry = fetchStatusRetry(base, {status: [502], retries: 1});
|
|
135
|
+
|
|
136
|
+
base.mockReturnValueOnce(Promise.reject(new Error('type error failed to fetch or whatever')));
|
|
137
|
+
base.mockReturnValueOnce(Promise.reject(new Error('type error failed to fetch or whatever')));
|
|
138
|
+
|
|
139
|
+
const response: Response = {
|
|
140
|
+
status: 200,
|
|
141
|
+
headers: {get: () => 'application/json'},
|
|
142
|
+
json: () => Promise.resolve({}),
|
|
143
|
+
text: () => Promise.resolve('some error')
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
147
|
+
|
|
148
|
+
await expect(withRetry('/some/url')).rejects.toThrowErrorMatchingInlineSnapshot('"type error failed to fetch or whatever"');
|
|
149
|
+
expect(base).toHaveBeenCalledTimes(2);
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
describe('timeout functionality', () => {
|
|
153
|
+
beforeEach(() => {
|
|
154
|
+
setTimeoutSpy.mockRestore();
|
|
155
|
+
jest.useFakeTimers();
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
afterEach(() => {
|
|
159
|
+
jest.useRealTimers();
|
|
160
|
+
doBeforeEach();
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
it('fetches normally with timeout option but completes before timeout', async() => {
|
|
164
|
+
const base = jest.fn();
|
|
165
|
+
const withRetry = fetchStatusRetry(base, {status: [502], timeout: 1000, retries: 1});
|
|
166
|
+
|
|
167
|
+
const response: Response = {
|
|
168
|
+
status: 200,
|
|
169
|
+
headers: {get: () => 'application/json'},
|
|
170
|
+
json: () => Promise.resolve({}),
|
|
171
|
+
text: () => Promise.resolve('some error')
|
|
172
|
+
};
|
|
173
|
+
|
|
174
|
+
base.mockReturnValue(Promise.resolve(response));
|
|
175
|
+
|
|
176
|
+
const result = withRetry('/some/url');
|
|
177
|
+
expect(await result).toBe(response);
|
|
178
|
+
expect(base).toHaveBeenCalledTimes(1);
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
it('times out when request takes too long', async() => {
|
|
182
|
+
const base = jest.fn();
|
|
183
|
+
const withRetry = fetchStatusRetry(base, {timeout: 100, retries: 0});
|
|
184
|
+
|
|
185
|
+
const pendingPromise = new Promise(() => {});
|
|
186
|
+
base.mockReturnValue(pendingPromise);
|
|
187
|
+
|
|
188
|
+
const resultPromise = withRetry('/some/url');
|
|
189
|
+
|
|
190
|
+
jest.advanceTimersByTime(100);
|
|
191
|
+
|
|
192
|
+
await expect(resultPromise).rejects.toThrowErrorMatchingInlineSnapshot('"fetch timeout after 100ms: /some/url"');
|
|
193
|
+
expect(base).toHaveBeenCalledTimes(1);
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
});
|
|
197
|
+
});
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { RetryOptions, retryWithDelay } from '../misc/helpers';
|
|
2
|
+
import { GenericFetch } from '.';
|
|
3
|
+
|
|
4
|
+
interface Options extends RetryOptions {
|
|
5
|
+
status?: number[];
|
|
6
|
+
timeout?: number;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
export const fetchStatusRetry = (base: GenericFetch, options: Options): GenericFetch => {
|
|
10
|
+
|
|
11
|
+
return (...params) => retryWithDelay(() => {
|
|
12
|
+
const fetchPromise = base(...params).then(r => {
|
|
13
|
+
if (options.status?.includes(r.status)) {
|
|
14
|
+
return r.text().then(text => {
|
|
15
|
+
throw new Error(`fetch failed ${params[0]} -- ${r.status}: ${text}`);
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
return r;
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
if (options.timeout) {
|
|
22
|
+
const timeoutPromise = new Promise<never>((_, reject) => {
|
|
23
|
+
setTimeout(() => {
|
|
24
|
+
reject(new Error(`fetch timeout after ${options.timeout}ms: ${params[0]}`));
|
|
25
|
+
}, options.timeout);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
return Promise.race([fetchPromise, timeoutPromise]);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
return fetchPromise;
|
|
32
|
+
}, options);
|
|
33
|
+
};
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { fetchError, fetchIdle, fetchLoading, FetchStateType, fetchSuccess, stateHasData, stateHasError } from '.';
|
|
2
|
+
|
|
3
|
+
describe('creators', () => {
|
|
4
|
+
it('creates FetchStateLoading', () => {
|
|
5
|
+
expect(fetchLoading()).toEqual({type: 'loading'});
|
|
6
|
+
});
|
|
7
|
+
it('creates FetchStateLoading, with data', () => {
|
|
8
|
+
expect(fetchLoading({type: FetchStateType.ERROR, error: 'some error', data: 'other data'})).toEqual({type: 'loading', data: 'other data'});
|
|
9
|
+
});
|
|
10
|
+
it('creates FetchStateError', () => {
|
|
11
|
+
expect(fetchError('hello')).toEqual({type: 'error', error: 'hello'});
|
|
12
|
+
});
|
|
13
|
+
it('creates FetchStateSuccess', () => {
|
|
14
|
+
expect(fetchSuccess('wow, such success')).toEqual({type: 'success', data: 'wow, such success'});
|
|
15
|
+
});
|
|
16
|
+
it('creates FetchStateIdle', () => {
|
|
17
|
+
expect(fetchIdle()).toEqual({type: 'idle'});
|
|
18
|
+
});
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
describe('guards', () => {
|
|
22
|
+
it('returns true with data', () => {
|
|
23
|
+
expect(stateHasData(fetchSuccess('wow'))).toBe(true);
|
|
24
|
+
});
|
|
25
|
+
it('returns false with data', () => {
|
|
26
|
+
expect(stateHasData(fetchLoading())).toBe(false);
|
|
27
|
+
});
|
|
28
|
+
it('returns true with error', () => {
|
|
29
|
+
expect(stateHasError(fetchError('wow'))).toBe(true);
|
|
30
|
+
});
|
|
31
|
+
it('returns false with error', () => {
|
|
32
|
+
expect(stateHasError(fetchLoading())).toBe(false);
|
|
33
|
+
});
|
|
34
|
+
});
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { METHOD } from '../routing';
|
|
2
|
+
|
|
3
|
+
/*
|
|
4
|
+
* these are just helpers for formatting responses, they don't actually do any loading. especially in UI development they
|
|
5
|
+
* help with continuity over loading, reloading, saving, and errors. this is pretty nice in typescript because you have to deal
|
|
6
|
+
* with the possibility that the result state is in a loading or error state. if you avoid dealing with those states you need
|
|
7
|
+
* to write very clear code to ignore them, which easily presents missing functionality like errors that are not being messaged
|
|
8
|
+
* to the user.
|
|
9
|
+
* */
|
|
10
|
+
export enum FetchStateType {
|
|
11
|
+
SUCCESS = 'success',
|
|
12
|
+
ERROR = 'error',
|
|
13
|
+
LOADING = 'loading',
|
|
14
|
+
IDLE = 'idle',
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export type FetchState<D, E> = FetchStateLoading<D>
|
|
18
|
+
| FetchStateError<D, E>
|
|
19
|
+
| FetchStateSuccess<D>
|
|
20
|
+
| FetchStateIdle;
|
|
21
|
+
|
|
22
|
+
type FetchStateLoading<D> = {type: FetchStateType.LOADING; data?: D};
|
|
23
|
+
type FetchStateError<D, E> = {type: FetchStateType.ERROR; data?: D; error: E};
|
|
24
|
+
type FetchStateSuccess<D> = {type: FetchStateType.SUCCESS; data: D};
|
|
25
|
+
type FetchStateIdle = {type: FetchStateType.IDLE};
|
|
26
|
+
|
|
27
|
+
/*
|
|
28
|
+
* keeps existing data but sets the new status
|
|
29
|
+
*
|
|
30
|
+
* const state = fetchLoading(previousState)
|
|
31
|
+
* */
|
|
32
|
+
export const fetchLoading = <D, E>(previous?: FetchState<D, E>): FetchStateLoading<D> => ({type: FetchStateType.LOADING, ...(previous && 'data' in previous ? {data: previous.data} : {})});
|
|
33
|
+
|
|
34
|
+
/*
|
|
35
|
+
* keeps existing data but sets the new status and error value
|
|
36
|
+
*
|
|
37
|
+
* const state = fetchError(error, previousState)
|
|
38
|
+
* */
|
|
39
|
+
export const fetchError = <D, E>(error: E, previous?: FetchState<D, E>): FetchStateError<D, E> => ({...previous, type: FetchStateType.ERROR, error});
|
|
40
|
+
|
|
41
|
+
/*
|
|
42
|
+
* formats data with success type
|
|
43
|
+
*
|
|
44
|
+
* const state = fetchSuccess(newData)
|
|
45
|
+
* */
|
|
46
|
+
export const fetchSuccess = <D>(data: D): FetchStateSuccess<D> => ({type: FetchStateType.SUCCESS, data});
|
|
47
|
+
|
|
48
|
+
/*
|
|
49
|
+
* formats data with idle type
|
|
50
|
+
*
|
|
51
|
+
* const state = fetchIdle(newData)
|
|
52
|
+
* */
|
|
53
|
+
export const fetchIdle = (): FetchStateIdle => ({type: FetchStateType.IDLE});
|
|
54
|
+
|
|
55
|
+
/*
|
|
56
|
+
* guard for checking if the state has result data, it might be true for any state type.
|
|
57
|
+
* */
|
|
58
|
+
export const stateHasData = <D, E>(state: {type: FetchStateType; data?: D; error?: E}): state is {type: FetchStateType; data: D} => 'data' in state;
|
|
59
|
+
/*
|
|
60
|
+
* guard for checking if the state has an error, it might be true for error or loading states.
|
|
61
|
+
* */
|
|
62
|
+
export const stateHasError = <D, E>(state: {type: FetchStateType; data?: D; error?: E}): state is {type: FetchStateType; error: E} => 'error' in state;
|
|
63
|
+
|
|
64
|
+
/*
|
|
65
|
+
* a minimal fetch interface that is compatible with both WindowOrWorkerGlobalScope['fetch'] and node-fetch
|
|
66
|
+
* only the features needed by this library are defined here. the generic is so that utilities can set
|
|
67
|
+
* themselves up to accept input fetchConfig that may extend this.
|
|
68
|
+
*/
|
|
69
|
+
export type FetchConfig = {
|
|
70
|
+
credentials?: 'include' | 'omit' | 'same-origin';
|
|
71
|
+
method?: METHOD;
|
|
72
|
+
body?: string;
|
|
73
|
+
headers?: {[key: string]: string};
|
|
74
|
+
};
|
|
75
|
+
type Headers = {
|
|
76
|
+
get: (name: string) => string | null;
|
|
77
|
+
};
|
|
78
|
+
export type Response = {
|
|
79
|
+
status: number;
|
|
80
|
+
headers: Headers;
|
|
81
|
+
json: () => Promise<any>;
|
|
82
|
+
text: () => Promise<string>;
|
|
83
|
+
};
|
|
84
|
+
export type GenericFetch<C extends FetchConfig = FetchConfig, R extends Response = Response> =
|
|
85
|
+
(url: string, fetchConfig?: C) => Promise<R>;
|
|
86
|
+
|
|
87
|
+
export type ConfigForFetch<F> = F extends GenericFetch<infer C, any> ? C : never;
|