import {z} from 'zod' export type ResourceId = string; export type GetApiDocumentsIdArgs = {id: ResourceId}; export type GetApiDocumentsIdOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const resourceId = z.string(); export const regulatoryDocumentType = z.enum(["alert", "announcement", "bill", "circular", "consultation paper", "decision", "enforcement", "general", "guidance", "hearing", "interview", "judgement", "legislation", "letter", "opinion", "parliamentary commentary", "policy paper", "press release", "publication", "resolution", "sanctions", "speech", "statement", "tender", "transcript", "transparency", "warning", "other"]); export const entityType = z.enum(["person", "organisation", "location", "substance", "disease", "product", "regulation"]); export const sentimentLabel = z.enum(["positive", "negative", "neutral"]); export const mention = z.object({position: z.enum(["content", "summary", "title", "quote"]), sentiment: sentimentLabel.optional()}); export const entityWithMentions = z.object({id: resourceId, type: entityType, name: z.string(), sentiment: sentimentLabel, salient: z.boolean().optional(), "salience-rank": z.number().int().gte(1).optional(), mentions: z.array(mention)}); export const source = z.object({id: resourceId, name: z.string(), country: z.string().optional(), subregion: z.string().optional(), region: z.string().optional()}); export const partialTopic = z.object({id: resourceId, name: z.string()}); export const category = z.object({id: resourceId, name: z.string()}); export const mediaType = z.enum(["online", "print"]); export const document = z.object({"story-id": resourceId.optional(), "signal-url": z.string().optional(), "regulatory-document": regulatoryDocumentType.optional(), entities: z.array(entityWithMentions), "published-at": z.string(), source: source, title: z.string(), topics: z.array(partialTopic), categories: z.object({"iptc-media-topics": z.array(category).optional()}).optional(), language: z.string().optional(), id: resourceId, "native-title": z.string().optional(), "media-type": mediaType}); export const documentResponse = z.object({document: document}); 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 document by id * * GET /documents/{id} */ export const getApiDocumentsId = async (args: GetApiDocumentsIdArgs, options?: GetApiDocumentsIdOptions) => { const {baseUrl = "https://api.signal-ai.com", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/documents/${encodeURIComponent(String(args.id))}${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(documentResponse, await res.json()) };