@forinda/kickjs-view 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Felix Orinda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @forinda/kickjs-view
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`.kick` views for [KickJS](https://kickjs.app/): server-rendered HTML templates that work on Express, Fastify, h3 and the edge.
+
+```html
+@layout('layouts/main')
+<h1>{{ user.name | titlecase }}</h1>
+@for (post of posts) {
+<post-card [post]="post" />
+} @empty {
+<p>No posts yet</p>
+}
+```
+
+- `{{ value | pipe }}`, escaped for where it lands; `@if`, `@for`, `@switch`, `@let`
+- layouts (mapped by folder, with a base layout), components with inputs and slots
+- pipes for dates, numbers and currency in a locale and time zone
+- templates checked at build time, shipped as data — no `eval`, no file system on the edge
+- `kick fmt:views` / `kick check:views`
+
+```ts
+import kickViews from 'virtual:kick-views'
+import { createViews, KickView } from '@forinda/kickjs-view'
+
+const views = createViews({ ...kickViews, layout: 'layouts/main' })
+bootstrap({ modules, adapters: [KickView({ views })] })
+
+// in a controller
+await ctx.render('users/show', { user })
+```
+
+Experimental while 0.x. Guide: [kickjs.app/guide/views](https://kickjs.app/guide/views).
+
+## License
+
+MIT

package/dist/assets-30rOQ1d0.d.ts

@@ -0,0 +1,88 @@
+
+import { a as ViewsOptions, r as Views } from "./views-DA6Conh5.js";
+import { _ as TemplateAst, s as CheckedTemplate, u as Expr, v as Diagnostic, y as Pos } from "./ast-B7pxZgFT.js";
+import { t as Project } from "./project-J0t2RzxZ.js";
+//#region src/parse/expression.d.ts
+/** Property names a template never reads, even through `[...]` (checked at runtime). */
+declare const FORBIDDEN_NAMES: ReadonlySet<string>;
+/**
+ * Parse one expression. `base` is where `src` starts in the template, so
+ * positions in diagnostics and spans point into the template file.
+ */
+declare function parseExpression(src: string, file: string, base: Pos): {
+  expr?: Expr;
+  diagnostics: Diagnostic[];
+};
+//#endregion
+//#region src/parse/template.d.ts
+interface ParseResult {
+  ast: TemplateAst;
+  diagnostics: Diagnostic[];
+}
+/** Parse a `.kick` source. A leading BOM is dropped; positions refer to the rest. */
+declare function parse(source: string, file: string): ParseResult;
+//#endregion
+//#region src/check/check.d.ts
+interface CheckResult {
+  template?: CheckedTemplate;
+  diagnostics: Diagnostic[];
+}
+/** Check one template of `project` by name. */
+declare function check(name: string, project: Project): CheckResult;
+//#endregion
+//#region src/urls.d.ts
+/**
+ * Attributes whose value is a URL a browser may navigate to, load or run
+ * (spec §4). Their assembled value is scheme-checked when rendered.
+ */
+declare const URL_ATTRS: ReadonlySet<string>;
+declare function isUrlAttr(tag: string, attr: string): boolean;
+//#endregion
+//#region src/pipes/read-exports.d.ts
+declare function readPipeExports(source: string, file: string): {
+  names: string[];
+  diagnostics: Diagnostic[];
+};
+//#endregion
+//#region src/adapter.d.ts
+type Next = (err?: unknown) => void;
+/**
+ * The web fetch entry's middleware (`createWebApp({ middlewares: [viewsMiddleware(views)] })`),
+ * which takes `(ctx, next)` middleware rather than adapters.
+ */
+declare function viewsMiddleware(views: Views): (ctx: {
+  req: object;
+}, next: () => unknown) => unknown;
+interface KickViewOptions extends ViewsOptions {
+  /** A views instance to use — share it with error pages and emails. */
+  views?: Views;
+}
+declare function KickView(options?: KickViewOptions): {
+  name: string;
+  views: Views;
+  middleware: () => {
+    handler: (req: object, res: unknown, next: Next) => void;
+    phase: 'beforeGlobal';
+  }[];
+};
+//#endregion
+//#region src/assets.d.ts
+interface ViteManifestChunk {
+  file: string;
+  css?: string[];
+  imports?: string[];
+  isEntry?: boolean;
+}
+type ViteManifest = Record<string, ViteManifestChunk>;
+type AssetsMode = {
+  dev: true;
+  base: string;
+} | {
+  dev: false;
+  manifest: ViteManifest;
+  base: string;
+};
+declare function assetTags(entry: string, mode: AssetsMode, nonce?: string): string;
+//#endregion
+export { KickView as a, readPipeExports as c, CheckResult as d, check as f, parseExpression as g, FORBIDDEN_NAMES as h, assetTags as i, URL_ATTRS as l, parse as m, ViteManifest as n, KickViewOptions as o, ParseResult as p, ViteManifestChunk as r, viewsMiddleware as s, AssetsMode as t, isUrlAttr as u };
+//# sourceMappingURL=assets-30rOQ1d0.d.ts.map

package/dist/assets-30rOQ1d0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets-30rOQ1d0.d.ts","names":[],"sources":["../src/parse/expression.ts","../src/parse/template.ts","../src/check/check.ts","../src/urls.ts","../src/pipes/read-exports.ts","../src/adapter.ts","../src/assets.ts"],"mappings":";;;;;;cAWa,iBAAiB;;;;;iBA+Yd,gBACd,aACA,cACA,MAAM;EACH,OAAO;EAAM,aAAa;;;;UCzYd;EACf,KAAK;EACL,aAAa;;;iBA01BC,MAAM,gBAAgB,eAAe;;;UC/0BpC;EACf,WAAW;EACX,aAAa;;;iBAmoBC,MAAM,cAAc,SAAS,UAAU;;;;;;;cCnqB1C,WAAW;iBAaR,UAAU,aAAa;;;iBC6DvB,gBACd,gBACA;EACG;EAAiB,aAAa;;;;KCvE9B,QAAQ;;;;;iBA2CG,gBACd,OAAO,SACL;EAAO;GAAe;UAQT,wBAAwB;;EAEvC,QAAQ;;iBAsBM,SAAS,UAAS;;;;IA9CM,UAAA,aAAM,cAAc,MAAQ;IAuD3B;;;;;UCzFxB;EACf;EACA;EACA;EACA;;KAGU,eAAe,eAAe;KAE9B;EACN;EAAW;;EACX;EAAY,UAAU;EAAc;;iBAE1B,UAAU,eAAe,MAAM,YAAY"}

package/dist/ast-B7pxZgFT.d.ts

@@ -0,0 +1,369 @@
+
+//#region src/diagnostics.d.ts
+/** A point in a template: 0-based offset, 1-based line and column (UTF-16 units). */
+interface Pos {
+  offset: number;
+  line: number;
+  column: number;
+}
+interface Span {
+  start: Pos;
+  end: Pos;
+}
+interface Diagnostic {
+  file: string;
+  span: Span;
+  message: string;
+  severity: 'error' | 'warning';
+  /** The templates being rendered, outermost first, when the error came from a render. */
+  stack?: string[];
+}
+/** The position of `offset` in `source`. */
+declare const positionAt: (source: string, offset: number) => Pos;
+//#endregion
+//#region src/ast.d.ts
+/** Bumped when the shape of a checked template changes; builds and runtimes must agree. */
+declare const AST_FORMAT_VERSION = 1;
+type Literal = string | number | boolean | null;
+interface PathSegment {
+  /** `.name` / `?.name` */
+  name?: string;
+  /** `[expr]` / `?.[expr]` */
+  computed?: Expr;
+  optional: boolean;
+}
+type Expr = {
+  kind: 'literal';
+  value: Literal;
+  span: Span;
+} | {
+  kind: 'path';
+  root: string;
+  segments: PathSegment[];
+  span: Span;
+} | {
+  kind: 'unary';
+  op: '!' | '-';
+  arg: Expr;
+  span: Span;
+} | {
+  kind: 'binary';
+  op: '+' | '-' | '<' | '>' | '<=' | '>=' | '==' | '!=' | '===' | '!==';
+  left: Expr;
+  right: Expr;
+  span: Span;
+} | {
+  kind: 'logical';
+  op: '&&' | '||' | '??';
+  left: Expr;
+  right: Expr;
+  span: Span;
+} | {
+  kind: 'conditional';
+  test: Expr;
+  whenTrue: Expr;
+  whenFalse: Expr;
+  span: Span;
+} | {
+  kind: 'pipe';
+  input: Expr;
+  name: string;
+  args: Expr[];
+  span: Span;
+};
+/** Where an interpolation lands, which decides how its value is escaped (spec §4). */
+type Ctx = 'text' | 'rcdata' | 'raw-text' | 'comment';
+interface Attr {
+  /** As written: `href`, `userId` (from `[userId]`), `on` (from `[class.on]`). */
+  name: string;
+  /**
+   * `static` `a="x"`, `interp` `a="x{{ y }}"`, `bare` `a`, `bind` `[a]="expr"`,
+   * `class` `[class.a]="expr"`, `style` `[style.a(.unit)]="expr"`.
+   */
+  kind: 'static' | 'interp' | 'bare' | 'bind' | 'class' | 'style';
+  /** `static` / `interp`: the value, literal text and expressions in order. */
+  parts?: Array<string | Expr>;
+  /** `bind` / `class` / `style`: the bound expression. */
+  expr?: Expr;
+  /** `[style.width.px]`: `px`. */
+  unit?: string;
+  quoted: boolean;
+  span: Span;
+}
+interface Element {
+  k: 'element';
+  /** As written. */
+  tag: string;
+  attrs: Attr[];
+  children: Node[];
+  /** Inside `<svg>` / `<math>`: names keep their case. */
+  foreign: boolean;
+  void: boolean;
+  selfClosing: boolean;
+  span: Span;
+}
+interface IfBranch {
+  /** Absent on `@else`. */
+  cond?: Expr;
+  /** `@if (x; as y)` */
+  alias?: string;
+  body: Node[];
+}
+type LoopVar = '$index' | '$first' | '$last' | '$even' | '$odd' | '$count';
+type Node = {
+  k: 'text';
+  value: string;
+  span: Span;
+} | {
+  k: 'interp';
+  expr: Expr;
+  ctx: Ctx;
+  span: Span;
+} | Element | {
+  k: 'comment';
+  children: Node[];
+  span: Span;
+} | {
+  k: 'if';
+  branches: IfBranch[];
+  span: Span;
+} | {
+  k: 'for';
+  item: string | [string, string];
+  of: Expr;
+  lets: Record<string, LoopVar>;
+  body: Node[];
+  empty?: Node[];
+  span: Span;
+} | {
+  k: 'switch';
+  on: Expr;
+  cases: Array<{
+    value: Expr;
+    body: Node[];
+  }>;
+  default?: Node[];
+  span: Span;
+} | {
+  k: 'let';
+  name: string;
+  expr: Expr;
+  span: Span;
+} | {
+  k: 'verbatim';
+  text: string;
+  span: Span;
+} | {
+  k: 'slot-outlet';
+  name?: string;
+  fallback: Node[];
+  span: Span;
+} | {
+  k: 'slot-fill';
+  name: string;
+  body: Node[];
+  span: Span;
+} | {
+  k: 'assets';
+  entry: string;
+  span: Span;
+};
+interface InputDecl {
+  name: string;
+  default?: {
+    value: Literal;
+    span: Span;
+  };
+  span: Span;
+}
+interface TemplateAst {
+  file: string;
+  /** `undefined`: none declared (the default layout applies); `null`: `@layout(none)`. */
+  layout?: string | null;
+  layoutSpan?: Span;
+  inputs: InputDecl[];
+  body: Node[];
+}
+/** `[line, column]` of a node in its template, for render errors. */
+type At = [number, number];
+/** A path segment: `.n` or `[e]`; `o` marks `?.`. */
+type CSeg = {
+  n: string;
+  o?: 1;
+} | {
+  e: CExpr;
+  o?: 1;
+};
+type CExpr =
+/** literal */
+{
+  k: 'l';
+  v: Literal;
+} |
+/** undefined (a name a component doesn't have) */
+{
+  k: 'x';
+} |
+/** page / shared data: `n` then the path */
+{
+  k: 'd';
+  n: string;
+  p: CSeg[];
+} |
+/** a scope slot (@let, loop item, @if alias, component input) then the path */
+{
+  k: 'v';
+  s: number;
+  p: CSeg[];
+} |
+/** a loop variable of the loop whose meta is in slot `s` */
+{
+  k: 'm';
+  s: number;
+  w: LoopVar;
+} | {
+  k: 'u';
+  o: '!' | '-';
+  a: CExpr;
+} | {
+  k: 'b';
+  o: string;
+  l: CExpr;
+  r: CExpr;
+} | {
+  k: 'c';
+  t: CExpr;
+  y: CExpr;
+  n: CExpr;
+} | {
+  k: 'p';
+  n: string;
+  i: CExpr;
+  a: CExpr[];
+};
+/** One attribute of an element whose attributes need work at render time. */
+type CAttr =
+/** static; `v: true` is a bare attribute */
+{
+  t: 's';
+  n: string;
+  v: string | true;
+} |
+/** `n="text {{ e }}"`; `u` marks a URL attribute (`srcset` checks each candidate) */
+{
+  t: 'i';
+  n: string;
+  p: Array<string | CExpr>;
+  u?: 'url' | 'srcset';
+} |
+/** `[n]="e"` */
+{
+  t: 'b';
+  n: string;
+  e: CExpr;
+  u?: 'url' | 'srcset';
+} |
+/** `[class.n]="e"` */
+{
+  t: 'c';
+  n: string;
+  e: CExpr;
+} |
+/** `[style.n(.x)]="e"` */
+{
+  t: 'y';
+  n: string;
+  e: CExpr;
+  x?: string;
+};
+type CNode =
+/** static output */
+{
+  k: 's';
+  t: string;
+} |
+/** `{{ e }}`: `text` escapes HTML (trusted HTML prints as is), `rcdata` (`<title>`, `<textarea>`) escapes everything, `json` is the one value of a JSON script */
+{
+  k: 'i';
+  c: 'text' | 'rcdata' | 'json';
+  e: CExpr;
+  at: At;
+} |
+/** the attributes of an element (between `<tag` and `>`); `f` takes a component caller's fallthrough attributes */
+{
+  k: 'A';
+  tag: string;
+  a: CAttr[];
+  f?: 1;
+  at: At;
+} | {
+  k: 'if';
+  br: Array<{
+    c?: CExpr;
+    a?: number;
+    b: CNode[];
+  }>;
+} | {
+  k: 'for';
+  e: CExpr;
+  it: number | [number, number];
+  m: number;
+  b: CNode[];
+  em?: CNode[];
+  at: At;
+} | {
+  k: 'sw';
+  e: CExpr;
+  cs: Array<{
+    e: CExpr;
+    b: CNode[];
+  }>;
+  d?: CNode[];
+} | {
+  k: 'let';
+  s: number;
+  e: CExpr;
+} |
+/** a component: inputs into its slots, fallthrough attributes, slot fills (`''` is the default) */
+{
+  k: 'cmp';
+  n: string;
+  in: Array<{
+    s: number;
+    e: CExpr;
+  }>;
+  fa: CAttr[];
+  f: Record<string, CNode[]>;
+  at: At;
+} |
+/** `<slot name="n">fallback</slot>` */
+{
+  k: 'o';
+  n: string;
+  fb: CNode[];
+} | {
+  k: 'as';
+  en: string;
+};
+interface CheckedTemplate {
+  v: typeof AST_FORMAT_VERSION;
+  name: string;
+  file: string;
+  /** declared layout; `null` is `@layout(none)`; absent means the default layout applies to a page */
+  layout?: string | null;
+  /** scope slots the template needs */
+  slots: number;
+  /** a component's inputs: name, slot, default, required */
+  inputs: Array<{
+    n: string;
+    s: number;
+    d?: Literal;
+    r: boolean;
+  }>;
+  /** `@slot('name') { }` fills a page passes to its layout */
+  fills: Record<string, CNode[]>;
+  body: CNode[];
+}
+//#endregion
+export { TemplateAst as _, CNode as a, Span as b, Ctx as c, IfBranch as d, InputDecl as f, PathSegment as g, Node as h, CExpr as i, Element as l, LoopVar as m, Attr as n, CSeg as o, Literal as p, CAttr as r, CheckedTemplate as s, AST_FORMAT_VERSION as t, Expr as u, Diagnostic as v, positionAt as x, Pos as y };
+//# sourceMappingURL=ast-B7pxZgFT.d.ts.map

package/dist/ast-B7pxZgFT.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-B7pxZgFT.d.ts","names":[],"sources":["../src/diagnostics.ts","../src/ast.ts"],"mappings":";;;UACiB;EACf;EACA;EACA;;UAGe;EACf,OAAO;EACP,KAAK;;UAGU;EACf;EACA,MAAM;EACN;EACA;;EAEA;;;cA6BW,aAAU,gBAAkB,mBAAmB;;;;cC5C/C;KAED;UAEK;;EAEf;;EAEA,WAAW;EACX;;KAGU;EACN;EAAiB,OAAO;EAAS,MAAM;;EACvC;EAAc;EAAc,UAAU;EAAe,MAAM;;EAC3D;EAAe;EAAe,KAAK;EAAM,MAAM;;EAE/C;EACA;EACA,MAAM;EACN,OAAO;EACP,MAAM;;EAEN;EAAiB;EAAwB,MAAM;EAAM,OAAO;EAAM,MAAM;;EACxE;EAAqB,MAAM;EAAM,UAAU;EAAM,WAAW;EAAM,MAAM;;EACxE;EAAc,OAAO;EAAM;EAAc,MAAM;EAAQ,MAAM;;;KAGvD;UAEK;;EAEf;;;;;EAKA;;EAEA,QAAQ,eAAe;;EAEvB,OAAO;;EAEP;EACA;EACA,MAAM;;UAGS;EACf;;EAEA;EACA,OAAO;EACP,UAAU;;EAEV;EACA;EACA;EACA,MAAM;;UAGS;;EAEf,OAAO;;EAEP;EACA,MAAM;;KAGI;KAEA;EACN;EAAW;EAAe,MAAM;;EAChC;EAAa,MAAM;EAAM,KAAK;EAAK,MAAM;IAC3C;EACE;EAAc,UAAU;EAAQ,MAAM;;EACtC;EAAS,UAAU;EAAY,MAAM;;EAErC;EACA;EACA,IAAI;EACJ,MAAM,eAAe;EACrB,MAAM;EACN,QAAQ;EACR,MAAM;;EAGN;EACA,IAAI;EACJ,OAAO;IAAQ,OAAO;IAAM,MAAM;;EAClC,UAAU;EACV,MAAM;;EAEN;EAAU;EAAc,MAAM;EAAM,MAAM;;EAC1C;EAAe;EAAc,MAAM;;EACnC;EAAkB;EAAe,UAAU;EAAQ,MAAM;;EACzD;EAAgB;EAAc,MAAM;EAAQ,MAAM;;EAClD;EAAa;EAAe,MAAM;;UAEvB;EACf;EACA;IAAY,OAAO;IAAS,MAAM;;EAClC,MAAM;;UAGS;EACf;;EAEA;EACA,aAAa;EACb,QAAQ;EACR,MAAM;;;KAII;;KAMA;EAAS;EAAW;;EAAY,GAAG;EAAO;;KAE1C;;;EAEN;EAAQ,GAAG;;;;EAEX;;;;EAEA;EAAQ;EAAW,GAAG;;;;EAEtB;EAAQ;EAAW,GAAG;;;;EAEtB;EAAQ;EAAW,GAAG;;EACtB;EAAQ;EAAc,GAAG;;EACzB;EAAQ;EAAW,GAAG;EAAO,GAAG;;EAChC;EAAQ,GAAG;EAAO,GAAG;EAAO,GAAG;;EAC/B;EAAQ;EAAW,GAAG;EAAO,GAAG;;;KAG1B;;;EAEN;EAAQ;EAAW;;;;EAEnB;EAAQ;EAAW,GAAG,eAAe;EAAQ;;;;EAE7C;EAAQ;EAAW,GAAG;EAAO;;;;EAE7B;EAAQ;EAAW,GAAG;;;;EAEtB;EAAQ;EAAW,GAAG;EAAO;;KAEvB;;;EAEN;EAAQ;;;;EAER;EAAQ;EAA+B,GAAG;EAAO,IAAI;;;;EAErD;EAAQ;EAAa,GAAG;EAAS;EAAO,IAAI;;EAC5C;EAAS,IAAI;IAAQ,IAAI;IAAO;IAAY,GAAG;;;EAE/C;EACA,GAAG;EACH;EACA;EACA,GAAG;EACH,KAAK;EACL,IAAI;;EAEJ;EAAS,GAAG;EAAO,IAAI;IAAQ,GAAG;IAAO,GAAG;;EAAY,IAAI;;EAC5D;EAAU;EAAW,GAAG;;;;EAGxB;EACA;EACA,IAAI;IAAQ;IAAW,GAAG;;EAC1B,IAAI;EACJ,GAAG,eAAe;EAClB,IAAI;;;;EAGJ;EAAQ;EAAW,IAAI;;EACvB;EAAS;;UAEE;EACf,UAAU;EACV;EACA;;EAEA;;EAEA;;EAEA,QAAQ;IAAQ;IAAW;IAAW,IAAI;IAAS;;;EAEnD,OAAO,eAAe;EACtB,MAAM"}

package/dist/cli.d.ts

@@ -0,0 +1,28 @@
+
+import { t as Project } from "./project-J0t2RzxZ.js";
+import { KickCliPlugin } from "@forinda/kickjs-cli-kit";
+//#region src/cli.d.ts
+export interface ViewsCliOptions {
+  /** Project root. */
+  root: string;
+  /** Views folder, relative to the root. Default `src/views`. */
+  dir?: string;
+  /** Only these files (relative to the root). Default: every `.kick` file in the views folder. */
+  paths?: string[];
+  log: (message: string) => void;
+}
+/** Format templates in place, or with `check` report the ones that would change. Returns the exit code. */
+export declare function fmtViews(opts: ViewsCliOptions & {
+  check?: boolean;
+  indent?: number;
+}): Promise<number>;
+/** Parse and check every template; print each problem with its position. Returns the exit code. */
+export declare function checkViews(opts: ViewsCliOptions & {
+  pipesFile?: string;
+  componentsDir?: string;
+  layouts?: Project['layouts'];
+  baseLayout?: string;
+}): Promise<number>;
+export declare const viewCliPlugin: KickCliPlugin;
+//#endregion
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","names":[],"sources":["../src/cli.ts"],"mappings":";;;;iBAqBiB;;EAEf;;EAEA;;EAEA;EACA,MAAM;;;wBA4Bc,SACpB,MAAM;EAAoB;EAAiB;IAC1C;;wBA0BmB,WACpB,MAAM;EACJ;EACA;EACA,UAAU;EACV;IAED;qBAuCU,eAAe"}

package/dist/cli.js

@@ -0,0 +1,12 @@
+/**
+ * @forinda/kickjs-view v0.1.0
+ *
+ * Copyright (c) Felix Orinda
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+import{d as parse,m as check,n as BUILTIN_PIPES,t as readPipeExports}from"./read-exports-CtiwXL4e.js";import{t as format}from"./format-BVAljUk8.js";import{readFile,readdir,writeFile}from"node:fs/promises";import{join,relative,resolve,sep}from"node:path";import{existsSync}from"node:fs";const line=(d,prefix)=>`${prefix}${d.file}:${d.span.start.line}:${d.span.start.column} — ${d.message}`;async function templates(viewsDir,root,paths){return paths?.length?paths.map(p=>relative(viewsDir,resolve(root,p))).filter(p=>p.endsWith(`.kick`)&&!p.startsWith(`..`)).map(p=>p.slice(0,-5).split(sep).join(`/`)):existsSync(viewsDir)?(await readdir(viewsDir,{recursive:!0,withFileTypes:!0})).filter(e=>e.isFile()&&e.name.endsWith(`.kick`)).map(e=>relative(viewsDir,join(direntDir(e),e.name)).slice(0,-5).split(sep).join(`/`)).toSorted():[]}async function fmtViews(opts){let dir=opts.dir??`src/views`,viewsDir=resolve(opts.root,dir),failed=!1,changed=0;for(let name of await templates(viewsDir,opts.root,opts.paths)){let file=join(viewsDir,`${name}.kick`),source=await readFile(file,`utf8`),r=format(source,`${name}.kick`,{indent:opts.indent});for(let d of r.diagnostics)opts.log(line(d,`${dir}/`));r.output===void 0?failed=!0:r.output!==source&&(changed++,opts.check?opts.log(`would reformat ${dir}/${name}.kick`):(await writeFile(file,r.output),opts.log(`formatted ${dir}/${name}.kick`)))}return failed||opts.check&&changed?1:0}async function checkViews(opts){let dir=opts.dir??`src/views`,viewsDir=resolve(opts.root,dir),pipesFile=resolve(opts.root,opts.pipesFile??join(dir,`pipes.ts`)),all=await templates(viewsDir,opts.root),pipes=new Set(BUILTIN_PIPES),errors=0,report=(d,prefix)=>{d.severity===`error`&&errors++,opts.log(line(d,prefix))};if(existsSync(pipesFile)){let read=readPipeExports(await readFile(pipesFile,`utf8`),relative(opts.root,pipesFile));for(let n of read.names)pipes.add(n);for(let d of read.diagnostics)report(d,``)}let project={templates:/* @__PURE__ */ new Map,pipes,componentsDir:opts.componentsDir??`components`,layouts:opts.layouts,baseLayout:opts.baseLayout},syntax=/* @__PURE__ */ new Set;for(let name of all){let r=parse(await readFile(join(viewsDir,`${name}.kick`),`utf8`),`${name}.kick`);project.templates.set(name,r.ast);for(let d of r.diagnostics)report(d,`${dir}/`);r.diagnostics.some(d=>d.severity===`error`)&&syntax.add(name)}let wanted=opts.paths?.length?await templates(viewsDir,opts.root,opts.paths):all;for(let name of wanted)if(!syntax.has(name))for(let d of check(name,project).diagnostics)report(d,`${dir}/`);return errors||opts.log(`${wanted.length} template(s) checked, no errors`),+!!errors}const viewCliPlugin={name:`kick/view`,register(program,ctx){program.command(`fmt:views [paths...]`).description(`Format .kick templates (spacing and indentation; raw regions untouched)`).option(`--check`,`list files that would change and exit 1, writing nothing`).option(`--dir <dir>`,`views folder`,`src/views`).action(async(paths,o)=>{process.exitCode=await fmtViews({root:ctx.projectRoot,dir:o.dir,paths,check:o.check,log:ctx.log})}),program.command(`check:views [paths...]`).description(`Check .kick templates for errors: syntax, unknown pipes, inputs, slots, layouts, unsafe interpolation`).option(`--dir <dir>`,`views folder`,`src/views`).option(`--pipes <file>`,`pipes file (default <dir>/pipes.ts)`).action(async(paths,o)=>{process.exitCode=await checkViews({root:ctx.projectRoot,dir:o.dir,paths,pipesFile:o.pipes,log:ctx.log})})}};function direntDir(e){return e.parentPath??e.path??``}export{checkViews,fmtViews,viewCliPlugin};
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["/**\n * `kick fmt:views` and `kick check:views`, as a kick CLI plugin:\n *\n * ```ts\n * // kick.config.ts\n * import { viewCliPlugin } from '@forinda/kickjs-view/cli'\n * export default defineConfig({ plugins: [viewCliPlugin] })\n * ```\n */\nimport { existsSync } from 'node:fs'\nimport { readdir, readFile, writeFile } from 'node:fs/promises'\nimport { join, relative, resolve, sep } from 'node:path'\nimport type { KickCliPlugin } from '@forinda/kickjs-cli-kit'\nimport type { Diagnostic } from './diagnostics'\nimport { check } from './check/check'\nimport type { Project } from './check/project'\nimport { format } from './format'\nimport { parse } from './parse/template'\nimport { BUILTIN_PIPES } from './pipes/builtins'\nimport { readPipeExports } from './pipes/read-exports'\n\nexport interface ViewsCliOptions {\n  /** Project root. */\n  root: string\n  /** Views folder, relative to the root. Default `src/views`. */\n  dir?: string\n  /** Only these files (relative to the root). Default: every `.kick` file in the views folder. */\n  paths?: string[]\n  log: (message: string) => void\n}\n\nconst line = (d: Diagnostic, prefix: string) =>\n  `${prefix}${d.file}:${d.span.start.line}:${d.span.start.column} — ${d.message}`\n\n/** Template names (`users/show`) under the views folder, or those `paths` name. */\nasync function templates(viewsDir: string, root: string, paths?: string[]): Promise<string[]> {\n  if (paths?.length) {\n    return paths\n      .map((p) => relative(viewsDir, resolve(root, p)))\n      .filter((p) => p.endsWith('.kick') && !p.startsWith('..'))\n      .map((p) => p.slice(0, -'.kick'.length).split(sep).join('/'))\n  }\n  if (!existsSync(viewsDir)) return []\n  const entries = await readdir(viewsDir, { recursive: true, withFileTypes: true })\n  return entries\n    .filter((e) => e.isFile() && e.name.endsWith('.kick'))\n    .map((e) =>\n      relative(viewsDir, join(direntDir(e), e.name))\n        .slice(0, -'.kick'.length)\n        .split(sep)\n        .join('/'),\n    )\n    .toSorted()\n}\n\n/** Format templates in place, or with `check` report the ones that would change. Returns the exit code. */\nexport async function fmtViews(\n  opts: ViewsCliOptions & { check?: boolean; indent?: number },\n): Promise<number> {\n  const dir = opts.dir ?? 'src/views'\n  const viewsDir = resolve(opts.root, dir)\n  let failed = false\n  let changed = 0\n  for (const name of await templates(viewsDir, opts.root, opts.paths)) {\n    const file = join(viewsDir, `${name}.kick`)\n    const source = await readFile(file, 'utf8')\n    const r = format(source, `${name}.kick`, { indent: opts.indent })\n    for (const d of r.diagnostics) opts.log(line(d, `${dir}/`))\n    if (r.output === undefined) {\n      failed = true\n      continue\n    }\n    if (r.output === source) continue\n    changed++\n    if (opts.check) opts.log(`would reformat ${dir}/${name}.kick`)\n    else {\n      await writeFile(file, r.output)\n      opts.log(`formatted ${dir}/${name}.kick`)\n    }\n  }\n  return failed || (opts.check && changed) ? 1 : 0\n}\n\n/** Parse and check every template; print each problem with its position. Returns the exit code. */\nexport async function checkViews(\n  opts: ViewsCliOptions & {\n    pipesFile?: string\n    componentsDir?: string\n    layouts?: Project['layouts']\n    baseLayout?: string\n  },\n): Promise<number> {\n  const dir = opts.dir ?? 'src/views'\n  const viewsDir = resolve(opts.root, dir)\n  const pipesFile = resolve(opts.root, opts.pipesFile ?? join(dir, 'pipes.ts'))\n  const all = await templates(viewsDir, opts.root)\n  const pipes = new Set(BUILTIN_PIPES)\n  let errors = 0\n  const report = (d: Diagnostic, prefix: string) => {\n    if (d.severity === 'error') errors++\n    opts.log(line(d, prefix))\n  }\n  if (existsSync(pipesFile)) {\n    const read = readPipeExports(await readFile(pipesFile, 'utf8'), relative(opts.root, pipesFile))\n    for (const n of read.names) pipes.add(n)\n    for (const d of read.diagnostics) report(d, '')\n  }\n  const project: Project = {\n    templates: new Map(),\n    pipes,\n    componentsDir: opts.componentsDir ?? 'components',\n    layouts: opts.layouts,\n    baseLayout: opts.baseLayout,\n  }\n  const syntax = new Set<string>()\n  for (const name of all) {\n    const r = parse(await readFile(join(viewsDir, `${name}.kick`), 'utf8'), `${name}.kick`)\n    project.templates.set(name, r.ast)\n    for (const d of r.diagnostics) report(d, `${dir}/`)\n    if (r.diagnostics.some((d) => d.severity === 'error')) syntax.add(name)\n  }\n  const wanted = opts.paths?.length ? await templates(viewsDir, opts.root, opts.paths) : all\n  for (const name of wanted) {\n    if (syntax.has(name)) continue\n    for (const d of check(name, project).diagnostics) report(d, `${dir}/`)\n  }\n  if (!errors) opts.log(`${wanted.length} template(s) checked, no errors`)\n  return errors ? 1 : 0\n}\n\nexport const viewCliPlugin: KickCliPlugin = {\n  name: 'kick/view',\n  register(program, ctx) {\n    program\n      .command('fmt:views [paths...]')\n      .description('Format .kick templates (spacing and indentation; raw regions untouched)')\n      .option('--check', 'list files that would change and exit 1, writing nothing')\n      .option('--dir <dir>', 'views folder', 'src/views')\n      .action(async (paths: string[], o: { check?: boolean; dir: string }) => {\n        process.exitCode = await fmtViews({\n          root: ctx.projectRoot,\n          dir: o.dir,\n          paths,\n          check: o.check,\n          log: ctx.log,\n        })\n      })\n    program\n      .command('check:views [paths...]')\n      .description(\n        'Check .kick templates for errors: syntax, unknown pipes, inputs, slots, layouts, unsafe interpolation',\n      )\n      .option('--dir <dir>', 'views folder', 'src/views')\n      .option('--pipes <file>', 'pipes file (default <dir>/pipes.ts)')\n      .action(async (paths: string[], o: { dir: string; pipes?: string }) => {\n        process.exitCode = await checkViews({\n          root: ctx.projectRoot,\n          dir: o.dir,\n          paths,\n          pipesFile: o.pipes,\n          log: ctx.log,\n        })\n      })\n  },\n}\n\n/** A dirent's folder: `parentPath` from Node 20.12, `path` before it. */\nfunction direntDir(e: { parentPath?: string; path?: string }): string {\n  return e.parentPath ?? e.path ?? ''\n}\n"],"mappings":";;;;;;;;;;8RA+BA,MAAM,MAAQ,EAAe,SAC3B,GAAG,SAAS,EAAE,KAAK,GAAG,EAAE,KAAK,MAAM,KAAK,GAAG,EAAE,KAAK,MAAM,OAAO,KAAK,EAAE,UAGxE,eAAe,UAAU,SAAkB,KAAc,MAAqC,CAS5F,OARI,OAAO,OACF,MACJ,IAAK,GAAM,SAAS,SAAU,QAAQ,KAAM,CAAC,CAAC,CAAC,CAAC,CAChD,OAAQ,GAAM,EAAE,SAAS,OAAO,GAAK,CAAC,EAAE,WAAW,IAAI,CAAC,CAAC,CACzD,IAAK,GAAM,EAAE,MAAM,EAAG,EAAe,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,EAE3D,WAAW,QAAQ,GAEjB,MADe,QAAQ,SAAU,CAAE,UAAW,GAAM,cAAe,EAAK,CAAC,EAAA,CAE7E,OAAQ,GAAM,EAAE,OAAO,GAAK,EAAE,KAAK,SAAS,OAAO,CAAC,CAAC,CACrD,IAAK,GACJ,SAAS,SAAU,KAAK,UAAU,CAAC,EAAG,EAAE,IAAI,CAAC,CAAC,CAC3C,MAAM,EAAG,EAAe,CAAC,CACzB,MAAM,GAAG,CAAC,CACV,KAAK,GAAG,CACb,CAAC,CACA,SAAS,EAVsB,CAAC,CAWrC,CAGA,eAAsB,SACpB,KACiB,CACjB,IAAM,IAAM,KAAK,KAAO,YAClB,SAAW,QAAQ,KAAK,KAAM,GAAG,EACnC,OAAS,GACT,QAAU,EACd,IAAK,IAAM,QAAQ,MAAM,UAAU,SAAU,KAAK,KAAM,KAAK,KAAK,EAAG,CACnE,IAAM,KAAO,KAAK,SAAU,GAAG,KAAK,MAAM,EACpC,OAAS,MAAM,SAAS,KAAM,MAAM,EACpC,EAAI,OAAO,OAAQ,GAAG,KAAK,OAAQ,CAAE,OAAQ,KAAK,MAAO,CAAC,EAChE,IAAK,IAAM,KAAK,EAAE,YAAa,KAAK,IAAI,KAAK,EAAG,GAAG,IAAI,EAAE,CAAC,EACtD,EAAE,SAAW,IAAA,GACf,OAAS,GAGP,EAAE,SAAW,SACjB,UACI,KAAK,MAAO,KAAK,IAAI,kBAAkB,IAAI,GAAG,KAAK,MAAM,GAE3D,MAAM,UAAU,KAAM,EAAE,MAAM,EAC9B,KAAK,IAAI,aAAa,IAAI,GAAG,KAAK,MAAM,GAE5C,CACA,OAAO,QAAW,KAAK,OAAS,QAAW,EAAI,CACjD,CAGA,eAAsB,WACpB,KAMiB,CACjB,IAAM,IAAM,KAAK,KAAO,YAClB,SAAW,QAAQ,KAAK,KAAM,GAAG,EACjC,UAAY,QAAQ,KAAK,KAAM,KAAK,WAAa,KAAK,IAAK,UAAU,CAAC,EACtE,IAAM,MAAM,UAAU,SAAU,KAAK,IAAI,EACzC,MAAQ,IAAI,IAAI,aAAa,EAC/B,OAAS,EACP,QAAU,EAAe,SAAmB,CAC5C,EAAE,WAAa,SAAS,SAC5B,KAAK,IAAI,KAAK,EAAG,MAAM,CAAC,CAC1B,EACA,GAAI,WAAW,SAAS,EAAG,CACzB,IAAM,KAAO,gBAAgB,MAAM,SAAS,UAAW,MAAM,EAAG,SAAS,KAAK,KAAM,SAAS,CAAC,EAC9F,IAAK,IAAM,KAAK,KAAK,MAAO,MAAM,IAAI,CAAC,EACvC,IAAK,IAAM,KAAK,KAAK,YAAa,OAAO,EAAG,EAAE,CAChD,CACA,IAAM,QAAmB,CACvB,0BAAW,IAAI,IACf,MACA,cAAe,KAAK,eAAiB,aACrC,QAAS,KAAK,QACd,WAAY,KAAK,UACnB,EACM,uBAAS,IAAI,IACnB,IAAK,IAAM,QAAQ,IAAK,CACtB,IAAM,EAAI,MAAM,MAAM,SAAS,KAAK,SAAU,GAAG,KAAK,MAAM,EAAG,MAAM,EAAG,GAAG,KAAK,MAAM,EACtF,QAAQ,UAAU,IAAI,KAAM,EAAE,GAAG,EACjC,IAAK,IAAM,KAAK,EAAE,YAAa,OAAO,EAAG,GAAG,IAAI,EAAE,EAC9C,EAAE,YAAY,KAAM,GAAM,EAAE,WAAa,OAAO,GAAG,OAAO,IAAI,IAAI,CACxE,CACA,IAAM,OAAS,KAAK,OAAO,OAAS,MAAM,UAAU,SAAU,KAAK,KAAM,KAAK,KAAK,EAAI,IACvF,IAAK,IAAM,QAAQ,OACjB,GAAI,QAAO,IAAI,IAAI,EACnB,IAAK,IAAM,KAAK,MAAM,KAAM,OAAO,CAAC,CAAC,YAAa,OAAO,EAAG,GAAG,IAAI,EAAE,EAGvE,OADK,QAAQ,KAAK,IAAI,GAAG,OAAO,OAAO,gCAAgC,EAChE,SACT,CAEA,MAAa,cAA+B,CAC1C,KAAM,YACN,SAAS,QAAS,IAAK,CACrB,QACG,QAAQ,sBAAsB,CAAC,CAC/B,YAAY,yEAAyE,CAAC,CACtF,OAAO,UAAW,0DAA0D,CAAC,CAC7E,OAAO,cAAe,eAAgB,WAAW,CAAC,CAClD,OAAO,MAAO,MAAiB,IAAwC,CACtE,QAAQ,SAAW,MAAM,SAAS,CAChC,KAAM,IAAI,YACV,IAAK,EAAE,IACP,MACA,MAAO,EAAE,MACT,IAAK,IAAI,GACX,CAAC,CACH,CAAC,EACH,QACG,QAAQ,wBAAwB,CAAC,CACjC,YACC,uGACF,CAAC,CACA,OAAO,cAAe,eAAgB,WAAW,CAAC,CAClD,OAAO,iBAAkB,qCAAqC,CAAC,CAC/D,OAAO,MAAO,MAAiB,IAAuC,CACrE,QAAQ,SAAW,MAAM,WAAW,CAClC,KAAM,IAAI,YACV,IAAK,EAAE,IACP,MACA,UAAW,EAAE,MACb,IAAK,IAAI,GACX,CAAC,CACH,CAAC,CACL,CACF,EAGA,SAAS,UAAU,EAAmD,CACpE,OAAO,EAAE,YAAc,EAAE,MAAQ,EACnC"}

