@dosgato/templating 0.0.120 → 0.0.121

package/dist/apitemplate.d.ts

@@ -70,14 +70,25 @@ export interface APITemplate<DataType> {
     name: string;
     /**
      * Each template must provide a function that returns links from its data so that they
-     * can be indexed. Only fields that are links need to be returned. Links inside rich editor
-     * text will be extracted automatically from any text returned by getFulltext (see below)
+     * can be indexed. Only fields that are links need to be returned as links inside rich editor
+     * text will be extracted automatically from any text returned by getFulltext (see below).
+     * Examples of links to include would be links refereced by `href` and `src` attributes in
+     * anchor, image, and video elements.
+     * @note You do not need to filter the links returned to ensure they're defined as that can
+     * be done by the routine that calls `getLinks`.
+     * @note If you are certain of the `LinkDefinition` translations allowed for the string of
+     * the link you would return in this array it would be a good idea to go ahead and coerce
+     * the string to the full type associated with it.
      */
     getLinks?: LinkGatheringFn<DataType>;
     /**
      * Each template must provide the text from any text or rich editor data it possesses, so that
      * the text can be decomposed into words and indexed for fulltext searches. Any text returned
      * by this function will also be scanned for links.
+     * Examples of text to include would be any text from data that's rendered as visible text content
+     * but not things like dates and times.
+     * @note You do not need to filter the text elements returned to ensure they're defined as that
+     * can be done by the routine that calls `getFulltext`.
      */
     getFulltext?: FulltextGatheringFn<DataType>;
     /**

package/dist/links.d.ts

@@ -79,11 +79,11 @@ export interface DataFolderLink {
 export type LinkDefinition = AssetLink | AssetFolderLink | PageLink | WebLink | DataLink | DataFolderLink;
 /**
  * This function is used by template definitions to help them identify links inside large blocks
- * of text and return them for indexing, and by render definitions to help replace them with the actual URLs
- */
+ * of text and return them for indexing, and by render definitions to help replace them with the actual URLs.
+ * @note This does not mean it finds raw links and converts them but that it finds and returns `LinkDefinition`
+ * conformant object strings in the text and returns those. */
 export declare function extractLinksFromText(text: string | undefined): LinkDefinition[];
 /**
- * This function is used by render definitions to replace links in large blocks with the actual
- * URLs they point to at render time.
- */
+ * This function is used by render definitions to replace `LinkDefinition` conformant link object text in large
+ * blocks with the actual URLs they point to at render time. */
 export declare function replaceLinksInText(text: string, resolved: Map<string, string | undefined>): string;

package/dist/links.js

@@ -1,18 +1,21 @@
+import { htmlDecode } from 'txstate-utils';
 const LinkRegex = /{.*"type"\s?:\s?"\w+".*?}/g;
+const HTMLEscapedLinkRegex = /{.*"type"\s?:\s?"\w+".*?}/g;
 /**
  * This function is used by template definitions to help them identify links inside large blocks
- * of text and return them for indexing, and by render definitions to help replace them with the actual URLs
- */
+ * of text and return them for indexing, and by render definitions to help replace them with the actual URLs.
+ * @note This does not mean it finds raw links and converts them but that it finds and returns `LinkDefinition`
+ * conformant object strings in the text and returns those. */
 export function extractLinksFromText(text) {
     if (!text)
         return [];
-    const matches = text.matchAll(LinkRegex);
-    return Array.from(matches).map(m => JSON.parse(m[0]));
+    const matches = Array.from(text.matchAll(LinkRegex)).map(m => JSON.parse(m[0]));
+    const morematches = Array.from(text.matchAll(HTMLEscapedLinkRegex)).map(m => JSON.parse(htmlDecode(m[0])));
+    return matches.concat(morematches);
 }
 /**
- * This function is used by render definitions to replace links in large blocks with the actual
- * URLs they point to at render time.
- */
+ * This function is used by render definitions to replace `LinkDefinition` conformant link object text in large
+ * blocks with the actual URLs they point to at render time. */
 export function replaceLinksInText(text, resolved) {
-    return text.replace(LinkRegex, m => resolved.get(m) ?? 'dg-broken-link');
+    return text.replace(LinkRegex, m => resolved.get(m) ?? 'dg-broken-link').replace(HTMLEscapedLinkRegex, m => resolved.get(htmlDecode(m)) ?? 'dg-broken-link');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.120",
+  "version": "0.0.121",
   "description": "A library to support building templates for dosgato CMS.",
   "type": "module",
   "exports": {
@@ -14,7 +14,7 @@
     "build": "rm -rf dist && tsc"
   },
   "dependencies": {
-    "txstate-utils": "^1.8.0"
+    "txstate-utils": "^1.8.8"
   },
   "devDependencies": {
     "@types/node": "^18.7.11",