robodev 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "robodev",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "CLI for Robodev Starbase — create, auth, link, and deploy file-based APIs",
   "type": "module",
   "license": "MIT",

package/src/api.ts

@@ -55,6 +55,7 @@ async function refresh(refreshToken: string): Promise<Credentials | null> {
   return (await res.json()) as Credentials;
 }
 
+/** Authenticated Starbase request. Reads `~/.robodev/credentials.json` and refreshes on 401. */
 export async function authed<T>(path: string, init: RequestInit = {}): Promise<T> {
   const credentials = await readCredentials();
   if (!credentials) {

package/src/config.ts

@@ -15,18 +15,22 @@ export type ProjectLink = {
 
 const PROD_URL = "https://robodev.povio.dev";
 
+/** Control-plane API. Override with `STARBASE_URL` for local Starbase. */
 export function starbaseUrl(): string {
   return (process.env.STARBASE_URL ?? PROD_URL).replace(/\/$/, "");
 }
 
+/** Browser UI used for OAuth. Override with `STARBASE_FE_URL`. */
 export function feUrl(): string {
   return (process.env.STARBASE_FE_URL ?? process.env.STARBASE_URL ?? PROD_URL).replace(/\/$/, "");
 }
 
+/** `~/.robodev/credentials.json` — tokens from `robodev auth`. */
 export function credentialsPath(): string {
   return join(homedir(), ".robodev", "credentials.json");
 }
 
+/** Project link file written by `create` / `link`. */
 export function linkPath(cwd = process.cwd()): string {
   return join(cwd, ".robodev");
 }
@@ -61,6 +65,7 @@ export async function writeLink(link: ProjectLink, cwd = process.cwd()): Promise
   await writeFile(linkPath(cwd), `${JSON.stringify(link, null, 2)}\n`);
 }
 
+/** Sets `VITE_API_URL` so the starter UI talks to the deployed project host. */
 export async function writeViteApiUrl(projectApiUrl: string, cwd = process.cwd()): Promise<void> {
   const envPath = join(cwd, ".env");
   let content = "";

package/src/index.ts

@@ -55,6 +55,7 @@ function prompt(question: string): Promise<string> {
   return rl.question(question).finally(() => rl.close());
 }
 
+/** Local loopback server that completes the browser OAuth handshake for `robodev auth`. */
 async function waitForOauthCode(): Promise<{ code: string; redirectUri: string }> {
   const state = randomBytes(16).toString("hex");
   return new Promise((resolve, reject) => {
@@ -184,6 +185,7 @@ async function runLink(projectId?: string): Promise<void> {
   console.log(`Frontend API ${project.apiUrl}`);
 }
 
+/** Collects `database.ts` plus every TypeScript file under `api/` for a deploy upload. */
 async function collectFiles(root: string): Promise<{ path: string; content: string }[]> {
   const files: { path: string; content: string }[] = [];
   const database = join(root, "database.ts");
@@ -220,6 +222,7 @@ async function collectFiles(root: string): Promise<{ path: string; content: stri
   return files;
 }
 
+/** Uploads schema + APIs. Destructive schema changes need confirmation or `--force`. */
 async function runDeploy(forceFlag: boolean, root = process.cwd()): Promise<void> {
   const link = await readLink(root);
   if (!link) {
@@ -356,6 +359,7 @@ async function npmInstall(root: string): Promise<void> {
   });
 }
 
+/** Creates a Starbase project, copies the starter template, links, deploys, and installs deps. */
 async function runCreate(pathArg?: string): Promise<void> {
   const root = resolve(process.cwd(), pathArg ?? ".");
   await mkdir(root, { recursive: true });

package/template/README.md

@@ -1,6 +1,6 @@
 # {{NAME}}
 
-Example Robodev app: a `space` database (`planets`, `rockets`), APIs in `api/`, and a small React UI.
+Starter app from `robodev create`: a `space` database (`planets`, `rockets`), file-based APIs in `api/`, and a small React UI.
 
 The backend is already on Starbase. Run the frontend:
 
@@ -10,6 +10,8 @@ npm run dev
 
 It reads `VITE_API_URL` from `.env` (written by `robodev create` / `robodev link`).
 
+Docs: https://robodev.povio.dev/docs
+
 Add tables in `database.ts` and routes as `api/<name>.ts`, then:
 
 ```bash

package/template/api/health.ts

@@ -1,4 +1,5 @@
-import { defineApi, z } from "robodev-lib";
+/** GET /health — liveness check for the deployed project host. */
+import { defineApi, z } from "@robodev-ai/sdk";
 
 export const get = defineApi({
   response: z.object({ ok: z.literal(true) }),

package/template/api/launch.ts

@@ -1,5 +1,6 @@
+/** POST /launch — marks a rocket as launched. */
 import { rockets } from "../database";
-import { defineApi, eq, z } from "robodev-lib";
+import { defineApi, eq, z } from "@robodev-ai/sdk";
 
 const Rocket = z.object({
   id: z.string(),

package/template/api/planets.ts

@@ -1,5 +1,6 @@
+/** GET/POST /planets — list (seeds sample rows on first GET) and create planets. */
 import { planets, rockets } from "../database";
-import { defineApi, z } from "robodev-lib";
+import { defineApi, z } from "@robodev-ai/sdk";
 
 const EARTH = "11111111-1111-1111-1111-111111111111";
 const MARS = "22222222-2222-2222-2222-222222222222";

package/template/api/rockets.ts

@@ -1,5 +1,6 @@
+/** GET/POST /rockets — list (optional `?destinationId=`) and create rockets. */
 import { rockets } from "../database";
-import { defineApi, eq, z } from "robodev-lib";
+import { defineApi, eq, z } from "@robodev-ai/sdk";
 
 const Rocket = z.object({
   id: z.string(),

package/template/database.ts

@@ -1,4 +1,8 @@
-import { boolean, defineDatabase, integer, pgTable, text, timestamp, uuid } from "robodev-lib";
+/**
+ * Starter schema. `robodev deploy` creates the `space` database and these tables
+ * (no migration files). Edit here and deploy again to sync.
+ */
+import { boolean, defineDatabase, integer, pgTable, text, timestamp, uuid } from "@robodev-ai/sdk";
 
 export const planets = pgTable("planets", {
   id: uuid("id").primaryKey().defaultRandom(),

package/template/package.json

@@ -10,7 +10,7 @@
   "dependencies": {
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "robodev-lib": "^0.2.0"
+    "@robodev-ai/sdk": "^0.2.0"
   },
   "devDependencies": {
     "@types/react": "^18.3.24",

package/template/src/main.tsx

@@ -1,3 +1,4 @@
+/** Starter UI. Calls the deployed project host using `VITE_API_URL` from `.env`. */
 import { StrictMode, useEffect, useState, type FormEvent } from "react";
 import { createRoot } from "react-dom/client";