[sitecore-jss] Introduce extra types from Edge schema into models

Sitecore · Aug 21, 2024 · f09a6cd · f09a6cd
1 parent 3e5d77c
commit f09a6cd
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/packages/sitecore-jss/src/layout/content-styles.ts b/packages/sitecore-jss/src/layout/content-styles.ts
@@ -1,6 +1,7 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
 import {
   ComponentRendering,
+  DatasourceField,
   Field,
   HtmlElementRendering,
   Item,
@@ -59,7 +60,10 @@ export const traversePlaceholder = (
   });
 };
 
-export const traverseField = (field: Field | Item | Item[] | undefined, config: Config) => {
+export const traverseField = (
+  field: Field | Item | Item[] | DatasourceField | undefined,
+  config: Config
+) => {
   if (!field || config.loadStyles) return;
 
   if ('editable' in field && field.editable) {

diff --git a/packages/sitecore-jss/src/layout/index.ts b/packages/sitecore-jss/src/layout/index.ts
@@ -16,6 +16,7 @@ export {
   ComponentParams,
   EditMode,
   FieldMetadata,
+  DatasourceField,
 } from './models';
 
 export {

diff --git a/packages/sitecore-jss/src/layout/models.ts b/packages/sitecore-jss/src/layout/models.ts
@@ -76,11 +76,15 @@ export type PlaceholdersData<TYPEDNAME extends string = string> = {
   [P in TYPEDNAME]: Array<ComponentRendering | HtmlElementRendering>;
 };
 
+export interface DatasourceField {
+  datasource: Item;
+}
+
 /**
  * Content field data passed to a component
  */
 export interface ComponentFields {
-  [name: string]: Field | Item | Item[];
+  [name: string]: Field | Item | Item[] | DatasourceField;
 }
 
 /**
@@ -137,7 +141,7 @@ export interface FieldMetadata {
 }
 
 /**
- * Content data returned from Content Service
+ * Content data returned from Layout Service
  */
 export interface Item {
   name: string;
@@ -147,6 +151,12 @@ export interface Item {
   fields: {
     [name: string]: Field | Item | Item[] | undefined;
   };
+  field?: {
+    [name: string]: Field;
+  };
+  children?: {
+    results: Item[];
+  };
 }
 
 /**