@dosgato/templating 1.1.9 → 1.1.11

package/dist/component.d.ts

@@ -211,20 +211,27 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * render of the parent component.
      */
     abstract render(): string;
+    /**
+     * If you are rendering a variation for a component that has areas and children,
+     * you can call Component.renderVariation(extension, this.renderedAreas) to help you easily
+     * render the areas and children inside whatever wrapper content you need.
+     */
+    static renderVariation(extension: string, renderedAreas: Map<string, RenderedComponent[]>): string;
     /**
      * Sometimes pages are requested with an alternate extension like .rss or .ics. In these
      * situations, each component should consider whether it should output anything. For
      * instance, if the extension is .rss and a component represents an article, it should
      * probably output an RSS item. If you don't recognize the extension, just return
-     * super.renderVariation(extension, renderedAreas) to give your child components a chance to
+     * Component.renderVariation(extension, this.renderedAreas) to give your child components a chance to
      * respond, or return empty string if you want your child components to be silent in all
      * cases.
      *
+     * If you implement this function to add content for a specific extension, you should also
+     * probably override `shouldFetchVariation` to return true for that extension. Also remember
+     * to use Component.renderVariation(extension, this.renderedAreas) to render your child components.
+     *
      * The extension will NOT include the preceding dot. In the case of an extended extension like
      * '.js.map', you will receive 'js.map'.
-     *
-     * This function will be run after the fetch phase. The context and html rendering phases
-     * will be skipped.
      */
     renderVariation(extension: string): string;
     /**

package/dist/component.js

@@ -85,23 +85,32 @@ export class Component extends ResourceProvider {
     setContext(renderCtxFromParent, areaName) {
         return renderCtxFromParent;
     }
+    /**
+     * If you are rendering a variation for a component that has areas and children,
+     * you can call Component.renderVariation(extension, this.renderedAreas) to help you easily
+     * render the areas and children inside whatever wrapper content you need.
+     */
+    static renderVariation(extension, renderedAreas) {
+        return Array.from(renderedAreas.values()).flatMap(ras => ras.map(ra => ra.output)).join('');
+    }
     /**
      * Sometimes pages are requested with an alternate extension like .rss or .ics. In these
      * situations, each component should consider whether it should output anything. For
      * instance, if the extension is .rss and a component represents an article, it should
      * probably output an RSS item. If you don't recognize the extension, just return
-     * super.renderVariation(extension, renderedAreas) to give your child components a chance to
+     * Component.renderVariation(extension, this.renderedAreas) to give your child components a chance to
      * respond, or return empty string if you want your child components to be silent in all
      * cases.
      *
+     * If you implement this function to add content for a specific extension, you should also
+     * probably override `shouldFetchVariation` to return true for that extension. Also remember
+     * to use Component.renderVariation(extension, this.renderedAreas) to render your child components.
+     *
      * The extension will NOT include the preceding dot. In the case of an extended extension like
      * '.js.map', you will receive 'js.map'.
-     *
-     * This function will be run after the fetch phase. The context and html rendering phases
-     * will be skipped.
      */
     renderVariation(extension) {
-        return Array.from(this.renderedAreas.values()).flatMap(ras => ras.map(ra => ra.output)).join('');
+        return Component.renderVariation(extension, this.renderedAreas);
     }
     /**
      * helper function to print an area's component list, but you can also override this if you

package/dist/render.d.ts

@@ -1,4 +1,4 @@
-import type { ContextBase, DataRecord, PageData, PageRecord, PageRecordNoData, PageRecordOptionalData } from './component.js';
+import type { ContextBase, DataRecord, PageData, PageRecord, PageRecordNoData, SiteInfo } from './component.js';
 import type { AssetFolderLink, AssetLink, DataFolderLink, DataLink, LinkDefinition, PageLink } from './links.js';
 /**
  * Safely encapsulates `content` in header tags based on the `ctx` context passed and adds any passed `attributes` to the header tagging.
@@ -134,7 +134,13 @@ export interface APIClient {
      * broken, but if a site has launch info that is simply disabled, getHref will still work. Any links generated
      * would work as soon as the launch info is enabled.
      */
-    getHref: (page: PageRecordOptionalData, opts?: {
+    getHref: (page: {
+        path: string;
+        site: SiteInfo;
+        pagetree: {
+            id: string;
+        };
+    }, opts?: {
         absolute?: boolean;
         extension?: string;
     }) => string | undefined;
@@ -151,7 +157,13 @@ export interface APIClient {
      * 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?: {
+    getHrefPlus: (page: {
+        path: string;
+        site: SiteInfo;
+        pagetree: {
+            id: string;
+        };
+    }, opts?: {
         absolute?: boolean;
         extension?: string;
     }) => {

package/package.json

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