AEM Headless Client for JavaScript

See aem-headless-client-java for the Java variant of this client
and aem-headless-client-nodejs for the server-side Node.js variant.

Installation

``bash
$ npm install @adobe/aem-headless-client-js
`

Usage

$3

`javascript
const AEMHeadless = require('@adobe/aem-headless-client-js');
`
Configure SDK with Host and Auth data (if needed)
`javascript
const aemHeadlessClient = new AEMHeadless({
serviceURL: '',
endpoint: '',
auth: '' || ['', ''],
headers: {'': '', ...}
})
// Eg:
const aemHeadlessClient = new AEMHeadless({
serviceURL: AEM_HOST_URI,
endpoint: 'content/graphql/endpoint.gql',
auth: [AEM_USER, AEM_PASS],
headers: {'customerheadername': 'customerheadervalue'}
})
`


$3

#### Promise syntax:
`javascript
aemHeadlessClient.runQuery(queryString)
.then(data => console.log(data))
.catch(e => console.error(e.toJSON()))

aemHeadlessClient.listPersistedQueries()
.then(data => console.log(data))
.catch(e => console.error(e.toJSON()))

aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
.then(data => console.log(data))
.catch(e => console.error(e.toJSON()))

aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
.then(data => console.log(data))
.catch(e => console.error(e.toJSON()))

aemHeadlessClient.runPersistedQuery('wknd/persist-query-name-with-variables', { name: 'John Doe'})
.then(data => console.log(data))
.catch(e => console.error(e.toJSON()))
`
#### Within async/await:
`javascript
(async () => {
let postData
try {
postData = await aemHeadlessClient.runQuery(queryString)
} catch (e) {
console.error(e.toJSON())
}

let list
try {
list = await aemHeadlessClient.listPersistedQueries()
} catch (e) {
console.error(e.toJSON())
}

try {
await aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
} catch (e) {
console.error(e.toJSON())
}

let getData
try {
getData = await aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
} catch (e) {
console.error(e.toJSON())
}
})()
`

#### Pagination:
`javascript
(async () => {
const model = 'article'
const fields = {
title
_path
authorFragment {
firstName
profilePicture {
...on ImageRef {
_authorUrl
}
}
}
}

// Loop all pages (default Cursor based)
const cursorQueryAll = await aemHeadlessClient.runPaginatedQuery(model, fields, { pageSize: 3 })
for await (let value of cursorQueryAll) {
console.log('cursorQueryAll', value)
}
// Manually get next page (default pageSize = 10)
const cursorQuery = await aemHeadlessClient.runPaginatedQuery(model, fields)
while (true) {
const { done, value } = await cursorQuery.next();
if (done) break
console.log('cursorQuery', value)
}
})()
`

Authorization

If auth param is a string, it's treated as a Bearer token

If auth param is an array, expected data is ['user', 'pass'] pair, and Basic Authorization will be used

If auth` is not defined, Authorization header will not be set

API Reference

See generated API Reference

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.