import {z} from 'zod' export type GetApiSpacesSpaceIdentifierProjectsProjectIdProgressionV1Args = {spaceIdentifier: string, projectId: string, releaseHistoryCount?: number | undefined}; export type GetApiSpacesSpaceIdentifierProjectsProjectIdProgressionV1Options = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const referenceDataItem = z.object({Id: z.string().optional(), Name: z.string().optional()}); export const channelCustomFieldDefinitionResource = z.object({Description: z.string().optional(), FieldName: z.string().optional()}); export const deploymentActionGitDependencyResource = z.object({DeploymentActionSlug: z.string(), GitDependencyName: z.string()}); export const channelGitResourceRuleResource = z.object({GitDependencyActions: z.array(deploymentActionGitDependencyResource).optional(), Id: z.string().optional(), Rules: z.array(z.string()).optional()}); export const deploymentActionPackageResource = z.object({DeploymentAction: z.string().optional(), PackageReference: z.string().optional()}); export const channelVersionRuleResource = z.object({ActionPackages: z.array(deploymentActionPackageResource).optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), Tag: z.string().optional(), VersioningStrategy: z.string().optional(), VersionRange: z.string().optional(), VersionTagRegex: z.string().optional()}).and(z.record(z.string(), z.unknown())); export const channelResource = z.object({AutomaticEphemeralEnvironmentDeployments: z.boolean().optional(), CustomFieldDefinitions: z.array(channelCustomFieldDefinitionResource).optional(), Description: z.string().optional(), EphemeralEnvironmentNameTemplate: z.string().optional(), GitReferenceRules: z.array(z.string()).optional(), GitResourceRules: z.array(channelGitResourceRuleResource).optional(), Id: z.string().optional(), IsDefault: z.boolean().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), LifecycleId: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), Name: z.string().optional(), ParentEnvironmentId: z.string().optional(), ProjectId: z.string().optional(), Rules: z.array(channelVersionRuleResource).optional(), Slug: z.string().optional(), SpaceId: z.string().optional(), TenantTags: z.array(z.string()).optional(), Type: z.string().optional()}); export const dashboardItemResource = z.object({ChannelId: z.string().optional(), CompletedTime: z.string().optional(), Created: z.string().optional(), DeploymentId: z.string().optional(), Duration: z.string().optional(), EnvironmentId: z.string().optional(), ErrorMessage: z.string().optional(), HasPendingInterruptions: z.boolean().optional(), HasPendingPreconditions: z.boolean().optional(), HasWarningsOrErrors: z.boolean().optional(), Id: z.string().optional(), IsCompleted: z.boolean().optional(), IsCurrent: z.boolean().optional(), IsPrevious: z.boolean().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), PendingInterruptionTypes: z.array(z.enum(["ManualIntervention", "GuidedFailure", "PullRequestCompletion", "ArgoCDApplicationSync", "KubernetesResourceVerification"])).optional(), PendingPreconditionTypes: z.array(z.string()).optional(), ProjectId: z.string().optional(), QueueTime: z.string().optional(), ReleaseId: z.string().optional(), ReleaseVersion: z.string().optional(), StartTime: z.string().optional(), State: z.enum(["Queued", "Executing", "Failed", "Canceled", "TimedOut", "Success", "Cancelling"]).optional(), TaskId: z.string().optional(), TenantId: z.string().optional()}); export const commitDetails = z.object({Comment: z.string().optional(), Id: z.string().optional(), LinkUrl: z.string().optional()}); export const workItemLink = z.object({Description: z.string().optional(), Id: z.string().optional(), LinkUrl: z.string().optional(), Source: z.string().optional()}); export const releasePackageVersionBuildInformationResource = z.object({Branch: z.string().optional(), BuildEnvironment: z.string().optional(), BuildNumber: z.string().optional(), BuildUrl: z.string().optional(), Commits: z.array(commitDetails).optional(), IssueTrackerName: z.string().optional(), PackageId: z.string().optional(), VcsCommitNumber: z.string().optional(), VcsCommitUrl: z.string().optional(), VcsRoot: z.string().optional(), VcsType: z.string().optional(), Version: z.string().optional(), WorkItems: z.array(workItemLink).optional()}); export const gitReferenceResource = z.object({GitCommit: z.string().optional(), GitRef: z.string().optional()}); export const selectedGitResource = z.object({ActionName: z.string().min(1), GitReferenceResource: gitReferenceResource, GitResourceReferenceName: z.string().optional()}); export const selectedPackage = z.object({ActionName: z.string().optional(), PackageReferenceName: z.string().optional(), StepName: z.string().optional(), Version: z.string().optional()}); export const snapshotGitReferenceResource = z.object({GitCommit: z.string().optional(), GitRef: z.string().optional(), VariablesGitCommit: z.string().optional()}); export const releaseResource = z.object({Assembled: z.string().optional(), BuildInformation: z.array(releasePackageVersionBuildInformationResource).optional(), ChannelId: z.string().optional(), CustomFields: z.record(z.string(), z.string()).optional(), Id: z.string().optional(), IgnoreChannelRules: z.boolean().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), LibraryVariableSetSnapshotIds: z.array(z.string()).optional(), Links: z.record(z.string(), z.string()).optional(), ProjectDeploymentProcessSnapshotId: z.string().optional(), ProjectId: z.string().optional(), ProjectVariableSetSnapshotId: z.string().optional(), ReleaseNotes: z.string().optional(), SelectedGitResources: z.array(selectedGitResource).optional(), SelectedPackages: z.array(selectedPackage).optional(), SpaceId: z.string().optional(), VariableSnapshotConcurrencyToken: z.string().optional(), Version: z.string().max(349), VersionControlReference: snapshotGitReferenceResource.optional()}); export const retentionPeriod = z.object({QuantityToKeep: z.number().int().optional(), ShouldKeepForever: z.boolean().optional(), Strategy: z.string().optional(), Unit: z.enum(["Days", "Items"]).optional()}); export const releaseProgressionResource = z.object({Channel: channelResource.optional(), Deployments: z.record(z.string(), z.array(dashboardItemResource)).optional(), HasUnresolvedDefect: z.boolean().optional(), NextDeployments: z.array(z.string()).optional(), Release: releaseResource.optional(), ReleaseRetentionPeriod: retentionPeriod.optional(), TentacleRetentionPeriod: retentionPeriod.optional()}); export const progressionResource = z.object({ChannelEnvironments: z.record(z.string(), z.array(referenceDataItem)).optional(), Environments: z.array(referenceDataItem).optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), LifecycleEnvironments: z.record(z.string(), z.array(referenceDataItem)).optional(), Links: z.record(z.string(), z.string()).optional(), Releases: z.array(releaseProgressionResource).optional()}); export const getProjectProgressionResponse = z.object({Progression: progressionResource}); 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 }; /** * Get the progress of a release in the environment lifecycle. * * GET /spaces/{spaceIdentifier}/projects/{projectId}/progression/v1 * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiSpacesSpaceIdentifierProjectsProjectIdProgressionV1 = async (args: GetApiSpacesSpaceIdentifierProjectsProjectIdProgressionV1Args, options?: GetApiSpacesSpaceIdentifierProjectsProjectIdProgressionV1Options) => { const {baseUrl = "https://demo.octopus.app/api", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.releaseHistoryCount != null) query.append("releaseHistoryCount", String(args.releaseHistoryCount)) if (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/spaces/${encodeURIComponent(String(args.spaceIdentifier))}/projects/${encodeURIComponent(String(args.projectId))}/progression/v1${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(getProjectProgressionResponse, await res.json()) };