🍻 Demo prepation for github.io

Author: Plopix

README.md

@@ -25,7 +25,7 @@ It's very common that you will want to build the navigation of your website foll
 These fetchers do the heaving lifting for you.
 
 ```javascript
-const fetch = createNavigationTreeFetcher(CrystallizeClient);
+const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
 const response = await fetch('/', 'en', 3);
 ```
 
@@ -53,7 +53,7 @@ This will trigger the following query:
 You might want more, so you can pass a first parameter like this:
 
 ```javascript
-const fetch = createNavigationTreeFetcher(CrystallizeClient);
+const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
 const response = await fetch('/', 'en', 2, {
     tenant: {
         __args: {
@@ -87,7 +87,7 @@ query ($language: String!, $path: String!) {
 You can also customize what you want in each level:
 
 ```javascript
-const fetch = createNavigationTreeFetcher(CrystallizeClient);
+const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
 const response = await fetch(
     '/',
     'en',

package.json

@@ -30,5 +30,5 @@
     },
     "license": "MIT",
     "name": "@crystallize/js-api-client",
-    "version": "0.1.1"
+    "version": "0.2.0"
 }

src/core/navigation.ts

@@ -75,18 +75,18 @@ function buildQueryFor(type: NavigationType, path: string) {
     }
 }
 
-type TreeFetcher<T> = (
+export type TreeFetcher = (
     path: string,
     language: string,
     depth: number,
     extraQuery?: any,
     perLevel?: (currentLevel: number) => any
-) => Promise<T>;
+) => Promise<any>;
 
 function fetchTree<T>(
     client: ClientInterface,
     type: NavigationType
-): TreeFetcher<T> {
+): TreeFetcher {
     return <T>(
         path: string,
         language: string,
@@ -110,10 +110,10 @@ function fetchTree<T>(
     };
 }
 
-export function createNavigationTreeFetcher(client: ClientInterface) {
+export function createNavigationByFoldersFetcher(client: ClientInterface) {
     return fetchTree(client, NavigationType.Tree);
 }
 
-export function createNavigationTopicFetcher(client: ClientInterface) {
+export function createNavigationByTopicsFetcher(client: ClientInterface) {
     return fetchTree(client, NavigationType.Topics);
 }

src/index.ts

@@ -1,7 +1,7 @@
 export * from './core/client';
 export * from './core/navigation';
 import { createClient } from './core/client';
-import { createNavigationTreeFetcher } from './core/navigation';
+import { createNavigationByFoldersFetcher } from './core/navigation';
 
 export const CrystallizeClient = createClient({
     tenantIdentifier: process.env.CRYSTALLIZE_TENANT_IDENTIFIER || '',
@@ -10,4 +10,4 @@ export const CrystallizeClient = createClient({
 });
 
 export const CrystallizeNavigationTreeFetcher =
-    createNavigationTreeFetcher(CrystallizeClient);
+    createNavigationByFoldersFetcher(CrystallizeClient);

tests/naigationTree.test.js tests/naigationFolders.test.jstests/naigationTree.test.js renamed to tests/naigationFolders.test.js

@@ -1,5 +1,5 @@
 const {
-    createNavigationTreeFetcher,
+    createNavigationByFoldersFetcher,
     createClient
 } = require('../dist/index.js');
 
@@ -8,7 +8,7 @@ test('Test Nav fetching Node: Shop', async () => {
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTreeFetcher(CrystallizeClient);
+    const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
     const response = await fetch('/shop', 'en', 3);
 
     expect(response.tree.path).toBe('/shop');
@@ -28,7 +28,7 @@ test('Test Nav fetching Node: /', async () => {
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTreeFetcher(CrystallizeClient);
+    const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
     const response = await fetch('/', 'en', 3);
     expect(response.tree.path).toBe('/');
     expect(response.tree.children[0].path).toBe('/shop');
@@ -39,7 +39,7 @@ test('Test Nav fetching Node: / + extra data', async () => {
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTreeFetcher(CrystallizeClient);
+    const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
     const response = await fetch('/', 'en', 2, {
         tenant: {
             __args: {
@@ -58,7 +58,7 @@ test('Test Nav fetching Node: / + extra data + specific level', async () => {
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTreeFetcher(CrystallizeClient);
+    const fetch = createNavigationByFoldersFetcher(CrystallizeClient);
     const response = await fetch(
         '/',
         'en',

tests/naigationTopic.test.js tests/naigationTopics.test.jstests/naigationTopic.test.js renamed to tests/naigationTopics.test.js

@@ -1,5 +1,5 @@
 const {
-    createNavigationTopicFetcher,
+    createNavigationByTopicsFetcher,
     createClient
 } = require('../dist/index.js');
 
@@ -8,7 +8,7 @@ test('Test Nav fetching Topic: /', async () => {
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTopicFetcher(CrystallizeClient);
+    const fetch = createNavigationByTopicsFetcher(CrystallizeClient);
     const response = await fetch('/', 'en', 3);
 
     // fetch topics returns a list of topics with no parents
@@ -22,7 +22,7 @@ test('Test Nav fetching Topic: /specials', async () => {
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTopicFetcher(CrystallizeClient);
+    const fetch = createNavigationByTopicsFetcher(CrystallizeClient);
     const response = await fetch('/specials', 'en', 3);
 
     expect(response.tree.name).toBe('Specials');
@@ -35,7 +35,7 @@ test('Test Nav fetching Topic: /specials + extra data + specific level', async (
         tenantIdentifier: 'furniture'
     });
 
-    const fetch = createNavigationTopicFetcher(CrystallizeClient);
+    const fetch = createNavigationByTopicsFetcher(CrystallizeClient);
     const response = await fetch(
         '/specials',
         'en',