@celljs/kit 4.3.0 → 4.4.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.
package/lib/types.d.ts CHANGED
@@ -45,25 +45,36 @@ export interface TargetModel {
45
45
  staticModules: ModuleRef[];
46
46
  modules: ModuleRef[];
47
47
  /**
48
- * Merged application configuration. Backend values keep `${...}` for runtime evaluation, and the
49
- * backend has `paths.public` (default `public`, relative to the output directory), which the
50
- * server resolves to an absolute path at startup.
48
+ * Application configuration (docs/design/config.md). Backend: every key, values keep `${...}` for
49
+ * runtime evaluation, and `paths.public` (default `public`, relative to the output directory) is
50
+ * resolved by the server at startup. Frontend: only the keys the schemas mark public, evaluated.
51
51
  */
52
52
  config: Record<string, unknown>;
53
+ /** Backend: schema types of keys whose value is an expression, which evaluation converts to. */
54
+ configTypes?: Record<string, 'number' | 'integer' | 'boolean'>;
53
55
  /**
54
- * `CELL_FRONTEND__*` / `CELL_BACKEND__*` variables of the environment the project was loaded in.
55
- * Frontend overrides are already applied to `config`; backend ones are applied by the server at
56
- * startup, so for the backend this tells what the same environment would change. Values are left out.
56
+ * `CELL_*` variables of the environment the project was loaded in. Frontend overrides are already
57
+ * applied before the public keys are picked; the server applies them at startup, so for the backend
58
+ * this tells what the same environment would change. Values are left out.
57
59
  */
58
60
  envOverrides: EnvOverrideReport;
61
+ /** Frontend: the pages of `src/browser/pages`, in file order (docs: Frontend and RPC). */
62
+ routes?: PageRoute[];
59
63
  }
