@checkstack/common 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @checkstack/common
 
+## 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.10.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.1"
   },
   "scripts": {
     "typecheck": "tsgo -b",

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>;
 }