@dosgato/templating 0.0.64 → 0.0.65

package/dist/component.d.ts

@@ -127,8 +127,8 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
         hideMaxWarning?: boolean;
         maxWarning?: string;
         hideInheritBars?: boolean;
-        newBarOpts: NewBarOpts;
-        editBarOpts: RenderAreaEditBarOpts;
+        newBarOpts?: NewBarOpts;
+        editBarOpts?: RenderAreaEditBarOpts;
     }): string;
     /**
      * During rendering, each component should determine the CSS blocks that it needs. This may
@@ -158,6 +158,12 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * CSS class
      */
     editClass(): string | undefined;
+    /**
+     * Override with `true` to indicate that this template never accepts data from editors
+     *
+     * Its edit bar will not have a pencil icon.
+     */
+    noData: boolean;
     /**
      * Components may override this function to give their new bars a custom
      * label
@@ -224,6 +230,7 @@ export interface PageRecord<DataType extends PageData = PageData> {
     linkId: string;
     createdAt: Date;
     modifiedAt: Date;
+    publishedAt: Date;
     path: string;
     data: DataType;
     site: SiteInfo;
@@ -262,6 +269,7 @@ interface BarOpts {
 export interface EditBarOpts extends BarOpts {
     inheritedFrom?: string;
     disableDelete?: boolean;
+    hideEdit?: boolean;
 }
 export interface RenderAreaEditBarOpts extends Omit<Omit<EditBarOpts, 'label'>, 'extraClass'> {
     label?: string | ((c: Component) => string);

package/dist/component.js

@@ -12,6 +12,12 @@ export class Component extends ResourceProvider {
     // a Component will also construct/hydrate all its child components
     constructor(data, path, parent, editMode) {
         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
@@ -171,6 +177,7 @@ export class Component extends ResourceProvider {
         options.extraClass ?? (options.extraClass = this.editClass());
         options.editMode ?? (options.editMode = this.editMode);
         options.inheritedFrom ?? (options.inheritedFrom = this.inheritedFrom);
+        options.hideEdit = this.noData || options.hideEdit;
         return Component.editBar(this.path, options);
     }
     /**

package/dist/uitemplate.d.ts

@@ -1,3 +1,4 @@
+import { ComponentData } from './component';
 export interface SvelteComponent {
     $set: (props?: Record<string, any>) => void;
     $on: (event: string, callback: (event: any) => void) => () => void;
@@ -19,8 +20,43 @@ export interface IconOrSVG extends IconifyIcon {
 }
 export interface UITemplate {
     templateKey: string;
-    dialog: SvelteComponent;
+    /**
+     * A svelte component that expects to be inside a @dosgato/dialog Form component
+     *
+     * This dialog will be how editors interact with your component and edit its data. If you
+     * do not provide a dialog, it will be assumed that this template has no data and it will be
+     * inserted into the page without further user interaction.
+     *
+     * Several props are delivered to the svelte component that may be important for you:
+     *
+     * - creating: boolean, true when creating component for the first time, false when editing
+     * - data: ComponentData, the current data on the page, should not be mutated during editing,
+     *   undefined when creating
+     * - templateProperties: the template properties for the current page template, so you can make
+     *   things like color pickers that visually match the colors of the current page template
+     * - environmentConfig: base URLs in case you need to generate a link to the API or something
+     */
+    dialog?: SvelteComponent;
+    /**
+     * Sometimes when you create a component that has areas, you want to automatically fill
+     * one or more areas with some default introductory content.
+     *
+     * You can place that introductory content here and it will be automatically placed into
+     * components with this template upon creation (and never again).
+     */
+    defaultContent?: Record<string, ComponentData[]>;
+    /**
+     * if present this SVG will be used when presenting users with
+     * an array of choices of templates to create. Ideally it should look
+     * a lot like the template will look on a webpage. It will be presented
+     * about 1-2 inches wide
+     */
     preview?: IconOrSVG;
+    /**
+     * if present this icon will be used to represent the template in various
+     * UI contexts. It will be presented about 3mm wide. Falls back to the
+     * preview image.
+     */
     icon?: IconOrSVG;
 }
 export {};

package/package.json

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