feat: add home location [EXT-3684] (#1322)

* feat: add home location api * chore: add explicit tests for shape of home and page apis * Update lib/types/api.types.ts Co-authored-by: Andi Pätzold <[email protected]> * fix: export HomeExtensionSDK type Co-authored-by: Andi Pätzold <[email protected]>
contentful · Aug 10, 2022 · 527ad19 · 527ad19
1 parent cd5de88
commit 527ad19
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 0 deletions.
diff --git a/lib/api.ts b/lib/api.ts
@@ -39,6 +39,7 @@ const LOCATION_TO_API_PRODUCERS: { [location: string]: ProducerFunc[] } = {
   [locations.LOCATION_ENTRY_EDITOR]: [makeSharedAPI, makeEntryAPI, makeEditorAPI],
   [locations.LOCATION_DIALOG]: [makeSharedAPI, makeDialogAPI, makeWindowAPI],
   [locations.LOCATION_PAGE]: [makeSharedAPI],
+  [locations.LOCATION_HOME]: [makeSharedAPI],
   [locations.LOCATION_APP_CONFIG]: [makeSharedAPI, makeAppAPI],
 }
 

diff --git a/lib/locations.ts b/lib/locations.ts
@@ -8,6 +8,7 @@ const locations: Locations = {
   LOCATION_ENTRY_EDITOR: 'entry-editor',
   LOCATION_PAGE: 'page',
   LOCATION_APP_CONFIG: 'app-config',
+  LOCATION_HOME: 'home',
 }
 
 export default locations
diff --git a/lib/types/api.types.ts b/lib/types/api.types.ts
@@ -232,6 +232,10 @@ export type PageExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
   ids: Omit<IdsAPI, EntryScopedIds>
 }
 
+export type HomeExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
+  ids: Omit<IdsAPI, EntryScopedIds>
+}
+
 export type AppExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
   /** A set of IDs actual for the app */
   ids: Omit<IdsAPI, EntryScopedIds | 'extension' | 'app'> & { app: string }
@@ -245,6 +249,7 @@ export type KnownSDK =
   | EditorExtensionSDK
   | PageExtensionSDK
   | AppExtensionSDK
+  | HomeExtensionSDK
 
 export interface Locations {
   LOCATION_ENTRY_FIELD: 'entry-field'
@@ -253,6 +258,7 @@ export interface Locations {
   LOCATION_DIALOG: 'dialog'
   LOCATION_ENTRY_EDITOR: 'entry-editor'
   LOCATION_PAGE: 'page'
+  LOCATION_HOME: 'home'
   LOCATION_APP_CONFIG: 'app-config'
 }
 

diff --git a/lib/types/index.ts b/lib/types/index.ts
@@ -10,6 +10,7 @@ export type {
   EditorExtensionSDK,
   EditorLocaleSettings,
   FieldExtensionSDK,
+  HomeExtensionSDK,
   IdsAPI,
   KnownSDK,
   LocalesAPI,

diff --git a/test/unit/api.spec.ts b/test/unit/api.spec.ts
@@ -110,6 +110,18 @@ describe('createAPI()', () => {
     test(expected, locations.LOCATION_DIALOG)
   })
 
+  it('returns correct shape of the home API (home)', () => {
+    const expected = []
+
+    test(expected, locations.LOCATION_HOME)
+  })
+
+  it('returns correct shape of the page API (page)', () => {
+    const expected = []
+
+    test(expected, locations.LOCATION_PAGE)
+  })
+
   it('returns correct shape of the app API (app)', () => {
     const expected = ['app']