@notionx/create-notionx-app 1.0.0

package/dist/templates/next.config.ts.tmpl

@@ -0,0 +1,18 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  // Add project-specific headers, redirects, or rewrites here.
+
+  // Allow `next/image` to load cover art hosted by Notion and the
+  // common placeholder hosts the scaffolder seeds into sample posts.
+  // Adjust this list if you self-host covers on R2 or another CDN.
+  images: {
+    remotePatterns: [
+      { protocol: "https", hostname: "prod-files-secure.s3.us-west-2.amazonaws.com" },
+      { protocol: "https", hostname: "www.notion.so" },
+      { protocol: "https", hostname: "images.unsplash.com" },
+    ],
+  },
+};
+
+export default nextConfig;

package/dist/templates/package.json.tmpl

@@ -0,0 +1,40 @@
+{
+  "name": "{{projectNameLower}}",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "dev": "vinext dev --port 3001",
+    "build": "vinext build",
+    "start": "vinext start",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "deploy": "vinext deploy",
+    "migrate:remote": "wrangler d1 migrations apply {{projectNameLower}}-db --remote"
+  },
+  "dependencies": {
+{{dependenciesBlock}}
+  },
+  "devDependencies": {
+    "@cloudflare/vite-plugin": "^1.40.0",
+    "@cloudflare/workers-types": "^4",
+    "@notionx/create-notionx-app": "{{createNotionxAppVersion}}",
+    "@tailwindcss/vite": "^4.0.0",
+    "@types/node": "^22",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@vinext/cloudflare": "^0.1.2",
+    "@vitejs/plugin-rsc": "^0.5.0",
+    "ntn": "^0.16.0",
+    "tailwindcss": "^4.0.0",
+    "typescript": "^5.5",
+    "vinext": "^0.1.4",
+    "vite": "^8",
+    "vitest": "^2",
+    "wrangler": "^4"
+  }
+}

package/dist/templates/shims/cloudflare-workers-empty.mjs

@@ -0,0 +1,4 @@
+// Minimal shim for `cloudflare:workers` in the client environment.
+// The real module is resolved by the @cloudflare/vite-plugin in the
+// rsc/ssr environments; the client bundle scan never executes this.
+export {};

package/dist/templates/shims/next-headers-empty.mjs

@@ -0,0 +1,4 @@
+// Minimal shim for `next/headers` in the client environment.
+// The real module is resolved by vinext/next in the rsc/ssr
+// environments; the client bundle scan never executes this.
+export {};

package/dist/templates/tests/smoke.test.ts.tmpl

@@ -0,0 +1,83 @@
+// Sanity test for the generated project. Verifies that
+// `defineContentSource` registers the content source picked in the
+// scaffolder prompt under the expected id and that the
+// `@notionx/core` API surface is reachable from the generated
+// project.
+
+import { describe, it, expect } from "vitest";
+import { {{contentSourceVarName}} } from "../lib/content/models.ts";
+import { pageFields, pagesDataSourceEnv } from "../lib/pages/model.ts";
+import {
+  defineContentSource,
+  getRegisteredSource,
+  getRegisteredSources,
+  type ContentSource,
+} from "@notionx/core/content";
+
+describe("content source registration", () => {
+  it("uses the id chosen in the scaffolder prompt", () => {
+    expect({{contentSourceVarName}}.id).toBe("{{contentSourceId}}");
+  });
+
+  it("is visible in notionx's registry", () => {
+    const ids = getRegisteredSources().map((s: ContentSource) => s.id);
+    expect(ids).toContain("{{contentSourceId}}");
+  });
+
+  it("returns the same instance from getRegisteredSource", () => {
+    expect(getRegisteredSource("{{contentSourceId}}")).toBe({{contentSourceVarName}});
+  });
+});
+
+describe("pages model", () => {
+  it("declares the Notion fields used for navigation and page rendering", () => {
+    expect(pagesDataSourceEnv).toBe("NOTION_PAGES_DATA_SOURCE_ID");
+    expect(pageFields.key).toBe("Key");
+    expect(pageFields.showInNav).toBe("Show in Nav");
+    expect(pageFields.footerOrder).toBe("Footer Order");
+    expect(pageFields.contentSource).toBe("Content Source");
+  });
+});
+
+describe("defineContentSource", () => {
+  it("is a re-registration-safe factory", () => {
+    const id = "smoke-{{contentSourceId}}";
+    const first = defineContentSource({
+      id,
+      kind: "article",
+      visibility: { public: true, admin: false },
+      source: {
+        type: "notion",
+        tokenEnv: "NOTION_TOKEN",
+        dataSourceEnv: "NOTION_DATA_SOURCE_ID",
+        fields: { title: "Title" },
+        query: { pageSize: 10 },
+      },
+      routes: {
+        listPath: "/smoke",
+        detailPath: "/smoke/[slug]",
+        detailParam: "slug",
+      },
+      ui: {
+        name: "Smoke",
+        pluralName: "Smokes",
+        navLabel: "Smoke",
+        listTitle: "Smoke",
+        listDescription: "Smoke",
+        emptyState: "empty",
+      },
+      capabilities: {
+        richBlocks: false,
+        coverImages: false,
+        gatedAssets: false,
+      },
+    });
+    expect(getRegisteredSource(id)).toBe(first);
+    const second = defineContentSource({
+      ...first,
+      ui: { ...first.ui, listTitle: "Updated" },
+    });
+    expect(getRegisteredSource(id)).toBe(second);
+    expect(getRegisteredSource(id)?.ui.listTitle).toBe("Updated");
+  });
+});

