@checkstack/queue-common 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# @checkstack/queue-common
+
+## 0.0.2
+
+### Patch Changes
+
+- d20d274: Initial release of all @checkstack packages. Rebranded from Checkmate to Checkstack with new npm organization @checkstack and domain checkstack.dev.
+- Updated dependencies [d20d274]
+  - @checkstack/common@0.0.2
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies [a65e002]
+  - @checkstack/common@0.2.0
+
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies [ffc28f6]
+  - @checkstack/common@0.1.0

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@checkstack/queue-common",
+  "version": "0.0.2",
+  "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": "workspace:*",
+    "@orpc/contract": "^1.13.2",
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.2",
+    "@checkstack/tsconfig": "workspace:*",
+    "@checkstack/scripts": "workspace:*"
+  }
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+export * from "./schemas";
+export * from "./permissions";
+export {
+  queueContract,
+  QueueApi,
+  type QueueContract,
+  type QueueMetadata,
+} from "./rpc-contract";
+export * from "./plugin-metadata";
+export { queueRoutes } from "./routes";

package/src/permissions.ts

@@ -0,0 +1,11 @@
+import { createPermission } from "@checkstack/common";
+
+/**
+ * Permissions for queue settings
+ */
+export const permissions = {
+  queueRead: createPermission("queue", "read", "Read Queue Settings"),
+  queueManage: createPermission("queue", "manage", "Update Queue Settings"),
+};
+
+export const permissionList = Object.values(permissions);

package/src/plugin-metadata.ts

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

package/src/routes.ts

@@ -0,0 +1,8 @@
+import { createRoutes } from "@checkstack/common";
+
+/**
+ * Route definitions for the queue plugin.
+ */
+export const queueRoutes = createRoutes("queue", {
+  config: "/config",
+});

package/src/rpc-contract.ts

@@ -0,0 +1,43 @@
+import { oc } from "@orpc/contract";
+import { createClientDefinition } from "@checkstack/common";
+import { z } from "zod";
+import { permissions } from "./permissions";
+import { pluginMetadata } from "./plugin-metadata";
+import {
+  QueuePluginDtoSchema,
+  QueueConfigurationDtoSchema,
+  UpdateQueueConfigurationSchema,
+} from "./schemas";
+
+// Permission metadata type
+export interface QueueMetadata {
+  permissions?: string[];
+}
+
+// Base builder with metadata support
+const _base = oc.$meta<QueueMetadata>({});
+
+// Queue RPC Contract with permission metadata
+export const queueContract = {
+  // Queue plugin queries - Read permission
+  getPlugins: _base
+    .meta({ permissions: [permissions.queueRead.id] })
+    .output(z.array(QueuePluginDtoSchema)),
+
+  getConfiguration: _base
+    .meta({ permissions: [permissions.queueRead.id] })
+    .output(QueueConfigurationDtoSchema),
+
+  // Queue configuration updates - Manage permission
+  updateConfiguration: _base
+    .meta({ permissions: [permissions.queueManage.id] })
+    .input(UpdateQueueConfigurationSchema)
+    .output(QueueConfigurationDtoSchema),
+};
+
+// Export contract type
+export type QueueContract = typeof queueContract;
+
+// Export client definition for type-safe forPlugin usage
+// Use: const client = rpcApi.forPlugin(QueueApi);
+export const QueueApi = createClientDefinition(queueContract, pluginMetadata);

package/src/schemas.ts

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

package/tsconfig.json

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