@dosgato/templating 0.0.24 → 0.0.27

package/dist/apitemplate.d.ts

@@ -1,6 +1,16 @@
-import { PageRecord, ComponentData } from './component.js';
+import { PageRecord, ComponentData, PageData } from './component.js';
 import { LinkDefinition } from './links.js';
 export declare type APITemplateType = 'page' | 'component' | 'data';
+export declare enum ValidationMessageType {
+    ERROR = "error",
+    WARNING = "warning",
+    SUCCESS = "success"
+}
+export interface ValidationFeedback {
+    type: `${ValidationMessageType}`;
+    path?: string;
+    message: string;
+}
 /**
  * This interface lays out the structure the API needs for each template in the system.
  */
@@ -41,17 +51,22 @@ export interface APITemplate {
     getFulltext: FulltextGatheringFn;
     /**
      * Each template must provide a validation function so that the API can enforce its data is
-     * shaped properly. If there are no issues, it should return an empty object {}, otherwise it
-     * should return an object with keys that reference the path to the error and values that
-     * are an array of error messages pertaining to that path.
+     * shaped properly.
+     *
+     * Each entry in the return array can have a type of error, warning, or success. Errors
+     * represent a validation failure and mean that saving will not succeed. Warnings are shown
+     * to the editor but do not prevent saving. Success messages postively affirm valid input - for
+     * instance, a name they chose is available.
      *
-     * For instance, if name is required and the user didn't provide one, you would return:
-     * { name: ['A name is required.'] }
+     * As an example, if name is required and the user didn't provide one, you would return:
+     * [{ type: 'error', path: 'name', message: 'A name is required.' }]
      *
      * This method is async so that you can do things like look in the database for conflicting
-     * names.
+     * names. The full page data, the path to this component, and a GraphQL query executor are
+     * available as parameters in case you need them. Keep in mind that the current editor MUST
+     * have access to any data you attempt to query in GraphQL.
      */
-    validate: (data: any) => Promise<Record<string, string[]>>;
+    validate?: (data: ComponentData, query: <T>(query: string, variables?: any) => Promise<T>, page: PageData, path: string) => Promise<ValidationFeedback[]>;
     /**
      * 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

package/dist/apitemplate.js

@@ -1,4 +1,10 @@
 import { stopwords } from './stopwords.js';
+export var ValidationMessageType;
+(function (ValidationMessageType) {
+    ValidationMessageType["ERROR"] = "error";
+    ValidationMessageType["WARNING"] = "warning";
+    ValidationMessageType["SUCCESS"] = "success";
+})(ValidationMessageType || (ValidationMessageType = {}));
 /**
  * This function is used by API template definitions to help them identify links inside large blocks
  * of text and return them for indexing.

package/package.json

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