@longform/async 0.1.1 → 0.2.1

package/lib/types.ts

@@ -67,7 +67,7 @@ export type WorkingFragment = {
   html: string;
   refs: FragmentRef[];
   els: WorkingElement[];
-  mountPoints?: MountPoint[];
+  mountpoints?: MountPoint[];
 };
 
 /**
@@ -346,7 +346,7 @@ export type Directive = {
   /**
    * The global hook is not implemented.
    *
-   * @internal.
+   * @internal
    */
   global?: (ctx: GlobalCtx) => void;
 
@@ -428,12 +428,12 @@ export type Annotation =
  *
  * `doc` Outputs all fragments normally.
  *
- * `head` Parses the `@id`, `@type`, @lang`, `@dir` and any directives
+ * `head` Parses the `\@id`, `\@type`, `\@lang`, `\@dir` and any directives
  * implementing the `meta` directive hook. It exits as soon as it hits
  * another directive type or fragment declaration.
  *
- * `mountable` Supports use of the `@mount` directive for turning elements
- * into mountpoints. This output mode populates the `mountPoints` array
+ * `mountable` Supports use of the `\@mount` directive for turning elements
+ * into mountpoints. This output mode populates the `mountpoints` array
  * in the parse result. This array can be looped over and data from another
  * rendering tool can mount its output into the named mount points. Once all
  * mountpoint entries have been populated the `tail` property in the parsed
@@ -443,7 +443,7 @@ export type Annotation =
  * supports documents implementing a single root element.
  *
  * `templates` parses every fragment as though it was a template even
- * if the `@template` directive is not used. This is useful for creating
+ * if the `\@template` directive is not used. This is useful for creating
  * directives which use the block args to define a Longform template.
  */
 export type OutputMode =
@@ -669,3 +669,30 @@ export type ParsedLongform = {
   tail?: string;
 };
 
+
+/**
+ * An object containing a parsed Longform template.
+ */
+export type TemplateOutput = {
+
+  /**
+   * The Longform identifier for the element.
+   */
+  id?: string;
+
+  /**
+   * The fragment type.
+   *
+   * `root` indicates the template is a root fragments
+   * `embed` indicates the fragment has a unique embedded HTML id.
+   * `bare` indicates the fragment has no embedded HTML id.
+   * `range` indicates the fragment is a range of elements, instead of having a single top level element.
+   * `text` indicates the fragment is text only can can be used in situations where HTML might be invalid.
+   */
+  type: 'root' | FragmentType;
+
+  /**
+   * The fragment output as a string.
+   */
+  html: string;
+};

package/package.json

@@ -4,7 +4,7 @@
   "author": "Matthew Quinn",
   "homepage": "https://github.com/occultist-dev/longform",
   "license": "MIT",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "type": "module",
   "keywords": [
     "HTML",
@@ -16,6 +16,7 @@
   "types": "./dist/mod.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/mod.d.ts",
       "import": "./dist/longform.js",
       "require": "./dist/longform.cjs"
     }
@@ -33,18 +34,24 @@
   "licenses": [
     {
       "type": "MIT",
-      "url": "https://github.com/occultist-dev/longform/blob/main/LICENSE"
+      "url": "https://codeberg.org/occultist/longform/blob/main/LICENSE"
     }
   ],
   "devDependencies": {
+    "@microsoft/api-extractor": "^7.58.10",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
     "@types/commonmark": "^0.27.10",
     "@types/deno": "^2.5.0",
     "@types/jsdom": "^27.0.0",
     "@types/node": "^24.8.1",
+    "@typescript-eslint/eslint-plugin": "^8.64.0",
+    "@typescript-eslint/parser": "^8.64.0",
     "commonmark": "^0.31.2",
     "dompurify": "^3.4.1",
+    "eslint": "^10.7.0",
+    "eslint-plugin-tsdoc": "^0.5.2",
+    "eslint-watch": "^8.0.0",
     "jsdom": "^27.0.1",
     "marked": "^16.4.1",
     "prettier": "^3.6.2",
@@ -64,7 +71,9 @@
     "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",
-    "spec": "node ./spec.ts"
+    "serve": "node serve.ts",
+    "spec": "node spec.ts",
+    "tsdoc": "node --watch --watch-path=lib lint.ts",
+    "release": "./release.sh"
   }
 }