import {z} from 'zod' export type GetApiSpaceIdReleasesArgs = {spaceId: string, skip?: number | undefined, take?: number | undefined}; export type GetApiSpaceIdReleasesOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; 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 releaseResourceCollection = z.object({Id: z.string().optional(), Items: z.array(releaseResource).optional(), ItemsPerPage: z.number().int().optional(), ItemType: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), LastPageNumber: z.number().int().optional(), Links: z.record(z.string(), z.string()).optional(), NumberOfPages: z.number().int().optional(), TotalResults: z.number().int().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 }; /** * Get a list of Releases for the given Space. * * GET /{spaceId}/releases * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiSpaceIdReleases = async (args: GetApiSpaceIdReleasesArgs, options?: GetApiSpaceIdReleasesOptions) => { 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.skip != null) query.append("skip", String(args.skip)) if (args.take != null) query.append("take", String(args.take)) if (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/${encodeURIComponent(String(args.spaceId))}/releases${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(releaseResourceCollection, await res.json()) };