@agility/content-sync 1.2.0 → 1.2.4

package/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - package.json
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Upgrade npm for Trusted Publisher OIDC support
+        run: npm install -g npm@latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish
+        run: npm publish --access public --provenance

package/dist/agility-sync-sdk.node.js

@@ -14482,21 +14482,21 @@ main_default.a.config({
  * @param {String} params.itemType - The type of item being saved/updated, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
  * @param {String} params.languageCode - The locale code associated to the item being saved/updated
  * @param {(String|Number)} params.itemID - The ID of the item being saved/updated - this could be a string or number depending on the itemType
- * @returns {Void}
+ * @returns {promise<void>}
  */
 var saveItem = /*#__PURE__*/function () {var _ref2 = asyncToGenerator_default()(/*#__PURE__*/regenerator_default.a.mark(function _callee(_ref) {var options, item, itemType, languageCode, itemID, filePath, dirPath, json;return regenerator_default.a.wrap(function (_context) {while (1) switch (_context.prev = _context.next) {case 0:options = _ref.options, item = _ref.item, itemType = _ref.itemType, languageCode = _ref.languageCode, itemID = _ref.itemID;
 
           filePath = store_interface_filesystem_getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });
 
-          dirPath = external_path_default.a.dirname(filePath);
+          dirPath = external_path_default.a.dirname(filePath);if (
 
 
-          if (!external_fs_default.a.existsSync(dirPath)) {
-            external_fs_default.a.mkdirSync(dirPath, { recursive: true });
-          }
+          external_fs_default.a.existsSync(dirPath)) {_context.next = 1;break;}_context.next = 1;return (
+            external_fs_default.a.promises.mkdir(dirPath, { recursive: true }));case 1:
+
 
-          json = JSON.stringify(item);
-          external_fs_default.a.writeFileSync(filePath, json);case 1:case "end":return _context.stop();}}, _callee);}));return function saveItem(_x) {return _ref2.apply(this, arguments);};}();
+          json = JSON.stringify(item);_context.next = 2;return (
+            external_fs_default.a.promises.writeFile(filePath, json));case 2:case "end":return _context.stop();}}, _callee);}));return function saveItem(_x) {return _ref2.apply(this, arguments);};}();
 
 /**
  * The function to handle deleting an item to your storage. This could be a Content Item, Page, Url Redirections, Sync State (state), or Sitemap.
@@ -14506,15 +14506,15 @@ var saveItem = /*#__PURE__*/function () {var _ref2 = asyncToGenerator_default()(
  * @param {String} params.itemType - The type of item being deleted, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
  * @param {String} params.languageCode - The locale code associated to the item being saved/updated
  * @param {(String|Number)} params.itemID - The ID of the item being deleted - this could be a string or number depending on the itemType
- * @returns {Void}
+ * @returns {promise<void>}
  */
 var deleteItem = /*#__PURE__*/function () {var _ref4 = asyncToGenerator_default()(/*#__PURE__*/regenerator_default.a.mark(function _callee2(_ref3) {var options, itemType, languageCode, itemID, filePath;return regenerator_default.a.wrap(function (_context2) {while (1) switch (_context2.prev = _context2.next) {case 0:options = _ref3.options, itemType = _ref3.itemType, languageCode = _ref3.languageCode, itemID = _ref3.itemID;
 
-          filePath = store_interface_filesystem_getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });
+          filePath = store_interface_filesystem_getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });if (!
+
+          external_fs_default.a.existsSync(filePath)) {_context2.next = 1;break;}_context2.next = 1;return (
+            external_fs_default.a.promises.unlink(filePath));case 1:case "end":return _context2.stop();}}, _callee2);}));return function deleteItem(_x2) {return _ref4.apply(this, arguments);};}();
 
