@dosgato/templating 0.0.2 → 0.0.5

package/dist/{template.d.ts → apitemplate.d.ts}

@@ -1,16 +1,20 @@
 import { PageWithAncestors, ComponentData } from './component';
 import { LinkDefinition } from './links';
-export declare type TemplateType = 'page' | 'component' | 'data';
+export declare type APITemplateType = 'page' | 'component' | 'data';
 /**
  * This interface lays out the structure the API needs for each template in the system.
  */
-export interface Template {
-    type: TemplateType;
+export interface APITemplate {
+    type: APITemplateType;
     /**
      * A unique string to globally identify this template across installations. Namespacing like
      * 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 Template {
      * 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.d.ts

@@ -1,5 +1,5 @@
+export * from './apitemplate';
 export * from './component';
 export * from './links';
 export * from './page';
 export * from './provider';
-export * from './template';

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];
@@ -10,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./apitemplate"), exports);
 __exportStar(require("./component"), exports);
 __exportStar(require("./links"), exports);
 __exportStar(require("./page"), exports);
 __exportStar(require("./provider"), exports);
-__exportStar(require("./template"), exports);

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/package.json

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