@dosgato/templating 0.0.38 → 0.0.39

package/dist/component.d.ts

@@ -19,6 +19,12 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
     parent?: Component;
     page?: Page;
     hadError: boolean;
+    /**
+     * This property will be set during page render and you may refer to it at any time to
+     * determine whether you are doing your work in edit mode or regular rendering mode.
+     * The editBar and newBar methods will automatically use it to blank out the editing UI.
+     */
+    editMode: boolean;
     /**
      * The rendering server will provide an instance of the APIClient interface so that
      * you can run any API GraphQL query you like in your `fetch` function. There are also
@@ -63,7 +69,7 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * you may add them to your this.areas map, e.g.
      * `this.areas.get('myarea').push(new Component(inheritedData, this.path + '/myarea/inherit1', this))`
      */
-    fetch(editMode: boolean): Promise<FetchedType>;
+    fetch(): Promise<FetchedType>;
     /**
      * 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
@@ -79,14 +85,14 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * the context received from the parent, but use it sparingly since it will stall the process.
      * Try to do all asynchronous work in the fetch phase.
      */
-    setContext(renderCtxFromParent: RenderContextType, editMode: boolean): RenderContextType | Promise<RenderContextType>;
+    setContext(renderCtxFromParent: RenderContextType): RenderContextType | Promise<RenderContextType>;
     /**
      * The final phase of rendering a component is the render phase. This step is BOTTOM-UP -
      * components at the bottom of the hierarchy will be rendered first, and the result of the
      * render will be passed to parent components so that the HTML can be included during the
      * render of the parent component.
      */
-    abstract render(renderedAreas: Map<string, string[]>, editMode: boolean): string;
+    abstract render(renderedAreas: Map<string, string[]>): 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
@@ -100,7 +106,7 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * will be skipped.
      */
     renderVariation(extension: string, renderedAreas: Map<string, string>): string;
-    constructor(data: DataType, path: string, parent: Component | undefined);
+    constructor(data: DataType, path: string, parent: Component | undefined, editMode: boolean);
     /**
      * For logging errors during rendering without crashing the render. If your fetch, setContext,
      * render, or renderVariation functions throw, the error will be logged but the page render will
@@ -198,5 +204,5 @@ export declare abstract class Page<DataType extends PageData = any, FetchedType
      */
     headContent: string;
     protected passError(e: Error, path: string): void;
-    constructor(page: PageRecord<DataType>);
+    constructor(page: PageRecord<DataType>, editMode: boolean);
 }

package/dist/component.js

@@ -11,11 +11,12 @@ import { ResourceProvider } from './provider.js';
 export class Component extends ResourceProvider {
     // the constructor is part of the recursive hydration mechanism: constructing
     // a Component will also construct/hydrate all its child components
-    constructor(data, path, parent) {
+    constructor(data, path, parent, editMode) {
         super();
         // properties for use during hydration, you do not have to provide these when
         // building a template, but you can use them in the functions you do provide
         this.areas = new Map();
+        this.editMode = editMode;
         this.parent = parent;
         const { areas, ...ownData } = data;
         this.data = ownData;
@@ -42,7 +43,7 @@ export class Component extends ResourceProvider {
      * you may add them to your this.areas map, e.g.
      * `this.areas.get('myarea').push(new Component(inheritedData, this.path + '/myarea/inherit1', this))`
      */
-    async fetch(editMode) {
+    async fetch() {
         return undefined;
     }
     /**
@@ -60,7 +61,7 @@ export class Component extends ResourceProvider {
      * the context received from the parent, but use it sparingly since it will stall the process.
      * Try to do all asynchronous work in the fetch phase.
      */
-    setContext(renderCtxFromParent, editMode) {
+    setContext(renderCtxFromParent) {
         return renderCtxFromParent;
     }
     /**
@@ -151,6 +152,7 @@ export class Component extends ResourceProvider {
     editBar(opts = {}) {
         opts.label ?? (opts.label = this.editLabel());
         opts.extraClass ?? (opts.extraClass = this.editClass());
+        opts.editMode = this.editMode;
         return editBar(this.path, opts);
     }
     /**
@@ -161,12 +163,13 @@ export class Component extends ResourceProvider {
     newBar(areaName, opts = {}) {
         opts.label ?? (opts.label = this.newLabel(areaName));
         opts.extraClass ?? (opts.extraClass = this.newClass(areaName));
+        opts.editMode = this.editMode;
         return newBar([this.path, 'areas', areaName].filter(isNotBlank).join('.'), opts);
     }
 }
 export class Page extends Component {
-    constructor(page) {
-        super(page.data, '', undefined);
+    constructor(page, editMode) {
+        super(page.data, '', undefined, editMode);
         this.pagePath = page.path;
     }
     passError(e, path) {

package/package.json

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