@dosgato/templating 0.0.58 → 0.0.60

package/dist/component.d.ts

@@ -193,11 +193,21 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
     logError(e: Error): void;
     protected passError(e: Error, path: string): void;
 }
+export interface SiteInfo {
+    id: string;
+    name: string;
+    launched: boolean;
+    url?: {
+        prefix: string;
+        path: string;
+    };
+}
 export interface PageRecord<DataType extends PageData = PageData> {
     id: string;
     linkId: string;
     path: string;
     data: DataType;
+    site: SiteInfo;
 }
 export interface ComponentData {
     templateKey: string;
@@ -233,7 +243,15 @@ export interface RenderedComponent<C extends Component = Component> {
     output: string;
 }
 export declare abstract class Page<DataType extends PageData = any, FetchedType = any, RenderContextType extends ContextBase = any> extends Component<DataType, FetchedType, RenderContextType> {
-    pagePath: string;
+    /**
+     * The page id in case you need to pass it to the API, e.g. this.api.getRootPage(this.id)
+     * in a page template or this.api.getRootPage(this.page.id) in a component template.
+     */
+    id: string;
+    /**
+     * Other data we've already collected about the page being rendered, in case it's needed.
+     */
+    pageInfo: PageRecord<DataType>;
     /**
      * This will be filled by the rendering server. The template properties are described
      * over in apitemplate.ts in the comment for APIPageTemplate.templateProperties.

package/dist/component.js

@@ -175,9 +175,10 @@ export class Component extends ResourceProvider {
 export class Page extends Component {
     constructor(page, editMode) {
         super(page.data, '', undefined, editMode);
-        this.pagePath = page.path;
+        this.id = page.id;
+        this.pageInfo = page;
     }
     passError(e, path) {
-        console.warn(`Recoverable issue occured during render of ${this.pagePath}. Component at ${path} threw the following error:`, e);
+        console.warn(`Recoverable issue occured during render of ${this.pageInfo.path}. Component at ${path} threw the following error:`, e);
     }
 }

package/dist/provider.d.ts

@@ -5,6 +5,10 @@ export interface CSSBlock {
     css?: string;
     /**
      * A file path to the CSS. The rendering server will read the file on startup.
+     *
+     * Typically you will set this with import.meta.url so that the path will be relative
+     * to the javascript code where you are writing your template class:
+     * path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../static/mystyles.css')
      */
     path?: string;
     /**
@@ -35,6 +39,11 @@ export interface JSBlock {
     js?: string;
     /**
      * A file path to the javascript. The rendering server will read the file on startup.
+     *
+     * Typically you will set this with import.meta.url so that the path will be relative
+     * to the javascript code where you are writing your template class:
+     * path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../static/myscript.js')
+  
      */
     path?: string;
     /**
@@ -60,6 +69,10 @@ export interface JSBlock {
 export interface FileDeclaration {
     /**
      * The path to the file.
+     *
+     * Typically you will set this with import.meta.url so that the path will be relative
+     * to the javascript code where you are writing your template class:
+     * path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../static/myfont.ttf')
      */
     path: string;
     /**
@@ -154,9 +167,6 @@ export declare abstract class ResourceProvider {
      * server. Use the provided `webpaths` map to obtain the proper resource URLs. They will be
      * available as soon as your template has been registered to the rendering server's templateRegistry.
      *
-     * Typically you will set this to something like `${__dirname}/static` so that the path will be relative
-     * to where you are writing your template class.
-     *
      * The map name you pick should be globally unique and only collide with other templates as
      * intended. For instance, the fontawesome font only needs to be provided once, even though
      * several templates might depend on it. Setting the name as 'fontawesome5' on all three

package/dist/provider.js

@@ -59,9 +59,6 @@ ResourceProvider.jsBlocks = new Map();
  * server. Use the provided `webpaths` map to obtain the proper resource URLs. They will be
  * available as soon as your template has been registered to the rendering server's templateRegistry.
  *
- * Typically you will set this to something like `${__dirname}/static` so that the path will be relative
- * to where you are writing your template class.
- *
  * The map name you pick should be globally unique and only collide with other templates as
  * intended. For instance, the fontawesome font only needs to be provided once, even though
  * several templates might depend on it. Setting the name as 'fontawesome5' on all three

package/dist/render.d.ts

@@ -50,6 +50,17 @@ export interface APIClient {
         absolute?: boolean;
         extension?: string;
     }) => Promise<string>;
+    /**
+     * Get a link href for a page
+     *
+     * By default this will generate relative links based on the page currently being rendered. Set
+     * absolute: true to generate a full URL suitable for a backend http request or non-HTML document
+     * like an RSS feed.
+     */
+    getHref: (page: PageRecord, opts?: {
+        absolute?: boolean;
+        extension?: string;
+    }) => string;
     /**
      * This function will be provided by the rendering server and should be used inside your fetch
      * method to prepare editor-provided HTML for rendering. It will do things like find and resolve

package/package.json

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