@checkstack/scripts 0.0.2

package/src/templates/backend/src/service.ts.hbs

@@ -0,0 +1,69 @@
+import type { NodePgDatabase } from "drizzle-orm/node-postgres";
+import { eq } from "drizzle-orm";
+import * as schema from "./schema";
+import { {{pluginNameCamel}}Items } from "./schema";
+import type {
+  Create{{pluginNamePascal}}Item,
+  Update{{pluginNamePascal}}Item,
+} from "@checkstack/{{pluginBaseName}}-common";
+
+export class {{pluginNamePascal}}Service {
+  constructor(private readonly database: NodePgDatabase<typeof schema>) {}
+
+  async getItems() {
+    return await this.database.select().from({{pluginNameCamel}}Items);
+  }
+
+  async getItem(id: string) {
+    const [item] = await this.database
+      .select()
+      .from({{pluginNameCamel}}Items)
+      .where(eq({{pluginNameCamel}}Items.id, id));
+
+    if (!item) {
+      throw new Error(`Item with id ${id} not found`);
+    }
+
+    return item;
+  }
+
+  async createItem(data: Create{{pluginNamePascal}}Item) {
+    const [item] = await this.database
+      .insert({{pluginNameCamel}}Items)
+      .values({
+        name: data.name,
+        description: data.description,
+      })
+      .returning();
+
+    if (!item) {
+      throw new Error("Failed to create item");
+    }
+
+    return item;
+  }
+
+  async updateItem(id: string, data: Update{{pluginNamePascal}}Item) {
+    const [item] = await this.database
+      .update({{pluginNameCamel}}Items)
+      .set({
+        name: data.name,
+        description: data.description,
+        updatedAt: new Date(),
+      })
+      .where(eq({{pluginNameCamel}}Items.id, id))
+      .returning();
+
+    if (!item) {
+      throw new Error(`Item with id ${id} not found`);
+    }
+
+    return item;
+  }
+
+  async deleteItem(id: string) {
+    await this.database
+      .delete({{pluginNameCamel}}Items)
+      .where(eq({{pluginNameCamel}}Items.id, id));
+  }
+}

package/src/templates/backend/tsconfig.json

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

package/src/templates/common/.changeset/initial.md.hbs

@@ -0,0 +1,5 @@
+--- "@checkstack/{{pluginName}}": patch --- Initial release of
+{{pluginNamePascal}}
+plugin
+
+{{pluginDescription}}

package/src/templates/common/README.md.hbs

@@ -0,0 +1,11 @@
+#
+{{pluginNamePascal}}
+Common Common package for the
+{{pluginNamePascal}}
+plugin. Contains shared contracts, types, and permissions. ## Structure -
+`src/permissions.ts` - Permission definitions - `src/schemas.ts` - Zod schemas
+and type definitions - `src/rpc-contract.ts` - oRPC contract definition -
+`src/index.ts` - Barrel exports ## Usage This package is consumed by both: -
+`@checkstack/{{pluginBaseName}}-backend` - Implements the contract -
+`@checkstack/{{pluginBaseName}}-frontend` - Consumes the contract ##
+Development ```bash # Type check bun run typecheck # Lint bun run lint ```

package/src/templates/common/package.json.hbs

@@ -0,0 +1,7 @@
+{ "name": "@checkstack/{{pluginName}}", "version": "0.0.1",
+"description": "{{pluginDescription}}", "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": "^3.23.0" }, "devDependencies": {
+"@checkstack/tsconfig": "workspace:*", "typescript": "^5.7.2" } }

package/src/templates/common/src/index.ts.hbs

@@ -0,0 +1,14 @@
+// Export permissions
+export { permissions, permissionList } from "./permissions";
+
+// Export routes
+export { {{pluginNameCamel}}Routes } from "./routes";
+
+// Export schemas and types
+export * from "./schemas";
+
+// Export plugin metadata
+export * from "./plugin-metadata";
+
+// Export contract and client definition
+export { {{pluginNameCamel}}Contract, {{pluginNamePascal}}Api, type {{pluginNamePascal}}Contract } from "./rpc-contract";

