@checkstack/common 0.9.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,111 @@
 # @checkstack/common
 
+## 0.11.0
+
+### Minor Changes
+
+- f23f3c9: Add the canonical `PaginationInput` zod schema and `PaginatedResult`
+  output factory in `@checkstack/common`. `PaginationInput` is an
+  integer-clamped `{ limit: 1-100 (default 20), offset: >= 0 (default 0) }`
+  shape that composes with `.extend({...})` for domain-specific filters
+  (e.g. `unreadOnly` on notifications). `PaginatedResult(itemSchema)`
+  returns the standard `{ items, total, limit, offset }` envelope. The
+  existing `PaginationInputSchema` / `paginatedOutput` / `PaginatedResponse`
+  exports are now marked `@deprecated` and will be removed once the
+  follow-up sweep migrates every `*-common` consumer to the canonical
+  contract.
+- f23f3c9: Sweep every paginated `*-common` contract onto the canonical
+  `PaginationInput` / `PaginatedResult` from `@checkstack/common` and
+  remove the now-unused legacy exports.
+
+  **BREAKING CHANGE** - `@checkstack/common` drops the deprecated
+  `PaginationInputSchema`, `paginatedOutput`, and `PaginatedResponse`
+  symbols. Callers must consume `PaginationInput` (input) and
+  `PaginatedResult(itemSchema)` (output) instead. The canonical input is
+  `{ limit (1-100, default 20), offset (>= 0, default 0) }`; the
+  canonical output envelope is
+  `{ items, total, limit, offset }`.
+
+  **BREAKING CHANGE** - `@checkstack/notification-common` migrates
+  `getNotifications` off the legacy `PaginationInputSchema`
+  (`{ limit, offset, unreadOnly }` with output `{ notifications, total }`)
+  onto `ListNotificationsInputSchema =
+PaginationInput.extend({ unreadOnly })` and
+  `PaginatedResult(NotificationSchema)`. The output key changes from
+  `notifications` to `items`, and `limit` / `offset` are now echoed on
+  the response. The `PaginationInput` type alias previously exported
+  from `notification-common` is removed - use `ListNotificationsInput`
+  or the canonical `PaginationInput` from `@checkstack/common`.
+
+  **BREAKING CHANGE** - `@checkstack/integration-common` migrates
+  `listSubscriptions` (inline `{ page, pageSize, ... }` -> output
+  `{ subscriptions, total }`) and `getDeliveryLogs` (via
+  `DeliveryLogQueryInputSchema` `{ subscriptionId?, eventType?, status?,
+page, pageSize }` -> output `{ logs, total }`) onto the canonical
+  `PaginationInput.extend({...})` input and
+  `PaginatedResult(itemSchema)` output. External callers must switch
+  from `{ page, pageSize }` to `{ limit, offset }` and read response
+  items from `data.items` (no more `data.subscriptions` / `data.logs`).
+
+  The matching `*-backend` handlers were updated to consume the new
+  input shape (`offset` arithmetic in lieu of `(page - 1) * pageSize`)
+  and to echo `limit` / `offset` on the response. The `*-frontend` call
+  sites in `NotificationsPage`, `NotificationBell`, `IntegrationsPage`,
+  and `DeliveryLogsPage` were updated to send the new input shape and
+  read `data.items`.
+
+## 0.10.0
+
+### Minor Changes
+
+- 9016526: Add a `/rest/:pluginId/*` HTTP mount that serves every plugin's oRPC contract
+  through the REST/OpenAPI shape described by `/api/openapi.json`. Queries are
+  `GET` with query parameters, mutations are `POST` with the input as the raw
+  JSON body. The existing `/api/:pluginId/*` mount continues to serve oRPC's
+  native wire protocol unchanged, so existing clients are not affected.
+
+  The OpenAPI spec at `/api/openapi.json` now reflects the real mount: every
+  `paths` entry is prefixed with `/rest` instead of `/api`.
+
+  Also fixes a SPA-fallback bug: the backend's `/api-docs` route previously
+  returned 404 on production deployments because the static-file middleware
+  skipped any path starting with `/api`, capturing `/api-docs` along with real
+  API routes. The skip now requires a trailing slash (`/api/`, `/rest/`).
+
+  Required access rules are now visible in the API Docs UI. The OpenAPI spec
+  generator was reading a non-existent `accessRules` field on procedure
+  metadata; the real field is `access: AccessRule[]`. Each procedure's access
+  rules are now flattened to fully-qualified IDs (e.g. `catalog.system.read`)
+  and emitted under `x-orpc-meta.accessRules`, which the existing
+  `Required Access Rules` section in the docs UI already knew how to render.
+
+  The API Docs schema renderer now handles record types (zod `z.record`),
+  `$ref`s into `components.schemas`, `oneOf`/`anyOf`/`allOf`, nullable union
+  types (`type: ["string", "null"]`), and `format` qualifiers. Previously
+  record outputs like `{ statuses: object }` masked the actual value type;
+  they now render as `{ [key]: <ResolvedType> { ... } }` with the inner
+  schema expanded, capped at 12 levels with cycle detection.
+
+  **REST method conventions.** `proc()` now defaults to `GET` for queries and
+  `POST` for mutations on the `/rest` mount, using bracket-notation query
+  params (`?filter[status]=active&ids[0]=a`) for GET inputs. Existing
+  procedures were updated to follow REST semantics:
+
+  - `update*` mutations → `PATCH`
+  - `delete*` / `remove*` mutations → `DELETE`
+  - `getBulk*` queries and any query taking a large array input → `POST`
+    (because `@orpc/openapi@1.13.x` has no GET→POST URL-length fallback)
+
+  GET endpoints require an `object` input — bare scalars like
+  `.input(z.string())` are not valid on GET. `getSystemConfigurations` was
+  refactored from `.input(z.string())` to `.input(z.object({ systemId: ... }))`
+  to fit the GET shape; the only call-site update was the in-process router
+  unpacking `input.systemId` instead of passing `input` directly.
+
+  The API Docs UI now renders query parameters (path/query/header/cookie) in a
+  dedicated table for GET endpoints, and the fetch example shows them in the
+  URL with `<required>` / `<optional>` placeholders.
+
 ## 0.9.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/common",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "license": "Elastic-2.0",
   "type": "module",
   "main": "./src/index.ts",
