Skip to content

Commit 13510ea

Browse files
easingthemeseasingthemes
authored
Feature/19 split browser and nodejs (#20)
* #19 - remove NodeJS functionality * #19 - remove not used packages * #19 -validate fetch instance * #19 - JSDocs fix * #19 add more info to test logs * #19 remove isBrowser helper, use a function. Remove unecesary defaults * #19 add default serviceURL * #19 remove isBrowser helper, use a function. Remove unecesary defaults * #18 update jest setup * #18 increase tests * #18 update e2e tests * #19 update docs * #19 update docs * #18 add test for persistent query variables * #18 fix eslint for jest * #19 update correct dev dependencies versions * #19 limit packaged files * #19 recreate package-lock * #19 expose named export * #19 fix workflow branch name * #19 Readme update missing await * #19 Add explicit async to async methods
1 parent 8fe9cbc commit 13510ea

20 files changed

+3103
-2017
lines changed

‎.eslintrc.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
{
2-
"extends": ["@adobe/eslint-config-aio-lib-config"]
3-
}
2+
"extends": ["@adobe/eslint-config-aio-lib-config"],
3+
"rules": {
4+
"jsdoc/check-tag-names": [
5+
"error",
6+
{
7+
"definedTags": ["jest-environment"]
8+
}
9+
]
10+
}
11+
}

‎.github/workflows/nodejs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
branches: [ '**' ]
66
pull_request:
7-
branches: [ $default-branch ]
7+
branches: [ main ]
88

99
jobs:
1010
build:

‎.npmrc

-2
This file was deleted.

‎README.md

+7-20
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
6363
.then(data => console.log(data))
6464
.catch(e => console.error(e.toJSON()))
6565

66-
aemHeadlessClient.runPersistedQuery('wknd/persist-query-name', { variable1: 'variable1Value' })
66+
aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
6767
.then(data => console.log(data))
6868
.catch(e => console.error(e.toJSON()))
6969

