@dosgato/templating 0.0.130 → 0.0.132

package/dist/component.d.ts

@@ -168,7 +168,9 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * method to prepare editor-provided HTML for later rendering. It will do things like find and
      * resolve link definitions in the internal dosgato format.
      */
-    fetchRichText: (html: string | undefined) => Promise<void>;
+    fetchRichText: (html: string | undefined, opts?: {
+        absolute?: boolean;
+    }) => Promise<void>;
     /**
      * This function will be provided by the rendering server and should be used during the render
      * phase to clean up editor-provided HTML. It will do things like clean up tags that were accidentally
@@ -350,6 +352,9 @@ export interface PageRecord<DataType extends PageData = PageData> {
     publishedAt?: Date;
     path: string;
     data: DataType;
+    pagetree: {
+        id: string;
+    };
     site: SiteInfo;
 }
 export interface PageRecordOptionalData<DataType extends PageData = PageData> extends Omit<PageRecord<DataType>, 'data'> {

package/dist/render.d.ts

@@ -106,16 +106,22 @@ export interface APIClient {
         extension?: string;
     }) => Promise<string | undefined>;
     /**
-     * Exactly like resolveLink but also returns the title of the target page, if the target page
-     * is internal to the CMS. If the target is a random web page outside the CMS, title will be
-     * undefined. Perhaps in the future title could be scraped from the page HTML.
+     * Exactly like resolveLink but also returns more data.
+     *
+     * First, the title of the target page, if the target page is internal to the CMS. If the
+     * target is a random web page outside the CMS, title will be undefined. Perhaps in the future
+     * title could be scraped from the page HTML.
+     *
+     * Second, a broken boolean that indicates whether the targeted page actually exists. See getHrefPlus
+     * for a detailed explanation.
      */
-    resolveLinkAndTitle: (lnk: string | LinkDefinition | undefined, opts?: {
+    resolveLinkPlus: (lnk: string | LinkDefinition | undefined, opts?: {
         absolute?: boolean;
         extension?: string;
     }) => Promise<{
         href?: string;
         title?: string;
+        broken: boolean;
     }>;
     /**
      * Get a link href for a page
@@ -132,6 +138,26 @@ export interface APIClient {
         absolute?: boolean;
         extension?: string;
     }) => string | undefined;
+    /**
+     * Exactly like getHref except it also returns whether or not the link it's returning is actually
+     * a broken link.
+     *
+     * When an internal link points at a page that has since been deleted, we don't want to return
+     * undefined or empty string or something like that, because it would mask the issue that a link has
+     * stopped working. Instead we return the path that we once pointed at, which we know won't work, but
+     * is at least something the user can read, and then reason about why the link broke and how to fix it.
+     *
+     * Since we are returning data we know is broken, it's nice to have a boolean that indicates that fact.
+     * Based on that boolean, components can be configured to render a shiny red warning message in edit mode
+     * so that editors can quickly identify broken links on their pages.
+     */
+    getHrefPlus: (page: PageRecordOptionalData, opts?: {
+        absolute?: boolean;
+        extension?: string;
+    }) => {
+        href: string | undefined;
+        broken: boolean;
+    };
     /**
      * Get assets by link
      *

package/dist/uitemplate.d.ts

@@ -189,9 +189,9 @@ export interface UIConfig {
     assetMetaDialog?: UITemplate['dialog'];
     tracing?: {
         init?: (env: TracingEnvironment) => void;
-        startTransaction?: (name: string, details: any, env: TracingEnvironment) => void;
-        endTransaction?: (name: string, details: any, env: TracingEnvironment) => void;
-        event?: (name: string, details: any, env: TracingEnvironment) => void;
+        startTransaction?: (name: string, details: any, env?: TracingEnvironment) => void;
+        endTransaction?: (name: string, details: any, env?: TracingEnvironment) => void;
+        event?: (name: string, details: any, env?: TracingEnvironment) => void;
     };
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.130",
+  "version": "0.0.132",
   "description": "A library to support building templates for dosgato CMS.",
   "type": "module",
   "exports": {