griddo-sdk 1.2.6 → 1.2.7

package/examples/paginationStructuredData.js

@@ -0,0 +1,50 @@
+const dotenv = require("dotenv");
+const SDK = require('./../index');
+
+/**
+ * Para probar el ejemplo hay que crearse un .env con las siguientes variables:
+ * - API_URL
+ * - PUBLIC_API_URL
+ * - USER_EMAIL
+ * - USER_PASSWORD
+ * - VERBOSE
+ */
+(async () => {
+	dotenv.config();
+
+	const sdk = new SDK();
+
+	const { API_URL, PUBLIC_API_URL, USER_EMAIL, USER_PASSWORD, VERBOSE } =
+		process.env;
+
+	if (!API_URL || !PUBLIC_API_URL || !USER_EMAIL || !USER_PASSWORD) {
+		throw new Error("Environment variables must be set");
+	}
+
+	// Conectar al entorno
+	await sdk.connect({
+		api: API_URL,
+		publicApi: PUBLIC_API_URL,
+		user: USER_EMAIL,
+		password: USER_PASSWORD,
+		verbose: VERBOSE === "true",
+	});
+
+	const queryParams = {
+		page: 1,
+		itemsPerPage: 2,
+		pagination: true,
+		includeDraft: false,
+		relatedFields: true,
+		deleted: false,
+		query: "prueba",
+	};
+
+	const paginationStructuredData = await sdk.getPaginationStructuredData(
+		"ALUMNI",
+		"8",
+		"2",
+		queryParams,
+	);
+	console.log("Structured Data:", paginationStructuredData);
+})();

package/examples/runTest.js

@@ -0,0 +1,12 @@
+const path = require('path');
+
+const fileName = process.argv[2];
+
+if (!fileName) {
+	console.error('Please provide a script name to run.');
+	process.exit(1);
+}
+
+const filePath = path.resolve(__dirname, fileName);
+
+require(filePath);

package/index.js

@@ -1,215 +1,215 @@
-const { api } = require("./api");
-const { getToken } = require("./models/auth");
-const { getPages, getPage, savePage, deletePage, restorePage } = require("./models/pages");
+const {api} = require('./api');
+const {getToken} = require('./models/auth');
+const {getPages, getPage, savePage, deletePage, restorePage} = require('./models/pages');
 const {
-	getStructuredData,
-	getStructuredDataByID,
-	saveStructuredData,
-	deleteStructuredData
-} = require("./models/structuredData");
-const { getLanguages } = require("./models/languages");
-const { getStatus } = require("./models/liveStatus");
-const { sendAlert } = require("./models/alerts");
+  getStructuredData,
+  getStructuredDataByID,
+  saveStructuredData,
+  deleteStructuredData
+} = require('./models/structuredData');
+const {getLanguages} = require('./models/languages');
+const {getStatus} = require('./models/liveStatus');
+const {sendAlert} = require('./models/alerts');
 
 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);
