@octaviaflow/flow-rules 0.11.0 → 0.11.1

package/dist/index.cjs

@@ -88,6 +88,7 @@ __export(exports_src, {
   NodeStatus: () => NodeStatus,
   ONEDRIVE_OPERATIONS: () => ONEDRIVE_OPERATIONS,
   OneDriveActionConfig: () => OneDriveActionConfig,
+  PLATFORM_CONFIG_KEYS: () => PLATFORM_CONFIG_KEYS,
   QueryMode: () => QueryMode,
   QueryType: () => QueryType,
   S3ActionConfig: () => S3ActionConfig,
@@ -5664,6 +5665,10 @@ function contractDerivedKeys(definition) {
 var MAX_STEP_CONFIG_BYTES = 256 * 1024;
 var FORBIDDEN_KEYS = new Set(["__proto__", "constructor", "prototype"]);
 var MAX_DEPTH = 12;
+var PLATFORM_CONFIG_KEYS = {
+  flowId: { key: "flowId", label: "Flow", type: "string" /* String */, validation: { required: false } },
+  outputAs: { key: "outputAs", label: "Output as", type: "string" /* String */, validation: { required: false } }
+};
 function typeMatches(field, value) {
   if (value === null || value === undefined || value === "")
     return true;
@@ -5771,8 +5776,10 @@ function validateStepConfig(step) {
   const declared = new Map(contractFieldsFor(definition).map((f) => [f.key, f]));
   const entries = Object.entries(config);
   for (const [key, value] of entries) {
-    const field = declared.get(key);
+    const field = declared.get(key) ?? PLATFORM_CONFIG_KEYS[key];
     if (!field) {
+      if (isEditorPrivateKey(key))
+        continue;
       issues.push({
         severity: "warning",
         code: "UNDECLARED_FIELD",

package/dist/index.d.ts

@@ -60,6 +60,6 @@ export { CONNECTOR_EVENT_ENTITIES, EVENT_CAPABLE_CONNECTOR_IDS, getEntitiesForCo
 export * from "./catalog/workflow";
 export { type FlowConnection, type FlowData, type FlowStep, generateConnectionsFromSteps, transformConnectionToEdge, transformFlowToWorkflow, transformStepToNode, validateFlowData, } from "./rules/flowShape";
 export { flattenNestedWorkflow } from "./rules/flattenNestedWorkflow";
-export { configErrors, MAX_STEP_CONFIG_BYTES, validateStepConfig, validateStepConfigs, type ConfigIssue, type ConfigIssueCode, } from "./rules/configSafety";
+export { configErrors, MAX_STEP_CONFIG_BYTES, validateStepConfig, PLATFORM_CONFIG_KEYS, validateStepConfigs, type ConfigIssue, type ConfigIssueCode, } from "./rules/configSafety";
 export { isMappingFunction, MAPPING_FUNCTION_SPECS, MAPPING_FUNCTIONS, mappingTransformFunctionName, USER_FUNCTION_PREFIX, type MappingFunction, type MappingFunctionSpec, } from "./rules/mappingFunctions";
 export { CONFIG_CONTRACTS, contractDerivedKeys, contractDrift, contractFieldsFor, contractVocabularyDrift, contractFor, declaredKeys, isEditorPrivateKey, type ConfigContract, type ContractField, type ContractFieldType, } from "./rules/configContracts";

package/dist/index.js

@@ -5510,6 +5510,10 @@ function contractDerivedKeys(definition) {
 var MAX_STEP_CONFIG_BYTES = 256 * 1024;
 var FORBIDDEN_KEYS = new Set(["__proto__", "constructor", "prototype"]);
 var MAX_DEPTH = 12;
+var PLATFORM_CONFIG_KEYS = {
+  flowId: { key: "flowId", label: "Flow", type: "string" /* String */, validation: { required: false } },
+  outputAs: { key: "outputAs", label: "Output as", type: "string" /* String */, validation: { required: false } }
+};
 function typeMatches(field, value) {
   if (value === null || value === undefined || value === "")
     return true;
@@ -5617,8 +5621,10 @@ function validateStepConfig(step) {
   const declared = new Map(contractFieldsFor(definition).map((f) => [f.key, f]));
   const entries = Object.entries(config);
   for (const [key, value] of entries) {
-    const field = declared.get(key);
+    const field = declared.get(key) ?? PLATFORM_CONFIG_KEYS[key];
     if (!field) {
+      if (isEditorPrivateKey(key))
+        continue;
       issues.push({
         severity: "warning",
         code: "UNDECLARED_FIELD",
@@ -5793,6 +5799,7 @@ export {
   NodeStatus,
   ONEDRIVE_OPERATIONS,
   OneDriveActionConfig,
+  PLATFORM_CONFIG_KEYS,
   QueryMode,
   QueryType,
   S3ActionConfig,

package/dist/rules/configSafety.d.ts

@@ -33,8 +33,26 @@
  * An enumerated field's options are checked but only WARN, for the same
  * reason — see the note at that check.
  */
+import { type FieldConfig } from "../catalog/types";
 /** Largest config a single step may carry, serialised. */
 export declare const MAX_STEP_CONFIG_BYTES: number;
+/**
+ * Keys that belong to the PLATFORM, not to any action — on nearly every step,
+ * declared by no contract, and rightly so:
+ *
+ *   - `flowId`: NodeConfigPanel seeds every custom panel's config with the flow
+ *     it belongs to, and it is saved with the step;
+ *   - `outputAs`: the Engine reads it for EVERY step type — the step's key in
+ *     the run's data bag.
+ *
+ * Type-checked like a declared field; never reported as undeclared; never
+ * advertised by `contractFieldsFor` (an agent is told the action's own keys).
+ * Before this, every panel-built step raised one to four UNDECLARED_FIELD
+ * warnings for these and the editor's own `_` snapshots, which drowned the
+ * warnings that mean something — `connection` on a storage step, `message` on
+ * a Slack step (DEV-412).
+ */
+export declare const PLATFORM_CONFIG_KEYS: Readonly<Record<string, FieldConfig>>;
 export type ConfigIssueCode = "FORBIDDEN_KEY" | "CONFIG_TOO_LARGE" | "CONFIG_TOO_DEEP" | "FIELD_WRONG_TYPE" | "FIELD_BAD_OPTION" | "UNDECLARED_FIELD";
 export interface ConfigIssue {
     severity: "error" | "warning";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octaviaflow/flow-rules",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "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",