@proteos/sdk 0.51.1 → 0.53.0

package/src/meta/list-extensions.ts

@@ -0,0 +1,98 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type {
+  CreateListExtensionRequest,
+  ListExtension,
+  ListListExtensionsOptions,
+  UpdateListExtensionRequest,
+} from './types.js'
+
+const LIST_EXTENSIONS_BASE_PATH = '/meta/v1/list-extensions'
+
+/**
+ * Service for entity extensions — attributes contributed to an EXISTING host
+ * entity by a resource that does not own it (typically a second module). The
+ * host's `attributes` are the materialized merge: its own attributes plus every
+ * extension's, each stamped with `extension_key`. Every write here
+ * re-materializes the host; an attribute name shared with the host or another
+ * extension is refused (`entity_extension_attribute_collision`).
+ */
+export interface ListExtensionService {
+  /** Lists entity extensions (auto-paginating iterator). */
+  list(
+    options?: ListListExtensionsOptions,
+  ): PageIterator<ListExtension, ListListExtensionsOptions>
+
+  /** Fetches a single page of entity extensions. */
+  listPage(options?: ListListExtensionsOptions): Promise<ListResult<ListExtension>>
+
+  /** Gets an entity extension by key (404 when unknown). */
+  get(key: string): Promise<ListExtension>
+
+  /**
+   * Creates an entity extension and merges its attributes into the host.
+   * @throws {ProteosError} 409 `entity_extension_already_exists` when the key
+   *   is taken; 400 `entity_extension_entity_not_found` when the host does
+   *   not exist; 400 `entity_extension_attribute_collision` on a name clash.
+   */
+  create(request: CreateListExtensionRequest): Promise<ListExtension>
+
+  /**
+   * Creates or replaces an entity extension idempotently by key
+   * (`PUT /meta/v1/list-extensions/:key`). Replaces the whole definition;
+   * the host binding (`list_slug`) of an existing key is immutable.
+   */
+  upsert(key: string, request: CreateListExtensionRequest): Promise<ListExtension>
+
+  /** Partially updates an entity extension (`attributes` replaces the whole list). */
+  update(key: string, request: UpdateListExtensionRequest): Promise<ListExtension>
+
+  /** Deletes an entity extension and removes its attributes from the host. */
+  delete(key: string): Promise<void>
+}
+
+export class ListExtensionServiceImpl implements ListExtensionService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(
+    options: ListListExtensionsOptions = {},
+  ): PageIterator<ListExtension, ListListExtensionsOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(options: ListListExtensionsOptions = {}): Promise<ListResult<ListExtension>> {
+    return this.client.requestWithQuery<ListResult<ListExtension>>(
+      'GET',
+      LIST_EXTENSIONS_BASE_PATH,
+      options,
+    )
+  }
+
+  async get(key: string): Promise<ListExtension> {
+    return this.client.request<ListExtension>('GET', `${LIST_EXTENSIONS_BASE_PATH}/${key}`)
+  }
+
+  async create(request: CreateListExtensionRequest): Promise<ListExtension> {
+    return this.client.request<ListExtension>('POST', LIST_EXTENSIONS_BASE_PATH, request)
+  }
+
+  async upsert(key: string, request: CreateListExtensionRequest): Promise<ListExtension> {
+    return this.client.request<ListExtension>('PUT', `${LIST_EXTENSIONS_BASE_PATH}/${key}`, {
+      ...request,
+      key,
+    })
+  }
+
+  async update(key: string, request: UpdateListExtensionRequest): Promise<ListExtension> {
+    return this.client.request<ListExtension>(
+      'PATCH',
+      `${LIST_EXTENSIONS_BASE_PATH}/${key}`,
+      request,
+    )
+  }
+
+  async delete(key: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${LIST_EXTENSIONS_BASE_PATH}/${key}`)
+  }
+}

package/src/meta/menu-configuration-extensions.ts

@@ -0,0 +1,132 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type {
+  CreateMenuConfigurationExtensionRequest,
+  ListMenuConfigurationExtensionsOptions,
+  MenuConfigurationExtension,
+  UpdateMenuConfigurationExtensionRequest,
+} from './types.js'
+
+const MENU_CONFIGURATION_EXTENSIONS_BASE_PATH = '/meta/v1/menu-configuration-extensions'
+
+/**
+ * Service for menu-configuration extensions — items contributed to an EXISTING
+ * host menu configuration by a resource that does not own it (typically a
+ * second module). The host's `items` are the materialized merge: its own tree
+ * plus every extension's placements, each contributed item stamped with
+ * `extension_key` (a replaced / removed host item kept under `replaced_item`).
+ * Every write here re-materializes the host; an item id shared with the host
+ * or another extension is refused
+ * (`menu_configuration_extension_item_id_collision`), an anchor the host does
+ * not have too (`menu_configuration_extension_anchor_not_found`).
+ */
+export interface MenuConfigurationExtensionService {
+  /** Lists menu-configuration extensions (auto-paginating iterator). */
+  list(
+    options?: ListMenuConfigurationExtensionsOptions,
+  ): PageIterator<MenuConfigurationExtension, ListMenuConfigurationExtensionsOptions>
+
+  /** Fetches a single page of menu-configuration extensions. */
+  listPage(
+    options?: ListMenuConfigurationExtensionsOptions,
+  ): Promise<ListResult<MenuConfigurationExtension>>
+
+  /** Gets a menu-configuration extension by key (404 when unknown). */
+  get(key: string): Promise<MenuConfigurationExtension>
+
+  /**
+   * Creates a menu-configuration extension and merges its items into the host.
+   * @throws {ProteosError} 409 `menu_configuration_extension_already_exists`
+   *   when the key is taken; 400 `menu_configuration_extension_menu_not_found`
+   *   when the host does not exist; 400
+   *   `menu_configuration_extension_anchor_not_found` /
+   *   `menu_configuration_extension_item_id_collision` on a bad placement.
+   */
+  create(request: CreateMenuConfigurationExtensionRequest): Promise<MenuConfigurationExtension>
+
+  /**
+   * Creates or replaces a menu-configuration extension idempotently by key
+   * (`PUT /meta/v1/menu-configuration-extensions/:key`). Replaces the whole definition;
+   * the host binding (`menu_slug`) of an existing key is immutable.
+   */
+  upsert(
+    key: string,
+    request: CreateMenuConfigurationExtensionRequest,
+  ): Promise<MenuConfigurationExtension>
+
+  /** Partially updates a menu-configuration extension (`placements` replaces the whole list). */
+  update(
+    key: string,
+    request: UpdateMenuConfigurationExtensionRequest,
+  ): Promise<MenuConfigurationExtension>
+
+  /** Deletes a menu-configuration extension and removes its items from the host. */
+  delete(key: string): Promise<void>
+}
+
+export class MenuConfigurationExtensionServiceImpl implements MenuConfigurationExtensionService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(
+    options: ListMenuConfigurationExtensionsOptions = {},
+  ): PageIterator<MenuConfigurationExtension, ListMenuConfigurationExtensionsOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(
+    options: ListMenuConfigurationExtensionsOptions = {},
+  ): Promise<ListResult<MenuConfigurationExtension>> {
+    return this.client.requestWithQuery<ListResult<MenuConfigurationExtension>>(
+      'GET',
+      MENU_CONFIGURATION_EXTENSIONS_BASE_PATH,
+      options,
+    )
+  }
+
+  async get(key: string): Promise<MenuConfigurationExtension> {
+    return this.client.request<MenuConfigurationExtension>(
+      'GET',
+      `${MENU_CONFIGURATION_EXTENSIONS_BASE_PATH}/${key}`,
+    )
+  }
+
+  async create(
+    request: CreateMenuConfigurationExtensionRequest,
+  ): Promise<MenuConfigurationExtension> {
+    return this.client.request<MenuConfigurationExtension>(
+      'POST',
+      MENU_CONFIGURATION_EXTENSIONS_BASE_PATH,
+      request,
+    )
+  }
+
+  async upsert(
+    key: string,
+    request: CreateMenuConfigurationExtensionRequest,
+  ): Promise<MenuConfigurationExtension> {
+    return this.client.request<MenuConfigurationExtension>(
+      'PUT',
+      `${MENU_CONFIGURATION_EXTENSIONS_BASE_PATH}/${key}`,
+      {
+        ...request,
+        key,
+      },
+    )
+  }
+
+  async update(
+    key: string,
+    request: UpdateMenuConfigurationExtensionRequest,
+  ): Promise<MenuConfigurationExtension> {
+    return this.client.request<MenuConfigurationExtension>(
+      'PATCH',
+      `${MENU_CONFIGURATION_EXTENSIONS_BASE_PATH}/${key}`,
+      request,
+    )
+  }
+
+  async delete(key: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${MENU_CONFIGURATION_EXTENSIONS_BASE_PATH}/${key}`)
+  }
+}

