@dosgato/templating 0.0.19 → 0.0.20

package/dist/apitemplate.d.ts

@@ -90,3 +90,15 @@ export interface Migration {
 }
 export declare type LinkGatheringFn = (data: any) => LinkDefinition[];
 export declare type FulltextGatheringFn = (data: any) => string[];
+/**
+ * This function is used by API template definitions to help them identify links inside large blocks
+ * of text and return them for indexing.
+ */
+export declare function extractLinksFromText(text: string): LinkDefinition[];
+/**
+ * This function is used by API template definitions to help them identify all the searchable
+ * words in a large block of text and return them for indexing.
+ */
+export declare function getKeywords(text: string, options?: {
+    stopwords?: boolean;
+}): string[];

package/dist/apitemplate.js

@@ -1,2 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeywords = exports.extractLinksFromText = void 0;
+const stopwords_1 = require("./stopwords");
+/**
+ * This function is used by API template definitions to help them identify links inside large blocks
+ * of text and return them for indexing.
+ */
+function extractLinksFromText(text) {
+    const matches = text.matchAll(/{.*"type"\s?:\s+"\w+".*?}/gi);
+    return Array.from(matches).map(m => JSON.parse(m[0]));
+}
+exports.extractLinksFromText = extractLinksFromText;
+/**
+ * This function is used by API template definitions to help them identify all the searchable
+ * words in a large block of text and return them for indexing.
+ */
+function getKeywords(text, options) {
+    return Array.from(new Set(text
+        .toLocaleLowerCase()
+        .normalize('NFD').replace(/\p{Diacritic}/gu, '')
+        .split(/[^\w-]+/)
+        .flatMap(word => word.includes('-') ? word.split('-').concat(word.replace('-', '')) : [word])
+        .filter(word => word.length > 2 && (options?.stopwords === false || !stopwords_1.stopwords[word]) && isNaN(Number(word)))));
+}
+exports.getKeywords = getKeywords;

package/dist/component.d.ts

@@ -1,4 +1,5 @@
 import { EditBarOpts } from './editbar';
+import { LinkDefinition } from './links';
 import { ResourceProvider } from './provider';
 /**
  * This is the primary templating class to build your templates. Subclass it and provide
@@ -18,6 +19,19 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
     parent?: Component;
     page?: Page;
     hadError: boolean;
+    /**
+     * This function will be provided by the rendering server and should be used inside your fetch,
+     * method to convert a link, as input by a user, into a URL suitable for an href, or optionally
+     * an absolute URL suitable for a backend http request or non-HTML document like an RSS feed.
+     */
+    resolveLink: (link: string | LinkDefinition, absolute?: boolean) => Promise<string>;
+    /**
+     * This function will be provided by the rendering server and should be used inside your fetch
+     * method to prepare editor-provided HTML for rendering. It will do things like find and resolve
+     * link definitions in the internal dosgato format and clean up tags that were accidentally left
+     * open to protect overall page integrity.
+     */
+    processRich: (text: string) => Promise<string>;
     /**
      * The first phase of rendering a component is the fetch phase. Each component may
      * provide a fetch method that looks up data it needs from external sources. This step
@@ -31,14 +45,14 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      */
     fetch(editMode: boolean): Promise<FetchedType>;
     /**
-     * The second phase of rendering a component is the context phase. This step is TOP-DOWN,
-     * each component will receive the parent component's context, modify it as desired,
-     * and then pass context to its children.
+     * The second phase of rendering a component is the context phase. This step is TOP-DOWN and
+     * NON-MUTATING. Each component will receive the parent component's context and then pass a
+     * NEW context object to its children.
      *
      * This is useful for rendering logic that is sensitive to where the component exists in
      * the hierarchy of the page. For instance, if a parent component has used an h2 header
      * already, it will want to inform its children so that they can use h3 next, and they inform
-     * their children that h4 is next, and so on. (Header level tracking is actually required in
+     * their children that h4 is next, and so on. (Header level tracking is supported by default in
      * dosgato CMS.)
      *
      * This function may return a promise in case you need to do something asynchronous based on

package/dist/component.js

@@ -45,14 +45,14 @@ class Component extends provider_1.ResourceProvider {
         return undefined;
     }
     /**
-     * The second phase of rendering a component is the context phase. This step is TOP-DOWN,
-     * each component will receive the parent component's context, modify it as desired,
-     * and then pass context to its children.
+     * The second phase of rendering a component is the context phase. This step is TOP-DOWN and
+     * NON-MUTATING. Each component will receive the parent component's context and then pass a
+     * NEW context object to its children.
      *
      * This is useful for rendering logic that is sensitive to where the component exists in
      * the hierarchy of the page. For instance, if a parent component has used an h2 header
      * already, it will want to inform its children so that they can use h3 next, and they inform
-     * their children that h4 is next, and so on. (Header level tracking is actually required in
+     * their children that h4 is next, and so on. (Header level tracking is supported by default in
      * dosgato CMS.)
      *
      * This function may return a promise in case you need to do something asynchronous based on

package/dist/links.d.ts

@@ -63,15 +63,3 @@ export interface DataFolderLink {
     path: string;
 }
 export declare type LinkDefinition = AssetLink | AssetFolderLink | PageLink | WebLink | DataLink | DataFolderLink;
-/**
- * This function is used by API template definitions to help them identify links inside large blocks
- * of text and return them for indexing.
- */
-export declare function extractLinksFromText(text: string): LinkDefinition[];
-/**
- * This function is used by API template definitions to help them identify all the searchable
- * words in a large block of text and return them for indexing.
- */
-export declare function getKeywords(text: string, options?: {
-    stopwords?: boolean;
-}): string[];