-		this.deletePage = this.deletePage.bind(this);
-		this.restorePage = this.restorePage.bind(this);
-		this.mapPages = this.mapPages.bind(this);
-		this.mapModulesFromPage = this.mapModulesFromPage.bind(this);
-		this.mapModules = this.mapModules.bind(this);
-		this.getStructuredDataByID = this.getStructuredDataByID.bind(this);
-		this.getStructuredData = this.getStructuredData.bind(this);
-		this.getPaginationStructuredData = this.getPaginationStructuredData.bind(this);
-		this.saveStructuredData = this.saveStructuredData.bind(this);
-		this.deleteStructuredData = this.deleteStructuredData.bind(this);
-		this.mapStructuredData = this.mapStructuredData.bind(this);
-		this.getLanguage = this.getLanguage.bind(this);
-		this.getDefaultLanguage = this.getDefaultLanguage.bind(this);
-		this.sendAlert = this.sendAlert.bind(this);
-		this.languages = [];
-		this.liveStatus = {};
+  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);
+	this.deletePage = this.deletePage.bind(this);
+	this.restorePage = this.restorePage.bind(this);
+	this.mapPages = this.mapPages.bind(this);
+	this.mapModulesFromPage = this.mapModulesFromPage.bind(this);
+	this.mapModules = this.mapModules.bind(this);
+	this.getStructuredDataByID = this.getStructuredDataByID.bind(this);
+	this.getStructuredData = this.getStructuredData.bind(this);
+	this.getPaginationStructuredData = this.getPaginationStructuredData.bind(this);
+	this.saveStructuredData = this.saveStructuredData.bind(this);
+	this.deleteStructuredData = this.deleteStructuredData.bind(this);
+	this.mapStructuredData = this.mapStructuredData.bind(this);
+	this.getLanguage = this.getLanguage.bind(this);
+	this.getDefaultLanguage = this.getDefaultLanguage.bind(this);
+	this.sendAlert = this.sendAlert.bind(this);
+	this.languages = [];
+	this.liveStatus = {};
+  }
+
+  async connect(environment) {
+	const {
+	  api,
+	  publicApi,
+	  user,
+	  password,
+	  verbose,
+	} = environment;
+	if (!api || !user || !password) throw new Error('Connection object must contain the keys api, user and password.');
+	if (!publicApi) console.log('WARNING: Connection object should contain the key publicApi (!!!).\n\n');
+	this._env = {
+	  api: api.endsWith('/') ? api.slice(0, -1) : api,
+	  publicApi: publicApi && (publicApi.endsWith('/') ? publicApi.slice(0, -1) : publicApi),
+	  token: await getToken(environment),
+	  verbose,
+	};
+	this.languages = await getLanguages(this._env);
+
+	const liveStatus = await getStatus(this._env);
+	for (const item of liveStatus) this.liveStatus[item.status] = item.id;
+  };
+
+  getLanguage(key, value) {
+	return this.languages.find(item => item[key] === value);
+  };
+
+  getDefaultLanguage() {
+	return this.languages.find(item => item.isDefault);
+  };
+
+  async mapPages(callback, templateName) {
+	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) {
+	  if (this._env.verbose) console.log('- No pages found.');
+	  return;
 	}
-
-	async connect(environment) {
-		const {
-			api,
-			publicApi,
-			user,
-			password,
-			verbose
-		} = environment;
-		if (!api || !user || !password) throw new Error("Connection object must contain the keys api, user and password.");
-		if (!publicApi) console.log("WARNING: Connection object should contain the key publicApi (!!!).\n\n");
-		this._env = {
-			api: api.endsWith("/") ? api.slice(0, -1) : api,
-			publicApi: publicApi && (publicApi.endsWith("/") ? publicApi.slice(0, -1) : publicApi),
-			token: await getToken(environment),
-			verbose
-		};
-		this.languages = await getLanguages(this._env);
-
-		const liveStatus = await getStatus(this._env);
-		for (const item of liveStatus) this.liveStatus[item.status] = item.id;
-	};
-
-	getLanguage(key, value) {
-		return this.languages.find(item => item[key] === value);
-	};
-
-	getDefaultLanguage() {
-		return this.languages.find(item => item.isDefault);
-	};
-
-	async mapPages(callback, templateName) {
-		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) {
-			if (this._env.verbose) console.log("- No pages found.");
-			return;
-		}
-		for (const pageId of pages) {
-			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);
-			if (result && JSON.stringify(page) !== JSON.stringify(result)) {
-				await savePage(this._env, result);
-			}
-		}
-	};
-
-	async mapModulesFromPage(page, moduleName, callback) {
-		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.");
-		const protectedPage = JSON.parse(JSON.stringify(page));
-		let found = false;
-		const search = async (modulePiece) => {
-			for (const key of Object.keys(modulePiece)) {
-				const module = modulePiece[key];
-				if (!module || typeof (module) !== "object") continue;
-				if (module.component === moduleName) {
-					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;
-				}
-				await search(module);
-			}
-		};
-		await search(protectedPage);
-		if (!found && this._env.verbose) console.log(`\tModule ${moduleName} not found.`);
-		return protectedPage;
-	};
-
-	async mapModules(callback, moduleName, template) {
-		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);
-		await this.mapPages(fixPage, template);
-	};
-
-	async savePage(page) {
-		return await savePage(this._env, page);
-	};
-
-	async getPage(id) {
-		return await getPage(this._env, id);
-	};
-
-	async deletePage(id) {
-		return await deletePage(this._env, id);
-	};
-
-	async restorePage(id) {
-		return await restorePage(this._env, id);
-	};
-
-	async getStructuredDataByID(id) {
-		return await getStructuredDataByID(this._env, id);
+	for (const pageId of pages) {
+	  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);
+	  if (result && JSON.stringify(page) !== JSON.stringify(result)) {
+		await savePage(this._env, result)
+	  }
 	}