@@ -20,7 +20,7 @@
   "devDependencies": {
     "typescript": "^5.7.2",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/scripts": "0.3.0"
+    "@checkstack/scripts": "0.3.2"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/pagination.test.ts

@@ -1,89 +1,156 @@
 import { describe, it, expect } from "bun:test";
-import { PaginationInputSchema, paginatedOutput } from "./pagination";
 import { z } from "zod";
+import { PaginationInput, PaginatedResult } from "./pagination";
 
-describe("PaginationInputSchema", () => {
-  it("should accept valid pagination input", () => {
-    const result = PaginationInputSchema.parse({
-      limit: 20,
-      offset: 40,
-    });
-
+describe("PaginationInput (canonical)", () => {
+  it("applies default limit and offset when omitted", () => {
+    const result = PaginationInput.parse({});
     expect(result.limit).toBe(20);
-    expect(result.offset).toBe(40);
+    expect(result.offset).toBe(0);
   });
 
-  it("should use default values when not provided", () => {
-    const result = PaginationInputSchema.parse({});
+  it("accepts valid limit and offset values", () => {
+    const result = PaginationInput.parse({ limit: 50, offset: 100 });
+    expect(result.limit).toBe(50);
+    expect(result.offset).toBe(100);
+  });
 
-    expect(result.limit).toBe(10);
-    expect(result.offset).toBe(0);
+  it("rejects limit below 1", () => {
+    expect(() => PaginationInput.parse({ limit: 0 })).toThrow();
+  });
+
+  it("rejects limit above 100", () => {
+    expect(() => PaginationInput.parse({ limit: 101 })).toThrow();
   });
 
-  it("should reject limit below 1", () => {
-    expect(() => PaginationInputSchema.parse({ limit: 0 })).toThrow();
+  it("rejects negative offset", () => {
+    expect(() => PaginationInput.parse({ offset: -1 })).toThrow();
   });
 
-  it("should reject limit above 100", () => {
-    expect(() => PaginationInputSchema.parse({ limit: 101 })).toThrow();
+  it("rejects non-integer limit values", () => {
+    expect(() => PaginationInput.parse({ limit: 10.5 })).toThrow();
   });
 
-  it("should reject negative offset", () => {
-    expect(() => PaginationInputSchema.parse({ offset: -1 })).toThrow();
+  it("rejects non-integer offset values", () => {
+    expect(() => PaginationInput.parse({ offset: 1.5 })).toThrow();
+  });
+
+  it("supports `.extend({...})` for domain extras", () => {
+    const ListNotificationsInput = PaginationInput.extend({
+      unreadOnly: z.boolean().default(false),
+    });
+
+    const parsed = ListNotificationsInput.parse({});
+    expect(parsed.limit).toBe(20);
+    expect(parsed.offset).toBe(0);
+    expect(parsed.unreadOnly).toBe(false);
+
+    const parsedWithExtras = ListNotificationsInput.parse({
+      limit: 5,
+      unreadOnly: true,
+    });
+    expect(parsedWithExtras.limit).toBe(5);
+    expect(parsedWithExtras.unreadOnly).toBe(true);
+  });
+
+  it("infers a typed PaginationInput", () => {
+    const sample: PaginationInput = { limit: 10, offset: 0 };
+    expect(sample.limit).toBe(10);
+    expect(sample.offset).toBe(0);
   });
 });
 
-describe("paginatedOutput", () => {
+describe("PaginatedResult (canonical)", () => {
   const ItemSchema = z.object({
     id: z.string(),
     name: z.string(),
   });
 
-  it("should create correct output schema structure", () => {
-    const outputSchema = paginatedOutput(ItemSchema);
-
-    const result = outputSchema.parse({
+  it("produces an { items, total, limit, offset } shape", () => {
+    const schema = PaginatedResult(ItemSchema);
+    const result = schema.parse({
       items: [
-        { id: "1", name: "Item 1" },
-        { id: "2", name: "Item 2" },
+        { id: "1", name: "First" },
+        { id: "2", name: "Second" },
       ],
-      total: 100,
+      total: 42,
+      limit: 20,
+      offset: 0,
     });
 
     expect(result.items).toHaveLength(2);
-    expect(result.total).toBe(100);
+    expect(result.total).toBe(42);
+    expect(result.limit).toBe(20);
+    expect(result.offset).toBe(0);
   });
 
-  it("should reject invalid items", () => {
-    const outputSchema = paginatedOutput(ItemSchema);
-
+  it("rejects items that do not match the inner schema", () => {
+    const schema = PaginatedResult(ItemSchema);
     expect(() =>
-      outputSchema.parse({
-        items: [{ id: "1" }], // Missing 'name'
+      schema.parse({
+        items: [{ id: "1" }],
         total: 1,
-      })
+        limit: 20,
+        offset: 0,
+      }),
     ).toThrow();
   });
 
-  it("should reject missing total", () => {
-    const outputSchema = paginatedOutput(ItemSchema);
+  it("rejects a missing total", () => {
+    const schema = PaginatedResult(ItemSchema);
+    expect(() =>
+      schema.parse({
+        items: [],
+        limit: 20,
+        offset: 0,
+      }),
+    ).toThrow();
+  });
 
+  it("rejects a missing limit/offset", () => {
+    const schema = PaginatedResult(ItemSchema);
     expect(() =>
-      outputSchema.parse({
-        items: [{ id: "1", name: "Item 1" }],
-      })
+      schema.parse({
+        items: [],
+        total: 0,
+      }),
     ).toThrow();
   });
 
-  it("should accept empty items array", () => {
-    const outputSchema = paginatedOutput(ItemSchema);
+  it("rejects a negative total", () => {
+    const schema = PaginatedResult(ItemSchema);
+    expect(() =>
+      schema.parse({
+        items: [],
+        total: -1,
+        limit: 20,
+        offset: 0,
+      }),
+    ).toThrow();
+  });
 
-    const result = outputSchema.parse({
+  it("accepts an empty items array", () => {
+    const schema = PaginatedResult(ItemSchema);
+    const result = schema.parse({
       items: [],
       total: 0,
+      limit: 20,
+      offset: 0,
     });
-
     expect(result.items).toEqual([]);
     expect(result.total).toBe(0);
   });
+
+  it("infers a typed result via z.infer", () => {
+    const schema = PaginatedResult(ItemSchema);
+    type Result = z.infer<typeof schema>;
+    const value: Result = {
+      items: [{ id: "x", name: "X" }],
+      total: 1,
+      limit: 20,
+      offset: 0,
+    };
+    expect(value.items[0]?.id).toBe("x");
+  });
 });
+

package/src/pagination.ts

@@ -1,55 +1,55 @@
 import { z } from "zod";
 
 /**
- * Standard pagination input schema for RPC procedures.
- * Use with paginatedOutput() for consistent pagination patterns.
+ * Canonical pagination input schema for RPC procedures.
+ *
+ * This is the single source of truth for paginated list inputs across
+ * the platform. Domain-specific extras (e.g. `unreadOnly` on
+ * notifications) must compose with `.extend({...})` — do NOT redefine
+ * the base fields.
  *
  * @example
  * ```typescript
- * // In your contract:
- * import { PaginationInputSchema, paginatedOutput } from "@checkstack/common";
+ * import { PaginationInput, PaginatedResult } from "@checkstack/common";
+ *
+ * const ListNotificationsInput = PaginationInput.extend({
+ *   unreadOnly: z.boolean().default(false),
+ * });
  *
- * const contract = {
- *   getItems: _base
- *     .input(PaginationInputSchema.extend({ search: z.string().optional() }))
- *     .output(paginatedOutput(ItemSchema)),
- * };
+ * const ListNotificationsOutput = PaginatedResult(NotificationSchema);
  * ```
  */
-export const PaginationInputSchema = z.object({
-  /** Number of items per page (1-100) */
-  limit: z.number().min(1).max(100).default(10),
-  /** Number of items to skip */
-  offset: z.number().min(0).default(0),
+export const PaginationInput = z.object({
+  /** Number of items per page (1-100). */
+  limit: z.number().int().min(1).max(100).default(20),
+  /** Number of items to skip from the start of the result set. */
+  offset: z.number().int().min(0).default(0),
 });
 
-export type PaginationInput = z.infer<typeof PaginationInputSchema>;
+export type PaginationInput = z.infer<typeof PaginationInput>;
 
 /**
- * Creates a paginated output schema wrapper.
- * Returns { items: T[], total: number } structure that works with usePagination hook.
+ * Canonical paginated response factory.
+ *
+ * Wraps an item schema in the standard `{ items, total, limit, offset }`
+ * shape. The echoed `limit` / `offset` mirror what the server actually
+ * applied so clients can render correct pagination controls even when
+ * defaults were used.
  *
  * @example
  * ```typescript
- * // Contract definition:
- * getUsers: _base
- *   .input(PaginationInputSchema)
- *   .output(paginatedOutput(UserSchema)),
+ * // In a contract:
+ * getNotifications: _base
+ *   .input(PaginationInput)
+ *   .output(PaginatedResult(NotificationSchema)),
  *
- * // Returns: { items: User[], total: number }
+ * // Returns: { items: Notification[], total: number, limit: number, offset: number }
  * ```
  */
-export function paginatedOutput<T extends z.ZodTypeAny>(itemSchema: T) {
-  return z.object({
+export const PaginatedResult = <T extends z.ZodTypeAny>(itemSchema: T) =>
+  z.object({
     items: z.array(itemSchema),
-    total: z.number(),
+    total: z.number().int().min(0),
+    limit: z.number().int(),
+    offset: z.number().int(),
   });
-}
-
-/**
- * Type helper for paginated responses
- */
-export type PaginatedResponse<T> = {
-  items: T[];
-  total: number;
-};

package/src/procedure-builder.ts

@@ -22,19 +22,40 @@ export type TypedContractProcedureBuilder<TMeta extends ProcedureMetadata> =
  * The return type preserves the operationType in the generic parameter,
  * enabling type-safe hook selection (useQuery vs useMutation) in usePluginClient.
  *
+ * REST shape (via `/rest/:pluginId/*` mounted with oRPC's OpenAPIHandler):
+ * queries default to HTTP `GET` (input encoded into the URL as bracket-notation
+ * query params, e.g. `?ids[0]=a&ids[1]=b`); mutations default to `POST` with the
+ * input as the JSON body.
+ *
+ * Override the method by chaining `.route({ method: "..." })` after
+ * `proc({...})`. The repo convention is:
+ *   - `create*` / `add*`              → `POST`   (default for mutations)
+ *   - `update*`                       → `PATCH`  (partial updates)
+ *   - `delete*` / `remove*`           → `DELETE`
+ *   - `getBulk*` and any query with   → `POST`   (avoid URL-length limits;
+ *     a large array input                         no automatic GET→POST fallback
+ *                                                 in `@orpc/openapi@1.13.x`)
+ *
+ * Constraint to know about: when method is `GET` (the default for queries),
+ * the input schema must be an `object`, `any`, or `unknown` — never a bare
+ * scalar like `z.string()`. GET has no field name to attach a top-level scalar
+ * to in a query string, so oRPC's OpenAPI generator throws at boot. Wrap the
+ * input in an object (`z.object({ id: z.string() })`) or, if the existing call
+ * sites can't be migrated, override the method to `POST`.
+ *
  * @example
  * ```typescript
  * import { proc } from "@checkstack/common";
  *
  * export const myContract = {
- *   // Returns TypedContractProcedureBuilder<{ operationType: "query", ... }>
+ *   // GET /rest/myplugin/getItems
  *   getItems: proc({
  *     operationType: "query",
  *     userType: "public",
  *     access: [myAccess.items.read],
  *   }).output(z.array(ItemSchema)),
  *
- *   // Returns TypedContractProcedureBuilder<{ operationType: "mutation", ... }>
+ *   // POST /rest/myplugin/createItem
  *   createItem: proc({
  *     operationType: "mutation",
  *     userType: "authenticated",
@@ -42,11 +63,24 @@ export type TypedContractProcedureBuilder<TMeta extends ProcedureMetadata> =
  *   })
  *     .input(CreateItemSchema)
  *     .output(ItemSchema),
+ *
+ *   // POST /rest/myplugin/getBulkItems — bulk query overrides default GET
+ *   // because `ids` can be too long for a query string.
+ *   getBulkItems: proc({
+ *     operationType: "query",
+ *     userType: "public",
+ *     access: [myAccess.items.read],
+ *   })
+ *     .route({ method: "POST" })
+ *     .input(z.object({ ids: z.array(z.string()) })),
  * };
  * ```
  */
 export function proc<TMeta extends ProcedureMetadata>(
   meta: TMeta
 ): TypedContractProcedureBuilder<TMeta> {
-  return oc.$meta<TMeta>(meta) as TypedContractProcedureBuilder<TMeta>;
+  const defaultMethod = meta.operationType === "query" ? "GET" : "POST";
+  return oc
+    .$meta<TMeta>(meta)
+    .route({ method: defaultMethod }) as TypedContractProcedureBuilder<TMeta>;
 }