kure schema

The schema library package defines common types and utilities for API packages.

Example

Building the example in the spec package would generate code which uses this package:

import type { ObjectMeta } from "jsr:@kure/api/meta";
import { factory, type NameScope, type Resource } from "jsr:@kure/schema";

export type APIVersion = "example.kure.sh/v1alpha1";
export const apiVersion: APIVersion = "example.kure.sh/v1alpha1";

/** Evaluate a math expression */
export interface Calculator implements Resource<APIVersion, "Calculator", "namespace", ObjectMeta> {
  spec: CalculatorSpec,
  status: CalculatorStatus,
}

export const Calculator = factory<Calculator>(apiVersion, "Calculator", "namespace");

/** Defines the input to Calculator */
export interface CalculatorSpec {
  expression: string,
}

/** Provides the output from Calculator */
export interface CalculatorStatus {
  result: number | null,

  /** If the input expression was invalid, explains the error */
  error?: string,
}