import {z} from 'zod' export type UUID = string; export type ProjectMemberRole = 'viewer' | 'interactive_viewer' | 'editor' | 'developer' | 'admin'; export type GetApiApiV1ProjectsProjectUuidHomepageViewAsArgs = {projectUuid: UUID, targetType: 'user' | 'group' | 'role', userUuid?: UUID | undefined, groupUuid?: UUID | undefined, role?: ProjectMemberRole | undefined}; export type GetApiApiV1ProjectsProjectUuidHomepageViewAsOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const projectMemberRole = z.enum(["viewer", "interactive_viewer", "editor", "developer", "admin"]); export const homepageViewAsReason = z.union([z.object({priority: z.number(), groupUuid: z.string(), type: z.literal("group")}), z.object({role: projectMemberRole, type: z.literal("role")}), z.object({type: z.literal("default")})]); export const homepageMarkdownBlock = z.object({config: z.object({content: z.string()}), type: z.literal("markdown"), id: z.string()}); export const homepageAskAiHeroBlock = z.object({config: z.object({showRecommendedActions: z.boolean().optional(), showGreeting: z.boolean()}), type: z.literal("ask-ai-hero"), id: z.string()}); export const homepageCollectionItemRef = z.object({uuid: z.string(), contentType: z.enum(["chart", "dashboard", "space", "data_app"])}); export const homepageCollectionBlock = z.object({config: z.object({items: z.array(homepageCollectionItemRef), title: z.string()}), type: z.literal("collection"), id: z.string()}); export const homepageResourcesLayout = z.enum(["card", "list"]); export const homepageResourceKind = z.enum(["video", "doc", "link", "claude", "youtube", "data-app"]); export const homepageResourceItem = z.object({appUuid: z.string().optional(), imageUrl: z.string().optional(), description: z.string().optional(), kind: homepageResourceKind, url: z.string(), title: z.string()}); export const homepageResourcesBlock = z.object({config: z.object({layout: homepageResourcesLayout.optional(), items: z.array(homepageResourceItem), title: z.string()}), type: z.literal("resources"), id: z.string()}); export const homepageAnnouncementsBlock = z.object({config: z.object({title: z.string()}), type: z.literal("announcements"), id: z.string()}); export const homepageMetricRef = z.object({label: z.string(), metricName: z.string(), tableName: z.string()}); export const homepageMetricsBlock = z.object({config: z.object({items: z.array(homepageMetricRef), title: z.string()}), type: z.literal("metrics"), id: z.string()}); export const homepageQuickAction = z.union([z.object({type: z.literal("ask-ai")}), z.object({type: z.literal("run-query")}), z.object({type: z.literal("browse-dashboards")}), z.object({type: z.literal("browse-spaces")}), z.object({label: z.string(), dashboardUuid: z.string(), type: z.literal("dashboard")})]); export const homepageQuickActionsBlock = z.object({config: z.object({actions: z.array(homepageQuickAction)}), type: z.literal("quick-actions"), id: z.string()}); export const homepageFavoritesBlock = z.object({config: z.object({title: z.string()}), type: z.literal("favorites"), id: z.string()}); export const homepageRecentBlock = z.object({config: z.object({title: z.string()}), type: z.literal("recent"), id: z.string()}); export const homepageBlock = z.union([homepageMarkdownBlock, homepageAskAiHeroBlock, homepageCollectionBlock, homepageResourcesBlock, homepageAnnouncementsBlock, homepageMetricsBlock, homepageQuickActionsBlock, homepageFavoritesBlock, homepageRecentBlock]); export const homepageRow = z.object({blocks: z.array(homepageBlock), id: z.string()}); export const homepageConfig = z.object({rows: z.array(homepageRow), version: z.literal(1)}); export const publishedProjectHomepage = z.object({config: homepageConfig, name: z.string(), homepageUuid: z.string()}); export const resolvedHomepage = z.object({homepage: publishedProjectHomepage, type: z.literal("homepage")}); export const homepageViewAsResult = z.object({reason: homepageViewAsReason.nullable(), resolved: resolvedHomepage.nullable()}); export const apiHomepageViewAsResponse = z.object({results: homepageViewAsResult, status: z.literal("ok")}); 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 /api/v1/projects/{projectUuid}/homepage/view-as */ export const getApiApiV1ProjectsProjectUuidHomepageViewAs = async (args: GetApiApiV1ProjectsProjectUuidHomepageViewAsArgs, options: GetApiApiV1ProjectsProjectUuidHomepageViewAsOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.targetType != null) query.append("targetType", String(args.targetType)) if (args.userUuid != null) query.append("userUuid", String(args.userUuid)) if (args.groupUuid != null) query.append("groupUuid", String(args.groupUuid)) if (args.role != null) query.append("role", String(args.role)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/projects/${encodeURIComponent(String(args.projectUuid))}/homepage/view-as${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(apiHomepageViewAsResponse, await res.json()) };