@octaviaflow/flow-rules 0.11.1 → 0.13.0

package/dist/rules/configContracts.d.ts

@@ -42,7 +42,23 @@ export type ContractFieldType = "string" | "text" | "select" | "json" | "connect
 export interface ContractField {
     type: string;
     required?: boolean;
+    /**
+     * The values a `select` accepts, when the set is fixed. `describe_action_type`
+     * lists them and the fence warns on a value outside them (`FIELD_BAD_OPTION`).
+     * A select with no `options` must say `dynamic: true` instead — the catalog
+     * test fails on one that says neither, because a select an agent cannot see
+     * the values of is a guess waiting to fail at run time (`mode: "append"` on a
+     * Transform, DEV-421).
+     */
     options?: ReadonlyArray<string | number>;
+    /**
+     * The values come from the customer's own system or from the upstream data
+     * (an object name, a sheet tab, an array path) — not from the catalog. Say
+     * where in `description`; `describe_connector_object` is the usual answer.
+     */
+    dynamic?: boolean;
+    /** Shown by the panel and by `describe_action_type`. */
+    description?: string;
     [extra: string]: unknown;
 }
 export interface ConfigContract {
@@ -54,10 +70,10 @@ export interface ConfigContract {
     };
 }
 /**
- * Every action in the catalog, keyed by action id — since 0.11.0 all 37
+ * Every action in the catalog, keyed by action id — since 0.11.0 all
  * definitions carry one (the last fifteen: group, ai_agent, idp_extract,
  * connector_trigger, the five file-format actions and the six storage
- * actions). `contractFor` is undefined only for an id the catalog does not
+ * actions; 0.13.0 added `aggregate`, the 38th). `contractFor` is undefined only for an id the catalog does not
  * know, and then consumers fall back to `inputSchema` alone. A new action is
  * a `config.ts` plus one line here; the drift test covers it from then on.
  */
@@ -80,6 +96,13 @@ export declare function isEditorPrivateKey(key: string): boolean;
  * editor should read.
  */
 export declare function contractFieldsFor(definition: ActionDefinition): FieldConfig[];
+/**
+ * Every `select` in a contract that names neither its `options` nor
+ * `dynamic: true`. A non-empty result is a bug: `describe_action_type` would
+ * show the field as a choice with nothing to choose from, and an agent would
+ * guess. The catalog test fails on any.
+ */
+export declare function selectsWithoutValues(actionId: string): string[];
 /**
  * `inputSchema` keys the contract does NOT know. A non-empty result is a bug:
  * `describe_action_type` is advertising a key the platform does not store under

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octaviaflow/flow-rules",
-  "version": "0.11.1",
+  "version": "0.13.0",
   "description": "The flow action catalog and the rules engine behind Flow Doctor — one definition of what a step accepts and what makes a flow valid, shared by the editor and the server",
   "type": "module",
   "main": "./dist/index.cjs",