Liking cljdoc? Tell your friends :D

hive-artcraft.schema

Malli value objects. AppModule is THE contract a Crafting App satisfies to mount under artcraft.

Malli value objects. AppModule is THE contract a Crafting App satisfies to mount under `artcraft`.
raw docstring

AppConfigclj

Per-app override under the addon config's :apps {"<app-id>" {...}}.

Per-app override under the addon config's :apps {"<app-id>" {...}}.
sourceraw docstring

AppModuleclj

One Crafting App, as data. :mount delegates every command to an existing hive addon's tool handler; :native is served by hive-artcraft from its catalog resource and transport shape. :port-requires names AppConfig keys a delegate needs before a port may be handed to it (PhotoCraft's control channel needs :token-ref). :app/token-ref marks a :native :port app whose control port authenticates every request (FilmCraft): it is the default reference, :apps {"<id>" {:token-ref ...}} overrides it, and the socket transport adds the resolved value to each request as a top-level "token" field.

One Crafting App, as data. :mount delegates every command to an existing hive addon's tool
handler; :native is served by hive-artcraft from its catalog resource and transport shape.
:port-requires names AppConfig keys a delegate needs before a port may be handed to it
(PhotoCraft's control channel needs :token-ref). :app/token-ref marks a :native :port app
whose control port authenticates every request (FilmCraft): it is the default reference,
:apps {"<id>" {:token-ref ...}} overrides it, and the socket transport adds the resolved
value to each request as a top-level "token" field.
sourceraw docstring

Catalogclj

Native-app catalog resource: the vectorcraft-shaped extraction (engine commands + control methods). :unexpanded (optional) lists command-building sites a static extractor did not expand (wrapper macros, helper fns), one {:macro :count :source} row per macro and file, so a partial :engine list is never mistaken for the whole registry.

Native-app catalog resource: the vectorcraft-shaped extraction (engine commands + control methods).
:unexpanded (optional) lists command-building sites a static extractor did not expand
(wrapper macros, helper fns), one {:macro :count :source} row per macro and file, so a
partial :engine list is never mistaken for the whole registry.
sourceraw docstring

CatalogEntryclj

source

envelopeclj

(envelope value)

Success-or-refusal envelope around value.

Success-or-refusal envelope around `value`.
sourceraw docstring

ErrorValueclj

source

PortResolutionclj

source

Requestclj

source

TokenRefclj

Where a control token lives, never the token itself: an environment variable of the hive JVM named <APP>_CONTROL_TOKEN (so a config cannot point the channel at an unrelated secret), or a file only the user can access. The value is read at send time, per request.

Where a control token lives, never the token itself: an environment variable of the hive JVM
named <APP>_CONTROL_TOKEN (so a config cannot point the channel at an unrelated secret), or a
file only the user can access. The value is read at send time, per request.
sourceraw docstring

ToolResultclj

source

TransportShapeclj

How hive reaches a running app. :port - JSON-lines engine.execute on 127.0.0.1:<port> (<app> --control PORT). Live. :control-file - --control <FILE>: random port + token handshake, ui.* methods only. Contract slot; calls refuse. :none - no external control surface (e.g. Tauri IPC). Catalog only; calls refuse.

How hive reaches a running app.
:port         - JSON-lines engine.execute on 127.0.0.1:<port> (`<app> --control PORT`). Live.
:control-file - `--control <FILE>`: random port + token handshake, ui.* methods only. Contract slot; calls refuse.
:none         - no external control surface (e.g. Tauri IPC). Catalog only; calls refuse.
sourceraw docstring

validate-moduleclj

(validate-module module)

Accept a module that satisfies AppModule, or refuse with the humanised reasons.

Accept a module that satisfies AppModule, or refuse with the humanised reasons.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close