@dosgato/templating 0.0.80 → 0.0.82

package/dist/component.d.ts

@@ -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
@@ -268,6 +284,7 @@ export interface PageRecordOptionalData<DataType extends PageData = PageData> ex
 export interface ComponentData {
     templateKey: string;
     areas?: Record<string, ComponentData[]>;
+    [keys: string]: any;
 }
 export interface PageData extends ComponentData {
     savedAtVersion: string;
@@ -275,6 +292,7 @@ export interface PageData extends ComponentData {
 export interface DataData {
     templateKey: string;
     savedAtVersion: string;
+    [keys: string]: any;
 }
 export interface ContextBase {
     /**

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, `areas.${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/uitemplate.d.ts

@@ -37,6 +37,13 @@ export interface UITemplate {
      *
      * You can place that introductory content here and it will be automatically placed into
      * components with this template upon creation (and never again).
+     *
+     * Whatever you put here will be added beneath the component's `areas` property, so it would
+     * be structured like:
+     * {
+     *   someArea: [componentData1, componentData2],
+     *   anotherArea: [componentData3]
+     * }
      */
     defaultContent?: Record<string, ComponentData[]>;
     /**

package/package.json

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