@iamu-dev/iamu 0.2.0-beta.17 → 0.2.0-beta.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,8 @@
1
+ export interface EditEntityOptions {
2
+ json?: boolean;
3
+ }
4
+ /**
5
+ * Open an entity in the user's $EDITOR or $VISUAL, and validate its frontmatter
6
+ * against the entity schema on exit.
7
+ */
8
+ export declare function editEntity(type: string, slug: string, opts?: EditEntityOptions): Promise<void>;
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Options for `iamu set`. Every field is staging: where a walk starts,
3
+ * what the world holds, which account a persona uses, which routes an
4
+ * area owns. What a scenario is about (narrative, tension, human tests,
5
+ * brief, background) is not settable here — that is authoring's.
6
+ *
7
+ * Commander maps `--no-<flag>` to `false`, which clears the field.
8
+ */
9
+ export interface SetEntityOptions {
10
+ /** Scenario start path, or `false` to clear. */
11
+ entry?: string | false;
12
+ /** Scenario default target URL, or `false` to clear. */
13
+ target?: string | false;
14
+ /** Scenario `state.description`. */
15
+ stateDescription?: string;
16
+ /** Scenario `state.approximation`. */
17
+ stateApproximation?: string;
18
+ /** `false` clears scenario `state` (Commander defaults it to `true`). */
19
+ state?: boolean;
20
+ /** Persona access key, or `false` to clear. */
21
+ access?: string | false;
22
+ /** Capability route prefixes, comma-separated; replaces `paths`, or `false` to clear. */
23
+ paths?: string | false;
24
+ /** Capability route prefix to add (repeatable). */
25
+ addPath?: string[];
26
+ /** Capability route prefix to remove (repeatable). */
27
+ removePath?: string[];
28
+ /** Capability visual grouping, or `false` to clear. */
29
+ area?: string | false;
30
+ /** JSON patch file (or - for stdin) containing staging fields. */
31
+ file?: string;
32
+ json?: boolean;
33
+ }
34
+ /**
35
+ * `iamu set <type> <slug>` — change the staging fields of an existing
36
+ * entity: a scenario's start path, target and starting state, a
37
+ * persona's access key, a capability's route prefixes and area.
38
+ *
39
+ * @example
40
+ * ```bash
41
+ * iamu set scenario maria--handoff --entry /incidents \
42
+ * --state-description "Five open incidents at one site"
43
+ * iamu set capability team-access --add-path /team
44
+ * ```
45
+ */
46
+ export declare function setEntity(type: string, slug: string, opts: SetEntityOptions): Promise<void>;
@@ -3,6 +3,8 @@ export interface SummaryOptions {
3
3
  worked?: string | string[];
4
4
  question?: string | string[];
5
5
  model?: string;
6
+ /** The walk could not start as set up: what was missing, or `false` to clear. */
7
+ blocked?: string | false;
6
8
  file?: string;
7
9
  json?: boolean;
8
10
  }
@@ -10,5 +12,9 @@ export interface SummaryData {
10
12
  what_worked: string[];
11
13
  open_questions: string[];
12
14
  model?: string;
15
+ /** Set when the walk could not start as set up (`--blocked`). */
16
+ blocked?: {
17
+ reason: string;
18
+ };
13
19
  }
14
20
  export declare function summaryCommand(runIdArg: string | undefined, opts: SummaryOptions): Promise<void>;
@@ -1,3 +1,6 @@
1
+ import { type EntityType } from "@iamu-dev/protocol";
2
+ import type { ZodSchema } from "zod";
3
+ export declare const schemaByType: Record<EntityType, ZodSchema>;
1
4
  export declare function validate(filePath: string | undefined, opts: {
2
5
  run?: string;
3
6
  all?: boolean;