package/src/templates/common/src/permissions.ts.hbs

@@ -0,0 +1,17 @@
+import { createPermission } from "@checkstack/common";
+
+export const permissions = {
+  {{pluginNameCamel}}Read: createPermission(
+    "{{pluginBaseName}}",
+    "read",
+    "Read {{pluginBaseName}} data",
+    { isAuthenticatedDefault: true } // Auto-assigned to "users" role
+  ),
+  {{pluginNameCamel}}Manage: createPermission(
+    "{{pluginBaseName}}",
+    "manage",
+    "Manage {{pluginBaseName}} data"
+  ),
+};
+
+export const permissionList = Object.values(permissions);

package/src/templates/common/src/plugin-metadata.ts.hbs

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

package/src/templates/common/src/routes.ts.hbs

@@ -0,0 +1,6 @@
+import { createRoutes } from "@checkstack/common"; /** * Route
+definitions for the
+{{pluginBaseName}}
+plugin. * Use these for type-safe route generation with resolveRoute(). */
+export const
+{{pluginNameCamel}}Routes = createRoutes("{{pluginBaseName}}", { home: "/", });

package/src/templates/common/src/rpc-contract.ts.hbs

@@ -0,0 +1,60 @@
+import { oc } from "@orpc/contract";
+import { createClientDefinition, type ProcedureMetadata } from "@checkstack/common";
+import { z } from "zod";
+import {
+  {{pluginNamePascal}}ItemSchema,
+  Create{{pluginNamePascal}}ItemSchema,
+  Update{{pluginNamePascal}}ItemSchema,
+} from "./schemas";
+import { permissions } from "./permissions";
+import { pluginMetadata } from "./plugin-metadata";
+
+// Create base builder with ProcedureMetadata support
+// See: https://docs.checkstack.dev/common-plugins#contract-based-auth-enforcement
+const _base = oc.$meta<ProcedureMetadata>({});
+
+export const {{pluginNameCamel}}Contract = {
+  // List all items - requires authenticated user with read permission
+  getItems: _base
+    .meta({ userType: "user", permissions: [permissions.{{pluginNameCamel}}Read.id] })
+    .output(z.array({{pluginNamePascal}}ItemSchema)),
+
+  // Get single item
+  getItem: _base
+    .meta({ userType: "user", permissions: [permissions.{{pluginNameCamel}}Read.id] })
+    .input(z.string())
+    .output({{pluginNamePascal}}ItemSchema),
+
+  // Create item
+  createItem: _base
+    .meta({ userType: "user", permissions: [permissions.{{pluginNameCamel}}Manage.id] })
+    .input(Create{{pluginNamePascal}}ItemSchema)
+    .output({{pluginNamePascal}}ItemSchema),
+
+  // Update item
+  updateItem: _base
+    .meta({ userType: "user", permissions: [permissions.{{pluginNameCamel}}Manage.id] })
+    .input(
+      z.object({
+        id: z.string(),
+        data: Update{{pluginNamePascal}}ItemSchema,
+      })
+    )
+    .output({{pluginNamePascal}}ItemSchema),
+
+  // Delete item
+  deleteItem: _base
+    .meta({ userType: "user", permissions: [permissions.{{pluginNameCamel}}Manage.id] })
+    .input(z.string())
+    .output(z.void()),
+};
+
+// Export contract type
+export type {{pluginNamePascal}}Contract = typeof {{pluginNameCamel}}Contract;
+
+// Export client definition for type-safe forPlugin usage
+// Use: const client = rpcApi.forPlugin({{pluginNamePascal}}Api);
+export const {{pluginNamePascal}}Api = createClientDefinition(
+  {{pluginNameCamel}}Contract,
+  pluginMetadata
+);

package/src/templates/common/src/schemas.ts.hbs

