@amerged/ohmyhost-sdk 0.1.44 → 0.1.45

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amerged/ohmyhost-sdk",
-  "version": "0.1.44",
+  "version": "0.1.45",
   "type": "module",
   "engines": {
     "node": ">=22"

package/src/packages/sdk-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ohmyhost/sdk-ts",
-  "version": "0.1.44",
+  "version": "0.1.45",
   "private": true,
   "type": "module",
   "exports": {

package/src/packages/sdk-ts/src/generated/index.ts

@@ -23,6 +23,7 @@ export {
   createOrganization,
   createProject,
   createProjectDatabaseAccess,
+  createProjectDatabaseWatch,
   createProjectDatabaseWebhook,
   createProjectDataChange,
   createProjectDevAccessTicket,
@@ -35,6 +36,7 @@ export {
   deletePaidProjectDomain,
   deleteProject,
   deleteProjectDatabaseSchedule,
+  deleteProjectDatabaseWatch,
   deleteProjectDatabaseWebhook,
   detachProjectMailDomainBinding,
   diffManagedSource,
@@ -91,6 +93,7 @@ export {
   listProjectDatabaseAccess,
   listProjectDatabaseScheduleRuns,
   listProjectDatabaseSchedules,
+  listProjectDatabaseWatches,
   listProjectDatabaseWebhookDeliveries,
   listProjectDatabaseWebhooks,
   listProjects,
@@ -271,6 +274,11 @@ export type {
   CreateProjectDatabaseAccessErrors,
   CreateProjectDatabaseAccessResponse,
   CreateProjectDatabaseAccessResponses,
+  CreateProjectDatabaseWatchData,
+  CreateProjectDatabaseWatchError,
+  CreateProjectDatabaseWatchErrors,
+  CreateProjectDatabaseWatchResponse,
+  CreateProjectDatabaseWatchResponses,
   CreateProjectDatabaseWebhookData,
   CreateProjectDatabaseWebhookError,
   CreateProjectDatabaseWebhookErrors,
@@ -325,6 +333,11 @@ export type {
   DatabaseScheduleRunAccepted,
   DatabaseScheduleRunPage,
   DatabaseScheduleSetRequest,
+  DatabaseWatch,
+  DatabaseWatchCreateRequest,
+  DatabaseWatchDeleted,
+  DatabaseWatchId,
+  DatabaseWatchPage,
   DatabaseWebhook,
   DatabaseWebhookCreated,
   DatabaseWebhookCreateRequest,
@@ -332,6 +345,8 @@ export type {
   DatabaseWebhookDelivery,
   DatabaseWebhookDeliveryId,
   DatabaseWebhookDeliveryPage,
+  DatabaseWebhookEventPattern,
+  DatabaseWebhookEventPatternWritable,
   DatabaseWebhookEventType,
   DatabaseWebhookId,
   DatabaseWebhookPage,
@@ -364,6 +379,11 @@ export type {
   DeleteProjectDatabaseScheduleErrors,
   DeleteProjectDatabaseScheduleResponse,
   DeleteProjectDatabaseScheduleResponses,
+  DeleteProjectDatabaseWatchData,
+  DeleteProjectDatabaseWatchError,
+  DeleteProjectDatabaseWatchErrors,
+  DeleteProjectDatabaseWatchResponse,
+  DeleteProjectDatabaseWatchResponses,
   DeleteProjectDatabaseWebhookData,
   DeleteProjectDatabaseWebhookError,
   DeleteProjectDatabaseWebhookErrors,
@@ -685,6 +705,11 @@ export type {
   ListProjectDatabaseSchedulesErrors,
   ListProjectDatabaseSchedulesResponse,
   ListProjectDatabaseSchedulesResponses,
+  ListProjectDatabaseWatchesData,
+  ListProjectDatabaseWatchesError,
+  ListProjectDatabaseWatchesErrors,
+  ListProjectDatabaseWatchesResponse,
+  ListProjectDatabaseWatchesResponses,
   ListProjectDatabaseWebhookDeliveriesData,
   ListProjectDatabaseWebhookDeliveriesError,
   ListProjectDatabaseWebhookDeliveriesErrors,

package/src/packages/sdk-ts/src/generated/sdk.gen.ts

@@ -60,6 +60,8 @@ import type {
   CreateOrganizationResponses,
   CreateProjectDatabaseAccessErrors,
   CreateProjectDatabaseAccessResponses,
+  CreateProjectDatabaseWatchErrors,
+  CreateProjectDatabaseWatchResponses,
   CreateProjectDatabaseWebhookErrors,
   CreateProjectDatabaseWebhookResponses,
   CreateProjectDataChangeErrors,
@@ -77,6 +79,7 @@ import type {
   CreateWorkspaceMailDomainRequest,
   CreateWorkspaceMailDomainResponses,
   DatabaseScheduleSetRequest,
+  DatabaseWatchCreateRequest,
   DatabaseWebhookCreateRequest,
   DeclareApplicationDomainIdentityErrors,
   DeclareApplicationDomainIdentityResponses,
@@ -88,6 +91,8 @@ import type {
   DeletePaidProjectDomainResponses,
   DeleteProjectDatabaseScheduleErrors,
   DeleteProjectDatabaseScheduleResponses,
+  DeleteProjectDatabaseWatchErrors,
+  DeleteProjectDatabaseWatchResponses,
   DeleteProjectDatabaseWebhookErrors,
   DeleteProjectDatabaseWebhookResponses,
   DeleteProjectErrors,
@@ -204,6 +209,8 @@ import type {
   ListProjectDatabaseScheduleRunsResponses,
   ListProjectDatabaseSchedulesErrors,
   ListProjectDatabaseSchedulesResponses,
+  ListProjectDatabaseWatchesErrors,
+  ListProjectDatabaseWatchesResponses,
   ListProjectDatabaseWebhookDeliveriesErrors,
   ListProjectDatabaseWebhookDeliveriesResponses,
   ListProjectDatabaseWebhooksErrors,
@@ -4759,6 +4766,149 @@ export const revokeProjectDatabaseAccess = <ThrowOnError extends boolean = true>
   });
 };
 
+/**
+ * List the project's database watches
+ *
+ * Returns every watch of the selected environment. Listing wakes a sleeping database.
+ */
+export const listProjectDatabaseWatches = <ThrowOnError extends boolean = true>(
+  parameters: {
+    "X-Request-Id"?: string;
+    project_id: Ulid;
+    environment?: "dev" | "prod";
+  },
+  options?: Options<never, ThrowOnError>,
+): RequestResult<
+  ListProjectDatabaseWatchesResponses,
+  ListProjectDatabaseWatchesErrors,
+  ThrowOnError,
+  "data"
+> => {
+  const params = buildClientParams(
+    [parameters],
+    [
+      {
+        args: [
+          { in: "headers", key: "X-Request-Id" },
+          { in: "path", key: "project_id" },
+          { in: "query", key: "environment" },
+        ],
+      },
+    ],
+  );
+  return (options?.client ?? client).get<
+    ListProjectDatabaseWatchesResponses,
+    ListProjectDatabaseWatchesErrors,
+    ThrowOnError,
+    "data"
+  >({
+    responseStyle: "data",
+    security: [{ scheme: "bearer", type: "http" }],
+    url: "/v1/projects/{project_id}/database/watches",
+    ...options,
+    ...params,
+  });
+};
+
+/**
+ * Watch the columns of one table for data events
+ *
+ * Attaches the pgcf.capture trigger that publishes only the listed columns of the table as data events of one environment. Subscribe to the returned event_type with a database webhook. The request wakes a sleeping database. Repeating an identical request leaves the watch unchanged; repeating it with other columns or operations replaces the trigger. A reached Stop budget refuses with project_budget_exceeded (402). At most 100 watches exist per database.
+ */
+export const createProjectDatabaseWatch = <ThrowOnError extends boolean = true>(
+  parameters: {
+    "X-Request-Id"?: string;
+    "Idempotency-Key": string;
+    project_id: Ulid;
+    databaseWatchCreateRequest: DatabaseWatchCreateRequest;
+  },
+  options?: Options<never, ThrowOnError>,
+): RequestResult<
+  CreateProjectDatabaseWatchResponses,
+  CreateProjectDatabaseWatchErrors,
+  ThrowOnError,
+  "data"
+> => {
+  const params = buildClientParams(
+    [parameters],
+    [
+      {
+        args: [
+          { in: "headers", key: "X-Request-Id" },
+          { in: "headers", key: "Idempotency-Key" },
+          { in: "path", key: "project_id" },
+          { key: "databaseWatchCreateRequest", map: "body" },
+        ],
+      },
+    ],
+  );
+  return (options?.client ?? client).post<
+    CreateProjectDatabaseWatchResponses,
+    CreateProjectDatabaseWatchErrors,
+    ThrowOnError,
+    "data"
+  >({
+    responseStyle: "data",
+    security: [{ scheme: "bearer", type: "http" }],
+    url: "/v1/projects/{project_id}/database/watches",
+    ...options,
+    ...params,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+      ...params.headers,
+    },
+  });
+};
+
+/**
+ * Delete one database watch
+ *
+ * Removes the capture trigger of the watch, so its table publishes no more data events. Deleting an already deleted watch answers not found. A reached Stop budget refuses with project_budget_exceeded (402).
+ */
+export const deleteProjectDatabaseWatch = <ThrowOnError extends boolean = true>(
+  parameters: {
+    "X-Request-Id"?: string;
+    "Idempotency-Key": string;
+    project_id: Ulid;
+    watch_id: string;
+    environment: "dev" | "prod";
+  },
+  options?: Options<never, ThrowOnError>,
+): RequestResult<
+  DeleteProjectDatabaseWatchResponses,
+  DeleteProjectDatabaseWatchErrors,
+  ThrowOnError,
+  "data"
+> => {
+  const params = buildClientParams(
+    [parameters],
+    [
+      {
+        args: [
+          { in: "headers", key: "X-Request-Id" },
+          { in: "headers", key: "Idempotency-Key" },
+          { in: "path", key: "project_id" },
+          { in: "path", key: "watch_id" },
+          { in: "query", key: "environment" },
+        ],
+      },
+    ],
+  );
+  return (options?.client ?? client).delete<
+    DeleteProjectDatabaseWatchResponses,
+    DeleteProjectDatabaseWatchErrors,
+    ThrowOnError,
+    "data"
+  >({
+    responseStyle: "data",
+    security: [{ scheme: "bearer", type: "http" }],
+    url: "/v1/projects/{project_id}/database/watches/{watch_id}",
+    ...options,
+    ...params,
+  });
+};
+
 /**
  * List the project's database webhooks
  *

package/src/packages/sdk-ts/src/generated/types.gen.ts

@@ -957,12 +957,63 @@ export type DatabaseWebhookEventType =
   | "database.resized"
   | "database.deleted";
 
+/**
+ * A platform event type, data.<topic> for the rows of one watched table, or data.* for every watched table. A bare * is not accepted and never matches data events.
+ */
+export type DatabaseWebhookEventPattern = DatabaseWebhookEventType | string;
+
+export type DatabaseWatchCreateRequest = {
+  environment: "dev" | "prod";
+  /**
+   * Schema of the table, public when omitted. The schemas pgcf, ohmyhost, information_schema and pg_* cannot be watched.
+   */
+  schema?: string;
+  /**
+   * Ordinary table owned by the application, created by a deployed migration.
+   */
+  table: string;
+  /**
+   * Columns published with every event, exactly as written; names are case-sensitive.
+   */
+  columns: Array<string>;
+  /**
+   * Row changes that publish an event; all three when omitted.
+   */
+  operations?: Array<"insert" | "update" | "delete">;
+};
+
+export type DatabaseWatch = {
+  id: string;
+  environment: "dev" | "prod";
+  schema: string;
+  table: string;
+  columns: Array<string>;
+  operations: Array<"insert" | "update" | "delete">;
+  /**
+   * Topic of the watched table, derived by the platform from its name.
+   */
+  topic: string;
+  /**
+   * Event type of the rows of the table; pass it to a database webhook.
+   */
+  event_type: string;
+};
+
+export type DatabaseWatchPage = {
+  items: Array<DatabaseWatch>;
+};
+
+export type DatabaseWatchDeleted = {
+  id: string;
+  deleted: true;
+};
+
 export type DatabaseWebhookCreateRequest = {
   /**
    * HTTPS receiver URL.
    */
   url: string;
-  event_types: Array<DatabaseWebhookEventType>;
+  event_types: Array<DatabaseWebhookEventPattern>;
   /**
    * Extra headers sent with every delivery. Names are case-insensitive and must be unique; content-type, host, content-length, connection, transfer-encoding, user-agent, te, upgrade, expect and any name starting with pgcf-, cf- or x-forwarded- are refused.
    */
@@ -975,7 +1026,7 @@ export type DatabaseWebhook = {
   id: string;
   environment: "dev" | "prod";
   url: string;
-  event_types: Array<DatabaseWebhookEventType>;
+  event_types: Array<DatabaseWebhookEventPattern>;
   /**
    * Names of the extra headers only; their values are never returned.
    */
@@ -987,7 +1038,7 @@ export type DatabaseWebhookCreated = {
   id: string;
   environment: "dev" | "prod";
   url: string;
-  event_types: Array<DatabaseWebhookEventType>;
+  event_types: Array<DatabaseWebhookEventPattern>;
   header_names: Array<string>;
   created_at: string;
   /**
@@ -1008,7 +1059,7 @@ export type DatabaseWebhookDeleted = {
 export type DatabaseWebhookDelivery = {
   id: string;
   event_id: string;
-  event_type: DatabaseWebhookEventType;
+  event_type: DatabaseWebhookEventType | string;
   webhook_id: string;
   state: "pending" | "delivered" | "dead_lettered";
   attempts: number;
@@ -1605,6 +1656,11 @@ export type ProblemDetails = {
     | "database_schedule_limit"
     | "database_schedule_not_runnable"
     | "database_webhook_delivery_pending"
+    | "database_watch_limit"
+    | "database_watch_table_unavailable"
+    | "database_watch_column_unavailable"
+    | "database_watch_events_unavailable"
+    | "database_watch_conflict"
     | "compute_change_pending"
     | "compute_change_conflict"
     | "billing_purchase_conflict"
@@ -1910,6 +1966,11 @@ export type ProjectDataChangePlan = {
   expires_at: string;
 };
 
+/**
+ * A platform event type, data.<topic> for the rows of one watched table, or data.* for every watched table. A bare * is not accepted and never matches data events.
+ */
+export type DatabaseWebhookEventPatternWritable = DatabaseWebhookEventType | string;
+
 /**
  * Immutable pre-build deployment plan. It expires exactly 24 hours after creation.
  */
@@ -2004,6 +2065,11 @@ export type DatabaseWebhookId = string;
  */
 export type DatabaseWebhookDeliveryId = string;
 
+/**
+ * Database watch identifier, derived from the watched schema and table.
+ */
+export type DatabaseWatchId = string;
+
 /**
  * Database schedule name, unique per project environment.
  */
@@ -8116,6 +8182,202 @@ export type RevokeProjectDatabaseAccessResponses = {
 export type RevokeProjectDatabaseAccessResponse =
   RevokeProjectDatabaseAccessResponses[keyof RevokeProjectDatabaseAccessResponses];
 
+export type ListProjectDatabaseWatchesData = {
+  body?: never;
+  headers?: {
+    /**
+     * Optional caller-provided correlation identifier.
+     */
+    "X-Request-Id"?: string;
+  };
+  path: {
+    /**
+     * Project identifier.
+     */
+    project_id: Ulid;
+  };
+  query?: {
+    /**
+     * Application environment to read; dev when omitted.
+     */
+    environment?: "dev" | "prod";
+  };
+  url: "/v1/projects/{project_id}/database/watches";
+};
+
+export type ListProjectDatabaseWatchesErrors = {
+  /**
+   * The request failed.
+   */
+  400: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  401: ProblemDetails;
+  /**
+   * The resource does not exist or is not visible to the authenticated principal.
+   */
+  404: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  429: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  503: ProblemDetails;
+};
+
+export type ListProjectDatabaseWatchesError =
+  ListProjectDatabaseWatchesErrors[keyof ListProjectDatabaseWatchesErrors];
+
+export type ListProjectDatabaseWatchesResponses = {
+  /**
+   * The database watches of the environment.
+   */
+  200: DatabaseWatchPage;
+};
+
+export type ListProjectDatabaseWatchesResponse =
+  ListProjectDatabaseWatchesResponses[keyof ListProjectDatabaseWatchesResponses];
+
+export type CreateProjectDatabaseWatchData = {
+  body: DatabaseWatchCreateRequest;
+  headers: {
+    /**
+     * Optional caller-provided correlation identifier.
+     */
+    "X-Request-Id"?: string;
+    /**
+     * Identifies one mutation and its canonical request payload.
+     */
+    "Idempotency-Key": string;
+  };
+  path: {
+    /**
+     * Project identifier.
+     */
+    project_id: Ulid;
+  };
+  query?: never;
+  url: "/v1/projects/{project_id}/database/watches";
+};
+
+export type CreateProjectDatabaseWatchErrors = {
+  /**
+   * The request failed.
+   */
+  400: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  401: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  402: ProblemDetails;
+  /**
+   * The resource does not exist or is not visible to the authenticated principal.
+   */
+  404: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  409: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  429: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  503: ProblemDetails;
+};
+
+export type CreateProjectDatabaseWatchError =
+  CreateProjectDatabaseWatchErrors[keyof CreateProjectDatabaseWatchErrors];
+
+export type CreateProjectDatabaseWatchResponses = {
+  /**
+   * The watch with the event type its deliveries carry.
+   */
+  201: DatabaseWatch;
+};
+
+export type CreateProjectDatabaseWatchResponse =
+  CreateProjectDatabaseWatchResponses[keyof CreateProjectDatabaseWatchResponses];
+
+export type DeleteProjectDatabaseWatchData = {
+  body?: never;
+  headers: {
+    /**
+     * Optional caller-provided correlation identifier.
+     */
+    "X-Request-Id"?: string;
+    /**
+     * Identifies one mutation and its canonical request payload.
+     */
+    "Idempotency-Key": string;
+  };
+  path: {
+    /**
+     * Project identifier.
+     */
+    project_id: Ulid;
+    /**
+     * Database watch identifier, derived from the watched schema and table.
+     */
+    watch_id: string;
+  };
+  query: {
+    /**
+     * Application environment the mutation applies to.
+     */
+    environment: "dev" | "prod";
+  };
+  url: "/v1/projects/{project_id}/database/watches/{watch_id}";
+};
+
+export type DeleteProjectDatabaseWatchErrors = {
+  /**
+   * The request failed.
+   */
+  400: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  401: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  402: ProblemDetails;
+  /**
+   * The resource does not exist or is not visible to the authenticated principal.
+   */
+  404: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  429: ProblemDetails;
+  /**
+   * The request failed.
+   */
+  503: ProblemDetails;
+};
+
+export type DeleteProjectDatabaseWatchError =
+  DeleteProjectDatabaseWatchErrors[keyof DeleteProjectDatabaseWatchErrors];
+
+export type DeleteProjectDatabaseWatchResponses = {
+  /**
+   * The identifier of the deleted watch.
+   */
+  200: DatabaseWatchDeleted;
+};
+
+export type DeleteProjectDatabaseWatchResponse =
+  DeleteProjectDatabaseWatchResponses[keyof DeleteProjectDatabaseWatchResponses];
+
 export type ListProjectDatabaseWebhooksData = {
   body?: never;
   headers?: {