package/dist/templates/tsconfig.json.tmpl

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [{ "name": "next" }],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": [
+    "next-env.d.ts",
+    "env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
+  "exclude": ["node_modules", "dist", ".wrangler"]
+}

package/dist/templates/vite.config.ts.tmpl

@@ -0,0 +1,53 @@
+import { defineConfig, type Plugin } from "vite";
+import vinext from "vinext";
+import { cloudflare } from "@cloudflare/vite-plugin";
+import tailwindcss from "@tailwindcss/vite";
+import { kvDataAdapter } from "@vinext/cloudflare/cache/kv-data-adapter";
+import { fileURLToPath } from "node:url";
+
+/**
+ * Provide empty shims for `cloudflare:workers` and `next/headers` in the
+ * client environment only. The cloudflare vite plugin resolves these
+ * virtual modules in the rsc/ssr environments, and workerd provides
+ * them at runtime. The client pre-bundle scan never executes the code;
+ * it just needs the import to resolve.
+ */
+function serverOnlyShimsForClient(): Plugin {
+  return {
+    name: "vinext:server-only-shims-for-client",
+    enforce: "pre",
+    resolveId(id) {
+      if (this.environment?.name !== "client") return null;
+      if (id === "cloudflare:workers") {
+        return fileURLToPath(
+          new URL("./shims/cloudflare-workers-empty.mjs", import.meta.url),
+        );
+      }
+      if (id === "next/headers") {
+        return fileURLToPath(
+          new URL("./shims/next-headers-empty.mjs", import.meta.url),
+        );
+      }
+      return null;
+    },
+  };
+}
+
+export default defineConfig({
+  plugins: [
+    // `kvDataAdapter()` is a config-time builder: it just returns a
+    // serializable descriptor pointing at the runtime KV cache factory.
+    // The actual KV handler is instantiated lazily on the first request
+    // (it reads the `VINEXT_KV_CACHE` binding from `env`), so this is
+    // safe to call from `vite.config.ts` — it never touches workerd.
+    vinext({ cache: { data: kvDataAdapter() } }),
+    cloudflare({ viteEnvironment: { name: "rsc", childEnvironments: ["ssr"] } }),
+    tailwindcss(),
+    serverOnlyShimsForClient(),
+  ],
+  resolve: {
+    alias: {
+      "@": fileURLToPath(new URL(".", import.meta.url)),
+    },
+  },
+});

package/dist/templates/vitest.config.ts.tmpl

@@ -0,0 +1,13 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    include: ["tests/**/*.test.{ts,mjs}"],
+  },
+  resolve: {
+    alias: {
+      "@": new URL(".", import.meta.url).pathname,
+    },
+  },
+});

package/dist/templates/worker/index.ts.tmpl

@@ -0,0 +1,52 @@
+// Cloudflare Worker entry point. Notionx-routed requests (health,
+// storage, notion media) are handled by `createNotionxWorker`
+// before falling through to the vinext app router.
+
+import handler from "vinext/server/app-router-entry";
+import { createNotionxWorker } from "@notionx/core/worker";
+import { authConfig } from "../lib/auth.config";
+import { searchAdapter } from "../lib/search/config";
+import { adminNav } from "../lib/admin/nav";
+import { managedContentSources } from "../lib/content/models";
+import { siteConfig } from "../lib/site/config";
+import { runWithRequestEnv } from "../lib/site/request-env";
+
+const notionx = createNotionxWorker({
+  sources: [...managedContentSources],
+  adminNav,
+  // `authConfig` is `undefined` when auth is disabled (scaffolded
+  // with `--no-auth` or after `notionx remove auth`). The worker
+  // bootstrap handles `undefined` by skipping session/admin gates.
+  ...(authConfig ? { authConfig } : {}),
+  // `searchAdapter` is `undefined` when search is disabled
+  // (scaffolded with `--no-search` or after `notionx remove search`).
+  // The worker bootstrap handles `undefined` by not registering
+  // the `/api/search` route.
+  ...(searchAdapter ? { searchAdapter } : {}),
+  siteConfig: {
+    name: siteConfig.name,
+    description: siteConfig.description,
+    defaultLocale: siteConfig.defaultLocale,
+    locales: [...siteConfig.locales],
+    navigation: siteConfig.navigation.main as unknown as unknown[],
+  },
+});
+
+export default {
+  async fetch(
+    request: Request,
+    env: Env,
+    ctx: ExecutionContext
+  ): Promise<Response> {
+    // Make `env` reachable from any async code path (RSC server
+    // components, server actions, Notion content loaders, etc.) via
+    // `getRequestEnv()`. See `lib/site/request-env.ts` for the
+    // rationale — we cannot use `cloudflare:workers.getRequestContext`
+    // because that module does not export it.
+    return runWithRequestEnv(env, async () => {
+      const notionxResponse = await notionx.fetch(request, env, ctx);
+      if (notionxResponse) return notionxResponse;
+      return handler.fetch(request, env, ctx);
+    });
+  },
+};

