import {z} from 'zod' export type GetApiEnvironmentEnvironmentIdServicesOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const storageTypeEnum = z.literal("FAST_SSD"); export const referenceObject = z.object({id: z.string()}); export const gitProviderEnum = z.enum(["BITBUCKET", "GITHUB", "GITLAB"]); export const applicationGitRepository = z.object({has_access: z.boolean().optional(), provider: gitProviderEnum, owner: z.string(), url: z.string(), name: z.string(), branch: z.string().optional(), root_path: z.string().optional(), deployed_commit_id: z.string().optional(), deployed_commit_date: z.string().optional(), deployed_commit_contributor: z.string().optional(), deployed_commit_tag: z.string().optional(), git_token_id: z.string().nullable().optional(), git_token_name: z.string().nullable().optional()}); export const buildModeEnum = z.literal("DOCKER"); export const probe = z.object({type: z.object({tcp: z.object({port: z.number().int().optional(), host: z.string().nullable().optional()}).nullable().optional(), http: z.object({path: z.string().optional(), scheme: z.string().optional(), port: z.number().int().optional()}).nullable().optional(), exec: z.object({command: z.array(z.string()).optional()}).nullable().optional(), grpc: z.object({service: z.string().nullable().optional(), port: z.number().int().optional()}).nullable().optional()}).optional(), initial_delay_seconds: z.number().int().optional(), period_seconds: z.number().int().optional(), timeout_seconds: z.number().int().optional(), success_threshold: z.number().int().optional(), failure_threshold: z.number().int().optional()}).nullable(); export const healthcheck = z.object({readiness_probe: probe.optional(), liveness_probe: probe.optional()}); export const portProtocolEnum = z.enum(["HTTP", "GRPC", "TCP", "UDP"]); export const servicePort = z.object({id: z.string(), name: z.string().optional(), internal_port: z.number().int(), external_port: z.number().int().optional(), publicly_accessible: z.boolean(), is_default: z.boolean().optional(), protocol: portProtocolEnum, public_path: z.string().optional(), public_path_rewrite: z.string().optional()}); export const servicePortResponseList = z.array(servicePort); export const annotation = z.object({key: z.string(), value: z.string()}); export const organizationAnnotationsGroupScopeEnum = z.enum(["DEPLOYMENTS", "STATEFUL_SETS", "SERVICES", "INGRESS", "HPA", "PODS", "SECRETS", "JOBS", "CRON_JOBS"]); export const organizationAnnotationsGroupResponse = z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), name: z.string(), annotations: z.array(annotation), scopes: z.array(organizationAnnotationsGroupScopeEnum)}); export const organizationAnnotationsGroupResponseList = z.array(organizationAnnotationsGroupResponse); export const label = z.object({key: z.string(), value: z.string(), propagate_to_cloud_provider: z.boolean()}); export const organizationLabelsGroupResponse = z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), name: z.string(), labels: z.array(label)}); export const organizationLabelsGroupResponseList = z.array(organizationLabelsGroupResponse); export const serviceTypeEnum = z.enum(["APPLICATION", "DATABASE", "CONTAINER", "JOB", "HELM", "TERRAFORM"]); export const containerRegistryKindEnum = z.enum(["ECR", "SCALEWAY_CR", "DOCKER_HUB", "GITHUB_CR", "GITHUB_ENTERPRISE_CR", "GITLAB_CR", "PUBLIC_ECR", "DOCR", "GENERIC_CR", "GCP_ARTIFACT_REGISTRY", "AZURE_CR"]); export const containerRegistryProviderDetailsResponse = z.object({id: z.string(), name: z.string(), url: z.string(), kind: containerRegistryKindEnum}); export const databaseTypeEnum = z.enum(["MONGODB", "MYSQL", "POSTGRESQL", "REDIS"]); export const databaseModeEnum = z.enum(["CONTAINER", "MANAGED"]); export const databaseAccessibilityEnum = z.enum(["PRIVATE", "PUBLIC"]); export const helmPortProtocolEnum = z.enum(["HTTP", "GRPC"]); export const helmPortResponseWithServiceName = z.object({id: z.string(), port_type: z.string(), name: z.string().optional(), internal_port: z.number().int(), external_port: z.number().int().optional(), namespace: z.string().optional(), protocol: helmPortProtocolEnum, is_default: z.boolean().optional(), service_name: z.string()}); export const kubernetesSelector = z.object({key: z.string(), value: z.string()}); export const helmPortResponseWithServiceSelectors = z.object({id: z.string(), port_type: z.string(), name: z.string().optional(), internal_port: z.number().int(), external_port: z.number().int().optional(), namespace: z.string().optional(), protocol: helmPortProtocolEnum, is_default: z.boolean().optional(), service_selectors: z.array(kubernetesSelector)}); export const helmSourceGitResponse = z.object({git_repository: applicationGitRepository}); export const helmSourceRepositoryResponse = z.object({chart_name: z.string(), chart_version: z.string(), repository: z.object({id: z.string(), name: z.string(), url: z.string()})}); export const helmKeyValues = z.array(z.array(z.string())); export const containerSource = z.object({image_name: z.string(), tag: z.string(), registry_id: z.string().optional(), registry: containerRegistryProviderDetailsResponse}); export const jobSourceDockerResponse = z.object({git_repository: applicationGitRepository.optional(), dockerfile_path: z.string().nullable().optional(), dockerfile_raw: z.string().nullable().optional(), docker_target_build_stage: z.string().nullable().optional()}); export const jobTypeEnum = z.enum(["LIFECYCLE", "CRON"]); export const jobLifecycleTypeEnum = z.enum(["GENERIC", "TERRAFORM", "CLOUDFORMATION"]); export const lifecycleJobResponse = z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), environment: referenceObject, maximum_cpu: z.number().int(), maximum_memory: z.number().int(), maximum_gpu: z.number().int().gte(0), name: z.string(), description: z.string().optional(), cpu: z.number().int(), memory: z.number().int(), gpu: z.number().int().gte(0), max_nb_restart: z.number().int().gte(0).optional(), max_duration_seconds: z.number().int().gte(0).optional(), auto_preview: z.boolean(), port: z.number().int().gte(1).nullable().optional(), source: z.union([z.object({image: containerSource}), z.object({docker: jobSourceDockerResponse})]), healthchecks: healthcheck, auto_deploy: z.boolean().optional(), icon_uri: z.string(), service_type: serviceTypeEnum, job_type: jobTypeEnum, schedule: z.object({on_start: z.object({arguments: z.array(z.string()).optional(), entrypoint: z.string().optional()}).optional(), on_stop: z.object({arguments: z.array(z.string()).optional(), entrypoint: z.string().optional()}).optional(), on_delete: z.object({arguments: z.array(z.string()).optional(), entrypoint: z.string().optional()}).optional(), lifecycle_type: jobLifecycleTypeEnum.optional()}), annotations_groups: organizationAnnotationsGroupResponseList.optional(), labels_groups: organizationLabelsGroupResponseList.optional()}); export const cronJobResponse = z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), environment: referenceObject, maximum_cpu: z.number().int(), maximum_memory: z.number().int(), maximum_gpu: z.number().int().gte(0), name: z.string(), description: z.string().optional(), cpu: z.number().int(), memory: z.number().int(), gpu: z.number().int().gte(0), max_nb_restart: z.number().int().gte(0).optional(), max_duration_seconds: z.number().int().gte(0).optional(), auto_preview: z.boolean(), port: z.number().int().gte(1).nullable().optional(), source: z.union([z.object({image: containerSource}), z.object({docker: jobSourceDockerResponse})]), healthchecks: healthcheck, auto_deploy: z.boolean().optional(), icon_uri: z.string(), service_type: serviceTypeEnum, job_type: jobTypeEnum, schedule: z.object({cronjob: z.object({arguments: z.array(z.string()).optional(), entrypoint: z.string().optional(), timezone: z.string(), scheduled_at: z.string()})}), annotations_groups: organizationAnnotationsGroupResponseList.optional(), labels_groups: organizationLabelsGroupResponseList.optional()}); export const terraformVariablesSourceResponse = z.object({tf_var_file_paths: z.array(z.string())}); export const terraformBackendKubernetes = z.object({}); export const terraformBackendUserProvided = z.object({}); export const terraformBackend = z.union([z.object({kubernetes: terraformBackendKubernetes}), z.object({user_provided: terraformBackendUserProvided})]); export const terraformProviderVersion = z.object({read_from_terraform_block: z.boolean().optional(), explicit_version: z.string()}); export const terraformJobResourcesResponse = z.object({cpu_milli: z.number().int(), ram_mib: z.number().int(), gpu: z.number().int().gte(0), storage_gib: z.number().int()}); export const getApiEnvironmentEnvironmentIdServicesResponse = z.object({results: z.array(z.discriminatedUnion("service_type", [z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), storage: z.array(z.object({id: z.string(), type: storageTypeEnum, size: z.number().int(), mount_point: z.string()})).optional(), environment: referenceObject, git_repository: applicationGitRepository.optional(), maximum_cpu: z.number().int().optional(), maximum_memory: z.number().int().optional(), maximun_gpu: z.number().int().gte(0).optional(), name: z.string(), description: z.string().optional(), build_mode: buildModeEnum.optional(), dockerfile_path: z.string().nullable().optional(), cpu: z.number().int().optional(), memory: z.number().int().optional(), gpu: z.number().int().gte(0).optional(), min_running_instances: z.number().int().gte(0).optional(), max_running_instances: z.number().int().optional(), healthchecks: healthcheck, auto_preview: z.boolean().optional(), ports: servicePortResponseList.optional(), arguments: z.array(z.string()).optional(), entrypoint: z.string().optional(), auto_deploy: z.boolean().optional(), annotations_groups: organizationAnnotationsGroupResponseList.optional(), labels_groups: organizationLabelsGroupResponseList.optional(), icon_uri: z.string(), service_type: serviceTypeEnum, docker_target_build_stage: z.string().nullable().optional()}), z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), storage: z.array(z.object({id: z.string(), type: storageTypeEnum, size: z.number().int(), mount_point: z.string()})).optional(), image_name: z.string(), tag: z.string(), registry_id: z.string().optional(), registry: containerRegistryProviderDetailsResponse, environment: referenceObject, maximum_cpu: z.number().int(), maximum_memory: z.number().int(), maximum_gpu: z.number().int().gte(0), name: z.string(), description: z.string().optional(), arguments: z.array(z.string()).optional(), entrypoint: z.string().optional(), cpu: z.number().int(), memory: z.number().int(), gpu: z.number().int().gte(0), min_running_instances: z.number().int().gte(0), max_running_instances: z.number().int(), healthchecks: healthcheck, auto_preview: z.boolean(), ports: servicePortResponseList.optional(), auto_deploy: z.boolean().optional(), annotations_groups: organizationAnnotationsGroupResponseList.optional(), labels_groups: organizationLabelsGroupResponseList.optional(), icon_uri: z.string(), service_type: serviceTypeEnum}), z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), name: z.string(), description: z.string().optional(), type: databaseTypeEnum, version: z.string(), mode: databaseModeEnum, accessibility: databaseAccessibilityEnum.optional(), cpu: z.number().int().optional(), instance_type: z.string().optional(), memory: z.number().int().optional(), storage: z.number().int().optional(), annotations_groups: z.array(z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), name: z.string(), annotations: z.array(annotation), scopes: z.array(organizationAnnotationsGroupScopeEnum)})).optional(), labels_groups: z.array(z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), name: z.string(), labels: z.array(label)})).optional(), icon_uri: z.string(), environment: referenceObject, host: z.string().optional(), port: z.number().int().optional(), maximum_cpu: z.number().int().optional(), maximum_memory: z.number().int().optional(), disk_encrypted: z.boolean().optional(), service_type: serviceTypeEnum}), z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), environment: referenceObject, name: z.string(), description: z.string().optional(), timeout_sec: z.number().int().gte(0).optional(), auto_preview: z.boolean(), auto_deploy: z.boolean(), ports: z.array(z.discriminatedUnion("port_type", [helmPortResponseWithServiceName, helmPortResponseWithServiceSelectors])).optional(), source: z.union([z.object({git: helmSourceGitResponse}), z.object({repository: helmSourceRepositoryResponse})]), arguments: z.array(z.string()), allow_cluster_wide_resources: z.boolean(), values_override: z.object({set: helmKeyValues.optional(), set_string: helmKeyValues.optional(), set_json: helmKeyValues.optional(), file: z.object({raw: z.object({values: z.array(z.object({name: z.string(), content: z.string()}))}).nullable().optional(), git: z.object({git_repository: applicationGitRepository, paths: z.array(z.string())}).nullable().optional()}).nullable().optional()}), icon_uri: z.string(), service_type: serviceTypeEnum}), lifecycleJobResponse, cronJobResponse, z.object({id: z.string(), created_at: z.string(), updated_at: z.string().optional(), name: z.string(), description: z.string().optional(), timeout_sec: z.number().int().gte(0), auto_approve: z.boolean(), auto_deploy: z.boolean(), terraform_files_source: z.object({git: z.object({git_repository: applicationGitRepository.optional()}).optional()}).optional(), icon_uri: z.string(), service_type: serviceTypeEnum, terraform_variables_source: terraformVariablesSourceResponse, provider: z.literal("TERRAFORM"), backend: terraformBackend, provider_version: terraformProviderVersion, job_resources: terraformJobResourcesResponse, environment: referenceObject, use_cluster_credentials: z.boolean(), action_extra_arguments: z.record(z.string(), z.array(z.string()))})])).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List Services By EnvironmentId * * GET /environment/{environmentId}/services * * Also accepts auth: bearerAuth */ export const getApiEnvironmentEnvironmentIdServices = async (options?: GetApiEnvironmentEnvironmentIdServicesOptions) => { const {baseUrl = "https://api.qovery.com", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("Authorization", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/environment/${encodeURIComponent(String(args.environmentId))}/services${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiEnvironmentEnvironmentIdServicesResponse, await res.json()) };