@dosgato/templating 0.0.98 → 0.0.100

package/dist/component.d.ts

@@ -82,16 +82,14 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * going to render anything. For instance, if we are rendering an '.ics' variation and this component
      * is not an event, it will not be participating and we'd like to avoid doing the work in the fetch().
      *
-     * This method returns a map of extensions where we SHOULD run fetch(). The default is only run fetch
+     * This method returns true for extensions where we SHOULD run fetch(). The default is only run fetch
      * on 'html'. Components that support other variations should override this method and opt in to more
      * extensions.
      *
-     * The extensions listed should NOT include the preceding dot. In the case of an extended extension like
-     * '.js.map', you should provide 'js.map'.
+     * The extension will NOT include the preceding dot. In the case of an extended extension like
+     * '.js.map', you should receive 'js.map'.
      */
-    variationsToFetch(): {
-        html: boolean;
-    };
+    shouldFetchVariation(extension: string): boolean;
     /**
      * Some components may be inheritable to subpages within the same site. For instance, a site's
      * social media links may appear on every page's footer. To accomplish this in your template,
@@ -575,6 +573,22 @@ export declare abstract class Page<DataType extends PageData = any, FetchedType
      * at any time during fetch, context, or render, to set an HTTP header on the response
      */
     addHeader: (key: string, value: string | undefined) => void;
+    /**
+     * URL for the currently rendering page
+     *
+     * The URL currently being rendered. For instance, if we are in edit mode it would begin
+     * with /.edit/ or in preview mode, /.preview/. Useful for referencing variations of the
+     * current page.
+     *
+     * Does not include hash or querystring.
+     *
+     * Also see `variationUrl` below.
+     */
+    url: string;
+    /**
+     * Get a URL for the current page with a different extension
+     */
+    variationUrl(extension: string): string;
     protected passError(e: Error, path: string): void;
     constructor(page: PageRecord<DataType>, editMode: boolean, extension: string);
 }

package/dist/component.js

@@ -1,7 +1,6 @@
 import { get, isNotBlank, titleCase } from 'txstate-utils';
 import { ResourceProvider } from './provider.js';
 function defaultWrap(info) { return info.output; }
-const acceptHtmlVariation = { html: true };
 /**
  * This is the primary templating class to build your templates. Subclass it and provide
  * at least a render function.
@@ -71,14 +70,14 @@ export class Component extends ResourceProvider {
      * going to render anything. For instance, if we are rendering an '.ics' variation and this component
      * is not an event, it will not be participating and we'd like to avoid doing the work in the fetch().
      *
-     * This method returns a map of extensions where we SHOULD run fetch(). The default is only run fetch
+     * This method returns true for extensions where we SHOULD run fetch(). The default is only run fetch
      * on 'html'. Components that support other variations should override this method and opt in to more
      * extensions.
      *
-     * The extensions listed should NOT include the preceding dot. In the case of an extended extension like
-     * '.js.map', you should provide 'js.map'.
+     * The extension will NOT include the preceding dot. In the case of an extended extension like
+     * '.js.map', you should receive 'js.map'.
      */
-    variationsToFetch() { return acceptHtmlVariation; }
+    shouldFetchVariation(extension) { return extension === 'html'; }
     /**
      * Inherit components from another page with matching area
      *
@@ -288,6 +287,12 @@ export class Page extends Component {
     get title() {
         return this.pageInfo.data.title ?? titleCase(this.pageInfo.name);
     }
+    /**
+     * Get a URL for the current page with a different extension
+     */
+    variationUrl(extension) {
+        return `${this.url.replace(/\.\w+$/, '')}.${extension}`;
+    }
     passError(e, path) {
         console.warn(`Recoverable issue occured during render of ${this.pageInfo.path}. Component at ${path} threw the following error:`, e);
     }

package/package.json

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