package/dist/templates/wrangler.jsonc.tmpl

@@ -0,0 +1,44 @@
+{
+  "$schema": "node_modules/wrangler/config-schema.json",
+  "name": "{{projectNameLower}}",
+  "compatibility_date": "2026-06-05",
+  "compatibility_flags": ["nodejs_compat"],
+  "main": "./worker/index.ts",
+  "assets": {
+    "directory": "dist/client",
+    "not_found_handling": "none",
+    "binding": "ASSETS"
+  },
+  "images": {
+    "binding": "IMAGES"
+  },
+  "d1_databases": [
+    {
+      "binding": "DB",
+      "database_name": "{{projectNameLower}}-db",
+      "database_id": "REPLACE_WITH_D1_DATABASE_ID",
+      "migrations_dir": "migrations"
+    }
+  ],
+  "kv_namespaces": [
+    {
+      "binding": "CONTENT_CACHE",
+      "id": "REPLACE_WITH_KV_NAMESPACE_ID"
+    },
+    {
+      "binding": "VINEXT_KV_CACHE",
+      "id": "REPLACE_WITH_VINEXT_KV_NAMESPACE_ID"
+    }
+  ],
+  "r2_buckets": [
+    {
+      "binding": "ASSETS_BUCKET",
+      "bucket_name": "{{projectNameLower}}-assets"
+    }
+  ],
+  "vars": {
+    "SITE_URL": "https://{{projectNameLower}}.example.com",
+    "NOTION_BLOCKS_DATA_SOURCE_ID": "REPLACE_WITH_NOTION_BLOCKS_DATA_SOURCE_ID",
+    "NOTION_SITE_SETTINGS_DATA_SOURCE_ID": "REPLACE_WITH_NOTION_SITE_SETTINGS_DATA_SOURCE_ID"
+  }
+}

package/dist/ui-presets.js

@@ -0,0 +1,60 @@
+// packages/create-notionx-app/src/ui-presets.ts
+//
+// Mirrors the component list from `presets.ts` for callers that
+// need the raw array (e.g. the README's "What's included" section)
+// plus dependency rendering helpers. The scaffolder only ships the
+// "site" set, so there is no preset-selection layer here.
+const SITE_PRESET_COMPONENTS = [
+    "accordion",
+    "alert",
+    "aspect-ratio",
+    "badge",
+    "button",
+    "card",
+    "dialog",
+    "dropdown-menu",
+    "input",
+    "label",
+    "separator",
+    "sheet",
+    "skeleton",
+    "table",
+    "tabs",
+    "tooltip",
+];
+const BASE_DEPENDENCIES = {
+    "@radix-ui/react-slot": "^1.2.0",
+    "class-variance-authority": "^0.7.1",
+    clsx: "^2.1.1",
+    "lucide-react": "^0.460.0",
+    "next-themes": "^0.4.4",
+    "tailwind-merge": "^2.5.5",
+    "tailwindcss-animate": "^1.0.7",
+};
+const COMPONENT_DEPENDENCIES = {
+    accordion: { "@radix-ui/react-accordion": "^1.2.1" },
+    "aspect-ratio": { "@radix-ui/react-aspect-ratio": "^1.1.0" },
+    dialog: { "@radix-ui/react-dialog": "^1.1.2" },
+    "dropdown-menu": { "@radix-ui/react-dropdown-menu": "^2.1.2" },
+    label: { "@radix-ui/react-label": "^2.1.0" },
+    separator: { "@radix-ui/react-separator": "^1.1.0" },
+    sheet: { "@radix-ui/react-dialog": "^1.1.2" },
+    tabs: { "@radix-ui/react-tabs": "^1.1.1" },
+    tooltip: { "@radix-ui/react-tooltip": "^1.1.4" },
+};
+export function uiComponents() {
+    return SITE_PRESET_COMPONENTS;
+}
+export function uiDependencies() {
+    const deps = { ...BASE_DEPENDENCIES };
+    for (const component of SITE_PRESET_COMPONENTS) {
+        Object.assign(deps, COMPONENT_DEPENDENCIES[component]);
+    }
+    return Object.fromEntries(Object.entries(deps).sort(([a], [b]) => a.localeCompare(b)));
+}
+export function renderDependencyLines(deps, indent = "    ") {
+    return Object.entries(deps)
+        .map(([name, version]) => `${indent}${JSON.stringify(name)}: ${JSON.stringify(version)},`)
+        .join("\n");
+}
+//# sourceMappingURL=ui-presets.js.map

