@spec editable_field_strings(Ash.Resource.t() | [Ash.Resource.t()]) :: [String.t()]

Returns the deduplicated list of editable and computed Xitdb field names as strings for one or more Xitdb.Ash.Resource modules, applying any configured field_aliases.

@spec pull_fields(Ash.Resource.t() | [Ash.Resource.t()]) :: [atom()]

Returns the deduplicated list of Xitdb slot atoms ([:id | editable ++ passthru]) for one or more Xitdb.Ash.Resource modules, applying any configured field_aliases.

@spec pull_pattern_for(Ash.Resource.t() | [Ash.Resource.t()]) :: String.t()

Compiles a structural Xitdb.Pull pattern string for one or more Xitdb.Ash.Resource modules.

@spec resolve_lock_change(Ash.Resource.t() | Spark.Dsl.t()) :: module() | nil

Resolves the Ash.Resource.Change module for locking/unlocking fields from the resource's xitdb.lock_change option or Application.get_env(:xitdb, :default_lock_change).

@spec resolve_store(Ash.Resource.t(), map() | keyword()) :: GenServer.server() | nil

Resolves the target Xitdb store server from context[:xitdb_store], keyword opts[:store], the resource's xitdb.store option, or Application.get_env(:xitdb, :default_store).

@spec xitdb_collection(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

Primary Xitdb hash_map collection (:organizations, :people, :events).

@spec xitdb_collection!(dsl_or_extended :: module() | map()) :: atom() | no_return()

Primary Xitdb hash_map collection (:organizations, :people, :events).

@spec xitdb_companion_resource(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

Optional companion resource sharing the same Xitdb entity (e.g. Profile <-> User).

@spec xitdb_companion_resource!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

Optional companion resource sharing the same Xitdb entity (e.g. Profile <-> User).

@spec xitdb_computed_xitdb_fields(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Derived Xitdb-only fields maintained by the engine (e.g. :normalized_name, :activity_count).

@spec xitdb_computed_xitdb_fields!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

Derived Xitdb-only fields maintained by the engine (e.g. :normalized_name, :activity_count).

@spec xitdb_editable_fields(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Canonical attributes subject to per-field survivorship locks and conflict detection.

@spec xitdb_editable_fields!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

Canonical attributes subject to per-field survivorship locks and conflict detection.

@spec xitdb_field_aliases(dsl_or_extended :: module() | map()) ::
  {:ok, keyword()} | :error

Maps Ash attribute names to Xitdb slot names (e.g. [parent_organization_id: :parent_org_id]).

@spec xitdb_field_aliases!(dsl_or_extended :: module() | map()) ::
  keyword() | no_return()

Maps Ash attribute names to Xitdb slot names (e.g. [parent_organization_id: :parent_org_id]).

@spec xitdb_ignored_sync_attributes(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Attributes accepted by sync_update_action that are bookkeeping metadata rather than projected Xitdb fields.

@spec xitdb_ignored_sync_attributes!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

Attributes accepted by sync_update_action that are bookkeeping metadata rather than projected Xitdb fields.

@spec xitdb_indexes(dsl_or_extended :: module() | map()) :: {:ok, keyword()} | :error

Secondary B+Tree index declarations ([domain: "domain->org_id", ...]).

@spec xitdb_indexes!(dsl_or_extended :: module() | map()) :: keyword() | no_return()

Secondary B+Tree index declarations ([domain: "domain->org_id", ...]).

@spec xitdb_lock_action(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

Ash update action that locks a single field.

@spec xitdb_lock_action!(dsl_or_extended :: module() | map()) :: atom() | no_return()

Ash update action that locks a single field.

@spec xitdb_lock_change(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

Ash.Resource.Change module automatically wired into lock_action and unlock_action (defaults to config :xitdb, :default_lock_change).

@spec xitdb_lock_change!(dsl_or_extended :: module() | map()) :: atom() | no_return()

Ash.Resource.Change module automatically wired into lock_action and unlock_action (defaults to config :xitdb, :default_lock_change).

@spec xitdb_locked_ids_set(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

Curation counted_hash_set tracking locked entity IDs (:locked_org_ids, etc.).

@spec xitdb_locked_ids_set!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

Curation counted_hash_set tracking locked entity IDs (:locked_org_ids, etc.).

@spec xitdb_merge_redirect_collection(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

Sorted map storing loser -> winner redirects (:org_merged_into, :merged_into).

@spec xitdb_merge_redirect_collection!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

Sorted map storing loser -> winner redirects (:org_merged_into, :merged_into).

@spec xitdb_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

xitdb DSL options

Returns a map containing the and any configured or default values.

@spec xitdb_passthru_fields(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Attributes projected into Xitdb without per-field conflict logging (e.g. :creatio_id).

@spec xitdb_passthru_fields!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

Attributes projected into Xitdb without per-field conflict logging (e.g. :creatio_id).

@spec xitdb_store(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

Default Xitdb Store GenServer name (overridable via context[:xitdb_store] or config :xitdb, :default_store).

@spec xitdb_store!(dsl_or_extended :: module() | map()) :: atom() | no_return()

Default Xitdb Store GenServer name (overridable via context[:xitdb_store] or config :xitdb, :default_store).

@spec xitdb_sync_update_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

Ash update action invoked by reconciler projectors.

@spec xitdb_sync_update_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

Ash update action invoked by reconciler projectors.

@spec xitdb_unlock_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

Ash update action that unlocks a single field.

@spec xitdb_unlock_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

Ash update action that unlocks a single field.