@dosgato/templating 0.0.17 → 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

@@ -14,7 +14,6 @@ class Component extends provider_1.ResourceProvider {
     // the constructor is part of the recursive hydration mechanism: constructing
     // a Component will also construct/hydrate all its child components
     constructor(data, path, parent) {
-        var _a;
         super();
         // properties for use during hydration, you do not have to provide these when
         // building a template, but you can use them in the functions you do provide
@@ -24,7 +23,7 @@ class Component extends provider_1.ResourceProvider {
         this.data = ownData;
         this.path = path;
         this.hadError = false;
-        let tmpParent = (_a = this.parent) !== null && _a !== void 0 ? _a : this;
+        let tmpParent = this.parent ?? this;
         while (!(tmpParent instanceof Page) && tmpParent.parent)
             tmpParent = tmpParent.parent;
         if (!(tmpParent instanceof Page))
@@ -46,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
@@ -89,8 +88,7 @@ class Component extends provider_1.ResourceProvider {
     }
     // helper function for recursively passing the error up until it reaches the page
     passError(e, path) {
-        var _a;
-        (_a = this.parent) === null || _a === void 0 ? void 0 : _a.passError(e, path);
+        this.parent?.passError(e, path);
     }
     /**
      * During rendering, each component should determine the CSS blocks that it needs. This may
@@ -150,9 +148,8 @@ class Component extends provider_1.ResourceProvider {
      * Generally should not be overridden - override editLabel and editClass instead
      */
     editBar(opts = {}) {
-        var _a, _b;
-        (_a = opts.label) !== null && _a !== void 0 ? _a : (opts.label = this.editLabel());
-        (_b = opts.extraClass) !== null && _b !== void 0 ? _b : (opts.extraClass = this.editClass());
+        opts.label ?? (opts.label = this.editLabel());
+        opts.extraClass ?? (opts.extraClass = this.editClass());
         return (0, editbar_1.editBar)(this.path, opts);
     }
     /**
@@ -161,9 +158,8 @@ class Component extends provider_1.ResourceProvider {
      * Generally should not be overridden - override newLabel and newClass instead
      */
     newBar(areaName, opts = {}) {
-        var _a, _b;
-        (_a = opts.label) !== null && _a !== void 0 ? _a : (opts.label = this.newLabel(areaName));
-        (_b = opts.extraClass) !== null && _b !== void 0 ? _b : (opts.extraClass = this.newClass(areaName));
+        opts.label ?? (opts.label = this.newLabel(areaName));
+        opts.extraClass ?? (opts.extraClass = this.newClass(areaName));
         return (0, editbar_1.newBar)(this.path + '.' + areaName, opts);
     }
 }

package/dist/editbar.js

@@ -3,12 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.newBar = exports.editBar = void 0;
 const txstate_utils_1 = require("txstate-utils");
 function editBar(path, opts) {
-    var _a;
     if (!opts.editMode)
         return '';
     const id = (0, txstate_utils_1.randomid)();
     return `
-<div class="dg-edit-bar ${(_a = opts.extraClass) !== null && _a !== void 0 ? _a : ''}" data-path="${(0, txstate_utils_1.htmlEncode)(path)}" draggable="true" ondragstart="window.dgEditing.drag(event)" ondragover="window.dgEditing.over(event)" ondragend="window.dgEditing.drop(event)">
+<div class="dg-edit-bar ${opts.extraClass ?? ''}" data-path="${(0, txstate_utils_1.htmlEncode)(path)}" draggable="true" ondragstart="window.dgEditing.drag(event)" ondragover="window.dgEditing.over(event)" ondragend="window.dgEditing.drop(event)">
   <span id="${id}" class="dg-edit-bar-label">${(0, txstate_utils_1.htmlEncode)(opts.label)}</span>
   <button onclick="window.dgEditing.edit(event)" aria-describedby="${id}">Edit</button>
   <button onclick="window.dgEditing.move(event)" aria-describedby="${id}">Move</button>
@@ -18,11 +17,10 @@ function editBar(path, opts) {
 }
 exports.editBar = editBar;
 function newBar(path, opts) {
-    var _a;
     if (!opts.editMode)
         return '';
     return `
-<div role="button" onclick="window.dgEditing.create(event)" class="dg-new-bar ${(_a = opts.extraClass) !== null && _a !== void 0 ? _a : ''}" data-path="${(0, txstate_utils_1.htmlEncode)(path)}">
+<div role="button" onclick="window.dgEditing.create(event)" class="dg-new-bar ${opts.extraClass ?? ''}" data-path="${(0, txstate_utils_1.htmlEncode)(path)}">
   ${(0, txstate_utils_1.htmlEncode)(opts.label)}
 </div>
   `.trim();

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/dist/stopwords.d.ts

@@ -0,0 +1 @@
+export declare const stopwords: Record<string, boolean>;

package/dist/stopwords.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stopwords = void 0;
+exports.stopwords = {
+    myself: true,
+    our: true,
+    ours: true,
+    ourselves: true,
+    you: true,
+    your: true,
+    yours: true,
+    yourself: true,
+    yourselves: true,
+    him: true,
+    his: true,
+    himself: true,
+    she: true,
+    her: true,
+    hers: true,
+    herself: true,
+    its: true,
+    itself: true,
+    they: true,
+    them: true,
+    their: true,
+    theirs: true,
+    themselves: true,
+    what: true,
+    which: true,
+    who: true,
+    whom: true,
+    this: true,
+    that: true,
+    these: true,
+    those: true,
+    are: true,
+    was: true,
+    were: true,
+    been: true,
+    being: true,
+    have: true,
+    has: true,
+    had: true,
+    having: true,
+    does: true,
+    did: true,
+    doing: true,
+    the: true,
+    and: true,
+    but: true,
+    because: true,
+    until: true,
+    while: true,
+    for: true,
+    with: true,
+    about: true,
+    against: true,
+    between: true,
+    into: true,
+    through: true,
+    during: true,
+    before: true,
+    after: true,
+    above: true,
+    below: true,
+    from: true,
+    down: true,
+    out: true,
+    off: true,
+    over: true,
+    under: true,
+    again: true,
+    further: true,
+    then: true,
+    once: true,
+    here: true,
+    there: true,
+    when: true,
+    where: true,
+    why: true,
+    how: true,
+    all: true,
+    any: true,
+    both: true,
+    each: true,
+    few: true,
+    more: true,
+    most: true,
+    other: true,
+    some: true,
+    such: true,
+    nor: true,
+    not: true,
+    only: true,
+    own: true,
+    same: true,
+    than: true,
+    too: true,
+    very: true,
+    can: true,
+    will: true,
+    just: true,
+    don: true,
+    should: true,
+    now: true,
+    // HTML
+    div: true,
+    span: true,
+    img: true,
+    abbr: true,
+    area: true,
+    main: true,
+    aside: true,
+    blockquote: true,
+    button: true,
+    caption: true,
+    code: true,
+    del: true,
+    strong: true,
+    font: true,
+    embed: true,
+    fieldset: true,
+    form: true,
+    figure: true,
+    iframe: true,
+    label: true,
+    input: true,
+    script: true,
+    nav: true,
+    select: true,
+    option: true,
+    picture: true,
+    pre: true,
+    small: true,
+    style: true,
+    svg: true,
+    sub: true,
+    table: true,
+    tbody: true,
+    href: true,
+    src: true,
+    srcset: true,
+    class: true,
+    textarea: true,
+    title: true,
+    onclick: true,
+    // LinkDefinition
+    siteId: true,
+    path: true,
+    type: true,
+    assetId: true,
+    linkId: true,
+    url: true
+};

package/dist-esm/index.js

@@ -3,3 +3,5 @@ import all from '../dist/index.js'
 export const ResourceProvider = all.ResourceProvider
 export const Component = all.Component
 export const Page = all.Page
+export const extractLinksFromText = all.extractLinksFromText
+export const getKeywords = all.getKeywords

package/package.json

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