70-
aemHeadlessClient.getQuery('wknd/persist-query-name-with-variables', { name: 'John Doe'})
70+
aemHeadlessClient.runPersistedQuery('wknd/persist-query-name-with-variables', { name: 'John Doe'})
7171
.then(data => console.log(data))
7272
.catch(e => console.error(e.toJSON()))
7373
```
@@ -76,27 +76,27 @@ aemHeadlessClient.getQuery('wknd/persist-query-name-with-variables', { name: 'Jo
7676
(async () => {
7777
let postData
7878
try {
79-
postData = aemHeadlessClient.postQuery(queryString)
79+
postData = await aemHeadlessClient.postQuery(queryString)
8080
} catch (e) {
8181
console.error(e.toJSON())
8282
}
8383

8484
let list
8585
try {
86-
list = aemHeadlessClient.listPersistedQueries()
86+
list = await aemHeadlessClient.listPersistedQueries()
8787
} catch (e) {
8888
console.error(e.toJSON())
8989
}
9090

9191
try {
92-
aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
92+
await aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
9393
} catch (e) {
9494
console.error(e.toJSON())
9595
}
9696

9797
let getData
9898
try {
99-
getData = aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
99+
getData = await aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
100100
} catch (e) {
101101
console.error(e.toJSON())
102102
}
@@ -107,27 +107,14 @@ aemHeadlessClient.getQuery('wknd/persist-query-name-with-variables', { name: 'Jo
107107

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

110-
If `auth` param is an array, expected data is ['user', 'pass'] pair, and Basic Authorization will be ued
110+
If `auth` param is an array, expected data is ['user', 'pass'] pair, and Basic Authorization will be used
111111

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

114-
### DEV token and service credentials
115-
116-
SDK contains helper function to get Auth token from credentials config file
117-
118-
```javascript
119-
const { getToken } = require('@adobe/aem-headless-client-js')
120-
(async () => {
121-
const {accessToken, type, expires} = await getToken('path/to/service-config.json')
122-
const sdkNode = new AEMHeadless('content/graphql/endpoint.gql', AEM_HOST_URI, accessToken)
123-
const data = sdkNode.runQuery(queryString)
124-
})()
125-
```
126114
## API Reference
127115

128116
See generated [API Reference](./api-reference.md)
129117

130-
131118
## Contributing
132119

133120
Contributions are welcome! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.

‎api-reference.md

+89-29
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ governing permissions and limitations under the License.
1616
## AEMHeadless
1717
This class provides methods to call AEM GraphQL APIs.
1818
Before calling any method initialize the instance
19-
with GraphQL endpoint, GraphQL host and auth if needed
19+
with GraphQL endpoint, GraphQL serviceURL and auth if needed
2020

2121
**Kind**: global class
2222

@@ -31,16 +31,34 @@ with GraphQL endpoint, GraphQL host and auth if needed
3131

3232
### new AEMHeadless(config)
3333
Constructor.
34+
3435
If param is a string, it's treated as AEM server URL, default GraphQL endpoint is used.
3536
For granular params, use config object
3637

37-
38-
| Param | Type | Description |
39-
| --- | --- | --- |
40-
| config | <code>object</code> \| <code>string</code> | Configuration object, or AEM server URL string |
41-
| [config.serviceURL] | <code>string</code> | AEM server URL |
42-
| [config.endpoint] | <code>string</code> | GraphQL endpoint |
43-
| [config.auth] | <code>string</code> \| <code>Array</code> | Bearer token string or [user,pass] pair array |
38+
<table>
39+
<thead>
40+
<tr>
41+
<th>Param</th><th>Type</th><th>Description</th>
42+
</tr>
43+
</thead>
44+
<tbody>
45+
<tr>
46+
<td>config</td><td><code>string</code> | <code>object</code></td><td><p>Configuration object, or AEM server URL string</p>
47+
</td>
48+
</tr><tr>
49+
<td>[config.serviceURL]</td><td><code>string</code></td><td><p>AEM server URL</p>
50+
</td>
51+
</tr><tr>
52+
<td>[config.endpoint]</td><td><code>string</code></td><td><p>GraphQL endpoint</p>
53+
</td>
54+
</tr><tr>
55+
<td>[config.auth]</td><td><code>string</code> | <code>Array</code></td><td><p>Bearer token string or [user,pass] pair array</p>
56+
</td>
57+
</tr><tr>
58+
<td>[config.fetch]</td><td><code>object</code></td><td><p>Fetch instance - required for NodeJS only, eg node-fetch/cross-fetch</p>
59+
</td>
60+
</tr> </tbody>
61+
</table>
4462

4563
<a name="AEMHeadless+runQuery"></a>
4664

@@ -49,11 +67,21 @@ Returns a Promise that resolves with a POST request JSON data.
4967

5068
**Kind**: instance method of [<code>AEMHeadless</code>](#AEMHeadless)
5169
**Returns**: <code>Promise.&lt;any&gt;</code> - - the response body wrapped inside a Promise
52-
53-
| Param | Type | Default | Description |
54-
| --- | --- | --- | --- |
55-
| query | <code>string</code> | | the query string |
56-
| [options] | <code>object</code> | <code>{}</code> | additional POST request options |
70+
<table>
71+
<thead>
72+
<tr>
73+
<th>Param</th><th>Type</th><th>Default</th><th>Description</th>
74+
</tr>
75+
</thead>
76+
<tbody>
77+
<tr>
78+
<td>query</td><td><code>string</code></td><td></td><td><p>the query string</p>
79+
</td>
80+
</tr><tr>
81+
<td>[options]</td><td><code>object</code></td><td><code>{}</code></td><td><p>additional POST request options</p>
82+
</td>
83+
</tr> </tbody>
84+
</table>
5785

5886
<a name="AEMHeadless+persistQuery"></a>
5987

@@ -62,12 +90,24 @@ Returns a Promise that resolves with a PUT request JSON data.
6290

6391
**Kind**: instance method of [<code>AEMHeadless</code>](#AEMHeadless)
6492
**Returns**: <code>Promise.&lt;any&gt;</code> - - the response body wrapped inside a Promise
65-
66-
| Param | Type | Default | Description |
67-
| --- | --- | --- | --- |
68-
| query | <code>string</code> | | the query string |
69-
| path | <code>string</code> | | AEM path to save query, format: configuration_name/endpoint_name |
70-
| [options] | <code>object</code> | <code>{}</code> | additional PUT request options |
93+
<table>
94+
<thead>
95+
<tr>
96+
<th>Param</th><th>Type</th><th>Default</th><th>Description</th>
97+
</tr>
98+
</thead>
99+
<tbody>
100+
<tr>
101+
<td>query</td><td><code>string</code></td><td></td><td><p>the query string</p>
102+
</td>
103+
</tr><tr>
104+
<td>path</td><td><code>string</code></td><td></td><td><p>AEM path to save query, format: configuration_name/endpoint_name</p>
105+
</td>
106+
</tr><tr>
107+
<td>[options]</td><td><code>object</code></td><td><code>{}</code></td><td><p>additional PUT request options</p>
108+
</td>
109+
</tr> </tbody>
110+
</table>
71111

72112
<a name="AEMHeadless+listPersistedQueries"></a>
73113

@@ -76,10 +116,18 @@ Returns a Promise that resolves with a GET request JSON data.
76116

77117
**Kind**: instance method of [<code>AEMHeadless</code>](#AEMHeadless)
78118
**Returns**: <code>Promise.&lt;any&gt;</code> - - the response body wrapped inside a Promise
79-
80-
| Param | Type | Default | Description |
81-
| --- | --- | --- | --- |
82-
| [options] | <code>object</code> | <code>{}</code> | additional GET request options |
119+
<table>
120+
<thead>
121+
<tr>
122+
<th>Param</th><th>Type</th><th>Default</th><th>Description</th>
123+
</tr>
124+
</thead>
125+
<tbody>
126+
<tr>
127+
<td>[options]</td><td><code>object</code></td><td><code>{}</code></td><td><p>additional GET request options</p>
128+
</td>
129+
</tr> </tbody>
130+
</table>
83131

84132
<a name="AEMHeadless+runPersistedQuery"></a>
85133

@@ -88,10 +136,22 @@ Returns a Promise that resolves with a GET request JSON data.
88136

89137
**Kind**: instance method of [<code>AEMHeadless</code>](#AEMHeadless)
90138
**Returns**: <code>Promise.&lt;any&gt;</code> - - the response body wrapped inside a Promise
91-
92-
| Param | Type | Default | Description |
93-
| --- | --- | --- | --- |
94-
| path | <code>string</code> | | AEM path for persisted query, format: configuration_name/endpoint_name |
95-
| [variables] | <code>object</code> | <code>{}</code> | query variables |
96-
| [options] | <code>object</code> | <code>{}</code> | additional GET request options |
139+
<table>
140+
<thead>
141+
<tr>
142+
<th>Param</th><th>Type</th><th>Default</th><th>Description</th>
143+
</tr>
144+
</thead>
145+
<tbody>
146+
<tr>
147+
<td>path</td><td><code>string</code></td><td></td><td><p>AEM path for persisted query, format: configuration_name/endpoint_name</p>
148+
</td>
149+
</tr><tr>
150+
<td>[variables]</td><td><code>object</code></td><td><code>{}</code></td><td><p>query variables</p>
151+
</td>
152+
</tr><tr>
153+
<td>[options]</td><td><code>object</code></td><td><code>{}</code></td><td><p>additional GET request options</p>
154+
</td>
155+
</tr> </tbody>
156+
</table>
97157

‎e2e/e2e.js

+6-7
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ governing permissions and limitations under the License.
1010
*/
1111

1212
const path = require('path')
13+
const fetch = require('cross-fetch')
1314

1415
// load .env values in the e2e folder, if any
1516
require('dotenv').config({ path: path.join(__dirname, '.env') })
1617

17-
const { AEMHeadless } = require('../src')
18+
const AEMHeadless = require('../src')
1819

1920
const { AEM_TOKEN, AEM_USER = 'admin', AEM_PASS = 'admin', AEM_HOST_URI = 'http://localhost:4502', AEM_GRAPHQL_ENDPOINT = 'content/graphql/global/endpoint.json' } = process.env
2021

@@ -34,29 +35,27 @@ beforeEach(() => {
3435
sdk = new AEMHeadless({
3536
serviceURL: AEM_HOST_URI,
3637
endpoint: AEM_GRAPHQL_ENDPOINT,
37-
auth: AEM_TOKEN || [AEM_USER, AEM_PASS]
38+
auth: AEM_TOKEN || [AEM_USER, AEM_PASS],
39+
fetch
3840
})
3941
})
4042

4143
test('e2e test sdk valid params', () => {
42-
// check success response
43-
const config = { serviceURL: AEM_HOST_URI, auth: AEM_TOKEN || [AEM_USER, AEM_PASS] }
44-
sdk = new AEMHeadless(config)
4544
expect(sdk).toHaveProperty('serviceURL')
4645
expect(sdk).toHaveProperty('endpoint')
4746
})
4847

4948
test('e2e test sdk missing params', () => {
5049
// check success response
51-
const config = {}
50+
const config = { fetch }
5251
sdk = new AEMHeadless(config)
5352
expect(sdk).toHaveProperty('serviceURL')
5453
expect(sdk).toHaveProperty('endpoint')
5554
})
5655

5756
test('e2e test sdk missing param serviceURL', () => {
5857
// check success response
59-
const config = { endpoint: 'test' }
58+
const config = { endpoint: 'test', fetch }
6059
sdk = new AEMHeadless(config)
6160
expect(sdk).toHaveProperty('serviceURL')
6261
expect(sdk).toHaveProperty('endpoint')

‎e2e/jest.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
module.exports = {
22
testEnvironment: 'node',
33
setupFilesAfterEnv: [
4-
'../test/jest/jest.setup.js'
4+
'../test/setup/jest.setup.js'
55
],
66
testRegex: './e2e/e2e.js'
77
}

0 commit comments

Comments
 (0)