typekro 0.5.0 → 0.8.0

package/dist/factories/cnpg/types.d.ts

@@ -0,0 +1,507 @@
+/**
+ * CloudNativePG (CNPG) Type Definitions
+ *
+ * ArkType schemas as the single source of truth, with types inferred via
+ * `typeof Schema.infer`. Status types remain as hand-written interfaces.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/
+ */
+/** Reference to a key in a Kubernetes Secret. */
+export interface SecretKeyRef {
+    name: string;
+    key: string;
+}
+/** Minimal object reference (name only). */
+export interface LocalObjectReference {
+    name: string;
+}
+/** Pod resource requests and limits. */
+export interface ResourceRequirements {
+    requests?: {
+        cpu?: string;
+        memory?: string;
+    };
+    limits?: {
+        cpu?: string;
+        memory?: string;
+    };
+}
+/** Kubernetes toleration for pod scheduling. */
+export interface Toleration {
+    key?: string;
+    operator?: 'Exists' | 'Equal';
+    value?: string;
+    effect?: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
+    tolerationSeconds?: number;
+}
+/**
+ * ArkType schema for CnpgBootstrapConfig.
+ *
+ * Configuration for installing the CloudNativePG operator via Helm.
+ * Used by the `cnpgBootstrap` composition to deploy the operator
+ * controller into the cluster.
+ */
+export declare const CnpgBootstrapConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name: string;
+    namespace?: string;
+    version?: string;
+    installCRDs?: boolean;
+    replicaCount?: number;
+    monitoring?: {
+        enabled?: boolean;
+    };
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    customValues?: Record<string, unknown>;
+}, {}>;
+/** Configuration for installing the CloudNativePG operator via Helm. */
+export type CnpgBootstrapConfig = typeof CnpgBootstrapConfigSchema.infer;
+/**
+ * Observed status of a CloudNativePG operator deployment.
+ */
+export interface CnpgBootstrapStatus {
+    /** Overall deployment phase (derived from HelmRelease Ready condition). */
+    phase: 'Ready' | 'Installing';
+    /** Whether the operator is ready to manage clusters. */
+    ready: boolean;
+    /** Deployed chart version. */
+    version?: string;
+}
+/** ArkType schema for CnpgBootstrapStatus. */
+export declare const CnpgBootstrapStatusSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    phase: "Ready" | "Installing";
+    ready: boolean;
+    version?: string;
+}, {}>;
+/**
+ * ArkType schema for ClusterConfig.
+ *
+ * Configuration for a CloudNativePG PostgreSQL cluster.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#ClusterSpec
+ */
+export declare const ClusterConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name: string;
+    spec: {
+        storage: {
+            size: string;
+            storageClass?: string;
+            resizeInUseVolumes?: boolean;
+            pvcTemplate?: {
+                accessModes?: string[];
+                volumeMode?: string;
+            };
+        };
+        instances?: number;
+        imageName?: string;
+        imagePullPolicy?: string;
+        imagePullSecrets?: {
+            name: string;
+        }[];
+        postgresql?: {
+            parameters?: Record<string, string>;
+            pg_hba?: string[];
+            shared_preload_libraries?: string[];
+        };
+        bootstrap?: {
+            initdb?: {
+                database?: string;
+                owner?: string;
+                encoding?: string;
+                dataChecksums?: boolean;
+                localeProvider?: string;
+                icuLocale?: string;
+            };
+            recovery?: {
+                source: string;
+                recoveryTarget?: {
+                    targetTime?: string;
+                    targetLSN?: string;
+                    targetName?: string;
+                    exclusive?: boolean;
+                };
+            };
+            pg_basebackup?: {
+                source: string;
+            };
+        };
+        backup?: {
+            barmanObjectStore?: {
+                destinationPath: string;
+                s3Credentials?: {
+                    accessKeyId: {
+                        name: string;
+                        key: string;
+                    };
+                    secretAccessKey: {
+                        name: string;
+                        key: string;
+                    };
+                    region?: string;
+                    sessionToken?: {
+                        name: string;
+                        key: string;
+                    };
+                };
+                azureCredentials?: {
+                    connectionString?: {
+                        name: string;
+                        key: string;
+                    };
+                    storageAccount?: {
+                        name: string;
+                        key: string;
+                    };
+                    storageKey?: {
+                        name: string;
+                        key: string;
+                    };
+                };
+                googleCredentials?: {
+                    gkeEnvironment?: boolean;
+                };
+                endpointURL?: string;
+                serverName?: string;
+                data?: {
+                    compression?: string;
+                    encryption?: string;
+                    jobs?: number;
+                    immediateCheckpoint?: boolean;
+                };
+                wal?: {
+                    compression?: string;
+                    maxParallel?: number;
+                };
+                tags?: Record<string, string>;
+            };
+            retentionPolicy?: string;
+            target?: "primary" | "prefer-standby";
+            volumeSnapshot?: {
+                className?: string;
+                online?: boolean;
+                onlineConfiguration?: {
+                    immediateCheckpoint?: boolean;
+                    waitForArchive?: boolean;
+                };
+            };
+        };
+        resources?: {
+            requests?: {
+                cpu?: string;
+                memory?: string;
+            };
+            limits?: {
+                cpu?: string;
+                memory?: string;
+            };
+        };
+        affinity?: {
+            enablePodAntiAffinity?: boolean;
+            nodeSelector?: Record<string, string>;
+            tolerations?: {
+                key?: string;
+                operator?: "Exists" | "Equal";
+                value?: string;
+                effect?: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
+                tolerationSeconds?: number;
+            }[];
+            topologyKey?: string;
+            podAntiAffinityType?: "required" | "preferred";
+        };
+        monitoring?: {
+            enabled?: boolean;
+            customQueriesConfigMap?: {
+                name: string;
+            }[];
+            podMonitorEnabled?: boolean;
+        };
+        certificates?: {
+            serverCASecret?: string;
+            serverTLSSecret?: string;
+            clientCASecret?: string;
+            replicationTLSSecret?: string;
+        };
+        externalClusters?: {
+            name: string;
+            connectionParameters?: Record<string, string>;
+            barmanObjectStore?: {
+                destinationPath: string;
+                s3Credentials?: {
+                    accessKeyId: {
+                        name: string;
+                        key: string;
+                    };
+                    secretAccessKey: {
+                        name: string;
+                        key: string;
+                    };
+                    region?: string;
+                    sessionToken?: {
+                        name: string;
+                        key: string;
+                    };
+                };
+                azureCredentials?: {
+                    connectionString?: {
+                        name: string;
+                        key: string;
+                    };
+                    storageAccount?: {
+                        name: string;
+                        key: string;
+                    };
+                    storageKey?: {
+                        name: string;
+                        key: string;
+                    };
+                };
+                googleCredentials?: {
+                    gkeEnvironment?: boolean;
+                };
+                endpointURL?: string;
+                serverName?: string;
+                data?: {
+                    compression?: string;
+                    encryption?: string;
+                    jobs?: number;
+                    immediateCheckpoint?: boolean;
+                };
+                wal?: {
+                    compression?: string;
+                    maxParallel?: number;
+                };
+                tags?: Record<string, string>;
+            };
+            password?: {
+                name: string;
+                key: string;
+            };
+        }[];
+    };
+    namespace?: string;
+    id?: string;
+}, {}>;
+/**
+ * Configuration for a CloudNativePG PostgreSQL cluster.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#ClusterSpec
+ */
+export type ClusterConfig = typeof ClusterConfigSchema.infer;
+/** Status condition for a CNPG cluster. */
+export interface ClusterCondition {
+    type: string;
+    status: 'True' | 'False' | 'Unknown';
+    reason?: string;
+    message?: string;
+    lastTransitionTime?: string;
+}
+/**
+ * Observed status of a CloudNativePG cluster.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#ClusterStatus
+ */
+export interface ClusterStatus {
+    /** Total instances detected. */
+    instances?: number;
+    /** Number of ready instances. */
+    readyInstances?: number;
+    /** Active primary instance name. */
+    currentPrimary?: string;
+    /** Write (primary) service name. */
+    writeService?: string;
+    /** Read (replica) service name. */
+    readService?: string;
+    /** Cluster operational phase. */
+    phase?: string;
+    /** Status conditions. */
+    conditions?: ClusterCondition[];
+    /** Last successful backup timestamp. */
+    lastSuccessfulBackup?: string;
+    /** Certificate status. */
+    certificates?: {
+        serverCASecret?: string;
+        expirations?: Record<string, string>;
+    };
+}
+/**
+ * ArkType schema for BackupConfig.
+ *
+ * Configuration for an on-demand CNPG backup.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#BackupSpec
+ */
+export declare const BackupConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name: string;
+    spec: {
+        cluster: {
+            name: string;
+        };
+        method?: "barmanObjectStore" | "volumeSnapshot" | "plugin";
+        target?: "primary" | "prefer-standby";
+        online?: boolean;
+        onlineConfiguration?: {
+            immediateCheckpoint?: boolean;
+            waitForArchive?: boolean;
+        };
+    };
+    namespace?: string;
+    id?: string;
+}, {}>;
+/**
+ * Configuration for an on-demand CNPG backup.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#BackupSpec
+ */
+export type BackupConfig = typeof BackupConfigSchema.infer;
+/**
+ * Observed status of a CNPG backup.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#BackupStatus
+ */
+export interface BackupStatus {
+    /** Backup lifecycle phase. */
+    phase?: 'new' | 'started' | 'completed' | 'failed';
+    /** Barman backup identifier. */
+    backupId?: string;
+    /** Barman backup name. */
+    backupName?: string;
+    /** Backup start timestamp. */
+    startedAt?: string;
+    /** Backup completion timestamp. */
+    stoppedAt?: string;
+    /** Error message if failed. */
+    error?: string;
+    /** Cloud storage destination path. */
+    destinationPath?: string;
+}
+/**
+ * ArkType schema for ScheduledBackupConfig.
+ *
+ * Configuration for a cron-scheduled CNPG backup.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#ScheduledBackupSpec
+ */
+export declare const ScheduledBackupConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name: string;
+    spec: {
+        cluster: {
+            name: string;
+        };
+        schedule: string;
+        method?: "barmanObjectStore" | "volumeSnapshot" | "plugin";
+        immediate?: boolean;
+        suspend?: boolean;
+        target?: "primary" | "prefer-standby";
+        backupOwnerReference?: "cluster" | "self" | "none";
+    };
+    namespace?: string;
+    id?: string;
+}, {}>;
+/**
+ * Configuration for a cron-scheduled CNPG backup.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#ScheduledBackupSpec
+ */
+export type ScheduledBackupConfig = typeof ScheduledBackupConfigSchema.infer;
+/**
+ * Observed status of a scheduled backup.
+ */
+export interface ScheduledBackupStatus {
+    /** Status conditions. */
+    conditions?: ClusterCondition[];
+    /** Latest schedule evaluation time. */
+    lastCheckTime?: string;
+    /** Most recent backup trigger time. */
+    lastScheduleTime?: string;
+    /** Next scheduled execution. */
+    nextScheduleTime?: string;
+    /** Last successful backup completion. */
+    lastSuccessfulBackup?: string;
+    /** Last failed backup time. */
+    lastFailedBackup?: string;
+}
+/**
+ * ArkType schema for PoolerConfig.
+ *
+ * Configuration for a CNPG PgBouncer connection pooler.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#PoolerSpec
+ */
+export declare const PoolerConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name: string;
+    spec: {
+        cluster: {
+            name: string;
+        };
+        pgbouncer: {
+            poolMode?: "session" | "transaction";
+            paused?: boolean;
+            parameters?: Record<string, string>;
+            pg_hba?: string[];
+            authQuery?: string;
+        };
+        type?: "r" | "rw" | "ro";
+        instances?: number;
+        template?: Record<string, unknown>;
+        deploymentStrategy?: Record<string, unknown>;
+    };
+    namespace?: string;
+    id?: string;
+}, {}>;
+/**
+ * Configuration for a CNPG PgBouncer connection pooler.
+ *
+ * @see https://cloudnative-pg.io/documentation/1.25/cloudnative-pg.v1/#PoolerSpec
+ */
+export type PoolerConfig = typeof PoolerConfigSchema.infer;
+/**
+ * Observed status of a CNPG pooler.
+ */
+export interface PoolerStatus {
+    /** Scheduled pod count. */
+    instances?: number;
+    /** Whether the pooler is ready. */
+    ready?: boolean;
+    /** Pooler service hostname (derived from resource name). */
+    hostname?: string;
+    /** Status conditions. */
+    conditions?: ClusterCondition[];
+}
+/**
+ * ArkType schema for CnpgHelmRepositoryConfig.
+ *
+ * Configuration for the CNPG Helm chart repository.
+ */
+export declare const CnpgHelmRepositoryConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name?: string;
+    namespace?: string;
+    url?: string;
+    interval?: string;
+    id?: string;
+}, {}>;
+/** Configuration for the CNPG Helm chart repository. */
+export type CnpgHelmRepositoryConfig = typeof CnpgHelmRepositoryConfigSchema.infer;
+/**
+ * ArkType schema for CnpgHelmReleaseConfig.
+ *
+ * Configuration for the CNPG Helm release.
+ */
+export declare const CnpgHelmReleaseConfigSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    name: string;
+    namespace?: string;
+    version?: string;
+    values?: Record<string, unknown>;
+    repositoryName?: string;
+    id?: string;
+}, {}>;
+/** Configuration for the CNPG Helm release. */
+export type CnpgHelmReleaseConfig = typeof CnpgHelmReleaseConfigSchema.infer;
+//# sourceMappingURL=types.d.ts.map