package/dist/edge.d.ts

@@ -0,0 +1,6 @@
+
+import { C as SafeHtml, D as safeStyleValue, E as read, O as sanitizeSrcset, S as render, T as escapeJsonForScript, _ as builtinPipes, a as ViewsOptions, b as RenderEnv, c as useFileLoader, d as EnvPipe, f as pipesFor, g as PipeEnv, h as BUILTIN_PIPES, i as ViewsBundle, k as sanitizeUrl, m as withEnv, n as RenderOptions, o as bundleLoader, p as safeHtml, r as Views, s as createViews, t as Loader, v as MAX_DEPTH, w as escapeHtml, x as RenderError, y as Pipe } from "./views-DA6Conh5.js";
+import { _ as TemplateAst, a as CNode, b as Span, c as Ctx, d as IfBranch, f as InputDecl, g as PathSegment, h as Node, i as CExpr, l as Element, m as LoopVar, n as Attr, o as CSeg, p as Literal, r as CAttr, s as CheckedTemplate, t as AST_FORMAT_VERSION, u as Expr, v as Diagnostic, x as positionAt, y as Pos } from "./ast-B7pxZgFT.js";
+import { i as templateName, n as componentTag, r as layoutResolver, t as Project } from "./project-J0t2RzxZ.js";
+import { a as KickView, c as readPipeExports, d as CheckResult, f as check, g as parseExpression, h as FORBIDDEN_NAMES, i as assetTags, l as URL_ATTRS, m as parse, n as ViteManifest, o as KickViewOptions, p as ParseResult, r as ViteManifestChunk, s as viewsMiddleware, t as AssetsMode, u as isUrlAttr } from "./assets-30rOQ1d0.js";
+export { AST_FORMAT_VERSION, type AssetsMode, type Attr, BUILTIN_PIPES, type CAttr, type CExpr, type CNode, type CSeg, type CheckResult, type CheckedTemplate, type Ctx, type Diagnostic, type Element, type EnvPipe, type Expr, FORBIDDEN_NAMES, type IfBranch, type InputDecl, KickView, type KickViewOptions, type Literal, type Loader, type LoopVar, MAX_DEPTH, type Node, type ParseResult, type PathSegment, type Pipe, type PipeEnv, type Pos, type Project, type RenderEnv, RenderError, type RenderOptions, SafeHtml, type Span, type TemplateAst, URL_ATTRS, type Views, type ViewsBundle, type ViewsOptions, type ViteManifest, type ViteManifestChunk, assetTags, builtinPipes, bundleLoader, check, componentTag, createViews, escapeHtml, escapeJsonForScript, isUrlAttr, layoutResolver, parse, parseExpression, pipesFor, positionAt, read, readPipeExports, render, safeHtml, safeStyleValue, sanitizeSrcset, sanitizeUrl, templateName, useFileLoader, viewsMiddleware, withEnv };

