@kustodian/schema 1.3.0 → 2.0.0

package/src/profile.ts

@@ -1,90 +0,0 @@
-import { z } from 'zod';
-
-import { api_version_schema } from './common.js';
-import { taint_schema } from './node-list.js';
-
-/**
- * Node profile specification schema.
- * Defines reusable configuration for labels, taints, and annotations.
- */
-export const node_profile_spec_schema = z.object({
-  name: z.string().min(1).optional(),
-  description: z.string().optional(),
-  labels: z.record(z.union([z.string(), z.boolean(), z.number()])).optional(),
-  taints: z.array(taint_schema).optional(),
-  annotations: z.record(z.string()).optional(),
-});
-
-export type NodeProfileSpecType = z.infer<typeof node_profile_spec_schema>;
-
-/**
- * Node profile metadata schema.
- */
-export const node_profile_metadata_schema = z.object({
-  name: z.string().min(1),
-});
-
-export type NodeProfileMetadataType = z.infer<typeof node_profile_metadata_schema>;
-
-/**
- * Standalone NodeProfile resource definition.
- * Used for profile files at profiles/<profile-name>.yaml
- */
-export const node_profile_resource_schema = z.object({
-  apiVersion: api_version_schema,
-  kind: z.literal('NodeProfile'),
-  metadata: node_profile_metadata_schema,
-  spec: node_profile_spec_schema,
-});
-
-export type NodeProfileResourceType = z.infer<typeof node_profile_resource_schema>;
-
-/**
- * Validates a NodeProfile resource and returns the result.
- */
-export function validate_node_profile_resource(
-  data: unknown,
-): z.SafeParseReturnType<unknown, NodeProfileResourceType> {
-  return node_profile_resource_schema.safeParse(data);
-}
-
-/**
- * Internal node profile type for use after loading.
- */
-export interface NodeProfileType {
-  name: string;
-  display_name?: string;
-  description?: string;
-  labels?: Record<string, string | boolean | number>;
-  taints?: z.infer<typeof taint_schema>[];
-  annotations?: Record<string, string>;
-}
-
-/**
- * Converts a NodeProfile resource to a NodeProfileType for internal use.
- */
-export function node_profile_resource_to_profile(
-  resource: NodeProfileResourceType,
-): NodeProfileType {
-  const profile: NodeProfileType = {
-    name: resource.metadata.name,
-  };
-
-  if (resource.spec.name !== undefined) {
-    profile.display_name = resource.spec.name;
-  }
-  if (resource.spec.description !== undefined) {
-    profile.description = resource.spec.description;
-  }
-  if (resource.spec.labels !== undefined) {
-    profile.labels = resource.spec.labels;
-  }
-  if (resource.spec.taints !== undefined) {
-    profile.taints = resource.spec.taints;
-  }
-  if (resource.spec.annotations !== undefined) {
-    profile.annotations = resource.spec.annotations;
-  }
-
-  return profile;
-}

package/src/sources.ts

