npm - create-softeneers-app - Versions diffs - 0.1.0 → 0.2.1 - Mend

create-softeneers-app 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (84) hide show

package/README.html +56 -0
package/README.md +16 -8
package/dist/args.js +33 -4
package/dist/args.js.map +1 -1
package/dist/fragments.js +127 -0
package/dist/fragments.js.map +1 -0
package/dist/index.js +18 -7
package/dist/index.js.map +1 -1
package/dist/prompts.js +27 -1
package/dist/prompts.js.map +1 -1
package/dist/templates.js +33 -8
package/dist/templates.js.map +1 -1
package/package.json +2 -2
package/templates/express-api/.env.example +13 -0
package/templates/express-api/README.md +77 -0
package/templates/express-api/docker-compose.yml +15 -0
package/templates/express-api/package.json +36 -0
package/templates/express-api/softeneers.template.json +17 -0
package/templates/express-api/src/auth/auth.ts +11 -0
package/templates/express-api/src/cars/demo.ts +10 -0
package/templates/express-api/src/cars/routes.ts +58 -0
package/templates/express-api/src/cars/store.ts +150 -0
package/templates/express-api/src/cars/types.ts +8 -0
package/templates/express-api/src/cars/validate.ts +16 -0
package/templates/express-api/src/db.ts +13 -0
package/templates/express-api/src/env.ts +23 -0
package/templates/express-api/src/index.ts +37 -0
package/templates/express-api/src/scripts/migrate.ts +13 -0
package/templates/express-api/src/scripts/seed.ts +20 -0
package/templates/express-api/test/validate.test.ts +25 -0
package/templates/express-api/tsconfig.json +14 -0
package/templates/hono-api/.env.example +13 -0
package/templates/hono-api/README.md +77 -0
package/templates/hono-api/docker-compose.yml +15 -0
package/templates/hono-api/package.json +34 -0
package/templates/hono-api/softeneers.template.json +17 -0
package/templates/hono-api/src/auth/auth.ts +11 -0
package/templates/hono-api/src/cars/demo.ts +10 -0
package/templates/hono-api/src/cars/routes.ts +43 -0
package/templates/hono-api/src/cars/store.ts +150 -0
package/templates/hono-api/src/cars/types.ts +8 -0
package/templates/hono-api/src/cars/validate.ts +16 -0
package/templates/hono-api/src/db.ts +13 -0
package/templates/hono-api/src/env.ts +23 -0
package/templates/hono-api/src/index.ts +26 -0
package/templates/hono-api/src/scripts/migrate.ts +13 -0
package/templates/hono-api/src/scripts/seed.ts +20 -0
package/templates/hono-api/test/validate.test.ts +25 -0
package/templates/hono-api/tsconfig.json +14 -0
package/templates/minimal/.env.example +2 -0
package/templates/minimal/README.md +33 -0
package/templates/minimal/package.json +22 -0
package/templates/minimal/src/index.ts +20 -0
package/templates/minimal/test/greet.test.ts +12 -0
package/templates/minimal/tsconfig.json +15 -0
package/templates/tanstack-start/.env.example +11 -0
package/templates/tanstack-start/README.md +74 -0
package/templates/tanstack-start/docker-compose.yml +15 -0
package/templates/tanstack-start/package.json +56 -0
package/templates/tanstack-start/public/favicon.ico +0 -0
package/templates/tanstack-start/public/logo192.png +0 -0
package/templates/tanstack-start/public/logo512.png +0 -0
package/templates/tanstack-start/public/manifest.json +25 -0
package/templates/tanstack-start/public/robots.txt +3 -0
package/templates/tanstack-start/softeneers.template.json +17 -0
package/templates/tanstack-start/src/cars/types.ts +8 -0
package/templates/tanstack-start/src/cars/validate.ts +16 -0
package/templates/tanstack-start/src/router.tsx +19 -0
package/templates/tanstack-start/src/routes/__root.tsx +54 -0
package/templates/tanstack-start/src/routes/api/auth/$.ts +14 -0
package/templates/tanstack-start/src/routes/cars.tsx +87 -0
package/templates/tanstack-start/src/routes/index.tsx +20 -0
package/templates/tanstack-start/src/server/auth.ts +11 -0
package/templates/tanstack-start/src/server/cars.ts +27 -0
package/templates/tanstack-start/src/server/db.ts +12 -0
package/templates/tanstack-start/src/server/demo.ts +9 -0
package/templates/tanstack-start/src/server/env.ts +22 -0
package/templates/tanstack-start/src/server/scripts/migrate.ts +13 -0
package/templates/tanstack-start/src/server/scripts/seed.ts +20 -0
package/templates/tanstack-start/src/server/store.ts +132 -0
package/templates/tanstack-start/src/styles.css +17 -0
package/templates/tanstack-start/tsconfig.json +28 -0
package/templates/tanstack-start/tsr.config.json +3 -0
package/templates/tanstack-start/vite.config.ts +14 -0

