@dosgato/templating 0.0.106 → 0.0.108

package/dist/apitemplate.d.ts

@@ -1,6 +1,6 @@
 import { ComponentData, DataData, PageData } from './component.js';
 import { LinkDefinition } from './links.js';
-export declare type APITemplateType = 'page' | 'component' | 'data';
+export type APITemplateType = 'page' | 'component' | 'data';
 export declare enum ValidationMessageType {
     ERROR = "error",
     WARNING = "warning",
@@ -147,7 +147,7 @@ export interface APIDataTemplate<DataType extends DataData = any> extends APITem
     validate?: (data: DataType, extras: DataExtras) => Promise<ValidationFeedback[]>;
     migrations?: DataMigration<DataType>[];
 }
-export declare type APIAnyTemplate = APIComponentTemplate | APIPageTemplate | APIDataTemplate;
+export type APIAnyTemplate = APIComponentTemplate | APIPageTemplate | APIDataTemplate;
 /**
  * In dosgato CMS, the data in the database is not altered except during user activity. This
  * means that older records could have been saved when the schema expected by component
@@ -181,13 +181,13 @@ export interface Migration<DataType, ExtraType> {
     up: (data: DataType, extras: ExtraType) => DataType | Promise<DataType>;
     down: (data: DataType, extras: ExtraType) => DataType | Promise<DataType>;
 }
-export declare type ComponentMigration<DataType extends ComponentData = ComponentData> = Migration<DataType, ComponentExtras>;
-export declare type PageMigration<DataType extends PageData = PageData> = Migration<DataType, PageExtras>;
-export declare type DataMigration<DataType extends DataData = DataData> = Migration<DataType, DataExtras>;
-export declare type AnyMigration = ComponentMigration | PageMigration | DataMigration;
-export declare type LinkGatheringFn<DataType> = (data: DataType) => (LinkDefinition | string | undefined)[];
-export declare type FulltextGatheringFn<DataType> = (data: DataType) => (string | undefined)[];
-export declare type GraphQLQueryFn = <T>(query: string, variables?: any) => Promise<T>;
+export type ComponentMigration<DataType extends ComponentData = ComponentData> = Migration<DataType, ComponentExtras>;
+export type PageMigration<DataType extends PageData = PageData> = Migration<DataType, PageExtras>;
+export type DataMigration<DataType extends DataData = DataData> = Migration<DataType, DataExtras>;
+export type AnyMigration = ComponentMigration | PageMigration | DataMigration;
+export type LinkGatheringFn<DataType> = (data: DataType) => (LinkDefinition | string | undefined)[];
+export type FulltextGatheringFn<DataType> = (data: DataType) => (string | undefined)[];
+export type GraphQLQueryFn = <T>(query: string, variables?: any) => Promise<T>;
 /**
  * This function is used by API template definitions to help them identify all the searchable
  * words in a large block of text and return them for indexing.

package/dist/component.js

@@ -9,33 +9,6 @@ function defaultWrap(info) { return info.output; }
  * parent and child components linked.
  */
 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, editMode, extension) {
-        super();
-        /**
-         * Override with `true` to indicate that this template never accepts data from editors
-         *
-         * Its edit bar will not have a pencil icon.
-         */
-        this.noData = false;
-        // Properties provided during the rendering process. 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(); // a Map of area names and the array of hydrated components in each
-        this.editMode = editMode;
-        this.extension = extension;
-        this.parent = parent;
-        const { areas, ...ownData } = data;
-        this.data = ownData;
-        this.path = path;
-        this.hadError = false;
-        let tmpParent = this.parent ?? this;
-        while (!(tmpParent instanceof Page) && tmpParent.parent)
-            tmpParent = tmpParent.parent;
-        if (!(tmpParent instanceof Page))
-            throw new Error('Hydration failed, could not map component back to its page.');
-        this.page = tmpParent;
-    }
     /**
      * The first phase of rendering a component is the fetch phase. Each component may
      * provide a fetch method that looks up data it needs from external sources. This step
@@ -259,6 +232,33 @@ export class Component extends ResourceProvider {
         options.editMode ?? (options.editMode = this.editMode);
         return Component.newBar([this.path, 'areas', areaName].filter(isNotBlank).join('.'), options);
     }
+    // the constructor is part of the recursive hydration mechanism: constructing
+    // a Component will also construct/hydrate all its child components
+    constructor(data, path, parent, editMode, extension) {
+        super();
+        /**
+         * Override with `true` to indicate that this template never accepts data from editors
+         *
+         * Its edit bar will not have a pencil icon.
+         */
+        this.noData = false;
+        // Properties provided during the rendering process. 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(); // a Map of area names and the array of hydrated components in each
+        this.editMode = editMode;
+        this.extension = extension;
+        this.parent = parent;
+        const { areas, ...ownData } = data;
+        this.data = ownData;
+        this.path = path;
+        this.hadError = false;
+        let tmpParent = this.parent ?? this;
+        while (!(tmpParent instanceof Page) && tmpParent.parent)
+            tmpParent = tmpParent.parent;
+        if (!(tmpParent instanceof Page))
+            throw new Error('Hydration failed, could not map component back to its page.');
+        this.page = tmpParent;
+    }
     /**
      * 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
@@ -274,11 +274,6 @@ export class Component extends ResourceProvider {
     }
 }
 export class Page extends Component {
-    constructor(page, editMode, extension) {
-        super(page.data, '', undefined, editMode, extension);
-        this.id = page.id;
-        this.pageInfo = page;
-    }
     /**
      * A convenience to get the page title.
      *
@@ -296,4 +291,9 @@ export class Page extends Component {
     passError(e, path) {
         console.warn(`Recoverable issue occured during render of ${this.pageInfo.path}. Component at ${path} threw the following error:`, e);
     }
+    constructor(page, editMode, extension) {
+        super(page.data, '', undefined, editMode, extension);
+        this.id = page.id;
+        this.pageInfo = page;
+    }
 }

package/dist/links.d.ts

@@ -75,7 +75,7 @@ export interface DataFolderLink {
     siteId?: string;
     path: string;
 }
-export declare type LinkDefinition = AssetLink | AssetFolderLink | PageLink | WebLink | DataLink | DataFolderLink;
+export type LinkDefinition = AssetLink | AssetFolderLink | PageLink | WebLink | DataLink | DataFolderLink;
 /**
  * This function is used by template definitions to help them identify links inside large blocks
  * of text and return them for indexing, and by render definitions to help replace them with the actual URLs

package/dist/render.d.ts

@@ -37,6 +37,7 @@ export interface PageForNavigation {
     title: string;
     path: string;
     href: string;
+    publishedAt?: Date;
     extra: Record<string, any>;
     children: this[];
 }
@@ -147,6 +148,16 @@ export interface APIClient {
          * you the root page and one level of subpages, etc.
          */
         depth?: number;
