import {z} from 'zod' export type GetApiDocumentsDocumentIdArgs = {documentId: string, include?: string | undefined}; export type GetApiDocumentsDocumentIdOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const documentType = z.enum(["Notice", "Rule", "Proposed Rule", "Supporting & Related Material", "Other"]); export const fileFormat = z.object({fileUrl: z.string().optional(), format: z.string().optional(), size: z.number().int().optional()}); export const documentDetail = z.object({address1: z.string().nullable().optional(), address2: z.string().nullable().optional(), agencyId: z.string().optional(), city: z.string().nullable().optional(), category: z.string().nullable().optional(), comment: z.string().optional(), country: z.string().nullable().optional(), docAbstract: z.string().optional(), docketId: z.string().optional(), documentType: documentType.optional(), email: z.string().nullable().optional(), fax: z.string().nullable().optional(), field1: z.string().nullable().optional(), field2: z.string().nullable().optional(), fileFormats: z.array(fileFormat).optional(), firstName: z.string().nullable().optional(), govAgency: z.string().nullable().optional(), govAgencyType: z.string().nullable().optional(), lastName: z.string().nullable().optional(), legacyId: z.string().nullable().optional(), modifyDate: z.string().optional(), objectId: z.string().optional(), openForComment: z.boolean().optional(), organization: z.string().nullable().optional(), originalDocumentId: z.string().optional(), pageCount: z.string().nullable().optional(), phone: z.string().nullable().optional(), postedDate: z.string().optional(), postmarkDate: z.string().nullable().optional(), reasonWithdrawn: z.string().nullable().optional(), receiveDate: z.string().optional(), restrictReason: z.string().optional(), restrictReasonType: z.string().optional(), stateProvinceRegion: z.string().nullable().optional(), subtype: z.string().nullable().optional(), title: z.string().optional(), trackingNbr: z.string().optional(), withdrawn: z.boolean().optional(), zip: z.string().optional(), additionalRins: z.array(z.string()).nullable().optional(), allowLateComments: z.boolean().optional(), authorDate: z.string().nullable().optional(), authors: z.array(z.string()).nullable().optional(), cfrPart: z.string().nullable().optional(), commentEndDate: z.string().nullable().optional(), commentStartDate: z.string().nullable().optional(), effectiveDate: z.string().nullable().optional(), exhibitLocation: z.string().nullable().optional(), exhibitType: z.string().nullable().optional(), frDocNum: z.string().nullable().optional(), frVolNum: z.string().nullable().optional(), implementationDate: z.string().nullable().optional(), media: z.string().nullable().optional(), ombApproval: z.string().nullable().optional(), paperLength: z.number().int().optional(), paperWidth: z.number().int().optional(), regWriterInstruction: z.string().nullable().optional(), sourceCitation: z.string().nullable().optional(), startEndPage: z.string().nullable().optional(), subject: z.string().nullable().optional(), topics: z.array(z.string()).nullable().optional()}); export const relationshipToAttachment = z.array(z.object({type: z.string().optional(), id: z.string().optional()})); export const link = z.string(); export const relationshipLinks = z.object({self: link.optional(), related: link.optional()}); export const relationship = z.object({data: relationshipToAttachment.optional(), links: relationshipLinks.optional()}); export const selfLink = z.object({self: link.optional()}); export const attachment = z.object({agencyNote: z.string().optional(), authors: z.array(z.string()).optional(), docAbstract: z.string().optional(), docOrder: z.number().int().optional(), fileFormats: z.array(fileFormat).optional(), modifyDate: z.string().optional(), publication: z.string().optional(), restrictReason: z.string().optional(), restrictReasonType: z.string().optional(), title: z.string().optional()}); export const attachmentFindAllItem = z.object({id: z.string().optional(), type: z.string().optional(), attributes: attachment.optional(), links: z.array(selfLink).optional()}); export const documentFindOneResponse = z.object({id: z.string().optional(), type: z.string().optional(), attributes: documentDetail.optional(), relationships: relationship.optional(), links: z.array(selfLink).optional(), included: z.array(attachmentFindAllItem).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 detailed information for specified documentId * * GET /documents/{documentId} */ export const getApiDocumentsDocumentId = async (args: GetApiDocumentsDocumentIdArgs, options?: GetApiDocumentsDocumentIdOptions) => { const {baseUrl = "https://api.regulations.gov/v4", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") if (args.include != null) query.append("include", String(args.include)) if (ApiKeyAuth !== undefined) headers.set("X-Api-Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/documents/${encodeURIComponent(String(args.documentId))}${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(documentFindOneResponse, await res.json()) };