package/templates/tanstack-start/softeneers.template.json ADDED Viewed

@@ -0,0 +1,17 @@
+{
+  "toggles": { "db": false, "auth": false, "docker": false },
+  "fragments": {
+    "db": {
+      "removePaths": ["src/server/db.ts", "src/server/scripts", "docker-compose.yml"],
+      "removeDeps": ["@softeneers/db", "mysql2"],
+      "removeScripts": ["db:migrate", "db:seed", "db:reset"]
+    },
+    "auth": {
+      "removePaths": ["src/server/auth.ts", "src/routes/api"],
+      "removeDeps": ["@softeneers/auth"]
+    },
+    "docker": {
+      "removePaths": ["docker-compose.yml"]
+    }
+  }
+}

package/templates/tanstack-start/src/cars/types.ts ADDED Viewed

@@ -0,0 +1,8 @@
+export interface Car {
+  id: number
+  brand: string
+  model: string
+  year: number
+}
+export type NewCar = Omit<Car, 'id'>

package/templates/tanstack-start/src/cars/validate.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import type { NewCar } from './types'
+/** Thrown when a submitted car is invalid. */
+export class ValidationError extends Error {}
+/** Validate and normalize untrusted input into a NewCar. Runs on the server. */
+export function parseNewCar(input: unknown): NewCar {
+  const b = (input ?? {}) as Record<string, unknown>
+  const brand = typeof b.brand === 'string' ? b.brand.trim() : ''
+  const model = typeof b.model === 'string' ? b.model.trim() : ''
+  const year = Number(b.year)
+  if (!brand || !model || !Number.isInteger(year)) {
+    throw new ValidationError('brand (string), model (string) and year (integer) are required.')
+  }
+  return { brand, model, year }
+}

package/templates/tanstack-start/src/router.tsx ADDED Viewed

@@ -0,0 +1,19 @@
+import { createRouter as createTanStackRouter } from '@tanstack/react-router'
+import { routeTree } from './routeTree.gen'
+export function getRouter() {
+  const router = createTanStackRouter({
+    routeTree,
+    scrollRestoration: true,
+    defaultPreload: 'intent',
+    defaultPreloadStaleTime: 0,
+  })
+  return router
+}
+declare module '@tanstack/react-router' {
+  interface Register {
+    router: ReturnType<typeof getRouter>
+  }
+}

package/templates/tanstack-start/src/routes/__root.tsx ADDED Viewed

@@ -0,0 +1,54 @@
+import { HeadContent, Scripts, createRootRoute } from '@tanstack/react-router'
+import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
+import { TanStackDevtools } from '@tanstack/react-devtools'
+import appCss from '../styles.css?url'
+export const Route = createRootRoute({
+  head: () => ({
+    meta: [
+      {
+        charSet: 'utf-8',
+      },
+      {
+        name: 'viewport',
+        content: 'width=device-width, initial-scale=1',
+      },
+      {
+        title: 'TanStack Start Starter',
+      },
+    ],
+    links: [
+      {
+        rel: 'stylesheet',
+        href: appCss,
+      },
+    ],
+  }),
+  shellComponent: RootDocument,
+})
+function RootDocument({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <head>
+        <HeadContent />
+      </head>
+      <body>
+        {children}
+        <TanStackDevtools
+          config={{
+            position: 'bottom-right',
+          }}
+          plugins={[
+            {
+              name: 'Tanstack Router',
+              render: <TanStackRouterDevtoolsPanel />,
+            },
+          ]}
+        />
+        <Scripts />
+      </body>
+    </html>
+  )
+}

package/templates/tanstack-start/src/routes/api/auth/$.ts ADDED Viewed

@@ -0,0 +1,14 @@
+import { createFileRoute } from '@tanstack/react-router'
+import { auth } from '../../../server/auth'
+// Catch-all server route: better-auth speaks the Fetch API, so hand it the raw
+// Request and return its Response. Handles every /api/auth/* endpoint.
+export const Route = createFileRoute('/api/auth/$')({
+  server: {
+    handlers: {
+      GET: ({ request }) => auth.handler(request),
+      POST: ({ request }) => auth.handler(request),
+    },
+  },
+})

package/templates/tanstack-start/src/routes/cars.tsx ADDED Viewed