package/dist/factories/cnpg/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/factories/cnpg/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAQH,iDAAiD;AACjD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,4CAA4C;AAC5C,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,wCAAwC;AACxC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,MAAM,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5C;AAED,gDAAgD;AAChD,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,GAAG,kBAAkB,GAAG,WAAW,CAAC;IACzD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAmDD;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;MAoBpC,CAAC;AAEH,wEAAwE;AACxE,MAAM,MAAM,mBAAmB,GAAG,OAAO,yBAAyB,CAAC,KAAK,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2EAA2E;IAC3E,KAAK,EAAE,OAAO,GAAG,YAAY,CAAC;IAC9B,wDAAwD;IACxD,KAAK,EAAE,OAAO,CAAC;IACf,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8CAA8C;AAC9C,eAAO,MAAM,yBAAyB;;;;MAIpC,CAAC;AAMH;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA+I9B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,mBAAmB,CAAC,KAAK,CAAC;AAE7D,2CAA2C;AAC3C,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAChC,wCAAwC;IACxC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,0BAA0B;IAC1B,YAAY,CAAC,EAAE;QACb,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACtC,CAAC;CACH;AAMD;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;MAuB7B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,kBAAkB,CAAC,KAAK,CAAC;AAE3D;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IACnD,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAMD;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;MA2BtC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,2BAA2B,CAAC,KAAK,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAChC,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gCAAgC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yCAAyC;IACzC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,+BAA+B;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAMD;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;MAiC7B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,kBAAkB,CAAC,KAAK,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAMD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;MAWzC,CAAC;AAEH,wDAAwD;AACxD,MAAM,MAAM,wBAAwB,GAAG,OAAO,8BAA8B,CAAC,KAAK,CAAC;AAEnF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;;MAatC,CAAC;AAEH,+CAA+C;AAC/C,MAAM,MAAM,qBAAqB,GAAG,OAAO,2BAA2B,CAAC,KAAK,CAAC"}