create-relkit 0.4.0 → 0.5.1

package/dist/templates/default/v1/fullstack/web/app/providers.tsx

@@ -0,0 +1,29 @@
+"use client";
+
+import { RelkitClientProvider } from "@relkit/client/react";
+import { useState, type ReactNode } from "react";
+import { agentTransports, type AgentTransport } from "./agent-config";
+
+export function Providers({ children }: { readonly children: ReactNode }) {
+  const [transport, setTransport] = useState<AgentTransport>("sse");
+  return (
+    <>
+      <label>
+        Agent transport
+        <select
+          value={transport}
+          onChange={(event) => setTransport(event.target.value as AgentTransport)}
+        >
+          {agentTransports.map((value) => (
+            <option key={value} value={value}>
+              {value.toUpperCase()}
+            </option>
+          ))}
+        </select>
+      </label>
+      <RelkitClientProvider key={transport} baseUrl="http://127.0.0.1:3000" transport={transport}>
+        {children}
+      </RelkitClientProvider>
+    </>
+  );
+}

package/dist/templates/default/v1/fullstack/web/next-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />

package/dist/templates/default/v1/fullstack/web/next.config.ts

@@ -0,0 +1,5 @@
+import type { NextConfig } from "next";
+import { withRelkit } from "@relkit/client/build/next";
+import { resolve } from "node:path";
+
+export default withRelkit({} satisfies NextConfig, { root: resolve(process.cwd()) });

package/dist/templates/default/v1/fullstack/web/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "jsx": "preserve",
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "types": ["react", "react-dom"]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "../.relkit/generated/client-registry.d.ts"],
+  "exclude": ["node_modules"]
+}

package/dist/templates/default/v1/minimal/package.json

@@ -15,12 +15,12 @@
     "graph": "relkit graph print"
   },
   "dependencies": {
-    "@relkit/app": "0.4.0"
+    "@relkit/app": "0.5.1"
   },
   "devDependencies": {
     "@types/bun": "1.3.10",
-    "@relkit/cli": "0.4.0",
-    "@relkit/testing": "0.4.0",
+    "@relkit/cli": "0.5.1",
+    "@relkit/testing": "0.5.1",
     "typescript": "5.9.3"
   }
 }

package/dist/templates/default/v1/tasks/.env.example

@@ -0,0 +1,2 @@
+# Local jobs use generated Docker secrets; add application values here when needed.
+

package/dist/templates/default/v1/tasks/README.md

@@ -0,0 +1,27 @@
+# my-app
+
+A small RelKit task and job project. The selected `--jobs` provider runs account-free
+through Docker and keeps task code in a domain-owned worker.
+
+```sh
+bun install
+bun run check
+bun run relkit local up --detach
+bun run dev
+```
+
+In a second terminal, trigger the generated Orders task and inspect its run:
+
+```sh
+bun run jobs:trigger
+bun run relkit jobs runs get --run-id <runId>
+```
+
+Use the `runId` from the trigger command. Other project checks are:
+
+```sh
+bun run test
+bun run build
+```
+
+The example task is `orders.exportOrders`; its fake export writes no external data.

package/dist/templates/default/v1/tasks/examples/export-orders.json

@@ -0,0 +1 @@
+{ "orderIds": ["order-1", "order-2"] }

package/dist/templates/default/v1/tasks/gitignore

@@ -0,0 +1,10 @@
+node_modules/
+.env
+.env.*
+!.env.example
+.relkit/generated/
+.relkit/build/
+.relkit/state/
+.relkit/observability/
+coverage/
+dist/

package/dist/templates/default/v1/tasks/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "my-app",
+  "private": true,
+  "type": "module",
+  "packageManager": "bun@1.3.10",
+  "scripts": {
+    "dev": "relkit dev",
+    "check": "relkit check",
+    "typecheck": "tsc --noEmit",
+    "test": "bun test",
+    "build": "relkit build",
+    "start": "relkit start",
+    "jobs:trigger": "relkit jobs trigger --job exportOrders --input-file examples/export-orders.json --operation-id example-trigger"
+  },
+  "dependencies": {
+    "@relkit/app": "0.5.1"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.10",
+    "@relkit/cli": "0.5.1",
+    "@relkit/testing": "0.5.1",
+    "typescript": "5.9.3"
+  }
+}

package/dist/templates/default/v1/tasks/relkit.config.ts

@@ -0,0 +1,11 @@
+import { defineApp } from "@relkit/app/config";
+import env from "@app/platform/env.js";
+// relkit:create:deployment-imports
+
+export default defineApp({
+  env,
+  server: { port: 3000, maxBodyBytes: 1_048_576 },
+  inspector: { port: 3210 },
+  telemetry: { redaction: { mode: "development-redacted", maxBytes: 65_536 } },
+  // relkit:create:deployment
+});

