@dosgato/templating 0.0.49 → 0.0.52

package/dist/apitemplate.d.ts

@@ -20,10 +20,10 @@ export interface ValidationFeedback {
 export interface PageExtras {
     /** A function for executing a graphql query to acquire more information than is already at hand. */
     query: GraphQLQueryFn;
-    /** The site id in which the page lives or is being created. */
-    siteId: string;
-    /** The pagetree id in which the page lives or is being created. */
-    pagetreeId: string;
+    /** The site id in which the page lives or is being created. Null if we are validating creation of a site. */
+    siteId?: string;
+    /** The pagetree id in which the page lives or is being created. Null if we are validating creation of a site or pagetree. */
+    pagetreeId?: string;
     /** The page id of the page's parent or parent-to-be. Null if it is the root page of a pagetree. */
     parentId?: string;
     /** The page's id, presumably to be used in graphql queries. NOTE: will be null during page creation. */
@@ -73,13 +73,13 @@ export interface APITemplate {
      * can be indexed. Only fields that are links need to be returned. Links inside rich editor
      * text will be extracted automatically from any text returned by getFulltext (see below)
      */
-    getLinks: LinkGatheringFn;
+    getLinks?: LinkGatheringFn;
     /**
      * Each template must provide the text from any text or rich editor data it possesses, so that
      * the text can be decomposed into words and indexed for fulltext searches. Any text returned
      * by this function will also be scanned for links.
      */
-    getFulltext: FulltextGatheringFn;
+    getFulltext?: FulltextGatheringFn;
 }
 export interface APIComponentTemplate extends APITemplate {
     type: 'component';
@@ -107,25 +107,25 @@ export interface APIComponentTemplate extends APITemplate {
      *
      * See the ComponentExtras type to see all the contextual information you'll have available.
      */
-    validate?: (data: ComponentData, extras: ComponentExtras) => Promise<ValidationFeedback[]>;
+    validate?: <T extends ComponentData>(data: T, extras: ComponentExtras) => Promise<ValidationFeedback[]>;
     /**
      * Each template must provide a list of migrations for upgrading the data schema over time.
      * Typically this will start as an empty array and migrations will be added as the template
      * gets refactored.
      */
-    migrations: ComponentMigration[];
+    migrations?: ComponentMigration[];
 }
 export interface APIPageTemplate extends APITemplate {
     type: 'page';
     /**
      * Page areas are the same as components but are required.
      */
-    areas: Record<string, string[]>;
+    areas?: Record<string, string[]>;
     /**
      * Page template implementations do not receive a path like component templates do.
      */
-    validate?: (data: PageData, extras: PageExtras) => Promise<ValidationFeedback[]>;
-    migrations: PageMigration[];
+    validate?: <T extends PageData>(data: T, extras: PageExtras) => Promise<ValidationFeedback[]>;
+    migrations?: PageMigration[];
     /**
      * 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
@@ -144,8 +144,8 @@ export interface APIDataTemplate extends APITemplate {
      * as well as the folder id (if applicable) and their own id. Keep in mind dataId will be
      * null when it is a creation operation.
      */
-    validate?: (data: ComponentData, extras: DataExtras) => Promise<ValidationFeedback[]>;
-    migrations: DataMigration[];
+    validate?: <T extends DataData>(data: T, extras: DataExtras) => Promise<ValidationFeedback[]>;
+    migrations?: DataMigration[];
 }
 export declare type APIAnyTemplate = APIComponentTemplate | APIPageTemplate | APIDataTemplate;
 /**

package/package.json

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