@checkstack/cache-common 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# @checkstack/cache-common
+
+## 0.2.0
+
+### Minor Changes
+
+- 8d1ef12: ## Infrastructure Configuration Shell & Cache System
+
+  ### New Packages
+
+  - **`@checkstack/cache-api`**: Core cache abstractions — `CacheProvider` interface, `createScopedCache` factory for plugin key isolation, `CachePlugin`/`CacheManager` lifecycle interfaces.
+  - **`@checkstack/cache-common`**: Shared cache types, RPC contract (`getPlugins`, `getConfiguration`, `updateConfiguration`), access rules, and plugin metadata.
+  - **`@checkstack/cache-backend`**: Cache settings RPC router — exposes plugin discovery, configuration read/write endpoints with access-gated authorization.
+  - **`@checkstack/cache-frontend`**: Cache configuration tab component for the Infrastructure Settings page.
+  - **`@checkstack/infrastructure-common`**: Infrastructure tab registry, routes, and shared types for the IDE-style configuration shell.
+  - **`@checkstack/infrastructure-frontend`**: Infrastructure Settings page with vertical tab bar, per-tab access control, and user menu integration.
+
+  ### Modified Packages
+
+  - **`@checkstack/backend-api`**: Added `cachePluginRegistry` and `cacheManager` to `RpcContext` and `coreServices`.
+  - **`@checkstack/backend`**: Registered cache services in boot sequence, added cache config loading, extended dependency sorter for cache plugin ordering.
+  - **`@checkstack/queue-frontend`**: Refactored from standalone `/queue/config` route to an infrastructure tab. Queue settings now live inside the Infrastructure Settings page.
+
+  ### Architecture
+
+  The former monolithic Queue Config page is replaced by a pluggable Infrastructure Settings shell (`/infrastructure/config`). Plugins register configuration tabs via `registerInfrastructureTab()` with their own access rules, icons, and components. The shell evaluates per-tab access and only renders tabs the user can see.
+
+### Patch Changes
+
+- Updated dependencies [8d1ef12]
+  - @checkstack/common@0.7.0

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@checkstack/cache-common",
+  "version": "0.2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "lint": "bun run lint:code",
+    "lint:code": "eslint . --max-warnings 0"
+  },
+  "dependencies": {
+    "@checkstack/common": "0.6.5",
+    "@orpc/contract": "^1.13.14",
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.2",
+    "@checkstack/tsconfig": "0.0.5",
+    "@checkstack/scripts": "0.1.2"
+  },
+  "checkstack": {
+    "type": "common"
+  }
+}

package/src/access.ts

@@ -0,0 +1,22 @@
+import { accessPair } from "@checkstack/common";
+
+/**
+ * Access rules for the Cache plugin.
+ */
+export const cacheAccess = {
+  /**
+   * Cache settings access.
+   */
+  settings: accessPair("cache", {
+    read: { description: "Read Cache Settings" },
+    manage: { description: "Update Cache Settings" },
+  }),
+};
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const cacheAccessRules = [
+  cacheAccess.settings.read,
+  cacheAccess.settings.manage,
+];

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./schemas";
+export * from "./access";
+export { cacheContract, CacheApi, type CacheContract } from "./rpc-contract";
+export * from "./plugin-metadata";

package/src/plugin-metadata.ts

@@ -0,0 +1,9 @@
+import { definePluginMetadata } from "@checkstack/common";
+
+/**
+ * Plugin metadata for the cache plugin.
+ * Exported from the common package so both backend and frontend can reference it.
+ */
+export const pluginMetadata = definePluginMetadata({
+  pluginId: "cache",
+});

package/src/rpc-contract.ts

@@ -0,0 +1,43 @@
+import { createClientDefinition, proc } from "@checkstack/common";
+import { z } from "zod";
+import { cacheAccess } from "./access";
+import { pluginMetadata } from "./plugin-metadata";
+import {
+  CachePluginDtoSchema,
+  CacheConfigurationDtoSchema,
+  UpdateCacheConfigurationSchema,
+} from "./schemas";
+
+/**
+ * Cache RPC Contract with access metadata.
+ * Mirrors queue contract structure.
+ */
+export const cacheContract = {
+  // Cache plugin queries - Read access
+  getPlugins: proc({
+    operationType: "query",
+    userType: "authenticated",
+    access: [cacheAccess.settings.read],
+  }).output(z.array(CachePluginDtoSchema)),
+
+  getConfiguration: proc({
+    operationType: "query",
+    userType: "authenticated",
+    access: [cacheAccess.settings.read],
+  }).output(CacheConfigurationDtoSchema),
+
+  // Cache configuration updates - Manage access
+  updateConfiguration: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [cacheAccess.settings.manage],
+  })
+    .input(UpdateCacheConfigurationSchema)
+    .output(CacheConfigurationDtoSchema),
+};
+
+// Export contract type
+export type CacheContract = typeof cacheContract;
+
+// Export client definition for type-safe forPlugin usage
+export const CacheApi = createClientDefinition(cacheContract, pluginMetadata);

package/src/schemas.ts

@@ -0,0 +1,38 @@
+import { z } from "zod";
+
+/**
+ * DTO for cache plugin information
+ */
+export const CachePluginDtoSchema = z.object({
+  id: z.string(),
+  displayName: z.string(),
+  description: z.string().optional(),
+  configVersion: z.number(),
+  configSchema: z.record(z.string(), z.unknown()),
+});
+
+export type CachePluginDto = z.infer<typeof CachePluginDtoSchema>;
+
+/**
+ * DTO for current cache configuration
+ */
+export const CacheConfigurationDtoSchema = z.object({
+  pluginId: z.string(),
+  config: z.record(z.string(), z.unknown()),
+});
+
+export type CacheConfigurationDto = z.infer<typeof CacheConfigurationDtoSchema>;
+
+/**
+ * Schema for updating cache configuration
+ */
+export const UpdateCacheConfigurationSchema = z.object({
+  pluginId: z.string().describe("ID of the cache plugin to use"),
+  config: z
+    .record(z.string(), z.unknown())
+    .describe("Plugin-specific configuration"),
+});
+
+export type UpdateCacheConfiguration = z.infer<
+  typeof UpdateCacheConfigurationSchema
+>;

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@checkstack/tsconfig/common.json",
+  "include": [
+    "src"
+  ]
+}