@@ -0,0 +1,25 @@
+import { z } from "zod";
+
+// Example schema - customize for your domain
+export const {{pluginNamePascal}}ItemSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  description: z.string().nullable(),
+  createdAt: z.date(),
+  updatedAt: z.date(),
+});
+
+export type {{pluginNamePascal}}Item = z.infer<typeof {{pluginNamePascal}}ItemSchema>;
+
+// Input schema for creating items (omit id and timestamps)
+export const Create{{pluginNamePascal}}ItemSchema = z.object({
+  name: z.string().min(1).max(255),
+  description: z.string().optional(),
+});
+
+export type Create{{pluginNamePascal}}Item = z.infer<typeof Create{{pluginNamePascal}}ItemSchema>;
+
+// Input schema for updating items
+export const Update{{pluginNamePascal}}ItemSchema = Create{{pluginNamePascal}}ItemSchema.partial();
+
+export type Update{{pluginNamePascal}}Item = z.infer<typeof Update{{pluginNamePascal}}ItemSchema>;

package/src/templates/common/tsconfig.json

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

package/src/templates/frontend/.changeset/initial.md.hbs

@@ -0,0 +1,5 @@
+--- "@checkstack/{{pluginName}}": patch --- Initial release of
+{{pluginNamePascal}}
+frontend plugin
+
+{{pluginDescription}}

package/src/templates/frontend/README.md.hbs

@@ -0,0 +1,29 @@
+# {{pluginNamePascal}} Frontend
+
+Frontend plugin for {{pluginNamePascal}}. Provides UI components and pages.
+
+## Structure
+
+- `src/index.tsx` - Plugin entry point
+- `src/api.ts` - Contract-based API definition
+- `src/components/` - React components
+
+## Development
+
+### Type Check
+
+```bash
+bun run typecheck
+```
+
+### Lint
+
+```bash
+bun run lint
+```
+
+## Testing
+
+```bash
+bun test
+```

package/src/templates/frontend/bunfig.toml.hbs

@@ -0,0 +1 @@
+[test] preload = ["@checkstack/test-utils-frontend/setup"]

package/src/templates/frontend/package.json.hbs

@@ -0,0 +1,12 @@
+{ "name": "@checkstack/{{pluginName}}", "version": "0.0.1",
+"description": "{{pluginDescription}}", "type": "module", "exports": { ".": {
+"import": "./src/index.tsx" } }, "scripts": { "typecheck": "tsc --noEmit",
+"lint": "bun run lint:code", "lint:code": "eslint . --max-warnings 0",
+"test:e2e": "bunx playwright test" }, "dependencies": {
+"@checkstack/frontend-api": "workspace:*", "@checkstack/common":
+"workspace:*", "@checkstack/{{pluginBaseName}}-common": "workspace:*",
+"@checkstack/ui": "workspace:*", "react": "^18.3.1", "react-router-dom":
+"^7.1.1", "lucide-react": "^0.469.0" }, "devDependencies": {
+"@checkstack/tsconfig": "workspace:*", "@types/react": "^18.3.1",
+"@playwright/test": "^1.49.0", "@checkstack/test-utils-frontend":
+"workspace:*", "typescript": "^5.7.2" } }

package/src/templates/frontend/playwright.config.ts.hbs

@@ -0,0 +1,3 @@
+import { createPlaywrightConfig } from
+"@checkstack/test-utils-frontend/playwright"; export default
+createPlaywrightConfig();

package/src/templates/frontend/src/api.ts.hbs

@@ -0,0 +1,15 @@
+import { createApiRef } from "@checkstack/frontend-api";
+import type { InferClient } from "@checkstack/common";
+import { {{pluginNamePascal}}Api } from "@checkstack/{{pluginBaseName}}-common";
+
+// Re-export types for convenience
+export type {
+  {{pluginNamePascal}}Item,
+  Create{{pluginNamePascal}}Item,
+  Update{{pluginNamePascal}}Item,
+} from "@checkstack/{{pluginBaseName}}-common";
+
+// {{pluginNamePascal}}ApiClient is the client type inferred from the Api definition
+export type {{pluginNamePascal}}ApiClient = InferClient<typeof {{pluginNamePascal}}Api>;
+
+export const {{pluginNameCamel}}ApiRef = createApiRef<{{pluginNamePascal}}ApiClient>("{{pluginBaseName}}-api");