@@ -0,0 +1,87 @@
+import { createFileRoute, useRouter } from '@tanstack/react-router'
+import { useState } from 'react'
+import { createCar, listCars, removeCar } from '../server/cars'
+export const Route = createFileRoute('/cars')({
+  component: CarsPage,
+  loader: async () => listCars(),
+})
+function CarsPage() {
+  const cars = Route.useLoaderData()
+  const router = useRouter()
+  const [brand, setBrand] = useState('')
+  const [model, setModel] = useState('')
+  const [year, setYear] = useState('')
+  const [error, setError] = useState('')
+  async function add(event: React.FormEvent) {
+    event.preventDefault()
+    setError('')
+    try {
+      await createCar({ data: { brand, model, year: Number(year) } })
+      setBrand('')
+      setModel('')
+      setYear('')
+      await router.invalidate()
+    } catch {
+      setError('Please provide a brand, model and a valid year.')
+    }
+  }
+  async function del(id: number) {
+    await removeCar({ data: id })
+    await router.invalidate()
+  }
+  return (
+    <div className="mx-auto max-w-2xl p-8">
+      <h1 className="text-3xl font-bold">Cars</h1>
+      <p className="mt-1 text-gray-500">A full CRUD example backed by a server function.</p>
+      <form onSubmit={add} className="mt-6 flex flex-wrap gap-2">
+        <input
+          className="flex-1 rounded border border-gray-300 px-3 py-2"
+          placeholder="Brand"
+          value={brand}
+          onChange={(e) => setBrand(e.target.value)}
+        />
+        <input
+          className="flex-1 rounded border border-gray-300 px-3 py-2"
+          placeholder="Model"
+          value={model}
+          onChange={(e) => setModel(e.target.value)}
+        />
+        <input
+          className="w-24 rounded border border-gray-300 px-3 py-2"
+          placeholder="Year"
+          value={year}
+          onChange={(e) => setYear(e.target.value)}
+        />
+        <button className="rounded bg-black px-4 py-2 font-medium text-white" type="submit">
+          Add
+        </button>
+      </form>
+      {error && <p className="mt-2 text-sm text-red-600">{error}</p>}
+      <ul className="mt-6 divide-y divide-gray-200">
+        {cars.length === 0 && <li className="py-3 text-gray-500">No cars yet — add one above.</li>}
+        {cars.map((car) => (
+          <li key={car.id} className="flex items-center justify-between py-3">
+            <span>
+              {car.brand} {car.model} <span className="text-gray-400">({car.year})</span>
+            </span>
+            <button
+              className="text-sm text-red-600 hover:underline"
+              type="button"
+              onClick={() => del(car.id)}
+            >
+              Delete
+            </button>
+          </li>
+        ))}
+      </ul>
+    </div>
+  )
+}

package/templates/tanstack-start/src/routes/index.tsx ADDED Viewed

@@ -0,0 +1,20 @@
+import { Link, createFileRoute } from '@tanstack/react-router'
+export const Route = createFileRoute('/')({ component: Home })
+function Home() {
+  return (
+    <div className="mx-auto max-w-2xl p-8">
+      <h1 className="text-4xl font-bold">Welcome to TanStack Start</h1>
+      <p className="mt-4 text-lg text-gray-600">
+        Generated by create-softeneers-app. A fullstack React app with type-safe server functions.
+      </p>
+      <Link
+        to="/cars"
+        className="mt-6 inline-block rounded bg-black px-5 py-2.5 font-medium text-white"
+      >
+        Open the cars CRUD demo →
+      </Link>
+    </div>
+  )
+}

package/templates/tanstack-start/src/server/auth.ts ADDED Viewed

@@ -0,0 +1,11 @@
+import { createAuth } from '@softeneers/auth'
+import { env } from './env'
+// Email + password auth via better-auth (@softeneers/auth). With no `database`
+// configured better-auth uses an in-memory store — fine for local dev; point it
+// at your DB for persistence. Mounted at /api/auth/* in routes/api/auth/$.ts.
+export const auth = createAuth({
+  secret: env.AUTH_SECRET,
+  baseURL: env.AUTH_BASE_URL,
+})

package/templates/tanstack-start/src/server/cars.ts ADDED Viewed