+        /**
+         * Only return pages that are published. Setting this to true will ensure that the
+         * page will appear the same in editing and preview views as it does in published
+         * and live views.
+         *
+         * By default it is false, which means that in editing/preview context it shows
+         * all pages, published and unpublished, but in published/live context it only shows
+         * other published pages.
+         */
+        published?: boolean;
         /**
          * Get extra data from the page data
          *

package/dist/uitemplate.d.ts

@@ -38,6 +38,20 @@ export interface UITemplate {
      * requests to the API.
      */
     dialog?: new (...args: any[]) => any;
+    /**
+     * Sometimes it's useful for a component to have a stable but random identifier for use
+     * during render. For instance, to set the id on an HTML element for reference by other
+     * components or code.
+     *
+     * If your component has a dialog, dosgato-dialog has a <FieldIdentifier> component for this;
+     * it's invisible but either creates or maintains a random string.
+     *
+     * If your component has no dialog but still needs an identifier, you can name a property
+     * here and dosgato-admin will generate one for you upon creation.
+     *
+     * For example, `randomId: 'id'` means your component data will look like `{ id: 'cym87regpk' }`
+     */
+    randomId?: string;
     /**
      * Sometimes when you create a component that has areas, you want to automatically fill
      * one or more areas with some default introductory content.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.106",
+  "version": "0.0.108",
   "description": "A library to support building templates for dosgato CMS.",
   "type": "module",
   "exports": {
@@ -18,7 +18,7 @@
   },
   "devDependencies": {
     "@types/node": "^18.7.11",
-    "eslint-config-standard-with-typescript": "^23.0.0",
+    "eslint-config-standard-with-typescript": "^26.0.0",
     "typescript": "^4.4.2"
   },
   "repository": {