griddo-sdk 1.0.6 → 1.0.9

package/index.js

@@ -1,13 +1,14 @@
 const { api } = require('./api');
 const { getToken } = require('./models/auth');
 const { getPages, getPage, savePage, deletePage, restorePage } = require('./models/pages');
-const { getStructuredData, saveStructuredData } = require('./models/structuredData');
+const { getStructuredData, saveStructuredData, deleteStructuredData } = require('./models/structuredData');
 const { getLanguages } = require('./models/languages');
 const { getStatus } = require('./models/liveStatus');
 
 class SDK {
     constructor() {
         this._env = {};
+        this.connect = this.connect.bind(this);
         this.api = this.api.bind(this);
         this.getPage = this.getPage.bind(this);
         this.savePage = this.savePage.bind(this);
@@ -18,6 +19,7 @@ class SDK {
         this.mapModules = this.mapModules.bind(this);
         this.getStructuredData = this.getStructuredData.bind(this);
         this.saveStructuredData = this.saveStructuredData.bind(this);
+        this.deleteStructuredData = this.deleteStructuredData.bind(this);
         this.getLanguage = this.getLanguage.bind(this);
         this.getDefaultLanguage = this.getDefaultLanguage.bind(this);
         this.languages = [];
@@ -28,12 +30,14 @@ class SDK {
         const {
             api,
             user,
-            password
+            password,
+            verbose,
         } = environment;
-        if (!api || !user || !password) throw new Error('Environment JSON file should contain the keys api, user and password.');
+        if (!api || !user || !password) throw new Error('Connection object must contain the keys api, user and password.');
         this._env = {
             api: api.endsWith('/') ? api.slice(0, -1) : api,
             token: await getToken(environment),
+            verbose,
         };
         this.languages = await getLanguages(this._env);
 
@@ -50,15 +54,15 @@ class SDK {
     };
 
     async mapPages(callback, templateName) {
-        console.log(`\nMapping ${templateName || 'all'} pages with callback function ${callback.name}...`);
+        if (this._env.verbose) console.log(`\nMapping ${templateName || 'all'} pages with callback function ${callback.name}...`);
         if (!callback || typeof (callback) !== 'function') throw new Error('Cannot map pages without a callback function.');
         const pages = await getPages(this._env, templateName);
         if (!pages?.length) {
-            console.log('- No pages found.');
+            if (this._env.verbose) console.log('- No pages found.');
             return;
         }
         for (const pageId of pages) {
-            console.log('- Mapping page', pageId);
+            if (this._env.verbose) console.log('- Mapping page', pageId);
             const page = await getPage(this._env, pageId)
             const pageProtected = JSON.parse(JSON.stringify(page));
             const result = await callback(pageProtected);
@@ -69,7 +73,7 @@ class SDK {
     };
 
     async mapModulesFromPage(page, moduleName, callback) {
-        console.log(`\tMapping modules ${moduleName} with callback function ${callback.name}...`);
+        if (this._env.verbose) console.log(`\tMapping modules ${moduleName} with callback function ${callback.name}...`);
         if (!callback || typeof (callback) !== 'function') throw new Error('Cannot map modules without a callback function.');
         if (!moduleName) throw new Error('Cannot map modules in page without selecting the module to map.');
         if (!page || typeof (page) !== 'object') throw new Error('Page to map modules not found.');
@@ -80,7 +84,7 @@ class SDK {
                 const module = modulePiece[key];
                 if (!module || typeof (module) !== 'object') continue;
                 if (module.component === moduleName) {
-                    if (!found) console.log(`\tModule ${moduleName} found.`);
+                    if (!found && this._env.verbose) console.log(`\tModule ${moduleName} found.`);
                     const newModule = await callback(JSON.parse(JSON.stringify(module)));
                     if (newModule) modulePiece[key] = newModule;
                     found = true;
@@ -89,12 +93,12 @@ class SDK {
             }
         };
         await search(protectedPage);
-        if (!found) console.log(`\tModule ${moduleName} not found.`);
+        if (!found && this._env.verbose) console.log(`\tModule ${moduleName} not found.`);
         return protectedPage;
     };
 
     async mapModules(callback, moduleName, template) {
-        console.log(`\nMapping modules ${moduleName} from ${template || 'all'} pages with callback function ${callback.name}...`);
+        if (this._env.verbose) console.log(`\nMapping modules ${moduleName} from ${template || 'all'} pages with callback function ${callback.name}...`);
         if (!callback || typeof (callback) !== 'function') throw new Error('Cannot map modules without a callback function.');
         if (!moduleName) throw new Error('Cannot map modules in page without selecting the module to map.');
         const fixPage = (page) => this.mapModulesFromPage(page, moduleName, callback);
@@ -125,6 +129,10 @@ class SDK {
         return await saveStructuredData(this._env, structuredData);
     };
 
+    async deleteStructuredData(id) {
+        return await deleteStructuredData(this._env, id);
+    };
+
     async api(...params) {
         return await api(this._env, ...params);
     };

package/models/auth.js

@@ -5,11 +5,12 @@ const getToken = async (params) => {
         api: apiKey,
         user: email,
         password,
+        verbose,
     } = params;
-    console.log('Logging to api...');
+    if (verbose) console.log('Logging to api...');
     const token = await api({ api: apiKey }, 'post', '/login_check', { email, password })
         .then(data => data.token);
-    console.log('Authenticated.');
+    if (verbose) console.log('Authenticated.');
     return token;
 };
 

package/models/pages.js

@@ -4,7 +4,7 @@ const getPages = (env, template = null) => api(env, 'get', `/pages/all/id/${temp
 
 const getPage = async (env, pageId) => {
     const page = await api(env, 'get', `/page/${pageId}`)
-    console.log('\tLoaded page', page.title);
+    if (env.verbose) console.log('\tLoaded page', page.title);
     return page;
 };
 
@@ -27,17 +27,17 @@ const savePage = async (env, page) => {
         actionName,
     } = actions[page.id ? 'update' : 'new'];
     const savedPage = await api(env, method, endpoint, page);
-    console.log(`\tPage ${actionName}.`);
+    if (env.verbose) console.log(`\tPage ${actionName}.`);
     return savedPage;
 };
 
 const deletePage = (env, id) => {
-    console.log('\tDelete page', id);
+    if (env.verbose) console.log('\tDelete page', id);
     return api(env, 'delete', `/page/${id}`);
 };
 
 const restorePage = (env, id) => {
-    console.log('\tRestore page', id);
+    if (env.verbose) console.log('\tRestore page', id);
     return api(env, 'delete', `/page/${id}/undo`);
 };
 

package/models/structuredData.js

@@ -1,12 +1,12 @@
 const { api } = require('../api');
 
-const getStructuredData = async (env, id, site = null, language = null) => {
+const getStructuredData = async (env, id, site = null, language = null, verbose) => {
     const headers = {
         lang: language,
     };
     const items = await api(env, 'get', `${site ? `/site/${site}` : ''}/structured_data_contents/${id}?pagination=false&includeDraft=true`, { headers })
         .then(data => data.items);
-    console.log(`\tStructured data ${id} loaded.`);
+    if (env.verbose) console.log(`\tStructured data ${id} loaded.`);
     return items;
 };
 
@@ -29,11 +29,17 @@ const saveStructuredData = async (env, structuredData) => {
         actionName,
     } = actions[structuredData.id ? 'update' : 'new'];
     const savedItem = await api(env, method, endpoint, structuredData);
-    console.log(`\tStructured data ${structuredData?.content?.title || structuredData?.content?.label || 'untitled'} in ${structuredData.structuredData} ${actionName}.`);
+    if (env.verbose) console.log(`\tStructured data ${structuredData?.content?.title || structuredData?.content?.label || 'untitled'} in ${structuredData.structuredData} ${actionName}.`);
     return savedItem;
 };
 
+const deleteStructuredData = (env, id) => {
+    if (env.verbose) console.log('\tDelete structured data', id);
+    return api(env, 'delete', `/structured_data_content/${id}`);
+};
+
 module.exports = {
     getStructuredData,
     saveStructuredData,
+    deleteStructuredData,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "griddo-sdk",
-  "version": "1.0.6",
+  "version": "1.0.9",
   "description": "",
   "main": "index.js",
   "scripts": {