PhoenixKit.Install.EndpointIntegration (phoenix_kit v1.7.130)

Copy Markdown View Source

Endpoint integration for PhoenixKit installation.

Previously, this module added the phoenix_kit_socket() macro to the parent app's endpoint. This is no longer needed as the Sync websocket is now handled automatically via phoenix_kit_routes() in the router.

This module now removes any existing deprecated phoenix_kit_socket() calls from endpoints during installation/updates.

Summary

Functions

Removes deprecated phoenix_kit_socket() and its import from the endpoint.

Ensures the host endpoint serves phoenix_kit_catalogue's vendored PDF.js viewer at /_pdfjs/ via a Plug.Static mount.

Functions

add_endpoint_integration(igniter)

Removes deprecated phoenix_kit_socket() and its import from the endpoint.

The phoenix_kit_socket() macro is deprecated. Sync websocket is now handled automatically via phoenix_kit_routes() in the router.

Parameters

  • igniter - The igniter context

Returns

Updated igniter with deprecated socket code and import removed.

add_pdfjs_static_mount(igniter)

Ensures the host endpoint serves phoenix_kit_catalogue's vendored PDF.js viewer at /_pdfjs/ via a Plug.Static mount.

Only added when :phoenix_kit_catalogue is a dependency (the mount references that app's priv, so adding it without the dep would break boot). Idempotent — skips when an at: "/_pdfjs" mount already exists. Called by both mix phoenix_kit.install and mix phoenix_kit.update.