@checkstack/command-common 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # @checkstack/command-common
 
+## 0.2.0
+
+### Minor Changes
+
+- 7a23261: ## TanStack Query Integration
+
+  Migrated all frontend components to use `usePluginClient` hook with TanStack Query integration, replacing the legacy `forPlugin()` pattern.
+
+  ### New Features
+
+  - **`usePluginClient` hook**: Provides type-safe access to plugin APIs with `.useQuery()` and `.useMutation()` methods
+  - **Automatic request deduplication**: Multiple components requesting the same data share a single network request
+  - **Built-in caching**: Configurable stale time and cache duration per query
+  - **Loading/error states**: TanStack Query provides `isLoading`, `error`, `isRefetching` states automatically
+  - **Background refetching**: Stale data is automatically refreshed when components mount
+
+  ### Contract Changes
+
+  All RPC contracts now require `operationType: "query"` or `operationType: "mutation"` metadata:
+
+  ```typescript
+  const getItems = proc()
+    .meta({ operationType: "query", access: [access.read] })
+    .output(z.array(itemSchema))
+    .query();
+
+  const createItem = proc()
+    .meta({ operationType: "mutation", access: [access.manage] })
+    .input(createItemSchema)
+    .output(itemSchema)
+    .mutation();
+  ```
+
+  ### Migration
+
+  ```typescript
+  // Before (forPlugin pattern)
+  const api = useApi(myPluginApiRef);
+  const [items, setItems] = useState<Item[]>([]);
+  useEffect(() => {
+    api.getItems().then(setItems);
+  }, [api]);
+
+  // After (usePluginClient pattern)
+  const client = usePluginClient(MyPluginApi);
+  const { data: items, isLoading } = client.getItems.useQuery({});
+  ```
+
+  ### Bug Fixes
+
+  - Fixed `rpc.test.ts` test setup for middleware type inference
+  - Fixed `SearchDialog` to use `setQuery` instead of deprecated `search` method
+  - Fixed null→undefined warnings in notification and queue frontends
+
+### Patch Changes
+
+- Updated dependencies [7a23261]
+  - @checkstack/common@0.3.0
+
 ## 0.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/command-common",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "exports": {
     ".": {

package/src/index.ts

@@ -1,9 +1,8 @@
-import { oc } from "@orpc/contract";
 import { z } from "zod";
 import {
   createClientDefinition,
   definePluginMetadata,
-  type ProcedureMetadata,
+  proc,
 } from "@checkstack/common";
 
 // =============================================================================
@@ -64,8 +63,6 @@ export type Command = z.infer<typeof CommandSchema>;
 // RPC CONTRACT
 // =============================================================================
 
-const _base = oc.$meta<ProcedureMetadata>({});
-
 /**
  * Command palette RPC contract.
  * Provides search functionality across all registered providers.
@@ -75,8 +72,11 @@ export const commandContract = {
    * Search across all registered search providers.
    * Returns results filtered by user access rules.
    */
-  search: _base
-    .meta({ userType: "public" })
+  search: proc({
+    operationType: "query",
+    userType: "public",
+    access: [],
+  })
     .input(z.object({ query: z.string() }))
     .output(z.array(SearchResultSchema)),
 
@@ -84,9 +84,11 @@ export const commandContract = {
    * Get all registered commands (for browsing without a query).
    * Returns commands filtered by user access rules.
    */
-  getCommands: _base
-    .meta({ userType: "public" })
-    .output(z.array(SearchResultSchema)),
+  getCommands: proc({
+    operationType: "query",
+    userType: "public",
+    access: [],
+  }).output(z.array(SearchResultSchema)),
 };
 
 export type CommandContract = typeof commandContract;