@bakery-framework/core 1.0.0 → 1.1.0

package/README.md

@@ -44,7 +44,7 @@ Pages are rendered server-side through Bakery's own `createElement`, so an app's
 
 ```json
 {
-  "extends": "@bakery-framework/core/tsconfig.app.json",
+  "extends": "@bakery-framework/core/tsconfig.server.json",
   "compilerOptions": {
     "jsx": "react",
     "jsxFactory": "createElement",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bakery-framework/core",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Bakery framework core: handlers, router, config, session, caches, logger, compiler.",
   "keywords": [
     "bakery",
@@ -20,7 +20,7 @@
     "url": "git+https://github.com/obillekyle/bakery.git",
     "directory": "packages/core"
   },
-  "homepage": "https://github.com/obillekyle/bakery#readme",
+  "homepage": "https://bakery.okyle.dev",
   "bugs": "https://github.com/obillekyle/bakery/issues",
   "publishConfig": {
     "access": "public"
@@ -55,11 +55,15 @@
     "./router": "./src/router.ts",
     "./utils/shared-pool": "./src/utils/shared-pool.ts",
     "./global.d.ts": "./src/global.d.ts",
-    "./core/bakery": "./src/core/bakery.ts"
+    "./core/bakery": "./src/core/bakery.ts",
+    "./tsconfig.server.json": "./tsconfig.server.json",
+    "./tsconfig.vue.json": "./tsconfig.vue.json"
   },
   "files": [
     "src",
     "tsconfig.app.json",
+    "tsconfig.server.json",
+    "tsconfig.vue.json",
     "!src/**/*.test.ts",
     "!src/tests"
   ],

package/tsconfig.app.json

@@ -1,26 +1,36 @@
 {
   "$comment": [
-    "Base tsconfig for applications built on Bakery. Extend it:",
+    "**Client-side code** — the plain `.ts` under your source root that ends up",
+    "in the browser bundle. Extend it:",
     "  { \"extends\": \"@bakery-framework/core/tsconfig.app.json\" }",
     "",
-    "The JSX settings are not optional. Bakery renders JSX server-side to a",
-    "string through its own `createElement`, so without these Bun falls back to",
-    "the automatic runtime and every .tsx page fails with",
-    "'Cannot find module react/jsx-dev-runtime'."
+    "BREAKING, 2.0.0: this file used to be the single config every app",
+    "extended, and it carried `bun-types` and the JSX settings. It is now the",
+    "*browser* half of a three-way split — server code extends",
+    "tsconfig.server.json, Vue SFCs extend tsconfig.vue.json.",
+    "",
+    "**`types` is deliberately empty.** That is the entire reason the split",
+    "exists: without `bun-types` there is no `Bun` global, so `Bun.hash()` in a",
+    "file bound for the browser is a type error instead of a runtime one. Adding",
+    "bun-types back here re-opens the hole quietly.",
+    "",
+    "No JSX settings either. `.tsx` is server-rendered in Bakery and belongs to",
+    "tsconfig.server.json; a `.tsx` file compiled under this config would pick up",
+    "the automatic runtime and fail at request time while typechecking clean."
+  ],
+  "_files_note": "client/globals.d.ts declares the globals the browser runtime binds onto globalThis (request, escapeHTML, is, Try, Case, match, …). It states each as `typeof import(...)` of the isomorphic module that implements it, so the declaration cannot drift from the value. Those modules are pure by convention — no Bun, no node builtins, no DOM — which is what makes them safe to pull into a project that has no bun-types.",
+  "files": [
+    "./src/client/globals.d.ts",
+    "./src/shared.d.ts",
+    "./src/types.d.ts"
   ],
-  "_files_note": "Paths in an extended config resolve relative to THIS file, so extending packages inherit core ambient declarations (createElement, Fragment, the JSX namespace, Bakery, AppConfig) without naming a node_modules path. shared.d.ts carries the handful of types the browser runtime needs too (MapOf, Wrapped, JsonResponse, ISFunction) and is declared there exactly once.",
-  "files": ["./src/global.d.ts", "./src/shared.d.ts", "./src/types.d.ts"],
   "compilerOptions": {
     "lib": ["ESNext", "DOM", "DOM.Iterable"],
     "target": "ESNext",
     "module": "Preserve",
     "moduleDetection": "force",
     "moduleResolution": "bundler",
-    "types": ["bun-types"],
-
-    "jsx": "react",
-    "jsxFactory": "createElement",
-    "jsxFragmentFactory": "Fragment",
+    "types": [],
 
     "allowImportingTsExtensions": true,
     "verbatimModuleSyntax": true,

package/tsconfig.server.json

@@ -0,0 +1,41 @@
+{
+  "$comment": [
+    "Server-side code: API routes, `.tsx` pages, server.config.ts, schema.ts,",
+    "orm/. Extend it:",
+    "  { \"extends\": \"@bakery-framework/core/tsconfig.server.json\" }",
+    "",
+    "This is the only one of the three that gets `bun-types`, and that is the",
+    "point of the split: `Bun.*` is a type error in browser code, because",
+    "browser code cannot call it. Before the split every app extended a single",
+    "config and `Bun.hash()` typechecked happily inside a file destined for the",
+    "browser bundle, where it fails at runtime.",
+    "",
+    "The JSX settings are not optional. Bakery renders JSX server-side to a",
+    "string through its own `createElement`, so without these Bun falls back to",
+    "the automatic runtime and every .tsx page fails with",
+    "'Cannot find module react/jsx-dev-runtime'."
+  ],
+  "_files_note": "Paths in an extended config resolve relative to THIS file, so extending packages inherit core's server ambient declarations (createElement, Fragment, the JSX namespace, Bakery, AppConfig) without naming a node_modules path. shared.d.ts carries the handful of types the browser needs too and is declared exactly once.",
+  "files": ["./src/global.d.ts", "./src/shared.d.ts", "./src/types.d.ts"],
+  "compilerOptions": {
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "moduleResolution": "bundler",
+    "types": ["bun-types"],
+
+    "jsx": "react",
+    "jsxFactory": "createElement",
+    "jsxFragmentFactory": "Fragment",
+
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}

package/tsconfig.vue.json

@@ -0,0 +1,39 @@
+{
+  "$comment": [
+    "Vue single-file components. Extend it:",
+    "  { \"extends\": \"@bakery-framework/core/tsconfig.vue.json\" }",
+    "",
+    "SFCs get `bun-types` like server code does, because @bakery-framework/",
+    "plugin-vue compiles and can render them on the server — a `<script>` block",
+    "is not browser-only the way a plain `.ts` under the source root is.",
+    "",
+    "**`tsc` cannot parse `.vue`.** This config is for `vue-tsc`, which wraps tsc",
+    "and understands SFCs. Pointing plain `tsc` at a project whose `include`",
+    "matches `**/*.vue` gets you either silence or a parse error, depending on",
+    "version — neither of which is a typecheck.",
+    "",
+    "`jsx: preserve` rather than Bakery's classic runtime: inside an SFC, JSX (if",
+    "used at all) belongs to Vue's own transform, not to `createElement`."
+  ],
+  "_files_note": "Server ambients, same as tsconfig.server.json — an SFC can reach Bakery, AppConfig and the JSX namespace.",
+  "files": ["./src/global.d.ts", "./src/shared.d.ts", "./src/types.d.ts"],
+  "compilerOptions": {
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "moduleResolution": "bundler",
+    "types": ["bun-types"],
+
+    "jsx": "preserve",
+
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}