@dosgato/templating 0.0.79 → 0.0.81

package/dist/component.d.ts

@@ -81,7 +81,7 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
     /**
      * An array of components to add to the area.
      */
-    components: ComponentData[], 
+    components: ComponentData[] | undefined, 
     /**
      * The page id of the page these components came from.
      *
@@ -104,6 +104,22 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * Default is 'top'.
      */
     mode?: 'top' | 'bottom' | 'replace') => void;
+    /**
+     * Inherit components from another page with matching area
+     *
+     * This is a convenience function for when you are inheriting components from
+     * the exact same area on another page. It will not cover all inheritance use
+     * cases, but it covers enough that having this as a shorthand is helpful.
+     *
+     * Call it in your fetch() method just like you would with registerInherited.
+     *
+     * Note that you can still provide `mode` and you can provide a `filter` function
+     * to reduce the number of components that get inherited.
+     */
+    inheritArea<T extends ComponentData>(page: PageRecord, areaName: string, opts?: {
+        mode?: 'top' | 'bottom' | 'replace';
+        filter?: (c: T) => boolean;
+    }): void;
     /**
      * 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

package/dist/component.js

@@ -1,4 +1,4 @@
-import { isNotBlank } from 'txstate-utils';
+import { get, isNotBlank } from 'txstate-utils';
 import { ResourceProvider } from './provider.js';
 function defaultWrap(info) { return info.output; }
 /**
@@ -56,6 +56,22 @@ export class Component extends ResourceProvider {
     async fetch() {
         return undefined;
     }
+    /**
+     * Inherit components from another page with matching area
+     *
+     * This is a convenience function for when you are inheriting components from
+     * the exact same area on another page. It will not cover all inheritance use
+     * cases, but it covers enough that having this as a shorthand is helpful.
+     *
+     * Call it in your fetch() method just like you would with registerInherited.
+     *
+     * Note that you can still provide `mode` and you can provide a `filter` function
+     * to reduce the number of components that get inherited.
+     */
+    inheritArea(page, areaName, opts) {
+        const components = get(page.data, areaName).filter(opts?.filter ?? (() => true));
+        this.registerInherited(areaName, components, page.id, opts?.mode);
+    }
     /**
      * 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

package/dist/render.d.ts

@@ -131,7 +131,7 @@ export interface APIClient {
      *
      * Returns the root page(s). Subpages are inside the `children` property.
      */
-    getNavigation: ({ beneath, depth, extra, absolute }: {
+    getNavigation: (opts?: {
         /**
          * Return pages beneath this path
          *

package/package.json

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