@@ -0,0 +1,27 @@
+import { createServerFn } from '@tanstack/react-start'
+import { parseNewCar } from '../cars/validate'
+import { carStore } from './store'
+// Server functions: type-safe RPC the client calls directly. Their bodies (and
+// the store/db imports above) run only on the server and are stripped from the
+// client bundle.
+export const listCars = createServerFn({ method: 'GET' }).handler(async () => {
+  return carStore.list()
+})
+export const createCar = createServerFn({ method: 'POST' })
+  .validator((data: unknown) => parseNewCar(data))
+  .handler(async ({ data }) => {
+    return carStore.create(data)
+  })
+export const removeCar = createServerFn({ method: 'POST' })
+  .validator((data: unknown) => {
+    const id = Number(data)
+    if (!Number.isInteger(id)) throw new Error('A numeric car id is required.')
+    return id
+  })
+  .handler(async ({ data }) => {
+    return carStore.remove(data)
+  })

package/templates/tanstack-start/src/server/db.ts ADDED Viewed

@@ -0,0 +1,12 @@
+import { createDb } from '@softeneers/db'
+import { env } from './env'
+// Configured (not-yet-connected) Sequelize instance. Server-only.
+export const sequelize = createDb({
+  host: env.DB_HOST,
+  port: env.DB_PORT,
+  database: env.DB_NAME,
+  username: env.DB_USER,
+  password: env.DB_PASSWORD,
+})

package/templates/tanstack-start/src/server/demo.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import type { NewCar } from '../cars/types'
+// Demo garage inventory seeded on first run so `npm run dev` shows a working
+// CRUD demo immediately — into MySQL when reachable, else the in-memory store.
+export const DEMO_CARS: NewCar[] = [
+  { brand: 'Toyota', model: 'Corolla', year: 2021 },
+  { brand: 'Tesla', model: 'Model 3', year: 2023 },
+  { brand: 'Ford', model: 'Mustang', year: 1969 },
+]

package/templates/tanstack-start/src/server/env.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import 'dotenv/config'
+import { createEnv, z } from '@softeneers/env'
+// Server-only validated environment. Variables for a feature exist only when
+// that toggle is enabled at generation time.
+export const env = createEnv({
+  schema: {
+    NODE_ENV: z.enum(['development', 'test', 'production']).default('development'),
+    // #if db
+    DB_HOST: z.string().default('127.0.0.1'),
+    DB_PORT: z.coerce.number().default(3306),
+    DB_NAME: z.string().default('app_dev'),
+    DB_USER: z.string().default('root'),
+    DB_PASSWORD: z.string().default(''),
+    // #endif
+    // #if auth
+    AUTH_SECRET: z.string().min(16).default('dev-secret-change-me-to-a-long-random-string'),
+    AUTH_BASE_URL: z.string().default('http://localhost:3000'),
+    // #endif
+  },
+})

package/templates/tanstack-start/src/server/scripts/migrate.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import 'dotenv/config'
+import { assertConnection } from '@softeneers/db'
+import { sequelize } from '../db'
+import '../store' // importing the store registers the Car model
+const reset = process.argv.includes('--reset')
+await assertConnection(sequelize)
+await sequelize.sync({ force: reset })
+console.log(reset ? 'Database reset — tables recreated.' : 'Database synced — tables ensured.')
+await sequelize.close()

package/templates/tanstack-start/src/server/scripts/seed.ts ADDED Viewed

@@ -0,0 +1,20 @@
+import 'dotenv/config'
+import { assertConnection } from '@softeneers/db'
+import { DEMO_CARS } from '../demo'
+import { sequelize } from '../db'
+import { CarModel } from '../store'
+await assertConnection(sequelize)
+await sequelize.sync()
+const count = await CarModel.count()
+if (count > 0) {
+  console.log(`Skipped seeding — ${count} cars already present.`)
+} else {
+  await CarModel.bulkCreate([...DEMO_CARS])
+  console.log(`Seeded ${DEMO_CARS.length} cars.`)
+}
+await sequelize.close()

package/templates/tanstack-start/src/server/store.ts ADDED Viewed

