@aws-blocks/core 0.1.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/LICENSE +174 -0
- package/dist/api.d.ts +147 -0
- package/dist/api.d.ts.map +1 -0
- package/dist/api.js +10 -0
- package/dist/api.test.d.ts +2 -0
- package/dist/api.test.d.ts.map +1 -0
- package/dist/api.test.js +19 -0
- package/dist/bb-utils.d.ts +11 -0
- package/dist/bb-utils.d.ts.map +1 -0
- package/dist/bb-utils.js +12 -0
- package/dist/builtin-routes.d.ts +6 -0
- package/dist/builtin-routes.d.ts.map +1 -0
- package/dist/builtin-routes.js +57 -0
- package/dist/cdk/__fixtures__/factory-backend.d.ts +3 -0
- package/dist/cdk/__fixtures__/factory-backend.d.ts.map +1 -0
- package/dist/cdk/__fixtures__/factory-backend.js +6 -0
- package/dist/cdk/__fixtures__/fullid-construct-backend.d.ts +2 -0
- package/dist/cdk/__fixtures__/fullid-construct-backend.d.ts.map +1 -0
- package/dist/cdk/__fixtures__/fullid-construct-backend.js +37 -0
- package/dist/cdk/__fixtures__/handler.d.ts +5 -0
- package/dist/cdk/__fixtures__/handler.d.ts.map +1 -0
- package/dist/cdk/__fixtures__/handler.js +3 -0
- package/dist/cdk/__fixtures__/side-effect-backend.d.ts +2 -0
- package/dist/cdk/__fixtures__/side-effect-backend.d.ts.map +1 -0
- package/dist/cdk/__fixtures__/side-effect-backend.js +5 -0
- package/dist/cdk/blocks-backend.d.ts +68 -0
- package/dist/cdk/blocks-backend.d.ts.map +1 -0
- package/dist/cdk/blocks-backend.js +214 -0
- package/dist/cdk/blocks-backend.test.d.ts +2 -0
- package/dist/cdk/blocks-backend.test.d.ts.map +1 -0
- package/dist/cdk/blocks-backend.test.js +151 -0
- package/dist/cdk/blocks-stack.test.d.ts +2 -0
- package/dist/cdk/blocks-stack.test.d.ts.map +1 -0
- package/dist/cdk/blocks-stack.test.js +78 -0
- package/dist/cdk/config-registry.d.ts +26 -0
- package/dist/cdk/config-registry.d.ts.map +1 -0
- package/dist/cdk/config-registry.js +80 -0
- package/dist/cdk/index.d.ts +35 -0
- package/dist/cdk/index.d.ts.map +1 -0
- package/dist/cdk/index.js +90 -0
- package/dist/cdk/mixins.d.ts +28 -0
- package/dist/cdk/mixins.d.ts.map +1 -0
- package/dist/cdk/mixins.js +37 -0
- package/dist/cdk/mixins.test.d.ts +2 -0
- package/dist/cdk/mixins.test.d.ts.map +1 -0
- package/dist/cdk/mixins.test.js +108 -0
- package/dist/cdk/node-version.d.ts +14 -0
- package/dist/cdk/node-version.d.ts.map +1 -0
- package/dist/cdk/node-version.js +15 -0
- package/dist/cdk/stack-metadata.d.ts +12 -0
- package/dist/cdk/stack-metadata.d.ts.map +1 -0
- package/dist/cdk/stack-metadata.js +22 -0
- package/dist/cdk/stack-metadata.test.d.ts +2 -0
- package/dist/cdk/stack-metadata.test.d.ts.map +1 -0
- package/dist/cdk/stack-metadata.test.js +56 -0
- package/dist/cdk/synth-guard.d.ts +14 -0
- package/dist/cdk/synth-guard.d.ts.map +1 -0
- package/dist/cdk/synth-guard.js +20 -0
- package/dist/cdk/synth-guard.test.d.ts +2 -0
- package/dist/cdk/synth-guard.test.d.ts.map +1 -0
- package/dist/cdk/synth-guard.test.js +15 -0
- package/dist/client/index.d.ts +97 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +238 -0
- package/dist/client/index.test.d.ts +2 -0
- package/dist/client/index.test.d.ts.map +1 -0
- package/dist/client/index.test.js +113 -0
- package/dist/common/config.d.ts +45 -0
- package/dist/common/config.d.ts.map +1 -0
- package/dist/common/config.js +154 -0
- package/dist/common/config.test.d.ts +2 -0
- package/dist/common/config.test.d.ts.map +1 -0
- package/dist/common/config.test.js +173 -0
- package/dist/common/constants.d.ts +11 -0
- package/dist/common/constants.d.ts.map +1 -0
- package/dist/common/constants.js +12 -0
- package/dist/common/crypto.d.ts +6 -0
- package/dist/common/crypto.d.ts.map +1 -0
- package/dist/common/crypto.js +14 -0
- package/dist/common/index.d.ts +220 -0
- package/dist/common/index.d.ts.map +1 -0
- package/dist/common/index.js +180 -0
- package/dist/common/index.test.d.ts +2 -0
- package/dist/common/index.test.d.ts.map +1 -0
- package/dist/common/index.test.js +195 -0
- package/dist/common/mock-data.d.ts +40 -0
- package/dist/common/mock-data.d.ts.map +1 -0
- package/dist/common/mock-data.js +39 -0
- package/dist/common/official-bb-names.generated.d.ts +7 -0
- package/dist/common/official-bb-names.generated.d.ts.map +1 -0
- package/dist/common/official-bb-names.generated.js +28 -0
- package/dist/common/sdk-registry.d.ts +136 -0
- package/dist/common/sdk-registry.d.ts.map +1 -0
- package/dist/common/sdk-registry.js +125 -0
- package/dist/constants.d.ts +27 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/constants.js +28 -0
- package/dist/cors.d.ts +39 -0
- package/dist/cors.d.ts.map +1 -0
- package/dist/cors.js +85 -0
- package/dist/cors.test.d.ts +2 -0
- package/dist/cors.test.d.ts.map +1 -0
- package/dist/cors.test.js +241 -0
- package/dist/db-naming.d.ts +21 -0
- package/dist/db-naming.d.ts.map +1 -0
- package/dist/db-naming.js +38 -0
- package/dist/db-naming.test.d.ts +2 -0
- package/dist/db-naming.test.d.ts.map +1 -0
- package/dist/db-naming.test.js +29 -0
- package/dist/errors.d.ts +67 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +69 -0
- package/dist/hosting.d.ts +258 -0
- package/dist/hosting.d.ts.map +1 -0
- package/dist/hosting.js +340 -0
- package/dist/hosting.test.d.ts +2 -0
- package/dist/hosting.test.d.ts.map +1 -0
- package/dist/hosting.test.js +1077 -0
- package/dist/index.cdk.d.ts +13 -0
- package/dist/index.cdk.d.ts.map +1 -0
- package/dist/index.cdk.js +13 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/lambda-handler.d.ts +131 -0
- package/dist/lambda-handler.d.ts.map +1 -0
- package/dist/lambda-handler.js +610 -0
- package/dist/lambda-handler.test.d.ts +2 -0
- package/dist/lambda-handler.test.d.ts.map +1 -0
- package/dist/lambda-handler.test.js +835 -0
- package/dist/pipeline/index.d.ts +4 -0
- package/dist/pipeline/index.d.ts.map +1 -0
- package/dist/pipeline/index.js +3 -0
- package/dist/pipeline/pipeline-construct.d.ts +130 -0
- package/dist/pipeline/pipeline-construct.d.ts.map +1 -0
- package/dist/pipeline/pipeline-construct.js +484 -0
- package/dist/pipeline/pipeline.test.d.ts +2 -0
- package/dist/pipeline/pipeline.test.d.ts.map +1 -0
- package/dist/pipeline/pipeline.test.js +1231 -0
- package/dist/pipeline/types.d.ts +351 -0
- package/dist/pipeline/types.d.ts.map +1 -0
- package/dist/pipeline/types.js +3 -0
- package/dist/raw-route.cdk.d.ts +47 -0
- package/dist/raw-route.cdk.d.ts.map +1 -0
- package/dist/raw-route.cdk.js +51 -0
- package/dist/raw-route.d.ts +119 -0
- package/dist/raw-route.d.ts.map +1 -0
- package/dist/raw-route.js +239 -0
- package/dist/raw-route.mock.d.ts +47 -0
- package/dist/raw-route.mock.d.ts.map +1 -0
- package/dist/raw-route.mock.js +51 -0
- package/dist/raw-route.test.d.ts +2 -0
- package/dist/raw-route.test.d.ts.map +1 -0
- package/dist/raw-route.test.js +597 -0
- package/dist/redact.d.ts +51 -0
- package/dist/redact.d.ts.map +1 -0
- package/dist/redact.js +134 -0
- package/dist/redact.test.d.ts +2 -0
- package/dist/redact.test.d.ts.map +1 -0
- package/dist/redact.test.js +199 -0
- package/dist/rpc.d.ts +54 -0
- package/dist/rpc.d.ts.map +1 -0
- package/dist/rpc.js +127 -0
- package/dist/rpc.test.d.ts +2 -0
- package/dist/rpc.test.d.ts.map +1 -0
- package/dist/rpc.test.js +60 -0
- package/dist/scripts/cdk-telemetry-env.d.ts +13 -0
- package/dist/scripts/cdk-telemetry-env.d.ts.map +1 -0
- package/dist/scripts/cdk-telemetry-env.js +21 -0
- package/dist/scripts/cdk-telemetry-env.test.d.ts +2 -0
- package/dist/scripts/cdk-telemetry-env.test.d.ts.map +1 -0
- package/dist/scripts/cdk-telemetry-env.test.js +56 -0
- package/dist/scripts/cleanup.d.ts +3 -0
- package/dist/scripts/cleanup.d.ts.map +1 -0
- package/dist/scripts/cleanup.js +35 -0
- package/dist/scripts/console.d.ts +6 -0
- package/dist/scripts/console.d.ts.map +1 -0
- package/dist/scripts/console.js +25 -0
- package/dist/scripts/deploy.d.ts +6 -0
- package/dist/scripts/deploy.d.ts.map +1 -0
- package/dist/scripts/deploy.js +82 -0
- package/dist/scripts/destroy.d.ts +6 -0
- package/dist/scripts/destroy.d.ts.map +1 -0
- package/dist/scripts/destroy.js +30 -0
- package/dist/scripts/dev-server-cors.test.d.ts +2 -0
- package/dist/scripts/dev-server-cors.test.d.ts.map +1 -0
- package/dist/scripts/dev-server-cors.test.js +23 -0
- package/dist/scripts/dev-server-telemetry.test.d.ts +2 -0
- package/dist/scripts/dev-server-telemetry.test.d.ts.map +1 -0
- package/dist/scripts/dev-server-telemetry.test.js +113 -0
- package/dist/scripts/dev-server.d.ts +21 -0
- package/dist/scripts/dev-server.d.ts.map +1 -0
- package/dist/scripts/dev-server.js +456 -0
- package/dist/scripts/ensure-secrets.d.ts +31 -0
- package/dist/scripts/ensure-secrets.d.ts.map +1 -0
- package/dist/scripts/ensure-secrets.js +100 -0
- package/dist/scripts/ensure-secrets.test.d.ts +2 -0
- package/dist/scripts/ensure-secrets.test.d.ts.map +1 -0
- package/dist/scripts/ensure-secrets.test.js +44 -0
- package/dist/scripts/external-migrations-step.d.ts +62 -0
- package/dist/scripts/external-migrations-step.d.ts.map +1 -0
- package/dist/scripts/external-migrations-step.js +243 -0
- package/dist/scripts/external-migrations-step.test.d.ts +2 -0
- package/dist/scripts/external-migrations-step.test.d.ts.map +1 -0
- package/dist/scripts/external-migrations-step.test.js +47 -0
- package/dist/scripts/extract-ts-types.d.ts +65 -0
- package/dist/scripts/extract-ts-types.d.ts.map +1 -0
- package/dist/scripts/extract-ts-types.js +664 -0
- package/dist/scripts/extract-ts-types.test.d.ts +2 -0
- package/dist/scripts/extract-ts-types.test.d.ts.map +1 -0
- package/dist/scripts/extract-ts-types.test.js +497 -0
- package/dist/scripts/generate-client-worker.d.ts +2 -0
- package/dist/scripts/generate-client-worker.d.ts.map +1 -0
- package/dist/scripts/generate-client-worker.js +13 -0
- package/dist/scripts/generate-client.d.ts +14 -0
- package/dist/scripts/generate-client.d.ts.map +1 -0
- package/dist/scripts/generate-client.js +73 -0
- package/dist/scripts/generate-client.test.d.ts +2 -0
- package/dist/scripts/generate-client.test.d.ts.map +1 -0
- package/dist/scripts/generate-client.test.js +48 -0
- package/dist/scripts/generate-spec-cli.d.ts +3 -0
- package/dist/scripts/generate-spec-cli.d.ts.map +1 -0
- package/dist/scripts/generate-spec-cli.js +77 -0
- package/dist/scripts/generate-spec-cli.test.d.ts +14 -0
- package/dist/scripts/generate-spec-cli.test.d.ts.map +1 -0
- package/dist/scripts/generate-spec-cli.test.js +90 -0
- package/dist/scripts/generate-spec.d.ts +61 -0
- package/dist/scripts/generate-spec.d.ts.map +1 -0
- package/dist/scripts/generate-spec.js +746 -0
- package/dist/scripts/generate-spec.test.d.ts +12 -0
- package/dist/scripts/generate-spec.test.d.ts.map +1 -0
- package/dist/scripts/generate-spec.test.js +88 -0
- package/dist/scripts/index.d.ts +12 -0
- package/dist/scripts/index.d.ts.map +1 -0
- package/dist/scripts/index.js +13 -0
- package/dist/scripts/sandbox.d.ts +11 -0
- package/dist/scripts/sandbox.d.ts.map +1 -0
- package/dist/scripts/sandbox.js +200 -0
- package/dist/scripts/telemetry-cli.d.ts +3 -0
- package/dist/scripts/telemetry-cli.d.ts.map +1 -0
- package/dist/scripts/telemetry-cli.js +8 -0
- package/dist/scripts/telemetry.d.ts +17 -0
- package/dist/scripts/telemetry.d.ts.map +1 -0
- package/dist/scripts/telemetry.js +150 -0
- package/dist/scripts/telemetry.test.d.ts +2 -0
- package/dist/scripts/telemetry.test.d.ts.map +1 -0
- package/dist/scripts/telemetry.test.js +203 -0
- package/dist/scripts/validate-spec.d.ts +22 -0
- package/dist/scripts/validate-spec.d.ts.map +1 -0
- package/dist/scripts/validate-spec.js +159 -0
- package/dist/server/index.d.ts +3 -0
- package/dist/server/index.d.ts.map +1 -0
- package/dist/server/index.js +3 -0
- package/dist/server/withAuth.d.ts +142 -0
- package/dist/server/withAuth.d.ts.map +1 -0
- package/dist/server/withAuth.js +261 -0
- package/dist/server/withAuth.test.d.ts +2 -0
- package/dist/server/withAuth.test.d.ts.map +1 -0
- package/dist/server/withAuth.test.js +278 -0
- package/dist/telemetry/client.d.ts +59 -0
- package/dist/telemetry/client.d.ts.map +1 -0
- package/dist/telemetry/client.js +215 -0
- package/dist/telemetry/config-writer.d.ts +16 -0
- package/dist/telemetry/config-writer.d.ts.map +1 -0
- package/dist/telemetry/config-writer.js +36 -0
- package/dist/telemetry/consent-commands.test.d.ts +2 -0
- package/dist/telemetry/consent-commands.test.d.ts.map +1 -0
- package/dist/telemetry/consent-commands.test.js +161 -0
- package/dist/telemetry/consent.d.ts +60 -0
- package/dist/telemetry/consent.d.ts.map +1 -0
- package/dist/telemetry/consent.js +122 -0
- package/dist/telemetry/environment.d.ts +33 -0
- package/dist/telemetry/environment.d.ts.map +1 -0
- package/dist/telemetry/environment.js +87 -0
- package/dist/telemetry/identifiers.d.ts +20 -0
- package/dist/telemetry/identifiers.d.ts.map +1 -0
- package/dist/telemetry/identifiers.js +86 -0
- package/dist/telemetry/index.d.ts +6 -0
- package/dist/telemetry/index.d.ts.map +1 -0
- package/dist/telemetry/index.js +4 -0
- package/dist/telemetry/telemetry.test.d.ts +2 -0
- package/dist/telemetry/telemetry.test.d.ts.map +1 -0
- package/dist/telemetry/telemetry.test.js +1131 -0
- package/dist/telemetry/trackCommand.d.ts +32 -0
- package/dist/telemetry/trackCommand.d.ts.map +1 -0
- package/dist/telemetry/trackCommand.js +102 -0
- package/dist/telemetry/types.d.ts +92 -0
- package/dist/telemetry/types.d.ts.map +1 -0
- package/dist/telemetry/types.js +1 -0
- package/dist/types.d.ts +24 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +3 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +2 -0
- package/package.json +83 -0
- package/src/api.test.ts +25 -0
- package/src/api.ts +163 -0
- package/src/bb-utils.ts +13 -0
- package/src/builtin-routes.ts +62 -0
- package/src/cdk/__fixtures__/factory-backend.ts +8 -0
- package/src/cdk/__fixtures__/fullid-construct-backend.ts +42 -0
- package/src/cdk/__fixtures__/handler.ts +4 -0
- package/src/cdk/__fixtures__/side-effect-backend.ts +7 -0
- package/src/cdk/blocks-backend.test.ts +207 -0
- package/src/cdk/blocks-backend.ts +249 -0
- package/src/cdk/blocks-stack.test.ts +106 -0
- package/src/cdk/config-registry.ts +106 -0
- package/src/cdk/index.ts +115 -0
- package/src/cdk/mixins.test.ts +129 -0
- package/src/cdk/mixins.ts +41 -0
- package/src/cdk/node-version.ts +17 -0
- package/src/cdk/stack-metadata.test.ts +71 -0
- package/src/cdk/stack-metadata.ts +29 -0
- package/src/cdk/synth-guard.test.ts +21 -0
- package/src/cdk/synth-guard.ts +23 -0
- package/src/client/index.test.ts +118 -0
- package/src/client/index.ts +320 -0
- package/src/common/config.test.ts +236 -0
- package/src/common/config.ts +169 -0
- package/src/common/constants.ts +15 -0
- package/src/common/crypto.ts +15 -0
- package/src/common/index.test.ts +242 -0
- package/src/common/index.ts +335 -0
- package/src/common/mock-data.ts +52 -0
- package/src/common/official-bb-names.generated.ts +29 -0
- package/src/common/sdk-registry.ts +150 -0
- package/src/constants.ts +31 -0
- package/src/cors.test.ts +279 -0
- package/src/cors.ts +91 -0
- package/src/db-naming.test.ts +48 -0
- package/src/db-naming.ts +41 -0
- package/src/errors.ts +72 -0
- package/src/hosting.test.ts +1431 -0
- package/src/hosting.ts +626 -0
- package/src/index.cdk.ts +45 -0
- package/src/index.ts +22 -0
- package/src/lambda-handler.test.ts +1005 -0
- package/src/lambda-handler.ts +706 -0
- package/src/pipeline/index.ts +12 -0
- package/src/pipeline/pipeline-construct.ts +662 -0
- package/src/pipeline/pipeline.test.ts +1565 -0
- package/src/pipeline/types.ts +384 -0
- package/src/raw-route.cdk.ts +56 -0
- package/src/raw-route.mock.ts +56 -0
- package/src/raw-route.test.ts +819 -0
- package/src/raw-route.ts +316 -0
- package/src/redact.test.ts +222 -0
- package/src/redact.ts +143 -0
- package/src/rpc.test.ts +73 -0
- package/src/rpc.ts +174 -0
- package/src/scripts/cdk-telemetry-env.test.ts +75 -0
- package/src/scripts/cdk-telemetry-env.ts +23 -0
- package/src/scripts/cleanup.ts +39 -0
- package/src/scripts/console.ts +34 -0
- package/src/scripts/deploy.ts +106 -0
- package/src/scripts/destroy.ts +42 -0
- package/src/scripts/dev-server-cors.test.ts +28 -0
- package/src/scripts/dev-server-telemetry.test.ts +127 -0
- package/src/scripts/dev-server.ts +515 -0
- package/src/scripts/ensure-secrets.test.ts +50 -0
- package/src/scripts/ensure-secrets.ts +113 -0
- package/src/scripts/external-migrations-step.test.ts +64 -0
- package/src/scripts/external-migrations-step.ts +269 -0
- package/src/scripts/extract-ts-types.test.ts +516 -0
- package/src/scripts/extract-ts-types.ts +773 -0
- package/src/scripts/generate-client-worker.ts +15 -0
- package/src/scripts/generate-client.test.ts +69 -0
- package/src/scripts/generate-client.ts +86 -0
- package/src/scripts/generate-spec-cli.test.ts +106 -0
- package/src/scripts/generate-spec-cli.ts +92 -0
- package/src/scripts/generate-spec.test.ts +99 -0
- package/src/scripts/generate-spec.ts +833 -0
- package/src/scripts/index.ts +21 -0
- package/src/scripts/sandbox.ts +230 -0
- package/src/scripts/telemetry-cli.ts +10 -0
- package/src/scripts/telemetry.test.ts +239 -0
- package/src/scripts/telemetry.ts +173 -0
- package/src/scripts/validate-spec.ts +199 -0
- package/src/server/index.ts +5 -0
- package/src/server/withAuth.test.ts +348 -0
- package/src/server/withAuth.ts +323 -0
- package/src/telemetry/client.ts +226 -0
- package/src/telemetry/config-writer.ts +52 -0
- package/src/telemetry/consent-commands.test.ts +196 -0
- package/src/telemetry/consent.ts +154 -0
- package/src/telemetry/environment.ts +100 -0
- package/src/telemetry/identifiers.ts +94 -0
- package/src/telemetry/index.ts +11 -0
- package/src/telemetry/telemetry.test.ts +1343 -0
- package/src/telemetry/trackCommand.ts +110 -0
- package/src/telemetry/types.ts +92 -0
- package/src/types.ts +33 -0
- package/src/version.ts +2 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
export type BlocksContext = {
|
|
2
|
+
request: {
|
|
3
|
+
headers: Headers;
|
|
4
|
+
body: ReadableStream<Uint8Array> | null;
|
|
5
|
+
json: () => Promise<any>;
|
|
6
|
+
text: () => Promise<string>;
|
|
7
|
+
/**
|
|
8
|
+
* Absolute URL of the incoming request. Built from the request's `host`
|
|
9
|
+
* header plus the path + query string. Useful for RawRoute handlers
|
|
10
|
+
* that need query-string parsing or must echo the request URL back
|
|
11
|
+
* (e.g., building OIDC redirect URIs).
|
|
12
|
+
*
|
|
13
|
+
* In dev: derived from `req.url` and `req.headers.host`.
|
|
14
|
+
* In AWS: derived from `event.path`, `event.queryStringParameters`,
|
|
15
|
+
* and `event.headers.host`. May include a trusted `x-forwarded-proto`
|
|
16
|
+
* to pick http vs https.
|
|
17
|
+
*/
|
|
18
|
+
url: URL;
|
|
19
|
+
/**
|
|
20
|
+
* Path parameters extracted from RawRoute patterns.
|
|
21
|
+
* Example: route `/users/{id}` with request `/users/123` → `{ id: '123' }`.
|
|
22
|
+
*
|
|
23
|
+
* Only populated for RawRoute handlers. Always `{}` for RPC API methods.
|
|
24
|
+
*/
|
|
25
|
+
params: Record<string, string>;
|
|
26
|
+
/**
|
|
27
|
+
* Abort signal tied to the HTTP deadline guard.
|
|
28
|
+
*
|
|
29
|
+
* Fires when the Lambda is about to return a 504 timeout response.
|
|
30
|
+
* Pass this to `fetch()`, AWS SDK calls, or any cancellable I/O so
|
|
31
|
+
* in-flight work is cancelled rather than continuing to run (and bill)
|
|
32
|
+
* after the client has already received a timeout.
|
|
33
|
+
*
|
|
34
|
+
* `undefined` in local dev or when no deadline is configured.
|
|
35
|
+
*/
|
|
36
|
+
signal?: AbortSignal;
|
|
37
|
+
};
|
|
38
|
+
response: {
|
|
39
|
+
headers: Headers;
|
|
40
|
+
status: number;
|
|
41
|
+
send: (body: any) => void;
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
export type ApiHandler<T extends Record<string, (...args: any[]) => any>> = (context: BlocksContext) => T;
|
|
45
|
+
type AsyncAPI<T extends Record<string, (...args: any[]) => any>> = {
|
|
46
|
+
[K in keyof T]: T[K] extends (...args: infer Args) => infer R ? (...args: Args) => Promise<Awaited<R>> : never;
|
|
47
|
+
};
|
|
48
|
+
/** Marker symbol to identify ApiNamespace instances during discovery. */
|
|
49
|
+
export declare const API_NAMESPACE_MARKER: unique symbol;
|
|
50
|
+
import type { ScopeParent } from './common/index.js';
|
|
51
|
+
/**
|
|
52
|
+
* Define a type-safe API namespace that works seamlessly between frontend and backend.
|
|
53
|
+
*
|
|
54
|
+
* ## Usage
|
|
55
|
+
*
|
|
56
|
+
* Define your API in the backend (`aws-blocks/index.ts`):
|
|
57
|
+
*
|
|
58
|
+
* ```typescript
|
|
59
|
+
* const scope = new Scope('my-app');
|
|
60
|
+
*
|
|
61
|
+
* export const api = new ApiNamespace(scope, 'api', (context) => ({
|
|
62
|
+
* async greet(name: string) {
|
|
63
|
+
* return { message: `Hello, ${name}!` };
|
|
64
|
+
* },
|
|
65
|
+
*
|
|
66
|
+
* async deleteAccount(id: string) {
|
|
67
|
+
* // Gated: throws 401 if the caller has no valid session.
|
|
68
|
+
* await auth.requireAuth(context);
|
|
69
|
+
* return db.users.delete(id);
|
|
70
|
+
* }
|
|
71
|
+
* }));
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* Import and call from the frontend with full type safety:
|
|
75
|
+
*
|
|
76
|
+
* ```typescript
|
|
77
|
+
* import { api } from 'aws-blocks';
|
|
78
|
+
*
|
|
79
|
+
* const result = await api.greet('World'); // Fully typed
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* ## Authentication — every method is a public endpoint
|
|
83
|
+
*
|
|
84
|
+
* Each method becomes a public, internet-reachable RPC endpoint with **no
|
|
85
|
+
* authentication by default**. Gating is opt-in per method by calling an auth
|
|
86
|
+
* Building Block at the top of the handler:
|
|
87
|
+
*
|
|
88
|
+
* ```typescript
|
|
89
|
+
* export const api = new ApiNamespace(scope, 'api', (context) => ({
|
|
90
|
+
* // No requireAuth call → callable by anyone.
|
|
91
|
+
* async listPublicPosts() {
|
|
92
|
+
* return db.posts.findPublished();
|
|
93
|
+
* },
|
|
94
|
+
*
|
|
95
|
+
* async createPost(input: NewPost) {
|
|
96
|
+
* const user = await auth.requireAuth(context);
|
|
97
|
+
* return db.posts.create({ ...input, authorId: user.userId });
|
|
98
|
+
* },
|
|
99
|
+
*
|
|
100
|
+
* async deletePost(id: string) {
|
|
101
|
+
* await auth.requireRole(context, 'admins');
|
|
102
|
+
* return db.posts.delete(id);
|
|
103
|
+
* },
|
|
104
|
+
* }));
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* The local mock applies no auth either, so an ungated method passes every
|
|
108
|
+
* local check and still ships callable by anyone. See your auth block's README
|
|
109
|
+
* (e.g. `@aws-blocks/bb-auth-cognito`) for `requireAuth` / `requireRole`.
|
|
110
|
+
*
|
|
111
|
+
* ## Context
|
|
112
|
+
*
|
|
113
|
+
* The `context` parameter provides access to:
|
|
114
|
+
* - `context.request.headers` - Incoming request headers
|
|
115
|
+
* - `context.request.json()` - Parse request body as JSON
|
|
116
|
+
* - `context.response.headers` - Set response headers (e.g., cookies)
|
|
117
|
+
* - `context.response.status` - Set HTTP status code
|
|
118
|
+
*
|
|
119
|
+
* ## Local vs Deployed
|
|
120
|
+
*
|
|
121
|
+
* - **Local**: APIs run in-process. Calls are direct function invocations.
|
|
122
|
+
* - **Deployed**: APIs run in Lambda. Calls go through API Gateway over HTTPS.
|
|
123
|
+
*
|
|
124
|
+
* The same code works in both environments without changes.
|
|
125
|
+
*
|
|
126
|
+
* ## Scaling Characteristics (AWS)
|
|
127
|
+
*
|
|
128
|
+
* - Serverless: Auto-scales from 0 to thousands of concurrent requests
|
|
129
|
+
* - Cold starts: ~100-500ms for first request after idle period
|
|
130
|
+
* - Warm requests: Single-digit millisecond overhead
|
|
131
|
+
* - Cost: Pay per request (free tier: 1M requests/month)
|
|
132
|
+
*
|
|
133
|
+
* ## Best Practices
|
|
134
|
+
*
|
|
135
|
+
* - No auth by default — gate methods with `requireAuth`/`requireRole` (see above)
|
|
136
|
+
* - Keep API methods focused and single-purpose
|
|
137
|
+
* - Use async/await for all I/O operations
|
|
138
|
+
* - Return serializable data (JSON-compatible types)
|
|
139
|
+
* - Handle errors explicitly - they'll be sent to the client
|
|
140
|
+
* - Use Building Blocks (KVStore, DistributedTable) for state
|
|
141
|
+
*/
|
|
142
|
+
export interface ApiNamespaceConstructor {
|
|
143
|
+
new <T extends Record<string, (...args: any[]) => any>>(scope: ScopeParent, name: string, handler: ApiHandler<T>): AsyncAPI<T>;
|
|
144
|
+
}
|
|
145
|
+
export declare const ApiNamespace: ApiNamespaceConstructor;
|
|
146
|
+
export {};
|
|
147
|
+
//# sourceMappingURL=api.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE;QACP,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QACxC,IAAI,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B;;;;;;;;;;WAUG;QACH,GAAG,EAAE,GAAG,CAAC;QACT;;;;;WAKG;QACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/B;;;;;;;;;WASG;QACH,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,CAAC;IACF,QAAQ,EAAE;QACR,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,KAAK,CAAC,CAAC;AAG1G,KAAK,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,IAAI;KAChE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,MAAM,CAAC,GACzD,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACtC,KAAK;CACV,CAAC;AAEF,yEAAyE;AACzE,eAAO,MAAM,oBAAoB,eAAoC,CAAC;AAEtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0FG;AACH,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;CAChI;AAED,eAAO,MAAM,YAAY,EAAE,uBAKnB,CAAC"}
|
package/dist/api.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/** Marker symbol to identify ApiNamespace instances during discovery. */
|
|
4
|
+
export const API_NAMESPACE_MARKER = Symbol.for('blocks:ApiNamespace');
|
|
5
|
+
export const ApiNamespace = class ApiNamespace {
|
|
6
|
+
constructor(scope, name, handler) {
|
|
7
|
+
handler[API_NAMESPACE_MARKER] = name;
|
|
8
|
+
return handler;
|
|
9
|
+
}
|
|
10
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.test.d.ts","sourceRoot":"","sources":["../src/api.test.ts"],"names":[],"mappings":""}
|
package/dist/api.test.js
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { test } from 'node:test';
|
|
4
|
+
import assert from 'node:assert';
|
|
5
|
+
import { ApiNamespace, API_NAMESPACE_MARKER } from './api.js';
|
|
6
|
+
import { Scope } from './common/index.js';
|
|
7
|
+
const scope = new Scope('test');
|
|
8
|
+
test('ApiNamespace stores name via marker symbol', () => {
|
|
9
|
+
const api1 = new ApiNamespace(scope, 'myapi', (ctx) => ({
|
|
10
|
+
test: () => 'hello'
|
|
11
|
+
}));
|
|
12
|
+
assert.strictEqual(api1[API_NAMESPACE_MARKER], 'myapi');
|
|
13
|
+
});
|
|
14
|
+
test('Different ApiNamespace names should not collide', () => {
|
|
15
|
+
const api1 = new ApiNamespace(scope, 'api1', (ctx) => ({ test: () => 'a' }));
|
|
16
|
+
const api2 = new ApiNamespace(scope, 'api2', (ctx) => ({ test: () => 'b' }));
|
|
17
|
+
assert.strictEqual(api1[API_NAMESPACE_MARKER], 'api1');
|
|
18
|
+
assert.strictEqual(api2[API_NAMESPACE_MARKER], 'api2');
|
|
19
|
+
});
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Utilities for Building Block authors.
|
|
3
|
+
*
|
|
4
|
+
* Used by standard BBs and available to customers writing custom Building Blocks.
|
|
5
|
+
* Not part of the main '.' export — import from '@aws-blocks/core/bb-utils'.
|
|
6
|
+
*/
|
|
7
|
+
export { getMockDataDir } from './common/mock-data.js';
|
|
8
|
+
export { API_NAMESPACE_MARKER } from './api.js';
|
|
9
|
+
export { EventSourceMapping } from './lambda-handler.js';
|
|
10
|
+
export { constantTimeEquals } from './common/crypto.js';
|
|
11
|
+
//# sourceMappingURL=bb-utils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bb-utils.d.ts","sourceRoot":"","sources":["../src/bb-utils.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC"}
|
package/dist/bb-utils.js
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/**
|
|
4
|
+
* Utilities for Building Block authors.
|
|
5
|
+
*
|
|
6
|
+
* Used by standard BBs and available to customers writing custom Building Blocks.
|
|
7
|
+
* Not part of the main '.' export — import from '@aws-blocks/core/bb-utils'.
|
|
8
|
+
*/
|
|
9
|
+
export { getMockDataDir } from './common/mock-data.js';
|
|
10
|
+
export { API_NAMESPACE_MARKER } from './api.js';
|
|
11
|
+
export { EventSourceMapping } from './lambda-handler.js';
|
|
12
|
+
export { constantTimeEquals } from './common/crypto.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"builtin-routes.d.ts","sourceRoot":"","sources":["../src/builtin-routes.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,IAAI,CA2C5C"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { getRegisteredRoutes, registerRoute } from './raw-route.js';
|
|
4
|
+
import { exec } from 'node:child_process';
|
|
5
|
+
import { join } from 'node:path';
|
|
6
|
+
function openInEditor(filePath) {
|
|
7
|
+
const platform = process.platform;
|
|
8
|
+
const cmd = platform === 'darwin' ? 'open' : platform === 'win32' ? 'start ""' : 'xdg-open';
|
|
9
|
+
exec(`${cmd} "${filePath}"`);
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Register built-in /aws-blocks/resources and /aws-blocks/settings routes.
|
|
13
|
+
* Skips if already registered (safe to call from both CDK and dev server).
|
|
14
|
+
*/
|
|
15
|
+
export function registerBuiltinRoutes() {
|
|
16
|
+
const routes = [
|
|
17
|
+
{
|
|
18
|
+
method: 'GET',
|
|
19
|
+
path: '/aws-blocks/resources',
|
|
20
|
+
handler: async (ctx) => {
|
|
21
|
+
const url = process.env.BB_RESOURCES_GROUP_URL;
|
|
22
|
+
if (!url) {
|
|
23
|
+
ctx.response.status = 200;
|
|
24
|
+
ctx.response.headers.set('Content-Type', 'text/html');
|
|
25
|
+
ctx.response.send(`<!DOCTYPE html><html><head><title>Resources</title><style>body{font-family:system-ui,sans-serif;max-width:640px;margin:4rem auto;padding:0 1rem;color:#1a1a1a}h1{font-size:1.5rem}p{line-height:1.6}code{background:#f3f4f6;padding:2px 6px;border-radius:4px;font-size:0.9em}</style></head><body><h1>Resources</h1><p>Locally, each Building Block persists data to <code>.bb-data/</code> in your project root. Tables, buckets, queues, and other state live under <code>.bb-data/{id}/</code>.</p><p>For deployed apps, this page automatically redirects to the Resources group in the AWS console.</p></body></html>`);
|
|
26
|
+
return;
|
|
27
|
+
}
|
|
28
|
+
ctx.response.status = 302;
|
|
29
|
+
ctx.response.headers.set('Location', url);
|
|
30
|
+
ctx.response.send('');
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
method: 'GET',
|
|
35
|
+
path: '/aws-blocks/settings',
|
|
36
|
+
handler: async (ctx) => {
|
|
37
|
+
const url = process.env.BB_SETTINGS_GROUP_URL;
|
|
38
|
+
if (!url) {
|
|
39
|
+
const settingsPath = join(process.cwd(), '.bb-data', 'settings.json');
|
|
40
|
+
openInEditor(settingsPath);
|
|
41
|
+
ctx.response.status = 200;
|
|
42
|
+
ctx.response.headers.set('Content-Type', 'text/html');
|
|
43
|
+
ctx.response.send(`<!DOCTYPE html><html><head><title>Settings</title><style>body{font-family:system-ui,sans-serif;max-width:640px;margin:4rem auto;padding:0 1rem;color:#1a1a1a}h1{font-size:1.5rem}p{line-height:1.6}code{background:#f3f4f6;padding:2px 6px;border-radius:4px;font-size:0.9em}a{color:#0066cc}</style></head><body><h1>Settings</h1><p>Opening <code>.bb-data/settings.json</code> in your default editor.</p><p>All AppSetting values are stored as <code>{ "fullId": value }</code> entries. Edit and save -- changes take effect on the next <code>get()</code> call.</p><p>File location: <code>${settingsPath}</code></p></body></html>`);
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
ctx.response.status = 302;
|
|
47
|
+
ctx.response.headers.set('Location', url);
|
|
48
|
+
ctx.response.send('');
|
|
49
|
+
},
|
|
50
|
+
},
|
|
51
|
+
];
|
|
52
|
+
for (const route of routes) {
|
|
53
|
+
if (!getRegisteredRoutes().some(r => r.method === route.method && r.path === route.path)) {
|
|
54
|
+
registerRoute(route);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factory-backend.d.ts","sourceRoot":"","sources":["../../../src/cdk/__fixtures__/factory-backend.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,CAAC,OAAO,WAAW,KAAK,EAAE,SAAS,QAExC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fullid-construct-backend.d.ts","sourceRoot":"","sources":["../../../src/cdk/__fixtures__/fullid-construct-backend.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/**
|
|
4
|
+
* Test fixture: a child Scope that embeds its `fullId` directly into a CDK
|
|
5
|
+
* construct ID.
|
|
6
|
+
*
|
|
7
|
+
* Why this matters
|
|
8
|
+
* ----------------
|
|
9
|
+
* Building Blocks routinely use their `fullId` as part of a construct ID, e.g.
|
|
10
|
+
* a DSQL block creating its migration Lambda as
|
|
11
|
+
* `new lambda.NodejsFunction(stack, `${this.fullId}DsqlMigrationFn`, ...)`.
|
|
12
|
+
* CDK forbids unresolved tokens in construct IDs (it throws
|
|
13
|
+
* "ID components may not include unresolved tokens" at synth time).
|
|
14
|
+
*
|
|
15
|
+
* `fullId` is derived from the enclosing stack name. In a nested-stack topology
|
|
16
|
+
* (e.g. Amplify Gen2's `backend.createStack('blocks')`) that stack name is a
|
|
17
|
+
* deploy-time token, so a naive `fullId` would carry a token and break synth.
|
|
18
|
+
*
|
|
19
|
+
* This fixture reproduces that exact pattern: importing it builds a construct
|
|
20
|
+
* whose ID is `${this.fullId}Marker`. If `fullId` ever contains a token, this
|
|
21
|
+
* side-effect import throws at synth time — which is what the test asserts must
|
|
22
|
+
* NOT happen.
|
|
23
|
+
*/
|
|
24
|
+
import * as cdk from 'aws-cdk-lib';
|
|
25
|
+
import { Scope } from '../index.js';
|
|
26
|
+
class FullIdConstructBlock extends Scope {
|
|
27
|
+
constructor(scope, id) {
|
|
28
|
+
super(id, { parent: scope });
|
|
29
|
+
const stack = cdk.Stack.of(this);
|
|
30
|
+
// Use fullId as a construct ID, the same way real Building Blocks do.
|
|
31
|
+
new cdk.CfnResource(stack, `${this.fullId}Marker`, {
|
|
32
|
+
type: 'AWS::CloudFormation::WaitConditionHandle',
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
const parent = globalThis.CURRENT_BLOCKS_STACK;
|
|
37
|
+
new FullIdConstructBlock(parent, 'db');
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../../src/cdk/__fixtures__/handler.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO;;;EAAgD,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"side-effect-backend.d.ts","sourceRoot":"","sources":["../../../src/cdk/__fixtures__/side-effect-backend.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import * as cdk from 'aws-cdk-lib';
|
|
2
|
+
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
|
|
3
|
+
import { Construct } from 'constructs';
|
|
4
|
+
/**
|
|
5
|
+
* Validate that the Node.js process was started with `--conditions=cdk`.
|
|
6
|
+
*
|
|
7
|
+
* Without this condition, conditional exports in Building Block packages
|
|
8
|
+
* resolve to their mock/default entry points instead of the CDK entry points.
|
|
9
|
+
* This causes a silent deployment failure: CDK synth "succeeds" but produces
|
|
10
|
+
* no real infrastructure (no tables, no IAM, no Lambda configs).
|
|
11
|
+
*/
|
|
12
|
+
export declare function assertCdkConditionActive(): void;
|
|
13
|
+
export interface BlocksBackendProps {
|
|
14
|
+
backendHandlerPath: string;
|
|
15
|
+
backendCDKPath: string;
|
|
16
|
+
}
|
|
17
|
+
/** Shared infra setup — creates Lambda + API Gateway on the given scope. */
|
|
18
|
+
export declare function setupBlocksInfra(scope: Construct, props: BlocksBackendProps, id?: string): {
|
|
19
|
+
handler: cdk.aws_lambda_nodejs.NodejsFunction;
|
|
20
|
+
gateway: cdk.aws_apigateway.RestApi;
|
|
21
|
+
apiUrl: string;
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Standalone CDK construct that provisions the Blocks backend: a single Lambda
|
|
25
|
+
* function fronted by API Gateway with RPC + catch-all proxy routing.
|
|
26
|
+
*
|
|
27
|
+
* Use this to embed a Blocks backend into any existing CDK stack. Building Blocks
|
|
28
|
+
* instantiated during the `backendCDKPath` import will automatically attach to
|
|
29
|
+
* this construct's Lambda handler.
|
|
30
|
+
*
|
|
31
|
+
* @example Drop into an existing stack
|
|
32
|
+
* ```ts
|
|
33
|
+
* const blocks = await BlocksBackend.create(myStack, 'Blocks', {
|
|
34
|
+
* backendHandlerPath: join(__dirname, 'handler.ts'),
|
|
35
|
+
* backendCDKPath: join(__dirname, 'infra.ts'),
|
|
36
|
+
* });
|
|
37
|
+
* // blocks.apiUrl, blocks.handler, blocks.gateway available
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
export declare class BlocksBackend extends Construct {
|
|
41
|
+
readonly apiUrl: string;
|
|
42
|
+
readonly gateway: apigateway.RestApi;
|
|
43
|
+
readonly handler: cdk.aws_lambda_nodejs.NodejsFunction;
|
|
44
|
+
readonly backendHandlerPath: string;
|
|
45
|
+
/**
|
|
46
|
+
* The fullId used by child Scopes to compute their env var names,
|
|
47
|
+
* construct IDs, and physical resource names (e.g., DynamoDB table names).
|
|
48
|
+
*
|
|
49
|
+
* Includes the CDK stack name to ensure physical resources are unique
|
|
50
|
+
* per deployment. This matches what the runtime sees via BLOCKS_STACK_NAME.
|
|
51
|
+
*
|
|
52
|
+
* IMPORTANT: this value MUST be token-free. Child Scopes embed `fullId` in
|
|
53
|
+
* CDK construct IDs (e.g. `${fullId}DsqlMigrationFn`), and CDK forbids
|
|
54
|
+
* unresolved tokens in construct IDs ("ID components may not include
|
|
55
|
+
* unresolved tokens"). It is also used to build env-var keys that must match
|
|
56
|
+
* byte-for-byte between synth time and runtime.
|
|
57
|
+
*
|
|
58
|
+
* A nested stack (e.g. Amplify Gen2 `backend.createStack('blocks')`) has a
|
|
59
|
+
* tokenized `stackName` that only resolves at deploy time. We therefore walk
|
|
60
|
+
* up to the top-level stack, whose name is concrete at synth time and still
|
|
61
|
+
* unique per deployment. The `Token.isUnresolved` guard is a defensive
|
|
62
|
+
* fallback to the (token-free) construct id should no resolvable name exist.
|
|
63
|
+
*/
|
|
64
|
+
get fullId(): string;
|
|
65
|
+
private constructor();
|
|
66
|
+
static create(scope: Construct, id: string, props: BlocksBackendProps): Promise<BlocksBackend>;
|
|
67
|
+
}
|
|
68
|
+
//# sourceMappingURL=blocks-backend.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"blocks-backend.d.ts","sourceRoot":"","sources":["../../src/cdk/blocks-backend.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,GAAG,MAAM,aAAa,CAAC;AAEnC,OAAO,KAAK,UAAU,MAAM,4BAA4B,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAOvC;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAkB/C;AAED,MAAM,WAAW,kBAAkB;IACjC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,4EAA4E;AAC5E,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,CAAC,EAAE,MAAM;;;;EA0GxF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC;IAC5C,SAAgB,OAAO,EAAE,GAAG,CAAC,iBAAiB,CAAC,cAAc,CAAC;IAC9D,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,MAAM,IAAI,MAAM,CAUnB;IAED,OAAO;WAmBM,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB;CAmB5E"}
|