feat(type-safe-api): websocket apis for typescript #731
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cogwirrel
force-pushed
the
feat/ts-websocket-api
branch
7 times, most recently
from
75c0943 to
4170ab5
Compare
agdimech
approved these changes
Mar 25, 2024
...dscape-react-ts-website/src/components/TypeSafeWebSocketApiClientProvider/index.tsx.mustache
Show resolved
Hide resolved
...e/samples/cloudscape-react-ts-website/src/components/WebSocketApiExplorer/index.tsx.mustache
Show resolved
Hide resolved
packages/cloudscape-react-ts-website/src/cloudscape-react-ts-website-project.ts
Show resolved
Hide resolved
...nfrastructure/samples/infrastructure/typescript/src/constructs/apis/websocketapi.ts.mustache
Show resolved
Hide resolved
packages/type-safe-api/docs/developer_guides/type-safe-api/websocket_clients.md
Show resolved
Hide resolved
packages/type-safe-api/docs/developer_guides/type-safe-api/websocket_clients.md
Show resolved
Hide resolved
packages/type-safe-api/docs/developer_guides/type-safe-api/websocket_lambda_handlers.md
Outdated
Show resolved
Hide resolved
packages/type-safe-api/docs/developer_guides/type-safe-api/websocket_using_openapi.md
Show resolved
Hide resolved
Add a new `TypeSafeWebSocketApiProject` which can be used to build WebSocket APIs in a similar manner to REST APIs. This includes: * Modelling an API in Smithy or OpenAPI * Generated CDK infrastructure (WebSocket API and Lambda functions) * Generated runtimes containing lambda handler wrappers, and server SDK to send messages to clients * Generated handler stubs with the `@handler` trait * Generated client and react hooks libraries for use client side * Integration with infrastructure and website projects * WebSocket API explorer * WebSocket API CDK construct with validation schemas as custom resource to scale for larger apis Only TypeScript is supported currently, but refactoring work has been done to make Python and Java support more straightforward. Note the new Java project in `internal/smithy-async-transformer` - this allows us to perform a transform on users' Smithy models to augment operations with additional traits required for OpenAPI generation.
cogwirrel
force-pushed
the
feat/ts-websocket-api
branch
from
78e34d1 to
0ff7491
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a new
TypeSafeWebSocketApiProjectwhich can be used to build WebSocket APIs in a similar manner to REST APIs.This includes:
@handlertraitOnly TypeScript is supported currently, but refactoring work has been done to make Python and Java support more straightforward.
Note the new Java project in
internal/smithy-async-transformer- this allows us to perform a transform on users' Smithy models to augment operations with additional traits required for OpenAPI generation.Note that this upgrades the version of CDK we depend on so that we can use the WebSocketApi construct - this has had a few minor knock on effects on the pipeline package.
Remaining items for follow up PRs: