@cratis/stage.runtime 5.6.0 → 5.8.0

package/dist/src/commandAvailability.d.ts

@@ -0,0 +1,15 @@
+import type { Command } from '@cratis/arc/commands';
+/** What the server says a caller may do with a command for the data a screen is showing. */
+export interface CommandAvailability {
+    /** Whether the server refused the command to this caller for these values. Anything else - answered, unanswered or failed - leaves the action offered. */
+    unavailable: boolean;
+    /** Why the server refused it, when it said. */
+    reason?: string;
+}
+/**
+ * Asks the server whether the command is authorized for the values the screen is showing, without running it. The server decides, so a policy that
+ * reads recorded state, such as the plan of the asset on the screen, answers for that asset; the answer is asked again when the data the screen reads
+ * changes, so an action withheld for one plan is offered again when the plan changes, without a reload. Only a refusal withholds the action: an
+ * unanswered or failed probe leaves it offered, because the guard controls what is offered and never what the system accepts.
+ */
+export declare function useCommandAvailability(commandType: (new () => Command) | undefined, values: Record<string, unknown>, version: unknown): CommandAvailability;