package/src/meta/page-extensions.ts

@@ -0,0 +1,98 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type {
+  CreatePageExtensionRequest,
+  PageExtension,
+  ListPageExtensionsOptions,
+  UpdatePageExtensionRequest,
+} from './types.js'
+
+const PAGE_EXTENSIONS_BASE_PATH = '/meta/v1/page-extensions'
+
+/**
+ * Service for entity extensions — attributes contributed to an EXISTING host
+ * entity by a resource that does not own it (typically a second module). The
+ * host's `attributes` are the materialized merge: its own attributes plus every
+ * extension's, each stamped with `extension_key`. Every write here
+ * re-materializes the host; an attribute name shared with the host or another
+ * extension is refused (`entity_extension_attribute_collision`).
+ */
+export interface PageExtensionService {
+  /** Lists entity extensions (auto-paginating iterator). */
+  list(
+    options?: ListPageExtensionsOptions,
+  ): PageIterator<PageExtension, ListPageExtensionsOptions>
+
+  /** Fetches a single page of entity extensions. */
+  listPage(options?: ListPageExtensionsOptions): Promise<ListResult<PageExtension>>
+
+  /** Gets an entity extension by key (404 when unknown). */
+  get(key: string): Promise<PageExtension>
+
+  /**
+   * Creates an entity extension and merges its attributes into the host.
+   * @throws {ProteosError} 409 `entity_extension_already_exists` when the key
+   *   is taken; 400 `entity_extension_entity_not_found` when the host does
+   *   not exist; 400 `entity_extension_attribute_collision` on a name clash.
+   */
+  create(request: CreatePageExtensionRequest): Promise<PageExtension>
+
+  /**
+   * Creates or replaces an entity extension idempotently by key
+   * (`PUT /meta/v1/page-extensions/:key`). Replaces the whole definition;
+   * the host binding (`page_slug`) of an existing key is immutable.
+   */
+  upsert(key: string, request: CreatePageExtensionRequest): Promise<PageExtension>
+
+  /** Partially updates an entity extension (`attributes` replaces the whole list). */
+  update(key: string, request: UpdatePageExtensionRequest): Promise<PageExtension>
+
+  /** Deletes an entity extension and removes its attributes from the host. */
+  delete(key: string): Promise<void>
+}
+
+export class PageExtensionServiceImpl implements PageExtensionService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(
+    options: ListPageExtensionsOptions = {},
+  ): PageIterator<PageExtension, ListPageExtensionsOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(options: ListPageExtensionsOptions = {}): Promise<ListResult<PageExtension>> {
+    return this.client.requestWithQuery<ListResult<PageExtension>>(
+      'GET',
+      PAGE_EXTENSIONS_BASE_PATH,
+      options,
+    )
+  }
+
+  async get(key: string): Promise<PageExtension> {
+    return this.client.request<PageExtension>('GET', `${PAGE_EXTENSIONS_BASE_PATH}/${key}`)
+  }
+
+  async create(request: CreatePageExtensionRequest): Promise<PageExtension> {
+    return this.client.request<PageExtension>('POST', PAGE_EXTENSIONS_BASE_PATH, request)
+  }
+
+  async upsert(key: string, request: CreatePageExtensionRequest): Promise<PageExtension> {
+    return this.client.request<PageExtension>('PUT', `${PAGE_EXTENSIONS_BASE_PATH}/${key}`, {
+      ...request,
+      key,
+    })
+  }
+
+  async update(key: string, request: UpdatePageExtensionRequest): Promise<PageExtension> {
+    return this.client.request<PageExtension>(
+      'PATCH',
+      `${PAGE_EXTENSIONS_BASE_PATH}/${key}`,
+      request,
+    )
+  }
+
+  async delete(key: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${PAGE_EXTENSIONS_BASE_PATH}/${key}`)
+  }
+}