@@ -0,0 +1,132 @@
+import type { Car, NewCar } from '../cars/types'
+import { DEMO_CARS } from './demo'
+// Server-only data layer behind the cars server functions. With `db` on it
+// persists to MySQL (Sequelize via @softeneers/db) and **falls back to an
+// in-memory store if the database is unreachable**, so `npm run dev` always
+// yields a working, pre-seeded demo. With `db` off it is always in-memory.
+// Never bundled into the client — only reached from server functions.
+export interface CarStore {
+  list(): Promise<Array<Car>>
+  get(id: number): Promise<Car | null>
+  create(input: NewCar): Promise<Car>
+  remove(id: number): Promise<boolean>
+}
+// In-memory backend (the default, and the fallback when no database is reachable).
+function createMemoryStore(): CarStore {
+  let nextId = 1
+  const cars = new Map<number, Car>()
+  for (const car of DEMO_CARS) {
+    const id = nextId++
+    cars.set(id, { id, ...car })
+  }
+  return {
+    async list() {
+      return [...cars.values()].sort((a, b) => a.id - b.id)
+    },
+    async get(id) {
+      return cars.get(id) ?? null
+    },
+    async create(input) {
+      const car: Car = { id: nextId++, ...input }
+      cars.set(car.id, car)
+      return car
+    },
+    async remove(id) {
+      return cars.delete(id)
+    },
+  }
+}
+// #if db
+import { DataTypes, Model, assertConnection } from '@softeneers/db'
+import { sequelize } from './db'
+class CarModel extends Model {
+  declare id: number
+  declare brand: string
+  declare model: string
+  declare year: number
+}
+CarModel.init(
+  {
+    id: { type: DataTypes.INTEGER, autoIncrement: true, primaryKey: true },
+    brand: { type: DataTypes.STRING, allowNull: false },
+    model: { type: DataTypes.STRING, allowNull: false },
+    year: { type: DataTypes.INTEGER, allowNull: false },
+  },
+  { sequelize, modelName: 'Car', tableName: 'cars' },
+)
+export { CarModel }
+const toCar = (m: CarModel): Car => ({ id: m.id, brand: m.brand, model: m.model, year: m.year })
+function createDbStore(): CarStore {
+  return {
+    async list() {
+      return (await CarModel.findAll({ order: [['id', 'ASC']] })).map(toCar)
+    },
+    async get(id) {
+      const m = await CarModel.findByPk(id)
+      return m ? toCar(m) : null
+    },
+    async create(input) {
+      return toCar(await CarModel.create(input))
+    },
+    async remove(id) {
+      const m = await CarModel.findByPk(id)
+      if (!m) return false
+      await m.destroy()
+      return true
+    },
+  }
+}
+// Resolve the backend once, lazily, on first use: try MySQL (create tables +
+// seed if empty); on any connection error, fall back to the in-memory store.
+let backend: Promise<CarStore> | null = null
+function resolveBackend(): Promise<CarStore> {
+  if (!backend) {
+    backend = (async () => {
+      try {
+        await assertConnection(sequelize)
+        await sequelize.sync()
+        const db = createDbStore()
+        if ((await db.list()).length === 0) {
+          for (const car of DEMO_CARS) await db.create(car)
+        }
+        console.log('Data store: MySQL')
+        return db
+      } catch {
+        console.warn(
+          'Data store: in-memory — database unreachable. Run `docker compose up -d` (and `npm run db:migrate && npm run db:seed`) for MySQL.',
+        )
+        return createMemoryStore()
+      }
+    })()
+  }
+  return backend
+}
+export const carStore: CarStore = {
+  async list() {
+    return (await resolveBackend()).list()
+  },
+  async get(id) {
+    return (await resolveBackend()).get(id)
+  },
+  async create(input) {
+    return (await resolveBackend()).create(input)
+  },
+  async remove(id) {
+    return (await resolveBackend()).remove(id)
+  },
+}
+// #endif
+// #if !db
+export const carStore: CarStore = createMemoryStore()
+// #endif

package/templates/tanstack-start/src/styles.css ADDED Viewed

@@ -0,0 +1,17 @@
+@import "tailwindcss";
+* {
+  box-sizing: border-box;
+}
+html,
+body,
+#app {
+  min-height: 100%;
+}
+body {
+  margin: 0;
+}

package/templates/tanstack-start/tsconfig.json ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "include": ["**/*.ts", "**/*.tsx"],
+  "compilerOptions": {
+    "target": "ES2022",
+    "jsx": "react-jsx",
+    "module": "ESNext",
+    "paths": {
+      "#/*": ["./src/*"],
+      "@/*": ["./src/*"]
+    },
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "types": ["vite/client"],
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    /* Linting */
+    "skipLibCheck": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  }
+}

package/templates/tanstack-start/tsr.config.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+  "target": "react"
+}

package/templates/tanstack-start/vite.config.ts ADDED Viewed

@@ -0,0 +1,14 @@
+import { defineConfig } from 'vite'
+import { devtools } from '@tanstack/devtools-vite'
+import { tanstackStart } from '@tanstack/react-start/plugin/vite'
+import viteReact from '@vitejs/plugin-react'
+import tailwindcss from '@tailwindcss/vite'
+const config = defineConfig({
+  resolve: { tsconfigPaths: true },
+  plugins: [devtools(), tailwindcss(), tanstackStart(), viteReact()],
+})
+export default config