-
-	async getStructuredData(
-		contentType,
-		site = null,
-		language = null,
-		queryParams = {
-			page: 0,
-			itemsPerPage: 0,
-			pagination: false,
-			deleted: false,
-			includeDraft: true,
-			relatedFields: false,
-			query: null
+  };
+
+  async mapModulesFromPage(page, moduleName, callback) {
+	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.');
+	const protectedPage = JSON.parse(JSON.stringify(page));
+	let found = false;
+	const search = async (modulePiece) => {
+	  for (const key of Object.keys(modulePiece)) {
+		const module = modulePiece[key];
+		if (!module || typeof (module) !== 'object') continue;
+		if (module.component === moduleName) {
+		  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;
 		}
-	) {
-		return await getStructuredData(this._env, contentType, site, language, queryParams);
+		await search(module);
+	  }
+	};
+	await search(protectedPage);
+	if (!found && this._env.verbose) console.log(`\tModule ${moduleName} not found.`);
+	return protectedPage;
+  };
+
+  async mapModules(callback, moduleName, template) {
+	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);
+	await this.mapPages(fixPage, template);
+  };
+
+  async savePage(page) {
+	return await savePage(this._env, page);
+  };
+
+  async getPage(id) {
+	return await getPage(this._env, id);
+  };
+
+  async deletePage(id) {
+	return await deletePage(this._env, id);
+  };
+
+  async restorePage(id) {
+	return await restorePage(this._env, id);
+  };
+
+  async getStructuredDataByID(id) {
+	return await getStructuredDataByID(this._env, id);
+  }
+
+  async getStructuredData(
+   contentType,
+   site = null,
+   language = null,
+   queryParams = {
+	 page: 0,
+	 itemsPerPage: 0,
+	 pagination: false,
+	 deleted: false,
+	 includeDraft: true,
+	 relatedFields: false,
+	 query: null,
+   },
+  ) {
+	return await getStructuredData(this._env, contentType, site, language, queryParams);
+  }
+
+  async getPaginationStructuredData(
+   contentType,
+   site = null,
+   language = null,
+   queryParams = {
+	 page: 1,
+	 itemsPerPage: 50,
+	 pagination: true,
+	 deleted: false,
+	 includeDraft: false,
+	 relatedFields: false,
+	 query: null,
+	 related: null,
+   },
+  ) {
+	return await getStructuredData(this._env, contentType, site, language, queryParams);
+  }
+
+  async saveStructuredData(structuredData) {
+	return await saveStructuredData(this._env, structuredData);
+  };
+
+  async deleteStructuredData(id) {
+	return await deleteStructuredData(this._env, id);
+  };
+
+  async mapStructuredData(callback, contentType) {
+	if (this._env.verbose) console.log(`\nMapping ${contentType || 'all'} structured data with callback function ${callback.name}...`);
+	if (!callback || typeof (callback) !== 'function') throw new Error('Cannot map structured data without a callback function.');
+	const content = await getStructuredData(this._env, contentType);
+	if (!content?.length) {
+	  if (this._env.verbose) console.log('- No structured data found.');
+	  return;
 	}
-
-	async getPaginationStructuredData(
-		contentType,
-		site = null,
-		language = null,
-		queryParams = {
-			page: 1,
-			itemsPerPage: 50,
-			pagination: true,
-			deleted: false,
-			includeDraft: false,
-			relatedFields: false,
-			query: null,
-			related: null
-		}
-	) {
-		return await (this._env, contentType, site, language, queryParams);
+	for (const structuredData of content) {
+	  if (this._env.verbose) console.log('- Mapping structured data', structuredData.id);
+	  const dataProtected = JSON.parse(JSON.stringify(structuredData));
+	  const result = await callback(dataProtected);
+	  if (result && JSON.stringify(structuredData) !== JSON.stringify(result)) {
+		await saveStructuredData(this._env, result)
+	  }
 	}
+  };
 
-	async saveStructuredData(structuredData) {
-		return await saveStructuredData(this._env, structuredData);
-	};
-
-	async deleteStructuredData(id) {
-		return await deleteStructuredData(this._env, id);
-	};
+  async api(...params) {
+	return await api(this._env, ...params);
+  };
 
-	async mapStructuredData(callback, contentType) {
-		if (this._env.verbose) console.log(`\nMapping ${contentType || "all"} structured data with callback function ${callback.name}...`);
-		if (!callback || typeof (callback) !== "function") throw new Error("Cannot map structured data without a callback function.");
-		const content = await getStructuredData(this._env, contentType);
-		if (!content?.length) {
-			if (this._env.verbose) console.log("- No structured data found.");
-			return;
-		}
-		for (const structuredData of content) {
-			if (this._env.verbose) console.log("- Mapping structured data", structuredData.id);
-			const dataProtected = JSON.parse(JSON.stringify(structuredData));
-			const result = await callback(dataProtected);
-			if (result && JSON.stringify(structuredData) !== JSON.stringify(result)) {
-				await saveStructuredData(this._env, result);
-			}
-		}
-	};
+  showLog(...text) {
+	console.log(`\t${text.join(' ')} `);
+  };
 
-	async api(...params) {
-		return await api(this._env, ...params);
-	};
-
-	showLog(...text) {
-		console.log(`\t${text.join(" ")} `);
-	};
-
-	async sendAlert(alert) {
-		return await sendAlert(this._env, alert);
-	};
+  async sendAlert(alert) {
+	return await sendAlert(this._env, alert);
+  };
 };
 
 module.exports = SDK;

