@dosgato/templating 1.1.1 → 1.1.2

package/dist/apitemplate.d.ts

@@ -17,7 +17,7 @@ export interface ValidationFeedback {
  * do advanced logic when validating or migrating data, e.g. looking up a name in the
  * API to make sure it hasn't been used already.
  */
-export interface PageExtras {
+export interface PageExtras<DataType = PageData> {
     /** 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. Null if we are validating creation of a site. */
@@ -35,14 +35,14 @@ export interface PageExtras {
     /** The name the page has or will have. NOTE: looking the page up by name will not work during page creation. */
     name: string;
     /**
-     * The full page data before the validation/migration in case validating depends on the previous
+     * The full page data before the validation in case validating depends on the previous
      * state of the page.
      *
-     * Will be undefined during page creations, and equal to the data already being passed to a migration.
+     * Will be undefined for page creation or during migration.
      */
-    page?: PageData;
+    page?: DataType;
 }
-export interface ComponentExtras extends PageExtras {
+export interface ComponentExtras<DataType = ComponentData> extends PageExtras {
     /** The path within the page data to the component currently being evaluated. */
     path: string;
     /**
@@ -51,12 +51,11 @@ export interface ComponentExtras extends PageExtras {
      */
     page: PageData;
     /**
-     * The component data before validation. Will be present during migration but equal to the
-     * data already being passed to the migration. Undefined for a new component.
+     * The component data before validation. Undefined for a new component or during migration.
      */
-    currentData?: ComponentData;
+    currentData?: DataType;
 }
-export interface DataExtras {
+export interface DataExtras<DataType = DataData> {
     /** A function for executing a graphql query to acquire more information than is already at hand. */
     query: GraphQLQueryFn;
     /** The id of the dataroot the entry lives in or will be placed in. */
@@ -66,10 +65,9 @@ export interface DataExtras {
     /** The id of the data entry itself. NOTE: will be null during page creation. */
     dataId?: string;
     /**
-     * The data before validation. Will be present during migration but equal to the
-     * data already being passed to the migration. Undefined for a new data entry.
+     * The data before validation. Undefined for a new data entry or during migration.
      */
-    currentData?: DataData;
+    currentData?: DataType;
 }
 /**
  * This interface lays out the structure the API needs for each template in the system.
@@ -177,7 +175,7 @@ export interface APIComponentTemplate<DataType extends ComponentData = any> exte
      *
      * See the ComponentExtras type to see all the contextual information you'll have available.
      */
-    validate?: (data: DataType, extras: ComponentExtras) => Promise<ValidationFeedback[]>;
+    validate?: (data: DataType, extras: ComponentExtras<DataType>) => 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
@@ -194,7 +192,7 @@ export interface APIPageTemplate<DataType extends PageData = any> extends APITem
     /**
      * Page template implementations do not receive a path like component templates do.
      */
-    validate?: (data: DataType, extras: PageExtras) => Promise<ValidationFeedback[]>;
+    validate?: (data: DataType, extras: PageExtras<DataType>) => Promise<ValidationFeedback[]>;
     migrations?: PageMigration<DataType>[];
     /**
      * Hard-coded properties that may be set on page templates to influence the rendering of
@@ -238,7 +236,7 @@ export interface APIDataTemplate<DataType extends DataData = any> extends APITem
      * the conflicting entry is deleted. Editing this data entry again will remove the "-1" because
      * of the lack of conflict.
      */
-    validate?: (data: DataType, extras: DataExtras, nameIsTaken: boolean) => Promise<ValidationFeedback[]>;
+    validate?: (data: DataType, extras: DataExtras<DataType>, nameIsTaken: boolean) => Promise<ValidationFeedback[]>;
     migrations?: DataMigration<DataType>[];
     /**
      * Mark this data type as inappropriate for sites. For example, if you have system-wide configuration

package/package.json

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