package/src/templates/frontend/src/components/{{pluginNamePascal}}ListPage.tsx.hbs

@@ -0,0 +1,81 @@
+import { useEffect, useState } from "react";
+import { useApi } from "@checkstack/frontend-api";
+import { {{pluginNameCamel}}ApiRef, type {{pluginNamePascal}}Item } from "../api";
+import { Button, Card } from "@checkstack/ui";
+import { useNavigate } from "react-router-dom";
+
+export const {{pluginNamePascal}}ListPage = () => {
+  const api = useApi({{pluginNameCamel}}ApiRef);
+  const navigate = useNavigate();
+  const [items, setItems] = useState<{{pluginNamePascal}}Item[]>([]);
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState<Error>();
+
+  useEffect(() => {
+    api
+      .getItems()
+      .then(setItems)
+      .catch(setError)
+      .finally(() => setLoading(false));
+  }, [api]);
+
+  const handleDelete = async (id: string) => {
+    try {
+      await api.deleteItem(id);
+      setItems(items.filter((item) => item.id !== id));
+    } catch (error) {
+      console.error("Failed to delete item:", error);
+    }
+  };
+
+  if (loading) return <div className="p-6">Loading...</div>;
+  if (error) return <div className="p-6 text-red-500">Error: {error.message}</div>;
+
+  return (
+    <div className="p-6">
+      <div className="flex justify-between items-center mb-4">
+        <h1 className="text-2xl font-bold">{{pluginNamePascal}} Items</h1>
+        <Button onClick={() => navigate("/{{pluginBaseName}}/new")}>
+          Create Item
+        </Button>
+      </div>
+
+      <div className="grid gap-4">
+        {items.map((item) => (
+          <Card key={item.id} className="p-4">
+            <div className="flex justify-between items-start">
+              <div>
+                <h3 className="font-semibold">{item.name}</h3>
+                {item.description && (
+                  <p className="text-sm text-gray-600">{item.description}</p>
+                )}
+              </div>
+              <div className="flex gap-2">
+                <Button
+                  variant="outline"
+                  size="sm"
+                  onClick={() => navigate(`/{{pluginBaseName}}/${item.id}`)}
+                >
+                  View
+                </Button>
+                <Button
+                  variant="destructive"
+                  size="sm"
+                  onClick={() => handleDelete(item.id)}
+                >
+                  Delete
+                </Button>
+              </div>
+            </div>
+          </Card>
+        ))}
+
+        {items.length === 0 && (
+          <Card className="p-8 text-center text-gray-500">
+            No items yet. Create your first item to get started.
+          </Card>
+        )}
+      </div>
+    </div>
+  );
+};

package/src/templates/frontend/src/index.tsx.hbs

@@ -0,0 +1,33 @@
+import { createFrontendPlugin, rpcApiRef, type ApiRef } from "@checkstack/frontend-api";
+import { {{pluginNameCamel}}ApiRef, type {{pluginNamePascal}}ApiClient } from "./api";
+import { {{pluginNamePascal}}ListPage } from "./components/{{pluginNamePascal}}ListPage";
+import { {{pluginNameCamel}}Routes, {{pluginNamePascal}}Api, pluginMetadata, permissions } from "@checkstack/{{pluginBaseName}}-common";
+
+export default createFrontendPlugin({
+  metadata: pluginMetadata,
+
+  // Register routes using typed route definitions
+  routes: [
+    {
+      route: {{pluginNameCamel}}Routes.routes.home,
+      element: <{{pluginNamePascal}}ListPage />,
+      title: "{{pluginNamePascal}}",
+      permission: permissions.{{pluginNameCamel}}Read,
+    },
+  ],
+
+  // Register client API using oRPC
+  apis: [
+    {
+      ref: {{pluginNameCamel}}ApiRef,
+      factory: (deps: { get: <T>(ref: ApiRef<T>) => T }): {{pluginNamePascal}}ApiClient => {
+        const rpcApi = deps.get(rpcApiRef);
+        // Create type-safe client using the plugin's Api definition
+        return rpcApi.forPlugin({{pluginNamePascal}}Api);
+      },
+    },
+  ],
+});
+
+export * from "./api";
+