package/models/structuredData.js

@@ -1,102 +1,101 @@
-const { api } = require("../api");
+const {api} = require('../api');
 
 const getStructuredData = async (
-	env,
-	contentType,
-	site = null,
-	language = null,
-	queryParams = {
-		page: 0,
-		itemsPerPage: 0,
-		pagination: false,
-		deleted: false,
-		includeDraft: true,
-		relatedFields: false,
-		query: null,
-		related: null
-	}
+ env,
+ contentType,
+ site = null,
+ language = null,
+ queryParams = {
+   page: 0,
+   itemsPerPage: 0,
+   pagination: false,
+   deleted: false,
+   includeDraft: true,
+   relatedFields: false,
+   query: null,
+   related: null,
+ },
 ) => {
-	const headers = {
-		lang: language
-	};
+  const headers = {
+	lang: language,
+  };
 
-	if (!queryParams.pagination) {
-		delete queryParams.page;
-		delete queryParams.itemsPerPage;
-		delete queryParams.deleted;
-		delete queryParams.relatedFields;
-	}
+  if (!queryParams.pagination) {
+	delete queryParams.page
+	delete queryParams.itemsPerPage
+	delete queryParams.deleted
+	delete queryParams.relatedFields
+  }
 
-	if (!queryParams.query) {
-		delete queryParams.query;
-	}
+  if (!queryParams.query) {
+	delete queryParams.query
+  }
 
-	const query = new URLSearchParams(queryParams).toString();
-	const path = `${site ? `/site/${site}` : ""}/structured_data_contents/${contentType || ""}?${query}`;
+  const query = new URLSearchParams(queryParams).toString();
+  const path = `${site ? `/site/${site}` : ''}/structured_data_contents/${contentType || ''}?${query}`
 
-	const items = await api(env, "get", path, null, headers)
-		.then(data => {
-			if (queryParams.pagination) {
-				data.page = queryParams.page
-				return data
-			}
-
-			return data.items
-		});
-	if (env.verbose) {
-		console.log(`\tStructured data ${contentType} loaded.`);
-	}
-	return items;
+  const items = await api(env, 'get', path, null, headers)
+   .then(data => {
+		 if (queryParams.pagination) {
+			 data.page = queryParams.page
+			 return data
+		 }
+		 return data.items
+	 });
+  if (env.verbose) {
+	console.log(`\tStructured data ${contentType} loaded.`);
+  }
+  return items;
 };
 
 const getStructuredDataByID = async (
-	env,
-	id
+ env,
+ id
 ) => {
-	const headers = {};
-	const path = `/structured_data_content/${id}`;
+  const headers = {};
+  const path = `/structured_data_content/${id}`
 
-	const items = await api(env, "get", path, null, headers)
-		.then(data => data);
+  const items = await api(env, 'get', path, null, headers)
+   .then(data => data);
 
-	if (env.verbose) {
-		console.log(`\tStructured data by content ID: ${id} loaded.`);
-	}
+  if (env.verbose) {
+	console.log(`\tStructured data by content ID: ${id} loaded.`);
+  }
 
-	return items;
-};
+  return items;
+}
 
 const saveStructuredData = async (env, structuredData) => {
-	const actions = {
-		new: {
-			method: "post",
-			endpoint: "/structured_data_content/",
-			actionName: "created"
-		},
-		update: {
-			method: "put",
-			endpoint: `/structured_data_content/${structuredData.id}`,
-			actionName: "updated"
-		}
-	};
-	const {
-		method,
-		endpoint,
-		actionName
-	} = actions[structuredData.id ? "update" : "new"];
-	const savedItem = await api(env, method, endpoint, structuredData);
-	if (env.verbose) console.log(`\tStructured data ${structuredData?.content?.title || structuredData?.content?.label || "untitled"} in ${structuredData.structuredData} ${actionName}.`);
-	return savedItem;
+  const actions = {
+	new: {
+	  method: 'post',
+	  endpoint: '/structured_data_content/',
+	  actionName: 'created',
+	},
+	update: {
+	  method: 'put',
+	  endpoint: `/structured_data_content/${structuredData.id}`,
+	  actionName: 'updated',
+	},
+  };
+  const {
+	method,
+	endpoint,
+	actionName,
+  } = actions[structuredData.id ? 'update' : 'new'];
+  const savedItem = await api(env, method, endpoint, structuredData);
+  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}`);
+  if (env.verbose) console.log('\tDelete structured data', id);
+  return api(env, 'delete', `/structured_data_content/${id}`);
 };
 
 module.exports = {
-	getStructuredData,
-	getStructuredDataByID,
-	saveStructuredData,
-	deleteStructuredData
+  getStructuredData,
+  getStructuredDataByID,
+  saveStructuredData,
+  deleteStructuredData,
 };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "griddo-sdk",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test:example": "node examples/runTest.js",
     "release": "bumpp --commit --push --tag"
   },
   "repository": {
@@ -21,6 +21,7 @@
     "axios": "0.26.0"
   },
   "devDependencies": {
-    "bumpp": "^9.4.1"
+    "bumpp": "^9.4.1",
+    "dotenv": "^16.4.5"
   }
 }