@@ -1,142 +0,0 @@
-import { z } from 'zod';
-
-/**
- * Git reference - exactly one of branch, tag, or commit must be specified.
- */
-export const git_ref_schema = z
-  .object({
-    branch: z.string().min(1).optional(),
-    tag: z.string().min(1).optional(),
-    commit: z.string().min(1).optional(),
-  })
-  .refine((data) => [data.branch, data.tag, data.commit].filter(Boolean).length === 1, {
-    message: "Exactly one of 'branch', 'tag', or 'commit' must be specified",
-  });
-
-export type GitRefType = z.infer<typeof git_ref_schema>;
-
-/**
- * Git source configuration for fetching templates from a Git repository.
- */
-export const git_source_schema = z.object({
-  url: z.string().url(),
-  ref: git_ref_schema,
-  path: z.string().optional(),
-});
-
-export type GitSourceType = z.infer<typeof git_source_schema>;
-
-/**
- * HTTP archive source configuration for fetching templates from URLs.
- * Supports tar.gz and zip archives.
- */
-export const http_source_schema = z.object({
-  url: z.string().url(),
-  checksum: z.string().optional(),
-  headers: z.record(z.string(), z.string()).optional(),
-});
-
-export type HttpSourceType = z.infer<typeof http_source_schema>;
-
-/**
- * OCI artifact source configuration for pulling templates from OCI registries.
- */
-export const oci_source_schema = z
-  .object({
-    registry: z.string().min(1),
-    repository: z.string().min(1),
-    tag: z.string().min(1).optional(),
-    digest: z.string().min(1).optional(),
-  })
-  .refine((data) => data.tag || data.digest, {
-    message: "Either 'tag' or 'digest' must be specified",
-  });
-
-export type OciSourceType = z.infer<typeof oci_source_schema>;
-
-/**
- * Duration format for TTL values.
- * Examples: 30m, 1h, 24h, 7d
- */
-export const duration_schema = z.string().regex(/^(\d+)(m|h|d)$/, {
-  message: "Duration must be in format: <number>(m|h|d), e.g., '30m', '1h', '7d'",
-});
-
-/**
- * Template source configuration - union of all source types.
- * Exactly one of git, http, or oci must be specified.
- */
-export const template_source_schema = z
-  .object({
-    name: z.string().min(1),
-    git: git_source_schema.optional(),
-    http: http_source_schema.optional(),
-    oci: oci_source_schema.optional(),
-    ttl: duration_schema.optional(),
-  })
-  .refine((data) => [data.git, data.http, data.oci].filter(Boolean).length === 1, {
-    message: "Exactly one of 'git', 'http', or 'oci' must be specified",
-  });
-
-export type TemplateSourceType = z.infer<typeof template_source_schema>;
-
-/**
- * Type guard for Git sources.
- */
-export function is_git_source(
-  source: TemplateSourceType,
-): source is TemplateSourceType & { git: GitSourceType } {
-  return source.git !== undefined;
-}
-
-/**
- * Type guard for HTTP sources.
- */
-export function is_http_source(
-  source: TemplateSourceType,
-): source is TemplateSourceType & { http: HttpSourceType } {
-  return source.http !== undefined;
-}
-
-/**
- * Type guard for OCI sources.
- */
-export function is_oci_source(
-  source: TemplateSourceType,
-): source is TemplateSourceType & { oci: OciSourceType } {
-  return source.oci !== undefined;
-}
-
-/**
- * Determines if a source reference is mutable (requires TTL-based refresh).
- * - Git branches: mutable
- * - Git tags/commits: immutable
- * - HTTP with checksum: immutable
- * - HTTP without checksum: mutable
- * - OCI 'latest' tag: mutable
- * - OCI other tags/digests: immutable
- */
-export function is_mutable_source(source: TemplateSourceType): boolean {
-  if (is_git_source(source)) {
-    return source.git.ref.branch !== undefined;
-  }
-
-  if (is_http_source(source)) {
-    return source.http.checksum === undefined;
-  }
-
-  if (is_oci_source(source)) {
-    return source.oci.tag === 'latest' && source.oci.digest === undefined;
-  }
-
-  return true;
-}
-
-/**
- * Validates a template source object and returns the result.
- */
-export function validate_template_source(
-  data: unknown,
-): z.SafeParseReturnType<unknown, TemplateSourceType> {
-  return template_source_schema.safeParse(data);
-}

package/src/template.ts

