add options

Author: lexoyo

Diff for: .eleventy.js

@@ -9,6 +9,8 @@ module.exports = (eleventyConfig, _options) => {
     allowSystem: false,
     onItem: item => item,
     filterCollection: ({collection, meta}) => true,
+    sequencial: false,
+    recursions: 7,
   }
 
   const options = {
@@ -23,6 +25,8 @@ module.exports = (eleventyConfig, _options) => {
     login: options.login,
     token: options.token,
     auth: options.auth,
+    sequencial: options.sequencial,
+    recursions: options.recursions,
   })
 
   // Add global data and init

Diff for: README.md

@@ -83,6 +83,8 @@ For this plugin to retrieve **private** data, use the `skd.authenticated` option
 | filterCollection | | |
 | allowHidden | Keep hidden collections in directus.collections.all | `true` |
 | allowSystem | Keep system collections in directus.collections.all | `true` |
+| sequencial | Should all collections and their items be fetched sequencially or in parallel | `false` |
+| recursions | How many levels of recursions do you need? This uses the `fields` field of requests. | `7` |
 
 ### Config Examples
 

Diff for: _scripts/client.js

@@ -5,14 +5,14 @@ const OPTION_LIMIT = (limit = -1) => ({
   limit,
 })
 
-const OPTION_WITH_FIELDS = () => ({
-  fields: [
-    '*.*.*.*.*.*.*', // this is for all fields on multiple levels
-  ],
-})
-
 const DIRECTUS_UPLOAD_FOLDER = process.env.DIRECTUS_UPLOAD_FOLDER
 
+async function allSync(promises) {
+  if (promises.length === 0) return []
+  const [firstElement, ...rest] = promises
+  return [await firstElement, ...(await allSync(rest))]
+}
+
 /**
  * @class Retrieve content from Directus
  */
@@ -24,6 +24,8 @@ class Client {
     token,
     allowHidden,
     allowSystem,
+    sequencial,
+    recursions,
   }) {
     // init attributes
     this.url = url
@@ -33,6 +35,13 @@ class Client {
     this.eleventyCollections = null
     this.allowHidden = allowHidden
     this.allowSystem = allowSystem
+    this.sequencial = sequencial
+    this.fields = {
+      // Get all fields on multiple levels
+      fields: [
+        '*'.repeat(recursions).split('').join('.'),
+      ],
+    }
 
     // init directus client
     this.directus = new Directus(url, { auth })
@@ -56,7 +65,7 @@ class Client {
    */
   async init(onItem = item => item, filterCollection = () => true) {
     if(this.initDone) {
-      return;
+      return
     }
     this.initDone = true
     this.login && await this.directus.auth.login(this.login)
@@ -92,7 +101,7 @@ class Client {
       // const collections = await this.directus.collections()
       const { data } = await this.directus.items('directus_collections').readByQuery({
         ...OPTION_LIMIT(),
-        ...OPTION_WITH_FIELDS(),
+        ...this.fields,
         ...options,
       })
       return data
@@ -114,7 +123,7 @@ class Client {
     try {
       const { data } = await this.directus.items(name).readByQuery({
         ...OPTION_LIMIT(),
-        ...OPTION_WITH_FIELDS(),
+        ...this.fields,
         ...options,
       })
       return data
@@ -189,7 +198,7 @@ class Client {
    */
   async get11tyCollectionsExpanded(onItem, filterCollection) {
     const collections = await this.get11tyCollections(filterCollection)
-    return Promise.all(collections.map(async collection => {
+    const promises = collections.map(async collection => {
       const data = await this.get11tyCollection(collection)
       if(!data) {
         console.warn('WARN: directus did not return any data for collection', collection)
@@ -200,11 +209,16 @@ class Client {
         return data
       }
 
-      let res = await Promise.all(data.map(onItem));
+      const onItemCbks = data.map(onItem)
+      const res = this.sequencial ?
+        await allSync(onItemCbks) :
+        await Promise.all(onItemCbks)
+
       res.__metadata = collection // FIXME: this adds a property to the array
 
       return res
-    }))
+    })
+    return this.sequencial ? allSync(promises) : Promise.all(promises)
     .then(collections => collections
       .filter(collection => !!collection) // filter the cases when directus errored
     )

Diff for: _scripts/client.test.js

@@ -4,6 +4,8 @@ const { start, stop } = require('./directus-server/')
 const port = 8056
 const OPTIONS = {
   url: `http://localhost:${port}`,
+  sequencial: true,
+  recursions: 7,
 }
 const NUM_COLLECTIONS = 5 // page, post, settings, multilingual, languages
 
@@ -63,7 +65,6 @@ describe('API', () => {
     expect(page).not.toBeUndefined()
     expect(page).toBeInstanceOf(Array)
     expect(page.length).toBeGreaterThan(0)
-    console.log(page)
     expect(page[0].text).toBe('Home page')
     expect(post).not.toBeUndefined()
     expect(post).toBeInstanceOf(Array)
@@ -73,10 +74,8 @@ describe('API', () => {
     expect(settings).toBeInstanceOf(Object)
     expect(settings.test_property).toBe('test value')
   })
-  test('getAll', async () => {
-  })
-  test('collections', async () => {
-  })
+  // TODO: test('getAll', async () => {})
+  // TODO: test('collections', async () => {})
   test('not multilingual', async () => {
     const {page} = await client.getCollections()
     expect(client.translate(page[0], null, 'en-US').lang).toBeUndefined()
@@ -96,5 +95,23 @@ describe('API', () => {
     expect(translated.text).not.toBeUndefined()
     expect(translated.text.startsWith('text '))
   })
+  test('options recursions', async () => {
+    // With the default recursions
+    let result = await client.getCollections()
+    expect(result.page).toBeInstanceOf(Array)
+    result.page.forEach(p => {
+      expect(p.user_created).toBeUndefined() // users is not public
+    })
+    client = await createClient({
+      ...OPTIONS,
+      recursions: 1,
+    })
+    await client.init()
+    result = await client.getCollections()
+    expect(result.page).toBeInstanceOf(Array)
+    result.page.forEach(p => {
+      expect(typeof p.user_created).toBe('string')
+    })
+  })
 })