package/src/templates/frontend/tsconfig.json.hbs

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

package/src/templates/node/.changeset/initial.md.hbs

@@ -0,0 +1,5 @@
+--- "@checkstack/{{pluginName}}": patch --- Initial release of
+{{pluginNamePascal}}
+utility plugin
+
+{{pluginDescription}}

package/src/templates/node/README.md.hbs

@@ -0,0 +1,8 @@
+#
+{{pluginNamePascal}}
+
+{{pluginDescription}}
+
+## Usage ```typescript import { hello{{pluginNamePascal}}
+} from "@checkstack/{{pluginName}}"; console.log(hello{{pluginNamePascal}}());
+``` ## Development ```bash bun run typecheck bun run lint bun test ```

package/src/templates/node/package.json.hbs

@@ -0,0 +1,3 @@
+{ "name": "@checkstack/{{pluginName}}", "version": "0.0.1",
+"description": "{{pluginDescription}}", "type": "module", "exports": { ".": {
+"import": "./src/index.ts" } }, "devDependencies": { "typescript": "^5.7.2" } }

package/src/templates/node/src/index.ts.hbs

@@ -0,0 +1,6 @@
+// {{pluginNamePascal}} utility plugin
+// Add your utility functions and exports here
+
+export function hello{{pluginNamePascal}}() {
+  return "Hello from {{pluginNamePascal}}!";
+}

package/src/templates/node/tsconfig.json

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

package/src/templates/react/.changeset/initial.md.hbs

@@ -0,0 +1,5 @@
+--- "@checkstack/{{pluginName}}": patch --- Initial release of
+{{pluginNamePascal}}
+component library
+
+{{pluginDescription}}

package/src/templates/react/README.md.hbs

@@ -0,0 +1,23 @@
+# {{pluginNamePascal}}
+
+{{pluginDescription}}
+
+## Components
+
+### {{pluginNamePascal}}Component
+
+```tsx
+import { {{pluginNamePascal}}Component } from "@checkstack/{{pluginName}}";
+
+function App() {
+  return <{{pluginNamePascal}}Component title="My Title" />;
+}
+```
+
+## Development
+
+```bash
+bun run typecheck
+bun run lint
+bun test
+```

package/src/templates/react/package.json.hbs

@@ -0,0 +1,4 @@
+{ "name": "@checkstack/{{pluginName}}", "version": "0.0.1",
+"description": "{{pluginDescription}}", "type": "module", "exports": { ".": {
+"import": "./src/index.tsx" } }, "dependencies": { "react": "^18.3.1" },
+"devDependencies": { "@types/react": "^18.3.1", "typescript": "^5.7.2" } }

package/src/templates/react/src/components/{{pluginNamePascal}}Component.tsx.hbs

@@ -0,0 +1,12 @@
+interface {{pluginNamePascal}}ComponentProps {
+  title?: string;
+}
+
+export function {{pluginNamePascal}}Component({ title = "{{pluginNamePascal}}" }: {{pluginNamePascal}}ComponentProps) {
+  return (
+    <div>
+      <h1>{title}</h1>
+      <p>This is a {{pluginNamePascal}} component.</p>
+    </div>
+  );
+}

package/src/templates/react/src/index.tsx.hbs

@@ -0,0 +1 @@
+export { {{pluginNamePascal}}Component } from "./components/{{pluginNamePascal}}Component";

package/src/templates/react/tsconfig.json

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