-          if (external_fs_default.a.existsSync(filePath)) {
-            external_fs_default.a.unlinkSync(filePath);
-          }case 1:case "end":return _context2.stop();}}, _callee2);}));return function deleteItem(_x2) {return _ref4.apply(this, arguments);};}();
 
 
 /**
@@ -14527,7 +14527,7 @@ var deleteItem = /*#__PURE__*/function () {var _ref4 = asyncToGenerator_default(
  * @param {(String|Number)} params.itemID - The ID of the item being updated - this could be a string or number depending on the itemType
  * @param {String} params.referenceName - The reference name of the Content List that this Content Item should be added to
  * @param {String} params.definitionName - The Model name that the Content Item is based on
- * @returns {Void}
+ * @returns {Promise<void>}
  */
 var mergeItemToList = /*#__PURE__*/function () {var _ref6 = asyncToGenerator_default()(/*#__PURE__*/regenerator_default.a.mark(function _callee3(_ref5) {var options, item, languageCode, itemID, referenceName, definitionName, contentList, cIndex;return regenerator_default.a.wrap(function (_context3) {while (1) switch (_context3.prev = _context3.next) {case 0:options = _ref5.options, item = _ref5.item, languageCode = _ref5.languageCode, itemID = _ref5.itemID, referenceName = _ref5.referenceName, definitionName = _ref5.definitionName;_context3.next = 1;return (
 
@@ -14571,15 +14571,15 @@ var mergeItemToList = /*#__PURE__*/function () {var _ref6 = asyncToGenerator_def
  * @param {String} params.itemType - The type of item being accessed, expected values are `item`, `list`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
  * @param {String} params.languageCode - The locale code associated to the item being accessed
  * @param {(String|Number)} params.itemID - The ID of the item being accessed - this could be a string or number depending on the itemType
- * @returns {Object}
+ * @returns {Promise<Object>}
  */
 var getItem = /*#__PURE__*/function () {var _ref8 = asyncToGenerator_default()(/*#__PURE__*/regenerator_default.a.mark(function _callee4(_ref7) {var options, itemType, languageCode, itemID, filePath, json;return regenerator_default.a.wrap(function (_context4) {while (1) switch (_context4.prev = _context4.next) {case 0:options = _ref7.options, itemType = _ref7.itemType, languageCode = _ref7.languageCode, itemID = _ref7.itemID;
           filePath = store_interface_filesystem_getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });if (
 
-          external_fs_default.a.existsSync(filePath)) {_context4.next = 1;break;}return _context4.abrupt("return", null);case 1:
+          external_fs_default.a.existsSync(filePath)) {_context4.next = 1;break;}return _context4.abrupt("return", null);case 1:_context4.next = 2;return (
 
-          json = external_fs_default.a.readFileSync(filePath, 'utf8');return _context4.abrupt("return",
-          JSON.parse(json));case 2:case "end":return _context4.stop();}}, _callee4);}));return function getItem(_x4) {return _ref8.apply(this, arguments);};}();
+            external_fs_default.a.promises.readFile(filePath, 'utf8'));case 2:json = _context4.sent;return _context4.abrupt("return",
+          JSON.parse(json));case 3:case "end":return _context4.stop();}}, _callee4);}));return function getItem(_x4) {return _ref8.apply(this, arguments);};}();
 
 
 /**
@@ -14587,10 +14587,10 @@ var getItem = /*#__PURE__*/function () {var _ref8 = asyncToGenerator_default()(/
  * @param {Object} params - The parameters object
  * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
  * @param {String} params.options.rootPath - The path to store/access the content as JSON 
- * @returns {Void}
+ * @returns {Promise<void>}
  */
-var clearItems = /*#__PURE__*/function () {var _ref0 = asyncToGenerator_default()(/*#__PURE__*/regenerator_default.a.mark(function _callee5(_ref9) {var options;return regenerator_default.a.wrap(function (_context5) {while (1) switch (_context5.prev = _context5.next) {case 0:options = _ref9.options;
-          external_fs_default.a.rmdirSync(options.rootPath, { recursive: true });case 1:case "end":return _context5.stop();}}, _callee5);}));return function clearItems(_x5) {return _ref0.apply(this, arguments);};}();
+var clearItems = /*#__PURE__*/function () {var _ref0 = asyncToGenerator_default()(/*#__PURE__*/regenerator_default.a.mark(function _callee5(_ref9) {var options;return regenerator_default.a.wrap(function (_context5) {while (1) switch (_context5.prev = _context5.next) {case 0:options = _ref9.options;_context5.next = 1;return (
+            external_fs_default.a.promises.rmdir(options.rootPath, { recursive: true }));case 1:case "end":return _context5.stop();}}, _callee5);}));return function clearItems(_x5) {return _ref0.apply(this, arguments);};}();
 
 
 
@@ -14603,37 +14603,37 @@ var mutexLock = /*#__PURE__*/function () {var _ref1 = asyncToGenerator_default()
 
 
           dir = external_os_default.a.tmpdir();
-          lockFile = "".concat(dir, "/", "agility-sync", ".mutex");
-          if (!external_fs_default.a.existsSync(lockFile)) {
-            external_fs_default.a.writeFileSync(lockFile, "agility-sync");
-          }
+          lockFile = "".concat(dir, "/", "agility-sync", ".mutex");if (
+          external_fs_default.a.existsSync(lockFile)) {_context6.next = 1;break;}_context6.next = 1;return (
+            external_fs_default.a.promises.writeFile(lockFile, "agility-sync"));case 1:_context6.next = 2;return (
+
+
 
-          //THE LOCK IS ALREADY HELD - WAIT UP!
-          _context6.next = 1;return waitOnLock(lockFile);case 1:_context6.prev = 1;return _context6.abrupt("return",
+            waitOnLock(lockFile));case 2:_context6.prev = 2;return _context6.abrupt("return",
 
 
-          Object(proper_lockfile["lockSync"])(lockFile));case 2:_context6.prev = 2;_t = _context6["catch"](1);if (!(
+          Object(proper_lockfile["lockSync"])(lockFile));case 3:_context6.prev = 3;_t = _context6["catch"](2);if (!(
 
-          "".concat(_t).indexOf("Lock file is already being held") !== -1)) {_context6.next = 8;break;}_context6.next = 3;return (
+          "".concat(_t).indexOf("Lock file is already being held") !== -1)) {_context6.next = 9;break;}_context6.next = 4;return (
 
 
-            sleep(100));case 3:_context6.next = 4;return (
-            waitOnLock(lockFile));case 4:_context6.prev = 4;return _context6.abrupt("return",
+            sleep(100));case 4:_context6.next = 5;return (
+            waitOnLock(lockFile));case 5:_context6.prev = 5;return _context6.abrupt("return",
 
 
-          Object(proper_lockfile["lockSync"])(lockFile));case 5:_context6.prev = 5;_t2 = _context6["catch"](4);if (!(
+          Object(proper_lockfile["lockSync"])(lockFile));case 6:_context6.prev = 6;_t2 = _context6["catch"](5);if (!(
 
-          "".concat(_t).indexOf("Lock file is already being held") !== -1)) {_context6.next = 8;break;}_context6.next = 6;return (
+          "".concat(_t).indexOf("Lock file is already being held") !== -1)) {_context6.next = 9;break;}_context6.next = 7;return (
 
 
-            sleep(100));case 6:_context6.next = 7;return (
-            waitOnLock(lockFile));case 7:return _context6.abrupt("return",
-          Object(proper_lockfile["lockSync"])(lockFile));case 8:throw (
+            sleep(100));case 7:_context6.next = 8;return (
+            waitOnLock(lockFile));case 8:return _context6.abrupt("return",
+          Object(proper_lockfile["lockSync"])(lockFile));case 9:throw (
 
 
 
 
-            Error("The mutex lock could not be obtained."));case 9:case "end":return _context6.stop();}}, _callee6, null, [[1, 2], [4, 5]]);}));return function mutexLock() {return _ref1.apply(this, arguments);};}();
+            Error("The mutex lock could not be obtained."));case 10:case "end":return _context6.stop();}}, _callee6, null, [[2, 3], [5, 6]]);}));return function mutexLock() {return _ref1.apply(this, arguments);};}();
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/content-sync",
-  "version": "1.2.0",
+  "version": "1.2.4",
   "description": "JavaScript SDK for synchronizing content from Agility CMS",
   "main": "dist/agility-sync-sdk.node.js",
   "scripts": {

package/src/store-interface-filesystem.js

@@ -1,8 +1,8 @@
 import fs from 'fs'
 import os from 'os'
 import path from 'path'
-import { sleep } from "./util.js"
-import { lockSync, unlockSync, checkSync, check } from "proper-lockfile"
+import { sleep } from "./util"
+import { lockSync, check } from "proper-lockfile"
 import dotenv from "dotenv"
 
 dotenv.config({
@@ -18,7 +18,7 @@ dotenv.config({
  * @param {String} params.itemType - The type of item being saved/updated, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
  * @param {String} params.languageCode - The locale code associated to the item being saved/updated
  * @param {(String|Number)} params.itemID - The ID of the item being saved/updated - this could be a string or number depending on the itemType
- * @returns {Void}
+ * @returns {promise<void>}
  */
 const saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
 
@@ -28,11 +28,11 @@ const saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
 
 
 	if (!fs.existsSync(dirPath)) {
-		fs.mkdirSync(dirPath, { recursive: true });
+		await fs.promises.mkdir(dirPath, { recursive: true });
 	}
 
 	let json = JSON.stringify(item);
-	fs.writeFileSync(filePath, json);
+	await fs.promises.writeFile(filePath, json);
 }
 /**
  * The function to handle deleting an item to your storage. This could be a Content Item, Page, Url Redirections, Sync State (state), or Sitemap.
@@ -42,14 +42,14 @@ const saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
  * @param {String} params.itemType - The type of item being deleted, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
  * @param {String} params.languageCode - The locale code associated to the item being saved/updated
  * @param {(String|Number)} params.itemID - The ID of the item being deleted - this could be a string or number depending on the itemType
- * @returns {Void}
+ * @returns {promise<void>}
  */
 const deleteItem = async ({ options, itemType, languageCode, itemID }) => {
 
 	let filePath = getFilePath({ options, itemType, languageCode, itemID });
 
 	if (fs.existsSync(filePath)) {
-		fs.unlinkSync(filePath);
+		await fs.promises.unlink(filePath);
 	}
 
 }
@@ -63,7 +63,7 @@ const deleteItem = async ({ options, itemType, languageCode, itemID }) => {
  * @param {(String|Number)} params.itemID - The ID of the item being updated - this could be a string or number depending on the itemType
  * @param {String} params.referenceName - The reference name of the Content List that this Content Item should be added to
  * @param {String} params.definitionName - The Model name that the Content Item is based on
- * @returns {Void}
+ * @returns {Promise<void>}
  */
 const mergeItemToList = async ({ options, item, languageCode, itemID, referenceName, definitionName }) => {
 
@@ -107,14 +107,14 @@ const mergeItemToList = async ({ options, item, languageCode, itemID, referenceN
  * @param {String} params.itemType - The type of item being accessed, expected values are `item`, `list`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
  * @param {String} params.languageCode - The locale code associated to the item being accessed
  * @param {(String|Number)} params.itemID - The ID of the item being accessed - this could be a string or number depending on the itemType
- * @returns {Object}
+ * @returns {Promise<Object>}
  */
 const getItem = async ({ options, itemType, languageCode, itemID }) => {
 	let filePath = getFilePath({ options, itemType, languageCode, itemID });
 
 	if (!fs.existsSync(filePath)) return null;
 
-	let json = fs.readFileSync(filePath, 'utf8');
+	let json = await fs.promises.readFile(filePath, 'utf8');
 	return JSON.parse(json);
 }
 
@@ -123,10 +123,10 @@ const getItem = async ({ options, itemType, languageCode, itemID }) => {
  * @param {Object} params - The parameters object
  * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
  * @param {String} params.options.rootPath - The path to store/access the content as JSON 
- * @returns {Void}
+ * @returns {Promise<void>}
  */
 const clearItems = async ({ options }) => {
-	fs.rmdirSync(options.rootPath, { recursive: true })
+	await fs.promises.rmdir(options.rootPath, { recursive: true })
 }
 
 
@@ -141,7 +141,7 @@ const mutexLock = async () => {
 	const dir = os.tmpdir();
 	const lockFile = `${dir}/${"agility-sync"}.mutex`
 	if (! fs.existsSync(lockFile)) {
-		fs.writeFileSync(lockFile, "agility-sync");
+		await fs.promises.writeFile(lockFile, "agility-sync");
 	}
 
 	//THE LOCK IS ALREADY HELD - WAIT UP!
@@ -199,4 +199,4 @@ export default {
 	getItem,
 	clearItems,
 	mutexLock
-}
+}

package/.github/workflows/publish.yaml

@@ -1,29 +0,0 @@
-name: Publish to NPM
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Use Node.js 20
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org/'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test
-
-      - name: Publish to NPM
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}