@raiyyan/brisk 0.1.0 → 0.2.0

package/dist/src/cli/templates/project.js

@@ -1,166 +0,0 @@
-import { authFiles } from "./auth.js";
-import { databaseFiles } from "./database.js";
-import { dockerFiles } from "./docker.js";
-export const PACKAGE = "@raiyyan/brisk";
-export const IMPORTS_MARKER = "// @brisk:imports";
-export const CONTROLLERS_MARKER = "// @brisk:controllers";
-export const REGISTRY = "src/features/index.ts";
-/** Composes the base project with every chosen option. */
-export function projectPlan(options) {
-    const plan = {
-        files: {
-            "src/env.ts": envTemplate(options),
-            "src/app.ts": appTemplate(options),
-            "src/main.ts": mainTemplate,
-            [REGISTRY]: registryTemplate,
-            ".env.example": envExample(options),
-            "tsconfig.json": tsconfigTemplate,
-            "vitest.config.ts": vitestTemplate(options),
-            ".gitignore": "node_modules\n.env\ncoverage\n*.db\n*.db-*\n",
-        },
-        dependencies: [PACKAGE],
-        devDependencies: ["typescript", "@types/node", "vitest"],
-        scripts: {
-            dev: "node --watch src/main.ts",
-            start: "node src/main.ts",
-            typecheck: "tsc --noEmit",
-            test: "vitest run",
-            brisk: "brisk",
-        },
-    };
-    if (options.db !== "none")
-        merge(plan, databaseFiles(options.db));
-    if (options.auth)
-        merge(plan, authFiles());
-    if (options.docker || options.ci)
-        merge(plan, dockerFiles(options));
-    if (options.web) {
-        plan.files["public/.gitkeep"] = "";
-        plan.dependencies.push("express", "cors", "express-rate-limit");
-        plan.devDependencies.push("@types/express", "@types/cors", "pino-pretty");
-    }
-    return plan;
-}
-function merge(plan, extra) {
-    Object.assign(plan.files, extra.files);
-    plan.dependencies.push(...(extra.dependencies ?? []));
-    plan.devDependencies.push(...(extra.devDependencies ?? []));
-    Object.assign(plan.scripts, extra.scripts);
-}
-function envTemplate({ db, auth, web }) {
-    const lines = [
-        `  NODE_ENV: z.enum(["development", "test", "production"]).default("development"),`,
-        `  PORT: z.coerce.number().int().positive().default(3000),`,
-        `  LOG_LEVEL: z.enum(["fatal", "error", "warn", "info", "debug", "trace", "silent"]).default("info"),`,
-    ];
-    if (db === "sqlite")
-        lines.push(`  DATABASE_PATH: z.string().min(1).default("data.db"),`);
-    if (db === "postgres") {
-        lines.push(`  DATABASE_URL: z.url(),`, `  DATABASE_POOL_SIZE: z.coerce.number().int().positive().default(10),`);
-    }
-    if (auth) {
-        lines.push(`  /** HMAC key for access tokens: 32+ random characters (\`openssl rand -base64 48\`). */`, `  AUTH_SECRET: z.string().min(32),`, `  AUTH_TOKEN_TTL_SECONDS: z.coerce.number().int().positive().default(3600),`);
-    }
-    if (web) {
-        lines.push(`  /** Browser origin allowed to call the API, such as http://localhost:5173. */`, `  WEB_ORIGIN: z.url().default("http://localhost:5173"),`, `  RATE_LIMIT_PER_MINUTE: z.coerce.number().int().positive().default(300),`);
-    }
-    return `import { defineEnv, z } from "${PACKAGE}";
-
-export const env = defineEnv({
-${lines.join("\n")}
-});
-`;
-}
-function envExample({ db, auth, web }) {
-    const lines = ["NODE_ENV=development", "PORT=3000", "LOG_LEVEL=info"];
-    if (db === "sqlite")
-        lines.push("DATABASE_PATH=data.db");
-    if (db === "postgres")
-        lines.push("DATABASE_URL=postgres://app:app@localhost:5432/app");
-    if (auth)
-        lines.push("AUTH_SECRET=replace-with-32-or-more-random-characters");
-    if (web)
-        lines.push("WEB_ORIGIN=http://localhost:5173");
-    return `${lines.join("\n")}\n`;
-}
-function appTemplate({ db, web }) {
-    const imports = [`import { createLogger, defineApp } from "${PACKAGE}";`];
-    if (web) {
-        imports.push(`import cors from "cors";`, `import express from "express";`, `import { rateLimit } from "express-rate-limit";`);
-    }
-    if (db !== "none")
-        imports.push(`import { uniqueViolation } from "./database/errors.ts";`);
-    imports.push(`import { env } from "./env.ts";`, `import { controllers } from "./features/index.ts";`);
-    const options = [
-        `  prefix: "/api",`,
-        `  controllers,`,
-        `  logger: createLogger({`,
-        `    level: env.NODE_ENV === "test" ? "silent" : env.LOG_LEVEL,`,
-        ...(web ? [`    pretty: env.NODE_ENV === "development",`] : []),
-        `  }),`,
-        `  openapi: { title: "API", version: "0.1.0" },`,
-        `  errors: {`,
-        ...(db === "none" ? [] : [`    mappers: [uniqueViolation],`]),
-        `    exposeInternal: env.NODE_ENV === "development",`,
-        `  },`,
-    ];
-    if (web) {
-        options.push(`  configureExpress: (expressApp) => {`, `    expressApp.use(cors({ origin: env.WEB_ORIGIN, credentials: true }));`, `    // Behind a proxy, set http: { trustProxy } so the limit applies per client, not per proxy.`, `    expressApp.use(rateLimit({ windowMs: 60_000, limit: env.RATE_LIMIT_PER_MINUTE, standardHeaders: "draft-8", legacyHeaders: false }));`, `    expressApp.use("/static", express.static("public", { maxAge: "1h" }));`, `  },`);
-    }
-    return `${imports.join("\n")}
-
-export const app = defineApp({
-${options.join("\n")}
-});
-
-/** The API's type, for a frontend's typed client: \`createClient<Api>(manifest, { baseUrl })\`. */
-export type Api = typeof app;
-`;
-}
-const mainTemplate = `import { app } from "./app.ts";
-import { env } from "./env.ts";
-
-await app.listen(env.PORT);
-`;
-const registryTemplate = `${IMPORTS_MARKER}
-
-/** Every controller by name. The names are the typed client's top level: \`api.users.get(...)\`. */
-export const controllers = {
-  ${CONTROLLERS_MARKER}
-};
-`;
-const tsconfigTemplate = `${JSON.stringify({
-    compilerOptions: {
-        target: "es2024",
-        module: "nodenext",
-        moduleResolution: "nodenext",
-        strict: true,
-        exactOptionalPropertyTypes: true,
-        noUncheckedIndexedAccess: true,
-        noEmit: true,
-        allowImportingTsExtensions: true,
-        verbatimModuleSyntax: true,
-        erasableSyntaxOnly: true,
-        skipLibCheck: true,
-        types: ["node"],
-    },
-    include: ["src", "test", "vitest.config.ts"],
-}, null, 2)}\n`;
-function vitestTemplate({ db, auth }) {
-    const env = [`NODE_ENV: "test"`];
-    if (db === "sqlite")
-        env.push(`DATABASE_PATH: ":memory:"`);
-    if (db === "postgres")
-        env.push(`DATABASE_URL: "postgres://app:app@localhost:5432/app_test"`);
-    if (auth)
-        env.push(`AUTH_SECRET: "test-secret-that-is-at-least-32-characters-long"`);
-    return `import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    env: { ${env.join(", ")} },
-  },
-});
-`;
-}
-//# sourceMappingURL=project.js.map

