@proteos/sdk 0.18.1

package/src/meta/pages.ts

@@ -0,0 +1,106 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type { CreatePageRequest, ListPagesOptions, Page, UpdatePageRequest } from './types.js'
+
+const PAGES_BASE_PATH = '/meta/v1/pages'
+
+/**
+ * Service for managing page configurations.
+ * Pages define the layout and content of entity detail views.
+ */
+export interface PageService {
+  /**
+   * Lists pages with optional filtering.
+   *
+   * @param options - Filter and pagination options
+   * @returns Async iterator over pages
+   */
+  list(options?: ListPagesOptions): PageIterator<Page, ListPagesOptions>
+
+  /**
+   * Fetches a single page of page configurations.
+   */
+  listPage(options?: ListPagesOptions): Promise<ListResult<Page>>
+
+  /**
+   * Gets a single page by slug.
+   *
+   * @param slug - Page slug (author-controlled, kebab-case, unique per org)
+   * @returns The page
+   * @throws {ProteosError} If page not found (404)
+   */
+  get(slug: string): Promise<Page>
+
+  /**
+   * Creates a new page.
+   *
+   * @param request - Page creation request
+   * @returns The created page
+   * @throws {ProteosError} If validation fails (400) or conflict (409)
+   */
+  create(request: CreatePageRequest): Promise<Page>
+
+  /**
+   * Creates or updates a page idempotently by slug. The URL slug wins on
+   * mismatch with the body's slug field.
+   *
+   * @param slug - Page slug
+   * @param request - Page body
+   * @returns The created or updated page
+   */
+  upsert(slug: string, request: CreatePageRequest): Promise<Page>
+
+  /**
+   * Updates an existing page.
+   *
+   * @param slug - Page slug
+   * @param request - Fields to update
+   * @returns The updated page
+   * @throws {ProteosError} If page not found (404) or validation fails (400)
+   */
+  update(slug: string, request: UpdatePageRequest): Promise<Page>
+
+  /**
+   * Deletes a page.
+   *
+   * @param slug - Page slug
+   * @throws {ProteosError} If page not found (404)
+   */
+  delete(slug: string): Promise<void>
+}
+
+/**
+ * Implementation of PageService.
+ */
+export class PageServiceImpl implements PageService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(options: ListPagesOptions = {}): PageIterator<Page, ListPagesOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(options: ListPagesOptions = {}): Promise<ListResult<Page>> {
+    return this.client.requestWithQuery<ListResult<Page>>('GET', PAGES_BASE_PATH, options)
+  }
+
+  async get(slug: string): Promise<Page> {
+    return this.client.request<Page>('GET', `${PAGES_BASE_PATH}/${slug}`)
+  }
+
+  async create(request: CreatePageRequest): Promise<Page> {
+    return this.client.request<Page>('POST', PAGES_BASE_PATH, request)
+  }
+
+  async upsert(slug: string, request: CreatePageRequest): Promise<Page> {
+    return this.client.request<Page>('PUT', `${PAGES_BASE_PATH}/${slug}`, { ...request, slug })
+  }
+
+  async update(slug: string, request: UpdatePageRequest): Promise<Page> {
+    return this.client.request<Page>('PATCH', `${PAGES_BASE_PATH}/${slug}`, request)
+  }
+
+  async delete(slug: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${PAGES_BASE_PATH}/${slug}`)
+  }
+}