Helpers

Utility functions for working with Criterion.

defineDecision()

Type-safe helper to define decisions with full inference.

function defineDecision<TInput, TOutput, TProfile>(
  definition: Decision<TInput, TOutput, TProfile>
): Decision<TInput, TOutput, TProfile>

Example:

import { defineDecision } from "@criterionx/core";

const myDecision = defineDecision({
  id: "my-decision",
  version: "1.0.0",
  inputSchema,
  outputSchema,
  profileSchema,
  rules: [/* ... */],
});

createRule()

Type-safe helper to create rules with inference.

function createRule<TContext, TProfile, TOutput>(
  rule: Rule<TContext, TProfile, TOutput>
): Rule<TContext, TProfile, TOutput>

Example:

import { createRule } from "@criterionx/core";

const highRiskRule = createRule({
  id: "high-risk",
  when: (input, profile) => input.amount > profile.threshold,
  emit: () => ({ risk: "HIGH" }),
  explain: (input, profile) => `Amount ${input.amount} > ${profile.threshold}`,
});

createProfileRegistry()

Creates an in-memory profile registry.

function createProfileRegistry<TProfile>(): ProfileRegistry<TProfile>

Example:

import { createProfileRegistry } from "@criterionx/core";

const registry = createProfileRegistry<MyProfileType>();

registry.register("us", usProfile);
registry.register("eu", euProfile);

const profile = registry.get("us");

isInlineProfile()

Type guard to check if profile option is inline or ID-based.

function isInlineProfile<TProfile>(
  options: RunOptions<TProfile>
): options is { profile: TProfile }

Example:

import { isInlineProfile } from "@criterionx/core";

if (isInlineProfile(options)) {
  // options.profile is TProfile
} else {
  // options.profile is string (ID)
}

toJsonSchema()

Convert a Zod schema to JSON Schema.

function toJsonSchema(schema: ZodSchema): JsonSchema

Example:

import { toJsonSchema } from "@criterionx/core";
import { z } from "zod";

const schema = z.object({
  name: z.string(),
  age: z.number(),
});

const jsonSchema = toJsonSchema(schema);
// {
//   type: "object",
//   properties: {
//     name: { type: "string" },
//     age: { type: "number" }
//   },
//   required: ["name", "age"]
// }

extractDecisionSchema()

Extract all schemas from a decision as JSON Schema.

function extractDecisionSchema(
  decision: Decision<unknown, unknown, unknown>
): DecisionSchema

Example:

import { extractDecisionSchema } from "@criterionx/core";

const schema = extractDecisionSchema(myDecision);
// {
//   id: "my-decision",
//   version: "1.0.0",
//   inputSchema: { type: "object", ... },
//   outputSchema: { type: "object", ... },
//   profileSchema: { type: "object", ... }
// }

Use cases:

• Generate API documentation
• Validate JSON inputs externally
• Generate clients in other languages
• Integrate with OpenAPI tools