@@ -1,129 +0,0 @@
-import { z } from 'zod';
-
-import {
-  api_version_schema,
-  health_check_expr_schema,
-  health_check_schema,
-  metadata_schema,
-  namespace_config_schema,
-  substitution_schema,
-} from './common.js';
-
-/**
- * Raw dependency reference to an external Flux Kustomization.
- * Used for dependencies outside the kustodian-generated system.
- */
-export const raw_dependency_ref_schema = z.object({
-  raw: z.object({
-    name: z.string().min(1),
-    namespace: z.string().min(1),
-  }),
-});
-
-export type RawDependencyRefType = z.infer<typeof raw_dependency_ref_schema>;
-
-/**
- * Dependency reference - either a string or a raw reference object.
- *
- * Supports three formats:
- * - Within-template: `database`
- * - Cross-template: `secrets/doppler`
- * - Raw external: `{ raw: { name: 'legacy-infrastructure', namespace: 'gitops-system' } }`
- */
-export const dependency_ref_schema = z.union([z.string(), raw_dependency_ref_schema]);
-
-export type DependencyRefType = z.infer<typeof dependency_ref_schema>;
-
-/**
- * Preservation mode for disabled kustomizations.
- *
- * - none: Delete all resources when disabled
- * - stateful: Keep PVCs, Secrets, and ConfigMaps (default, safe)
- * - custom: Keep only specified resource types
- */
-export const preservation_mode_schema = z.enum(['none', 'stateful', 'custom']);
-
-export type PreservationModeType = z.infer<typeof preservation_mode_schema>;
-
-/**
- * Preservation policy for a kustomization when disabled.
- */
-export const preservation_policy_schema = z.object({
-  mode: preservation_mode_schema.default('stateful'),
-  keep_resources: z.array(z.string()).optional(),
-});
-
-export type PreservationPolicyType = z.infer<typeof preservation_policy_schema>;
-
-/**
- * A single kustomization within a template.
- * Maps to a Flux Kustomization resource.
- */
-export const kustomization_schema = z.object({
-  name: z.string().min(1),
-  path: z.string().min(1),
-  namespace: namespace_config_schema.optional(),
-  depends_on: z.array(dependency_ref_schema).optional(),
-  substitutions: z.array(substitution_schema).optional(),
-  health_checks: z.array(health_check_schema).optional(),
-  health_check_exprs: z.array(health_check_expr_schema).optional(),
-  prune: z.boolean().optional().default(true),
-  wait: z.boolean().optional().default(true),
-  timeout: z.string().optional(),
-  retry_interval: z.string().optional(),
-  enabled: z.boolean().optional().default(true),
-  preservation: preservation_policy_schema.optional(),
-});
-
-export type KustomizationType = z.infer<typeof kustomization_schema>;
-
-/**
- * Node label requirement - requires specific labels to be present on cluster nodes.
- */
-export const node_label_requirement_schema = z.object({
-  type: z.literal('nodeLabel'),
-  key: z.string().min(1),
-  value: z.string().optional(),
-  atLeast: z.number().int().positive().default(1),
-});
-
-export type NodeLabelRequirementType = z.infer<typeof node_label_requirement_schema>;
-
-/**
- * Template requirement - validates cluster prerequisites before deployment.
- * Currently supports node label requirements, extensible for future types.
- */
-export const template_requirement_schema = z.discriminatedUnion('type', [
-  node_label_requirement_schema,
-]);
-
-export type TemplateRequirementType = z.infer<typeof template_requirement_schema>;
-
-/**
- * Template specification containing kustomizations.
- */
-export const template_spec_schema = z.object({
-  requirements: z.array(template_requirement_schema).optional(),
-  kustomizations: z.array(kustomization_schema).min(1),
-});
-
-export type TemplateSpecType = z.infer<typeof template_spec_schema>;
-
-/**
- * Complete Template resource definition.
- */
-export const template_schema = z.object({
-  apiVersion: api_version_schema,
-  kind: z.literal('Template'),
-  metadata: metadata_schema,
-  spec: template_spec_schema,
-});
-
-export type TemplateType = z.infer<typeof template_schema>;
-
-/**
- * Validates a template object and returns the result.
- */
-export function validate_template(data: unknown): z.SafeParseReturnType<unknown, TemplateType> {
-  return template_schema.safeParse(data);
-}