DeliveryClient
One method per endpoint of /content/delivery/v1, nothing opinionated — see createContentClient for the layer above.
Properties
Section titled “Properties”baseUrl
Section titled “baseUrl”
readonlybaseUrl:string
sandbox
Section titled “sandbox”
readonlysandbox:SandboxMode|null
The sandbox mode the most recent response reported, or null. A sandbox organization’s responses say so (X-Ebitex-Sandbox); a page you build from one should carry noindex — see
sandboxRobots. Reflects the last response this client read from the network, so a call answered from a cache you hold yourself does not refresh it.
Methods
Section titled “Methods”getBlob()
Section titled “getBlob()”getBlob(
blobId,options?):Promise<Response>
Raw bytes of a published-referenced blob — the server-side fallback for an SSR/build step
that already holds the key. A browser should use a Blob value’s own public url instead.
Parameters
Section titled “Parameters”blobId
Section titled “blobId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Response>
getComponent()
Section titled “getComponent()”getComponent(
provider,key,options?):Promise<ExpandedReference<ContentDocument>>
Parameters
Section titled “Parameters”provider
Section titled “provider”string
string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<ExpandedReference<ContentDocument>>
getSchemaBundle()
Section titled “getSchemaBundle()”getSchemaBundle(
options?):Promise<SchemaBundle>
Every Contract’s delivered-shape JSON Schema, self-contained — see cli/codegen.ts for the typed-consumer story built on this.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<SchemaBundle>
getSitemap()
Section titled “getSitemap()”getSitemap(
options?):Promise<SitemapResult>
The data a sitemap is built from — GET /sitemap. Pair it with buildSitemapXml from
@ebitex/content-sdk/sitemap; serving the result at a URL is yours.
Parameters
Section titled “Parameters”options?
Section titled “options?”SitemapOptions
Returns
Section titled “Returns”Promise<SitemapResult>
getStreamFacet()
Section titled “getStreamFacet()”getStreamFacet(
stream,field,options?):Promise<StreamFacetResult>
{value, label, count} triples for one of the stream’s own declared filters — GET /streams/{stream}/facets. Every declared filter kind except fullText is facetable.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<StreamFacetResult>
listAudiences()
Section titled “listAudiences()”listAudiences(
options?):Promise<string[]>
The ids of the audiences published content names — GET /audiences. Ask Audience about these and no others.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string[]>
listComponents()
Section titled “listComponents()”listComponents(
options):Promise<ComponentPage>
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<ComponentPage>
listLocales()
Section titled “listLocales()”listLocales(
options?):Promise<LocaleTreeNode[]>
Parameters
Section titled “Parameters”options?
Section titled “options?”LocalesOptions
Returns
Section titled “Returns”Promise<LocaleTreeNode[]>
listNodes()
Section titled “listNodes()”listNodes(
options?):Promise<NavigationResult>
The published Experience tree, for navigation — GET /nodes.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<NavigationResult>
listSites()
Section titled “listSites()”listSites(
options?):Promise<SiteSummary[]>
Parameters
Section titled “Parameters”options?
Section titled “options?”SitesAndLocalesOptions
Returns
Section titled “Returns”Promise<SiteSummary[]>
queryStream()
Section titled “queryStream()”queryStream(
stream,options?):Promise<StreamPage>
One page of an authored stream — GET /streams/{stream}; stream is the external id (or Guid).
Parameters
Section titled “Parameters”stream
Section titled “stream”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<StreamPage>
resolvePath()
Section titled “resolvePath()”resolvePath(
path,options?):Promise<PathResult>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<PathResult>