package/dist/links.js

@@ -1,26 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKeywords = exports.extractLinksFromText = void 0;
-const stopwords_1 = require("./stopwords");
-/**
- * This function is used by API template definitions to help them identify links inside large blocks
- * of text and return them for indexing.
- */
-function extractLinksFromText(text) {
-    const matches = text.matchAll(/{.*"type"\s?:\s+"\w+".*?}/gi);
-    return Array.from(matches).map(m => JSON.parse(m[0]));
-}
-exports.extractLinksFromText = extractLinksFromText;
-/**
- * This function is used by API template definitions to help them identify all the searchable
- * words in a large block of text and return them for indexing.
- */
-function getKeywords(text, options) {
-    return Array.from(new Set(text
-        .toLocaleLowerCase()
-        .normalize('NFD').replace(/\p{Diacritic}/gu, '')
-        .split(/[^\w-]+/)
-        .flatMap(word => word.includes('-') ? word.split('-').concat(word.replace('-', '')) : [word])
-        .filter(word => word.length > 2 && (options?.stopwords === false || !stopwords_1.stopwords[word]) && isNaN(Number(word)))));
-}
-exports.getKeywords = getKeywords;

package/dist/render.d.ts

@@ -0,0 +1,5 @@
+import { ContextBase } from './component';
+export declare function printHeader(ctx: ContextBase, content: string): string;
+export declare function advanceHeader(ctx: ContextBase, content?: string): {
+    headerLevel: number;
+};

package/dist/render.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.advanceHeader = exports.printHeader = void 0;
+const txstate_utils_1 = require("txstate-utils");
+function printHeader(ctx, content) {
+    if ((0, txstate_utils_1.isBlank)(content))
+        return '';
+    const level = (ctx.headerLevel ?? 0) + 1;
+    if (level < 1)
+        return `<h1>${content}</h1>`;
+    if (level > 6)
+        return `<h6>${content}</h1>`;
+    return `<h${level}>${content}</h${level}>`;
+}
+exports.printHeader = printHeader;
+function advanceHeader(ctx, content) {
+    const ret = { ...ctx };
+    if (!(0, txstate_utils_1.isBlank)(content))
+        ret.headerLevel = (ret.headerLevel ?? 0) + 1;
+    return ret;
+}
+exports.advanceHeader = advanceHeader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "A library to support building templates for dosgato CMS.",
   "exports": {
     "require": "./dist/index.js",