@walkeros/cli 4.8.0 → 4.8.1-next-1792019907609

package/dist/validate.d.ts

@@ -0,0 +1,93 @@
+import { z, ValidateResult as ValidateResult$1, ValidationError as ValidationError$1, ValidationWarning as ValidationWarning$1, ValidationType } from '@walkeros/core/dev';
+export { ValidationType } from '@walkeros/core/dev';
+
+/**
+ * Validate Command Schemas
+ *
+ * Zod schemas for validate command parameter validation.
+ */
+
+/**
+ * Validate options schema.
+ *
+ * @remarks
+ * Options for the programmatic validate() API.
+ */
+declare const ValidateOptionsSchema: z.ZodObject<{
+    flow: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    strict: z.ZodOptional<z.ZodBoolean>;
+    offline: z.ZodOptional<z.ZodBoolean>;
+    configDir: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type ValidateOptions = z.infer<typeof ValidateOptionsSchema>;
+
+/**
+ * Every code an error, warning or skip of `validate` can carry. Agents and
+ * tests branch on these, never on message text.
+ */
+declare const VALIDATE_CODES: readonly ["INPUT_ERROR", "SERIALIZATION_ERROR", "OPTION_NOT_APPLICABLE", "FLOW_NOT_FOUND", "ENTRY_NOT_FOUND", "AMBIGUOUS_ENTRY", "UNSUPPORTED_SECTION", "INVALID_PATH", "SCHEMA_VALIDATION", "CONFIG_WARNING", "EMPTY_FLOWS", "UNKNOWN_KEY", "CONFLICT", "MISSING_PACKAGE", "OBSOLETE_CODE_STRING", "INVALID_IMPORT", "INVALID_CODE_SHAPE", "PACKAGE_VERSION_MISSING", "DEPRECATED_PACKAGE", "UNKNOWN_ROUTE_TARGET", "ROUTE_DEAD_CODE", "ROUTE_EMPTY_MANY", "ROUTE_SINGLE_MANY", "ROUTE_FIRST_MATCH", "INCOMPATIBLE_EXAMPLES", "EXAMPLES_INCOMPLETE", "CONTRACT_VIOLATION", "MAPPING_DOT_KEY", "FLOW_REF_WARNING", "FLOW_CYCLE", "VAR_CYCLE", "INVALID_COMPONENT_NAME", "INVALID_REFERENCE", "STORE_REFERENCE_NOT_FOUND", "STATE_STORE_UNKNOWN", "STATE_STORE_FILE", "TRANSFORMER_MAPPING_NO_OP", "UNRESOLVED_REFERENCE", "MISSING_ENV", "WEB_SECRET_REF", "UNRESOLVED_CONTRACT", "ENTRY_SCHEMA", "NO_CONTRACT_SECTION", "INVALID_CONTRACT", "FLAT_CONTRACT_SHAPE", "INVALID_CONTRACT_ENTRY", "UNKNOWN_CONTRACT_KEY", "INVALID_TAGGING", "INVALID_SCHEMA", "INVALID_EXTENDS", "INVALID_SECTION", "INVALID_EVENTS", "CIRCULAR_EXTENDS", "INVALID_ENTITY_KEY", "INVALID_ENTITY", "INVALID_ACTION_KEY", "INVALID_SCHEMA_ENTRY", "NOT_AN_OBJECT", "MISSING_EVENT_NAME", "EMPTY_EVENT_NAME", "INVALID_EVENT_NAME", "INVALID_MAPPING_TYPE", "INVALID_EVENT_PATTERN", "INVALID_RULE_TYPE", "CATCH_ALL_NOT_LAST", "GATED_BY_ERRORS", "CONTRACT_NOT_STATIC", "NO_PACKAGE", "NO_SETTINGS_SCHEMA", "SCHEMA_UNAVAILABLE"];
+type ValidateCode = (typeof VALIDATE_CODES)[number];
+/**
+ * Named checks a run includes (`details.scope.checks`). `file:` checks run
+ * on the whole file whatever `--flow` says; `flow:` checks run per flow in
+ * scope; `entry:` checks run per entry `--path` addressed.
+ */
+type ValidateCheck = 'file:schema' | 'file:contract' | 'flow:schema' | 'flow:steps' | 'flow:structure' | 'flow:package-versions' | 'flow:routes' | 'flow:examples' | 'flow:contract-examples' | 'flow:mapping-keys' | 'flow:resolve' | 'flow:package-settings' | 'entry:settings' | 'contract' | 'event' | 'mapping';
+interface ValidateScopeEntry {
+    /** Section of the addressed entry, when the path or the match names one. */
+    section?: string;
+    key: string;
+    /** Flows that have the entry and were checked. */
+    flows: string[];
+    /** Flows searched for the entry. */
+    searchedFlows: string[];
+}
+/** What a run covered (C6). */
+interface ValidateScope {
+    flows: string[];
+    entry?: ValidateScopeEntry;
+    checks: ValidateCheck[];
+    /** Set when `offline` removed the package settings check from `checks`. */
+    offline?: true;
+}
+/** A check the scope includes that did not run (C5). */
+interface ValidateSkip {
+    path: string;
+    check: ValidateCheck;
+    reason: string;
+    code: ValidateCode;
+}
+/** A value known only at runtime, not schema-checked (info, not a skip). */
+interface ValidateDeferred {
+    path: string;
+    reference: string;
+}
+interface ValidateDetails {
+    scope?: ValidateScope;
+    skipped?: ValidateSkip[];
+    deferred?: ValidateDeferred[];
+    [key: string]: unknown;
+}
+interface ValidationError extends ValidationError$1 {
+    /** The JSON Schema keyword of an ENTRY_SCHEMA error. */
+    keyword?: string;
+}
+interface ValidationWarning extends ValidationWarning$1 {
+    keyword?: string;
+}
+interface ValidateResult extends ValidateResult$1 {
+    errors: ValidationError[];
+    warnings: ValidationWarning[];
+    details: ValidateDetails;
+}
+
+/**
+ * Programmatic API for validation.
+ * Can be called directly from code or MCP server.
+ *
+ * Accepts parsed objects, JSON strings, file paths, or URLs as input.
+ */
+declare function validate(type: ValidationType, input: unknown, options?: ValidateOptions): Promise<ValidateResult>;
+
+export { VALIDATE_CODES, type ValidateCheck, type ValidateCode, type ValidateDeferred, type ValidateOptions, type ValidateResult, type ValidateScope, type ValidateSkip, type ValidationError, type ValidationWarning, validate };