refactor: change the type of additionalProperties in TemplateConfig t…

…o 'Record<string, any>'
yext · Jul 22, 2024 · 65a7e9f · 65a7e9f
1 parent 9ba356b
commit 65a7e9f
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/packages/pages/docs/api/pages.templateconfig.additionalproperties.md b/packages/pages/docs/api/pages.templateconfig.additionalproperties.md
@@ -9,5 +9,5 @@ The field to pass additional metadata
 **Signature:**
 
 ```typescript
-additionalProperties?: string;
+additionalProperties?: Record<string, any>;
 ```
diff --git a/packages/pages/docs/api/pages.templateconfig.md b/packages/pages/docs/api/pages.templateconfig.md
@@ -16,7 +16,7 @@ export interface TemplateConfig
 
 | Property                                                                      | Modifiers | Type                        | Description                                                                                                  |
 | ----------------------------------------------------------------------------- | --------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ |
-| [additionalProperties?](./pages.templateconfig.additionalproperties.md)       |           | string                      | _(Optional)_ The field to pass additional metadata                                                           |
+| [additionalProperties?](./pages.templateconfig.additionalproperties.md)       |           | Record<string, any>         | _(Optional)_ The field to pass additional metadata                                                           |
 | [alternateLanguageFields?](./pages.templateconfig.alternatelanguagefields.md) |           | string\[\]                  | _(Optional)_ The specific fields to add additional language options to based on the stream's localization    |
 | [hydrate?](./pages.templateconfig.hydrate.md)                                 |           | boolean                     | _(Optional)_ Determines if hydration is allowed or not for webpages                                          |
 | [name?](./pages.templateconfig.name.md)                                       |           | string                      | _(Optional)_ The name of the template feature. If not defined uses the template filename (without extension) |

diff --git a/packages/pages/etc/pages.api.md b/packages/pages/etc/pages.api.md
@@ -329,7 +329,7 @@ export type Template<T extends TemplateRenderProps> = (
 
 // @public
 export interface TemplateConfig {
-  additionalProperties?: string;
+  additionalProperties?: Record<string, any>;
   alternateLanguageFields?: string[];
   hydrate?: boolean;
   name?: string;

diff --git a/packages/pages/src/common/src/feature/features.ts b/packages/pages/src/common/src/feature/features.ts
@@ -34,7 +34,7 @@ interface FeatureConfigBase {
   /** @deprecated field will be unsupported in the future */
   alternateLanguageFields?: string[];
   onUrlChange?: PluginFunctionSelector;
-  additionalProperties?: string;
+  additionalProperties?: Record<string, any>;
 }
 
 interface EntityPageSetConfig extends FeatureConfigBase {

diff --git a/packages/pages/src/common/src/template/internal/types.ts b/packages/pages/src/common/src/template/internal/types.ts
@@ -76,7 +76,7 @@ export interface TemplateConfigInternal {
   /** The field to use as the slug for dynamic dev mode */
   slugField?: string;
   /** The field to pass additional metadata */
-  additionalProperties?: string;
+  additionalProperties?: Record<string, any>;
   /** The type of template */
   templateType: "entity" | "static";
 }

diff --git a/packages/pages/src/common/src/template/types.ts b/packages/pages/src/common/src/template/types.ts
@@ -118,7 +118,7 @@ export interface TemplateConfig {
   /** The field to use as the slug for dynamic dev mode */
   slugField?: string;
   /** The field to pass additional metadata */
-  additionalProperties?: string;
+  additionalProperties?: Record<string, any>;
 }
 
 /**