package/dist/edge.js

@@ -0,0 +1,11 @@
+/**
+ * @forinda/kickjs-view v0.1.0
+ *
+ * Copyright (c) Felix Orinda
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+import{S as positionAt,_ as templateName,a as escapeHtml,c as safeStyleValue,d as parse,f as FORBIDDEN_NAMES,g as layoutResolver,h as componentTag,i as SafeHtml,l as sanitizeSrcset,m as check,n as BUILTIN_PIPES,o as escapeJsonForScript,p as parseExpression,r as builtinPipes,s as read,t as readPipeExports,u as sanitizeUrl,v as URL_ATTRS,w as AST_FORMAT_VERSION,y as isUrlAttr}from"./read-exports-CtiwXL4e.js";import{a as createViews,c as RenderError,d as safeHtml,f as withEnv,i as bundleLoader,l as render,n as KickView,o as useFileLoader,r as viewsMiddleware,s as MAX_DEPTH,t as assetTags,u as pipesFor}from"./exports-WibN1iWb.js";export{AST_FORMAT_VERSION,BUILTIN_PIPES,FORBIDDEN_NAMES,KickView,MAX_DEPTH,RenderError,SafeHtml,URL_ATTRS,assetTags,builtinPipes,bundleLoader,check,componentTag,createViews,escapeHtml,escapeJsonForScript,isUrlAttr,layoutResolver,parse,parseExpression,pipesFor,positionAt,read,readPipeExports,render,safeHtml,safeStyleValue,sanitizeSrcset,sanitizeUrl,templateName,useFileLoader,viewsMiddleware,withEnv};