package/dist/templates/default/v1/tasks/src/orders/functions/health.function.ts

@@ -0,0 +1,9 @@
+import { defineFunction } from "@relkit/app/functions";
+import { z } from "@relkit/app/schema";
+
+export default defineFunction({
+  id: "orders.health",
+  input: z.object({}),
+  output: z.object({ ok: z.literal(true) }),
+  handler: async () => ({ ok: true as const }),
+});

package/dist/templates/default/v1/tasks/src/orders/jobs/export-orders.job.ts

@@ -0,0 +1,15 @@
+import { defineJob } from "@relkit/app/jobs";
+import exportOrders from "@app/orders/tasks/export-orders.task.js";
+
+const exportOrdersJob = defineJob({
+  id: "orders.export-orders-job",
+  name: "exportOrders",
+  task: exportOrders,
+  client: {
+    public: true,
+    operations: ["trigger", "get", "list", "watch"],
+    fields: ["status", "progress", "output"],
+  },
+});
+
+export default exportOrdersJob;

package/dist/templates/default/v1/tasks/src/orders/service.ts

@@ -0,0 +1,10 @@
+import { defineService } from "@relkit/app/services";
+import exportOrders from "@app/orders/jobs/export-orders.job.js";
+import exportOrdersTask from "@app/orders/tasks/export-orders.task.js";
+import health from "@app/orders/functions/health.function.js";
+
+export default defineService({
+  functions: { health },
+  tasks: { exportOrdersTask },
+  jobs: { exportOrders },
+});

package/dist/templates/default/v1/tasks/src/orders/tasks/export-orders.task.ts

@@ -0,0 +1,19 @@
+import { defineTask } from "@relkit/app/tasks";
+import { z } from "@relkit/app/schema";
+
+const exportOrders = defineTask({
+  id: "orders.export-orders",
+  version: "1",
+  execution: "durable",
+  input: z.object({ orderIds: z.array(z.string()) }),
+  output: z.object({ exported: z.number().int().nonnegative() }),
+  progress: z.object({ completed: z.number().int().nonnegative() }),
+  handler: async ({ orderIds }, context) => {
+    await context.progress.emit({ completed: 0 });
+    context.log.info("fake order export", { count: orderIds.length });
+    await context.progress.emit({ completed: orderIds.length });
+    return { exported: orderIds.length };
+  },
+});
+
+export default exportOrders;

package/dist/templates/default/v1/tasks/src/platform/env.ts

@@ -0,0 +1,3 @@
+import { defineEnv } from "@relkit/app/config";
+
+export default defineEnv({});

package/dist/templates/default/v1/tasks/src/routes/health/route.ts

@@ -0,0 +1,4 @@
+import { defineRoute } from "@relkit/app/routes";
+import orders from "@app/orders/service.js";
+
+export const GET = defineRoute({ target: orders.health });

package/dist/templates/default/v1/tasks/tests/unit/export-orders.task.test.ts

@@ -0,0 +1,7 @@
+import { expect, test } from "bun:test";
+import task from "@app/orders/tasks/export-orders.task.js";
+
+test("declares a typed export task", () => {
+  expect(task.ref.id).toBe("orders.export-orders");
+  expect(task.version).toBe("1");
+});

package/dist/templates/default/v1/tasks/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "allowImportingTsExtensions": true,
+    "baseUrl": ".",
+    "paths": { "@app/*": ["src/*"] }
+  },
+  "include": ["src", "tests", "examples"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-relkit",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "Create a RELKIT application from a supported project template.",
   "license": "MIT",
   "repository": {
@@ -35,5 +35,10 @@
     "build": "tsc -b && bun ../../scripts/package-create-relkit-templates.ts",
     "check": "tsc -b --pretty false",
     "typecheck": "tsc -b --pretty false && bun ../../scripts/package-create-relkit-templates.ts"
+  },
+  "dependencies": {
+    "@clack/prompts": "1.7.0",
+    "@relkit/compiler": "0.5.1",
+    "typescript": "5.9.3"
   }
 }

package/dist/templates/default/v1/agent/src/hello/functions/ask-assistant.function.ts

@@ -1,16 +0,0 @@
-import { defineFunction } from "@relkit/app/functions";
-import { z } from "@relkit/app/schema";
-import assistant from "@app/hello/agents/assistant.agent.js";
-
-export default defineFunction({
-  id: "hello.ask-assistant",
-
-  input: z.object({ question: z.string().min(1) }),
-  output: z.object({ answer: z.string() }),
-
-  dependencies: { agents: { assistant } },
-
-  handler: async (input, context) => {
-    return context.agents.assistant(input);
-  },
-});