package/dist/src/cli/templates/project.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.js","sourceRoot":"","sources":["../../../../src/cli/templates/project.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,CAAC,MAAM,OAAO,GAAG,gBAAgB,CAAC;AACxC,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAClD,MAAM,CAAC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAC1D,MAAM,CAAC,MAAM,QAAQ,GAAG,uBAAuB,CAAC;AAoBhD,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,OAAoB;IAC9C,MAAM,IAAI,GAAS;QACjB,KAAK,EAAE;YACL,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC;YAClC,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC;YAClC,aAAa,EAAE,YAAY;YAC3B,CAAC,QAAQ,CAAC,EAAE,gBAAgB;YAC5B,cAAc,EAAE,UAAU,CAAC,OAAO,CAAC;YACnC,eAAe,EAAE,gBAAgB;YACjC,kBAAkB,EAAE,cAAc,CAAC,OAAO,CAAC;YAC3C,YAAY,EAAE,8CAA8C;SAC7D;QACD,YAAY,EAAE,CAAC,OAAO,CAAC;QACvB,eAAe,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,QAAQ,CAAC;QACxD,OAAO,EAAE;YACP,GAAG,EAAE,0BAA0B;YAC/B,KAAK,EAAE,kBAAkB;YACzB,SAAS,EAAE,cAAc;YACzB,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,OAAO;SACf;KACF,CAAC;IACF,IAAI,OAAO,CAAC,EAAE,KAAK,MAAM;QAAE,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAClE,IAAI,OAAO,CAAC,IAAI;QAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3C,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC;QAChE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,KAAK,CAAC,IAAU,EAAE,KAAoB;IAC7C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC;IACtD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,CAAC;IAC5D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAe;IACjD,MAAM,KAAK,GAAG;QACZ,mFAAmF;QACnF,2DAA2D;QAC3D,sGAAsG;KACvG,CAAC;IACF,IAAI,EAAE,KAAK,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IAC1F,IAAI,EAAE,KAAK,UAAU,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CACR,0BAA0B,EAC1B,uEAAuE,CACxE,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,KAAK,CAAC,IAAI,CACR,2FAA2F,EAC3F,oCAAoC,EACpC,6EAA6E,CAC9E,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,EAAE,CAAC;QACR,KAAK,CAAC,IAAI,CACR,iFAAiF,EACjF,yDAAyD,EACzD,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IACD,OAAO,iCAAiC,OAAO;;;EAG/C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;CAEjB,CAAC;AACF,CAAC;AAED,SAAS,UAAU,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAe;IAChD,MAAM,KAAK,GAAG,CAAC,sBAAsB,EAAE,WAAW,EAAE,gBAAgB,CAAC,CAAC;IACtE,IAAI,EAAE,KAAK,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACzD,IAAI,EAAE,KAAK,UAAU;QAAE,KAAK,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;IACxF,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;IAC9E,IAAI,GAAG;QAAE,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IACxD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,EAAe;IAC3C,MAAM,OAAO,GAAG,CAAC,4CAA4C,OAAO,IAAI,CAAC,CAAC;IAC1E,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CACV,0BAA0B,EAC1B,gCAAgC,EAChC,iDAAiD,CAClD,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,KAAK,MAAM;QAAE,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;IAC3F,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,oDAAoD,CAAC,CAAC;IAEtG,MAAM,OAAO,GAAG;QACd,mBAAmB;QACnB,gBAAgB;QAChB,0BAA0B;QAC1B,gEAAgE;QAChE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,6CAA6C,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO;QACP,gDAAgD;QAChD,aAAa;QACb,GAAG,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,iCAAiC,CAAC,CAAC;QAC7D,qDAAqD;QACrD,MAAM;KACP,CAAC;IACF,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CACV,uCAAuC,EACvC,0EAA0E,EAC1E,iGAAiG,EACjG,0IAA0I,EAC1I,4EAA4E,EAC5E,MAAM,CACP,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;;EAG5B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;CAKnB,CAAC;AACF,CAAC;AAED,MAAM,YAAY,GAAG;;;;CAIpB,CAAC;AAEF,MAAM,gBAAgB,GAAG,GAAG,cAAc;;;;IAItC,kBAAkB;;CAErB,CAAC;AAEF,MAAM,gBAAgB,GAAG,GAAG,IAAI,CAAC,SAAS,CACxC;IACE,eAAe,EAAE;QACf,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,UAAU;QAClB,gBAAgB,EAAE,UAAU;QAC5B,MAAM,EAAE,IAAI;QACZ,0BAA0B,EAAE,IAAI;QAChC,wBAAwB,EAAE,IAAI;QAC9B,MAAM,EAAE,IAAI;QACZ,0BAA0B,EAAE,IAAI;QAChC,oBAAoB,EAAE,IAAI;QAC1B,kBAAkB,EAAE,IAAI;QACxB,YAAY,EAAE,IAAI;QAClB,KAAK,EAAE,CAAC,MAAM,CAAC;KAChB;IACD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,kBAAkB,CAAC;CAC7C,EACD,IAAI,EACJ,CAAC,CACF,IAAI,CAAC;AAEN,SAAS,cAAc,CAAC,EAAE,EAAE,EAAE,IAAI,EAAe;IAC/C,MAAM,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACjC,IAAI,EAAE,KAAK,QAAQ;QAAE,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC3D,IAAI,EAAE,KAAK,UAAU;QAAE,GAAG,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;IAC9F,IAAI,IAAI;QAAE,GAAG,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;IACrF,OAAO;;;;aAII,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;;;CAG1B,CAAC;AACF,CAAC"}