@dosgato/templating 0.0.3 → 0.0.6

package/dist/apitemplate.d.ts

@@ -11,6 +11,10 @@ export interface APITemplate {
      * edu.txstate.RichTextEditor could be useful but no special format is required.
      */
     templateKey: string;
+    /**
+     * A uniquey human-readable name describing this template
+     */
+    name: string;
     /**
      * Each template must declare its areas and the template keys of components that will be
      * permitted inside each area. The list of allowed component templates can be updated beyond
@@ -48,6 +52,16 @@ export interface APITemplate {
      * names.
      */
     validate: (data: any) => Promise<Record<string, string[]>>;
+    /**
+     * Hard-coded properties that may be set on page templates to influence the rendering of
+     * components on the page. For instance, a set of color choices that are customized for
+     * each template design. Components on the page may refer to the color information stored
+     * in the template during dialogs and while rendering. Changing to a different page template
+     * could then result in different color choices for components like buttons.
+     *
+     * Must be null for non-page templates.
+     */
+    templateProperties?: any;
 }
 /**
  * In dosgato CMS, the data in the database is not altered except during user activity. This

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/links.d.ts

@@ -18,6 +18,7 @@ export interface AssetLink {
  */
 export interface AssetFolderLink {
     type: 'assetfolder';
+    source: string;
     id: string;
     siteId: string;
     path: string;

package/dist/provider.d.ts

@@ -1,3 +1,20 @@
+export interface CSSBlock {
+    css?: string;
+    path?: string;
+    version?: string;
+    defer?: boolean;
+}
+export interface JSBlock {
+    js?: string;
+    path?: string;
+    version?: string;
+    defer?: boolean;
+}
+export interface FileDeclaration {
+    path: string;
+    version?: string;
+    mime: string;
+}
 /**
  * This class is a parent class for Component, but it can also be used as a standalone
  * if you are creating a set of templates with shared resources. This will be fairly
@@ -20,22 +37,23 @@ export declare abstract class ResourceProvider {
      * version number of any given name will be used. Other versions of that name will be ignored.
      *
      * For convenience you can either provide the `css` property with the CSS as a string, or the
-     * `path` property with the full server path to a CSS file (node's __dirname function will
+     * `path` property with the full server path (NOT URL) to a CSS file (node's __dirname function will
      * help you determine it). You MUST provide one or the other.
+     *
+     * You may also set `defer` to true if a css block is not needed for the initial render of
+     * the page. For instance, if your component has a modal that the user can trigger, you can
+     * defer the CSS for that modal since it will not be needed until the page has gone interactive
+     * and the user has clicked something.
      */
-    static cssBlocks: Map<string, {
-        css?: string;
-        path?: string;
-        version?: string;
-    }>;
+    static cssBlocks: Map<string, CSSBlock>;
     /**
      * Same as cssBlocks() but for javascript.
+     *
+     * In this case `defer` is much more useful, as most javascript is interactive and could run
+     * after the page renders. Any code that adds event observers or the like should be marked with
+     * defer to improve the initial render time.
      */
-    static jsBlocks: Map<string, {
-        js?: string;
-        path?: string;
-        version?: string;
-    }>;
+    static jsBlocks: Map<string, JSBlock>;
     /**
      * If your template needs to serve any files, like fonts or images, you can provide
      * a filesystem path in this static property and the files will be served by the rendering
@@ -58,11 +76,7 @@ export declare abstract class ResourceProvider {
      * DO NOT change the mime type without changing the name. Other templates could end up with
      * the wrong file extension.
      */
-    static files: Map<string, {
-        path: string;
-        version?: string;
-        mime: string;
-    }>;
+    static files: Map<string, FileDeclaration>;
     /**
      * Template code will need to generate HTML and CSS that points at the static files
      * provided above. In order to do so, we need information from the template registry (since

package/dist/provider.js

@@ -27,12 +27,21 @@ exports.ResourceProvider = ResourceProvider;
  * version number of any given name will be used. Other versions of that name will be ignored.
  *
  * For convenience you can either provide the `css` property with the CSS as a string, or the
- * `path` property with the full server path to a CSS file (node's __dirname function will
+ * `path` property with the full server path (NOT URL) to a CSS file (node's __dirname function will
  * help you determine it). You MUST provide one or the other.
+ *
+ * You may also set `defer` to true if a css block is not needed for the initial render of
+ * the page. For instance, if your component has a modal that the user can trigger, you can
+ * defer the CSS for that modal since it will not be needed until the page has gone interactive
+ * and the user has clicked something.
  */
 ResourceProvider.cssBlocks = new Map();
 /**
  * Same as cssBlocks() but for javascript.
+ *
+ * In this case `defer` is much more useful, as most javascript is interactive and could run
+ * after the page renders. Any code that adds event observers or the like should be marked with
+ * defer to improve the initial render time.
  */
 ResourceProvider.jsBlocks = new Map();
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "A library to support building templates for dosgato CMS.",
   "exports": {
     "require": "./dist/index.js",