package/dist/ui-presets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-presets.js","sourceRoot":"","sources":["../src/ui-presets.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,EAAE;AACF,gEAAgE;AAChE,mEAAmE;AACnE,mEAAmE;AACnE,0DAA0D;AAE1D,MAAM,sBAAsB,GAAG;IAC7B,WAAW;IACX,OAAO;IACP,cAAc;IACd,OAAO;IACP,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,eAAe;IACf,OAAO;IACP,OAAO;IACP,WAAW;IACX,OAAO;IACP,UAAU;IACV,OAAO;IACP,MAAM;IACN,SAAS;CACD,CAAC;AAEX,MAAM,iBAAiB,GAA2B;IAChD,sBAAsB,EAAE,QAAQ;IAChC,0BAA0B,EAAE,QAAQ;IACpC,IAAI,EAAE,QAAQ;IACd,cAAc,EAAE,UAAU;IAC1B,aAAa,EAAE,QAAQ;IACvB,gBAAgB,EAAE,QAAQ;IAC1B,qBAAqB,EAAE,QAAQ;CAChC,CAAC;AAEF,MAAM,sBAAsB,GAA2C;IACrE,SAAS,EAAE,EAAE,2BAA2B,EAAE,QAAQ,EAAE;IACpD,cAAc,EAAE,EAAE,8BAA8B,EAAE,QAAQ,EAAE;IAC5D,MAAM,EAAE,EAAE,wBAAwB,EAAE,QAAQ,EAAE;IAC9C,eAAe,EAAE,EAAE,+BAA+B,EAAE,QAAQ,EAAE;IAC9D,KAAK,EAAE,EAAE,uBAAuB,EAAE,QAAQ,EAAE;IAC5C,SAAS,EAAE,EAAE,2BAA2B,EAAE,QAAQ,EAAE;IACpD,KAAK,EAAE,EAAE,wBAAwB,EAAE,QAAQ,EAAE;IAC7C,IAAI,EAAE,EAAE,sBAAsB,EAAE,QAAQ,EAAE;IAC1C,OAAO,EAAE,EAAE,yBAAyB,EAAE,QAAQ,EAAE;CACjD,CAAC;AAEF,MAAM,UAAU,YAAY;IAC1B,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,IAAI,GAA2B,EAAE,GAAG,iBAAiB,EAAE,CAAC;IAC9D,KAAK,MAAM,SAAS,IAAI,sBAAsB,EAAE,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAC5D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,IAA4B,EAC5B,MAAM,GAAG,MAAM;IAEf,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACxB,GAAG,CACF,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAClB,GAAG,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAClE;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@notionx/create-notionx-app",
+  "version": "1.0.0",
+  "description": "Scaffold a new vinext (Next.js on Cloudflare Workers + D1 + R2) project backed by @notionx/core, with one-step provisioning of D1 / KV / R2 / Turnstile / Notion / Resend / Google OAuth.",
+  "type": "module",
+  "bin": {
+    "create-notionx-app": "./dist/index.js",
+    "notionx": "./dist/cli-notionx.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "vinext",
+    "notionx",
+    "notionx",
+    "nextjs",
+    "cloudflare",
+    "workers",
+    "d1",
+    "r2",
+    "turnstile",
+    "notion",
+    "scaffold",
+    "create-notionx-app"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.7"
+  },
+  "devDependencies": {
+    "@types/node": "^22",
+    "tsx": "^4",
+    "typescript": "^5.5",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/digwis/nextion.git",
+    "directory": "packages/create-notionx-app"
+  },
+  "author": "zhaofilms",
+  "homepage": "https://github.com/digwis/nextion#readme",
+  "bugs": {
+    "url": "https://github.com/digwis/nextion/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node scripts/copy-templates.mjs",
+    "dev": "tsx src/index.ts",
+    "test": "vitest run"
+  }
+}