create-objectstack 14.7.0 → 15.0.0

package/README.md

@@ -1,15 +1,19 @@
 # create-objectstack
 
-Scaffold a new [ObjectStack](https://objectstack.com) project in seconds.
+Scaffold a new [ObjectStack](https://objectstack.ai) project in seconds.
+
+```bash
+npm create objectstack@latest my-app
+```
 
 ## Usage
 
 ```bash
-# Interactive — creates project in a new directory
+# Create a project in a new directory (blank template)
 npx create-objectstack my-app
 
 # Use a specific template
-npx create-objectstack my-app --template full-stack
+npx create-objectstack my-app --template todo
 
 # Scaffold in the current directory
 npx create-objectstack
@@ -20,80 +24,71 @@ npx create-objectstack my-app --skip-install
 
 ## Templates
 
-| Template | Description |
-| --- | --- |
-| `minimal-api` *(default)* | Server + memory driver + 1 object + REST API |
-| `full-stack` | Server + UI + auth + 3 CRM objects (Contact, Company, Deal) |
-| `plugin` | Reusable plugin skeleton with test setup |
+| Template | Source | Description |
+| --- | --- | --- |
+| `blank` *(default)* | bundled (offline) | Minimal starter — one object, REST API, ready to extend |
+| `todo` | remote | Universal task & project management starter |
+| `compliance` | remote | Compliance posture & evidence management (SOC2 / ISO27001) |
+| `content` | remote | Content marketing pipeline — editorial calendar & channel ROI |
+| `contracts` | remote | Post-signature CLM — approvals, obligations, renewals |
+| `procurement` | remote | Source-to-pay — vendors, POs, receipts, invoice matching |
+
+Remote templates are fetched from
+[`objectstack-ai/templates`](https://github.com/objectstack-ai/templates) at
+scaffold time and require network access; `blank` is bundled and always works
+offline.
 
 ## Options
 
 | Option | Description |
 | --- | --- |
 | `[name]` | Project name (defaults to current directory name) |
-| `-t, --template <name>` | Project template (default: `minimal-api`) |
+| `-t, --template <name>` | Project template (default: `blank`) |
 | `--skip-install` | Skip dependency installation |
+| `--skip-skills` | Skip installing the ObjectStack AI skills bundle |
 | `-V, --version` | Show version |
 | `-h, --help` | Show help |
 
-## What Gets Generated
+## What it does
+
+1. Copies the template into the target directory and rewrites its identity:
+   `package.json` name, `objectstack.manifest.json` name/displayName, the
+   `objectstack.config.ts` manifest literals, and the README title. A
+   **namespace** is derived from the project name (`my-app` → `my_app`) and
+   every object name in the template is re-prefixed to match
+   (`blank_note` → `my_app_note`).
+2. Installs dependencies (pnpm if available, otherwise npm).
+3. Installs the ObjectStack AI skills bundle for coding agents
+   (`npx skills add objectstack-ai/framework --all`).
+4. Writes `AGENTS.md` and `.github/copilot-instructions.md` with the project
+   conventions — unless the template ships its own.
 
-### minimal-api
+## What Gets Generated (blank)
 
 ```
 my-app/
-├── objectstack.config.ts
+├── objectstack.config.ts        # defineStack() entry point
+├── objectstack.manifest.json    # name, namespace, version
 ├── package.json
 ├── tsconfig.json
 ├── .gitignore
 ├── README.md
+├── AGENTS.md                    # conventions for coding agents
 └── src/
     └── objects/
         ├── index.ts
-        └── task.ts
+        └── note.object.ts
 ```
 
-### full-stack
+Next steps inside the project:
 
+```bash
+npm run dev        # start the dev server
+npm run validate   # verify metadata: schema + predicates + bindings
 ```
-my-app/
-├── objectstack.config.ts
-├── package.json
-├── tsconfig.json
-├── .gitignore
-├── README.md
-└── src/
-    ├── objects/
-    │   ├── index.ts
-    │   ├── contact.ts
-    │   ├── company.ts
-    │   └── deal.ts
-    ├── views/
-    │   ├── contact_list.ts
-    │   ├── company_list.ts
-    │   └── deal_list.ts
-    └── apps/
-        ├── index.ts
-        └── crm.ts
-```
-
-### plugin
 
-```
-my-plugin/
-├── objectstack.config.ts
-├── package.json
-├── tsconfig.json
-├── .gitignore
-├── README.md
-├── src/
-│   ├── index.ts
-│   └── objects/
-│       ├── index.ts
-│       └── sample.ts
-└── test/
-    └── sample.test.ts
-```
+See the docs:
+[Your First Project](https://docs.objectstack.ai/docs/getting-started/your-first-project).
 
 ## License
 

package/dist/index.js

@@ -11,9 +11,24 @@ import { createGunzip } from "zlib";
 import { createWriteStream, createReadStream } from "fs";
 import { mkdtemp, rm } from "fs/promises";
 import * as tar from "tar";
-var __filename = fileURLToPath(import.meta.url);
-var __dirname = path.dirname(__filename);
-var BUNDLED_TEMPLATES_DIR = path.resolve(__dirname, "templates");
+
+// src/pkg-utils.ts
+function syncObjectStackDeps(pkg, version) {
+  if (!/^\d+\.\d+\.\d+/.test(version) || version.startsWith("0.")) return;
+  for (const deps of [pkg.dependencies, pkg.devDependencies]) {
+    if (!deps) continue;
+    for (const dep of Object.keys(deps)) {
+      if (dep.startsWith("@objectstack/")) {
+        deps[dep] = `^${version}`;
+      }
+    }
+  }
+}
+
+// src/index.ts
+var __filename2 = fileURLToPath(import.meta.url);
+var __dirname2 = path.dirname(__filename2);
+var BUNDLED_TEMPLATES_DIR = path.resolve(__dirname2, "templates");
 var REMOTE_REPO = "objectstack-ai/templates";
 var REMOTE_BRANCH = "main";
 var REMOTE_TARBALL_URL = `https://codeload.github.com/${REMOTE_REPO}/tar.gz/refs/heads/${REMOTE_BRANCH}`;
@@ -59,7 +74,7 @@ function sanitizeNamespace(name) {
 }
 function readCliVersion() {
   try {
-    const pkgPath = path.resolve(__dirname, "..", "package.json");
+    const pkgPath = path.resolve(__dirname2, "..", "package.json");
     const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
     return String(pkg.version || "0.0.0");
   } catch {
@@ -196,6 +211,7 @@ function rewriteProjectIdentity(targetDir, projectName, namespace) {
     try {
       const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
       pkg.name = projectName;
+      syncObjectStackDeps(pkg, readCliVersion());
       fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
     } catch {
     }

package/dist/templates/blank/README.md

@@ -9,7 +9,17 @@ pnpm install
 pnpm dev
 ```
 
-The REST API is served at `http://localhost:3000/api`.
+The REST API is served at `http://localhost:3000/api/v1`. Data endpoints
+require a session — the dev server seeds a login-ready admin
+(`admin@objectos.ai` / `admin123`) on an empty database:
+
+```bash
+curl -c cookies.txt -X POST http://localhost:3000/api/v1/auth/sign-in/email \
+  -H "Content-Type: application/json" \
+  -d '{"email":"admin@objectos.ai","password":"admin123"}'
+
+curl -b cookies.txt "http://localhost:3000/api/v1/data/<your_object>"
+```
 
 ## Layout
 

package/dist/templates/blank/objectstack.config.ts

@@ -11,10 +11,4 @@ export default defineStack({
     description: 'Minimal ObjectStack environment — a clean slate for building.',
   },
   objects: Object.values(objects),
-  api: {
-    rest: {
-      enabled: true,
-      basePath: '/api',
-    },
-  },
 });

package/dist/templates/blank/package.json

@@ -11,13 +11,13 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@objectstack/spec": "^6.0.0",
-    "@objectstack/runtime": "^6.0.0",
-    "@objectstack/driver-memory": "^6.0.0",
-    "@objectstack/plugin-hono-server": "^6.0.0"
+    "@objectstack/spec": "^15.0.0",
+    "@objectstack/runtime": "^15.0.0",
+    "@objectstack/driver-memory": "^15.0.0",
+    "@objectstack/plugin-hono-server": "^15.0.0"
   },
   "devDependencies": {
-    "@objectstack/cli": "^6.0.0",
-    "typescript": "^5.3.0"
+    "@objectstack/cli": "^15.0.0",
+    "typescript": "^6.0.0"
   }
 }

package/dist/templates/blank/src/objects/note.object.ts

@@ -16,11 +16,15 @@ export const Note = ObjectSchema.create({
       searchable: true,
       maxLength: 200,
     }),
-    body: Field.longText({
+    body: Field.textarea({
       label: 'Body',
     }),
   },
 
+  // Org-wide default (OWD): who can see records they don't own. The security
+  // posture gate (ADR-0090) requires an explicit, authored decision here.
+  sharingModel: 'private',
+
   enable: {
     apiEnabled: true,
     searchable: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-objectstack",
-  "version": "14.7.0",
+  "version": "15.0.0",
   "description": "Create a new ObjectStack project — npx create-objectstack",
   "bin": {
     "create-objectstack": "./bin/create-objectstack.js"
@@ -23,7 +23,8 @@
     "@types/node": "^26.1.1",
     "@types/tar": "^7.0.87",
     "tsup": "^8.5.1",
-    "typescript": "^6.0.3"
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10"
   },
   "repository": {
     "type": "git",
@@ -44,6 +45,7 @@
   },
   "scripts": {
     "build": "tsup",
-    "dev": "tsup --watch"
+    "dev": "tsup --watch",
+    "test": "vitest run"
   }
 }