60
- /** Configuration overrides from environment variables (`CELL_BACKEND__SERVER__PORT=8080` → `cell.server.port`). */
64
+ /** A page of `src/browser/pages`: `users/[id].tsx` is `/users/:id`. */
65
+ export interface PageRoute {
66
+ /** Path of the route, below `react.path`: `/`, `/users/:id`, `/docs/*`. */
67
+ path: string;
68
+ /** The page, relative to the project root; its default export is the component. */
69
+ file: string;
70
+ /** The `_layout` files around it, outermost first, relative to the project root. */
71
+ layouts: string[];
72
+ }
73
+ /** Configuration overrides from environment variables (`CELL_SERVER__PORT=8080` → `server.port`). */
61
74
  export interface EnvOverrideReport {
62
- /** `shadows`: the key under `cell` with the same first name that the variable does not set (reach it with `CELL_<TARGET>__CELL__...`). */
63
75
  applied: {
64
76
  variable: string;
65
77
  path: string;
66
- shadows?: string;
67
78
  }[];
68
79
  /** Variables with the prefix that match no key or whose value does not fit the key's type. */
69
80
  problems: {
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAE5C,kGAAkG;AAClG,MAAM,WAAW,iBAAiB;IAC9B,iGAAiG;IACjG,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5C,8DAA8D;IAC9D,aAAa,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAClD,6FAA6F;IAC7F,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,uGAAuG;IACvG,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,wGAAwG;AACxG,MAAM,WAAW,SAAS;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;IACd,sDAAsD;IACtD,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,uDAAuD;IACvD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,oGAAoG;IACpG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC;;;;OAIG;IACH,YAAY,EAAE,iBAAiB,CAAC;CACnC;AAED,mHAAmH;AACnH,MAAM,WAAW,iBAAiB;IAC9B,0IAA0I;IAC1I,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAChE,8FAA8F;IAC9F,QAAQ,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACrD;AAED,0FAA0F;AAC1F,MAAM,WAAW,YAAY;IACzB,aAAa,EAAE,CAAC,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,OAAO,CAAC,EAAE,WAAW,CAAC;CACzB;AACD,mHAAmH;AACnH,MAAM,WAAW,cAAc;IAC3B,aAAa,EAAE,CAAC,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,KAAK,GAAG,KAAK,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mHAAmH;IACnH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,mKAAmK;IACnK,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,gGAAgG;IAChG,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,sFAAsF;IACtF,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACrF"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAE5C,kGAAkG;AAClG,MAAM,WAAW,iBAAiB;IAC9B,iGAAiG;IACjG,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5C,8DAA8D;IAC9D,aAAa,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAClD,6FAA6F;IAC7F,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,uGAAuG;IACvG,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,wGAAwG;AACxG,MAAM,WAAW,SAAS;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;IACd,sDAAsD;IACtD,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,uDAAuD;IACvD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,oGAAoG;IACpG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,gGAAgG;IAChG,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC,CAAC;IAC/D;;;;OAIG;IACH,YAAY,EAAE,iBAAiB,CAAC;IAChC,0FAA0F;IAC1F,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,uEAAuE;AACvE,MAAM,WAAW,SAAS;IACtB,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,qGAAqG;AACrG,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C,8FAA8F;IAC9F,QAAQ,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACrD;AAED,0FAA0F;AAC1F,MAAM,WAAW,YAAY;IACzB,aAAa,EAAE,CAAC,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,OAAO,CAAC,EAAE,WAAW,CAAC;CACzB;AACD,mHAAmH;AACnH,MAAM,WAAW,cAAc;IAC3B,aAAa,EAAE,CAAC,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,KAAK,GAAG,KAAK,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mHAAmH;IACnH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,mKAAmK;IACnK,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,gGAAgG;IAChG,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,sFAAsF;IACtF,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACrF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celljs/kit",
3
- "version": "4.3.0",
3
+ "version": "4.4.1",
4
4
  "description": "Types and helpers for writing Cell 4 modules, presets and deployers.",
5
5
  "type": "module",
6
6
  "homepage": "https://github.com/cellbang/cell",
package/src/types.ts CHANGED
@@ -49,23 +49,36 @@ export interface TargetModel {
49
49
  staticModules: ModuleRef[];
50
50
  modules: ModuleRef[];
51
51
  /**
52
- * Merged application configuration. Backend values keep `${...}` for runtime evaluation, and the
53
- * backend has `paths.public` (default `public`, relative to the output directory), which the
54
- * server resolves to an absolute path at startup.
52
+ * Application configuration (docs/design/config.md). Backend: every key, values keep `${...}` for
53
+ * runtime evaluation, and `paths.public` (default `public`, relative to the output directory) is
54
+ * resolved by the server at startup. Frontend: only the keys the schemas mark public, evaluated.
55
55
  */
56
56
  config: Record<string, unknown>;
57
+ /** Backend: schema types of keys whose value is an expression, which evaluation converts to. */
58
+ configTypes?: Record<string, 'number' | 'integer' | 'boolean'>;
57
59
  /**
58
- * `CELL_FRONTEND__*` / `CELL_BACKEND__*` variables of the environment the project was loaded in.
59
- * Frontend overrides are already applied to `config`; backend ones are applied by the server at
60
- * startup, so for the backend this tells what the same environment would change. Values are left out.
60
+ * `CELL_*` variables of the environment the project was loaded in. Frontend overrides are already
61
+ * applied before the public keys are picked; the server applies them at startup, so for the backend
62
+ * this tells what the same environment would change. Values are left out.
61
63
  */
62
64
  envOverrides: EnvOverrideReport;
65
+ /** Frontend: the pages of `src/browser/pages`, in file order (docs: Frontend and RPC). */
66
+ routes?: PageRoute[];
63
67
  }
64
68
 
65
- /** Configuration overrides from environment variables (`CELL_BACKEND__SERVER__PORT=8080` → `cell.server.port`). */
69
+ /** A page of `src/browser/pages`: `users/[id].tsx` is `/users/:id`. */
70
+ export interface PageRoute {
71
+ /** Path of the route, below `react.path`: `/`, `/users/:id`, `/docs/*`. */
72
+ path: string;
73
+ /** The page, relative to the project root; its default export is the component. */
74
+ file: string;
75
+ /** The `_layout` files around it, outermost first, relative to the project root. */
76
+ layouts: string[];
77
+ }
78
+
79
+ /** Configuration overrides from environment variables (`CELL_SERVER__PORT=8080` → `server.port`). */
66
80
  export interface EnvOverrideReport {
67
- /** `shadows`: the key under `cell` with the same first name that the variable does not set (reach it with `CELL_<TARGET>__CELL__...`). */
68
- applied: { variable: string; path: string; shadows?: string }[];
81
+ applied: { variable: string; path: string }[];
69
82
  /** Variables with the prefix that match no key or whose value does not fit the key's type. */
70
83
  problems: { variable: string; message: string }[];
71
84
  }