Skip to content

CHANGELOG.md

Latest commit

 

History

History
144 lines (93 loc) · 6.84 KB

CHANGELOG.md

File metadata and controls

144 lines (93 loc) · 6.84 KB
Raw

@asyncapi/generator-components

0.8.0

Minor Changes

  • 04655f0: The WebSocket Dart, JavaScript, and Python templates now emit a spec-aware runnable example next to the generated client, rendered from shared components instead of being shipped as a hardcoded file.

    New components in @asyncapi/generator-components (all under src/components/example/, each throwing unsupportedLanguage for languages outside dart | javascript | python):

    • Imports — the example's import block, derived from the clientFileName parameter
    • Handlers — placeholder message/error handlers; Python renders one handle_<snake_op_id> per receive operation plus a custom_error_handler, JavaScript and Dart render a fixed myMessageHandler / myErrorHandler pair
    • OpenConnection — the connect() invocation
    • Close — the close() invocation, for use in the example's finally block
    • SendInvocations — a bounded iteration loop invoking each send operation in turn, with payloads resolved from message.examples()
    • OutgoingProcessor — the outgoing message processor definition, rendered only when the spec has send operations

    Template changes shipped through @asyncapi/generator:

    • Each client now generates a runnable example file based on your AsyncAPI document, instead of shipping a fixed one.
    • A new exampleFileName parameter (default example.dart / example.js / example.py) overrides the generated example's filename.

Patch Changes

  • 989b027: Release the existing hooks package and pin AsyncAPI workspace dependencies instead of publishing wildcard ranges.

0.7.0

Minor Changes

  • 5fe91b0: Generated Python and JavaScript WebSocket clients no longer swallow send errors. Failures are now forwarded to the registered error handlers and raised by default, so callers learn when a message fails to send. Pass raise_send_errors=False (Python) or throwSendErrors=false (JavaScript) to the constructor to keep a high-throughput producer loop running and rely on the error handlers instead.

0.6.0

Minor Changes

  • 51bcc7b: Add unified error handling for @asyncapi/generator-components. A set of error codes was introduced to help template component development, so you can consistently introduce input validation errors.

0.5.0

Minor Changes

  • 11a1b8d: - Updated Component: OnMessage (Python) - Added discriminator-based routing logic that automatically dispatches messages to operation-specific handlers before falling back to generic handlers

    • New Helpers:
      • getMessageDiscriminatorData - Extracts discriminator key and value from individual messages
      • getMessageDiscriminatorsFromOperations - Collects all discriminator metadata from receive operations
    • Enhanced Python webSocket client generation with automatic operation-based message routing:

    How python routing works

    • Generated WebSocket clients now automatically route incoming messages to operation-specific handlers based on message discriminators. Users can register handlers for specific message types without manually parsing or filtering messages.
    • When a message arrives, the client checks it against registered discriminators (e.g., type: "hello", type: "events_api")
    • If a match is found, the message is routed to the specific operation handler (e.g., onHelloMessage, onEvent)
    • If no match is found, the message falls back to generic message handlers
    • This enables clean separation of message handling logic based on message types

    discriminator is a string field that you can add to any AsyncAPI Schema. This also means that it is limited to AsyncAPI Schema only, and it won't work with other schema formats, like for example, Avro.

    The implementation automatically derives discriminator information from your AsyncAPI document:

    • Discriminator key is extracted from the discriminator field in your AsyncAPI spec
    • Discriminator value is extracted from the const property defined in message schemas

    Example AsyncAPI Schema with discriminator and const:

    schemas:
  hello:
    type: object
    discriminator: type # you specify name of property
    properties:
      type:
        type: string
        const: hello # you specify the value of the discriminator property that is used for routing
        description: A hello string confirming WebSocket connection

    Fallback

    When defaults aren't available in the AsyncAPI document, users must provide both discriminator_key and discriminator_value when registering handlers. Providing only one parameter is not supported - you must provide either both or neither.

    Why this limitation exists: When a receive operation has multiple messages sharing the same discriminator key (e.g., all use "type" field), we need the specific value (e.g., "hello", "disconnect") to distinguish between them. Without both pieces of information, the routing becomes ambiguous.

    Example:

    # Default case - discriminator info auto-derived from AsyncAPI doc
client.register_on_hello_message_handler(my_handler)

# Custom case - must provide both key AND value
client.register_on_hello_message_handler(
    my_handler,
    discriminator_key="message_type",
    discriminator_value="custom_hello"
)

Patch Changes

  • Updated dependencies [11a1b8d]
    • @asyncapi/generator-helpers@1.1.0

0.4.1

Patch Changes

  • c5be81a: Enforce new helpers and components release to use latest versions in generator. Required because of the recent misconfiguration of releases and Trusted Publishing.
  • Updated dependencies [c5be81a]
    • @asyncapi/generator-helpers@1.0.1

0.4.0

Minor Changes

  • 715c1d2: Centralize reusable README components for consistent template rendering across languages

0.3.1

Patch Changes

  • 91735c3: Fix invalid Java method name generation and properly handle multiple WebSocket handlers

    • Generate valid Java method names for WebSocket operation handlers with strange identifiers.
    • Produce distinct @OnTextMessage handler methods for each send operation and add safe default routing for unrecognized messages.
    • Update onClose/onOpen formatting.

0.3.0

Minor Changes

  • 62d1eda: Introduced new WebSocket client template components in @asyncapi/generator-components:

0.2.0

Minor Changes

  • 32c321b: Initial release of @asyncapi/generator-components and @asyncapi/generator-helpers to make them available for @asyncapi/generator