feat: hostnames API (#1633)

* feat: add hostnames API * test: update shared api test * fix: cdn -> cda * refactor: tweak property names * refactor: tweak property names
contentful · Aug 25, 2023 · e776ce4 · e776ce4
1 parent fe3c043
commit e776ce4
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 1 deletion.
diff --git a/lib/api.ts b/lib/api.ts
@@ -61,7 +61,7 @@ function makeSharedAPI(
   channel: Channel,
   data: ConnectMessage
 ): BaseAppSDK<KeyValueMap, KeyValueMap, never> {
-  const { user, parameters, locales, ids, initialContentTypes } = data
+  const { user, parameters, locales, ids, initialContentTypes, hostnames } = data
   const currentLocation = data.location || locations.LOCATION_ENTRY_FIELD
 
   return {
@@ -90,6 +90,7 @@ function makeSharedAPI(
       warning: (message: string) => channel.send('notify', { type: 'warning', message }),
     },
     ids,
+    hostnames,
     access: {
       can: (action: string, entity: any, patch?: JSONPatchItem[]) =>
         channel.call('checkAccess', action, entity, patch) as Promise<boolean>,

diff --git a/lib/types/api.types.ts b/lib/types/api.types.ts
@@ -104,6 +104,22 @@ export interface IdsAPI {
   contentType: string
 }
 
+/** Hostnames */
+export interface HostnamesAPI {
+  /** Hostname of the Content Delivery API */
+  delivery: string
+  /** Hostname of the Content Management API */
+  management: string
+  /** Hostname of the Preview API */
+  preview: string
+  /** Hostname of the Upload API */
+  upload: string
+  /** Hostname of the GraphQL API */
+  graphql: string
+  /** Hostname of the Web App */
+  webapp: string
+}
+
 /** Content API */
 export interface ContentTypeAPI {
   sys: {
@@ -243,6 +259,8 @@ export interface BaseAppSDK<
   access: AccessAPI
   /** Exposes relevant ids, keys may be ommited based on location */
   ids: Omit<IdsAPI, EntryScopedIds>
+  /** Exposes hostnames to interact with Contentful's API or to link to the web app */
+  hostnames: HostnamesAPI
   /** Adapter to be injected in contentful-management client */
   cmaAdapter: Adapter
   /** A CMA Client initialized with default params */
@@ -389,4 +407,5 @@ export interface ConnectMessage {
   }
   fieldInfo: EntryFieldInfo[]
   field?: FieldInfo
+  hostnames: HostnamesAPI
 }
diff --git a/lib/types/index.ts b/lib/types/index.ts
@@ -33,6 +33,7 @@ export type {
   SharedEditorSDK,
   UserAPI,
   JSONPatchItem,
+  HostnamesAPI,
 } from './api.types'
 
 export type {

diff --git a/test/unit/api.spec.ts b/test/unit/api.spec.ts
@@ -16,6 +16,7 @@ const sharedExpected = [
   'ids',
   'access',
   'cmaAdapter',
+  'hostnames',
   'cma',
 ]