@longform/longform 0.0.18 → 0.0.19

package/lib/mod.ts

@@ -1,3 +1,18 @@
 
-export type { FragmentType, Fragment, ParsedResult } from './types.js';
-export { longform, processTemplate } from './longform.js';
+export type {
+  SerializationElement,
+  SerializerConfig,
+  Doc,
+  Element,
+  GlobalCtx,
+  MetaCtx,
+  ElementCtx,
+  AttrCtx,
+  RenderCtx,
+  AsyncRenderCtx,
+  DirectiveDef,
+  OutputMode,
+  LongformArgs,
+  ParsedResult,
+} from './types.ts';
+export { longform, processTemplate } from './longform.ts';

package/lib/types.ts

@@ -15,9 +15,9 @@ export type WorkingElement = {
   indent: number;
   key?: string;
   id?: string;
-  tag?: string;
+  tag: string;
   class?: string;
-  attrs: Record<string, string | null>;
+  attrs: Record<string, string | true | null>;
   text?: string;
   html: string;
   mount?: string;
@@ -50,7 +50,7 @@ export type FragmentRef = {
 };
 
 export type WorkingFragment = {
-  id?: string;
+  id: string;
   template: boolean;
   mountable: boolean;
   type: WorkingFragmentType;
@@ -83,7 +83,7 @@ export type Doc = {
   allowElements(elements: Record<string,  SerializationElement>): void;
 };
 
-export type SimplifiedElement = {
+export type Element = {
   id?: string;
   tag: string;
   class?: string;
@@ -96,19 +96,27 @@ export type GlobalCtx = {
 
 export type MetaCtx = {
   inlineArgs?: string;
-}
+  blockArgs?: string;
+};
 
-export type BeforeRenderCtx = {
-  inlineArg?: string;
-  blockArg?: string;
-  el: SimplifiedElement;
-  chain: SimplifiedElement[];
+export type ElementCtx = {
+  inlineArgs?: string;
+  blockArgs?: string;
+  el: Element;
+  chain: Element[];
+  doc: Readonly<Doc>;
+};
+
+export type RenderCtx = {
+  inlineArgs?: string;
+  blockArgs?: string;
+  doc: Readonly<Doc>;
+};
+
+export type AsyncRenderCtx = {
+  inlineArgs?: string;
+  blockArgs?: string;
   doc: Readonly<Doc>;
-  //serializerConfig?: SerializerConfig;
-  //setMeta(key: string, value: unknown): void;
-  //allowAll(): void;
-  //allowAttributes(attributes: string[]): void;
-  //allowElements(elements: Record<string,  SerializationElement>): void;
 };
 
 export type AttrCtx = {
@@ -131,27 +139,21 @@ export type DirectiveDef = {
    */
   meta?: (args: MetaCtx) => unknown;
   global?: (ctx: GlobalCtx) => void;
-  beforeFragment?: () => void;
-  beforeElement?: () => void;
-  beforeRender?: (ctx: BeforeRenderCtx) => void;
-  render?: (inlineArgs?: string, blockArgs?: string) => string;
-  attr?: (ctx: AttrCtx) => string;
+  element?: (ctx: ElementCtx) => void;
+  render?: (ctx: RenderCtx) => string | undefined;
+  asyncRender?: (ctx: AsyncRenderCtx) => Promise<string | undefined>;
+  attr?: (ctx: AttrCtx) => string | boolean | undefined | null;
 };
 
 export type AppliedDirective = {
-  inlineArg?: string;
-  blockArg?: string;
-  onGlobal?: (ctx: GlobalCtx) => void;
-  beforeFragment?: () => void;
-  beforeElement?: () => void;
-  beforeRender?: (ctx: BeforeRenderCtx) => void;
-  render?: (inlineArgs?: string, blockArgs?: string) => string;
-  attr?: (ctx: AttrCtx) => string;
+  inlineArgs?: string;
+  blockArgs?: string;
+  element?: (ctx: ElementCtx) => void;
 }
 
 export type OutputMode =
   | 'doc'
-  | 'meta'
+  | 'head'
   | 'mountable'
 ;
 
@@ -212,6 +214,7 @@ export type LongformArgs = {
   allowedElements?: Array<string | SerializationElement>;
   directives?: Record<string, DirectiveDef>;
   fragments?: Record<string, Fragment>;
+  debug?: boolean;
 };
 
 export type ParsedResult = {
@@ -220,6 +223,7 @@ export type ParsedResult = {
   lang?: string;
   dir?: string;
   meta: Record<string, unknown>;
+  data: Record<string, unknown>;
   mountable?: boolean;
   root?: string;
   selector?: string;

package/package.json

@@ -4,7 +4,7 @@
   "author": "Matthew Quinn",
   "homepage": "https://github.com/occultist-dev/longform",
   "license": "MIT",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "type": "module",
   "keywords": [
     "HTML",
@@ -37,6 +37,7 @@
     }
   ],
   "devDependencies": {
+    "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
     "@types/commonmark": "^0.27.10",
     "@types/deno": "^2.5.0",
@@ -63,6 +64,7 @@
     "build": "node build.ts",
     "bench": "deno bench --no-check --allow-read ./bench/longform.bench.ts",
     "test": "node --test test/**/*.test.ts",
-    "serve": "node ./serve.ts"
+    "serve": "node ./serve.ts",
+    "spec": "node ./spec.ts"
   }
 }