@symbo.ls/sdk 2.34.24 → 2.34.29

package/dist/cjs/services/PullRequestService.js

@@ -141,7 +141,7 @@ class PullRequestService extends import_BaseService.BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -172,7 +172,7 @@ class PullRequestService extends import_BaseService.BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -199,7 +199,7 @@ class PullRequestService extends import_BaseService.BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {

package/dist/esm/index.js

@@ -48044,7 +48044,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -48075,7 +48075,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -48102,7 +48102,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {

package/dist/esm/services/PullRequestService.js

@@ -918,7 +918,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -949,7 +949,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -976,7 +976,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {

package/dist/esm/services/index.js

@@ -48044,7 +48044,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -48075,7 +48075,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -48102,7 +48102,7 @@ var PullRequestService = class extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {

package/dist/node/services/PullRequestService.js

@@ -119,7 +119,7 @@ class PullRequestService extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -150,7 +150,7 @@ class PullRequestService extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {
@@ -177,7 +177,7 @@ class PullRequestService extends BaseService {
         }
       );
       if (response.success) {
-        return response.data;
+        return response;
       }
       throw new Error(response.message);
     } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@symbo.ls/sdk",
-  "version": "2.34.24",
+  "version": "2.34.29",
   "type": "module",
   "main": "dist/esm/index.js",
   "module": "dist/esm/index.js",
@@ -47,12 +47,12 @@
     "test:unit-all": "cross-env NODE_ENV=$NODE_ENV npx tape src/services/tests/**/*.test.js | tap-spec"
   },
   "dependencies": {
-    "@domql/element": "^2.34.24",
-    "@domql/utils": "^2.34.24",
+    "@domql/element": "^2.34.29",
+    "@domql/utils": "^2.34.29",
     "@grafana/faro-web-sdk": "^1.19.0",
     "@grafana/faro-web-tracing": "^1.19.0",
-    "@symbo.ls/router": "^2.34.24",
-    "@symbo.ls/socket": "^2.34.24",
+    "@symbo.ls/router": "^2.34.29",
+    "@symbo.ls/socket": "^2.34.29",
     "acorn": "^8.14.0",
     "acorn-walk": "^8.3.4",
     "dexie": "^4.0.11",
@@ -75,5 +75,5 @@
     "tap-spec": "^5.0.0",
     "tape": "^5.9.0"
   },
-  "gitHead": "4886a866c3adef97083fc36e3e4db40c1543054d"
+  "gitHead": "90cb8b61065249122ff356c3ea6eb56191c49bfa"
 }

package/src/services/PullRequestService.js

@@ -136,7 +136,7 @@ export class PullRequestService extends BaseService {
         }
       )
       if (response.success) {
-        return response.data
+        return response
       }
       throw new Error(response.message)
     } catch (error) {
@@ -169,7 +169,7 @@ export class PullRequestService extends BaseService {
         }
       )
       if (response.success) {
-        return response.data
+        return response
       }
       throw new Error(response.message)
     } catch (error) {
@@ -199,7 +199,7 @@ export class PullRequestService extends BaseService {
       )
 
       if (response.success) {
-        return response.data
+        return response
       }
       throw new Error(response.message)
     } catch (error) {

package/src/services/tests/BranchService/mergeBranch.test.js

@@ -34,6 +34,29 @@ test('mergeBranch should return response data', async (t) => {
   t.end()
 })
 
+test('mergeBranch should handle error', async (t) => {
+  t.plan(1)
+  const branchDataMock = {
+    name: 'Test_Branch_Name'
+  }
+  const testProjectId = 'Test Project ID'
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').throws('Test Error')
+  try {
+    await branchServiceStub.mergeBranch(testProjectId, branchDataMock.name)
+    t.fail('mergeBranch successfully failed')
+  } catch (err) {
+    t.equal(
+      err.toString(),
+      'Error: Failed to merge branch: Sinon-provided Test Error',
+      'Actual error matches expected error'
+    )
+  }
+  sandbox.restore()
+  t.end()
+})
+
 function checkProjectIdValidation () {
   const badData = [
     {
@@ -135,8 +158,48 @@ function checkBranchDataNameValidation () {
   }
 }
 
+function checkMergeConflictErrorHandling () {
+  const mergeError = [
+    {
+      name: 'merge conflict error',
+      value: 'conflicts',
+      expectedError: 'Error: Merge conflicts detected: Sinon-provided conflicts'
+    },
+    {
+      name: '409 Conflict client error',
+      value: '409',
+      expectedError: 'Error: Merge conflicts detected: Sinon-provided 409'
+    }
+  ]
+  for (let ii = 0; ii < mergeError.length; ii++) {
+    test(`mergeBranch should handle ${mergeError[ii].name}`, async (t) => {
+      t.plan(1)
+      const branchDataMock = {
+        name: 'Test_Branch_Name'
+      }
+      const testProjectId = 'Test Project ID'
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').throws(mergeError[ii].value)
+      try {
+        await branchServiceStub.mergeBranch(testProjectId, branchDataMock.name)
+        t.fail('mergeBranch successfully failed')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          mergeError[ii].expectedError,
+          'Actual error matches expected error'
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+
 checkBranchDataNameValidation()
 checkProjectIdValidation()
+checkMergeConflictErrorHandling()
 // #endregion
 
 // #region Cleanup

package/src/services/tests/BranchService/publishVersion.test.js

@@ -0,0 +1,183 @@
+/* eslint-disable no-undefined */
+import test from 'tape'
+import sinon from 'sinon'
+import { BranchService } from '../../BranchService.js'
+
+// #region Setup
+const sandbox = sinon.createSandbox()
+// #endregion
+
+// #region Tests
+test('publishVersion should return response data', async (t) => {
+  t.plan(1)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const publishVersionMock = {
+    name: 'Test_Branch_Name',
+    version: '1.0.0',
+    branch: 'main'
+  }
+  const testProjectId = 'Test Project ID'
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+  const response = await branchServiceStub.publishVersion(
+    testProjectId,
+    publishVersionMock
+  )
+  t.equal(
+    response,
+    responseStub.data,
+    'Actual response matches expected response'
+  )
+  sandbox.restore()
+  t.end()
+})
+
+test('publishVersion should return response data', async (t) => {
+  t.plan(1)
+  const publishVersionMock = {
+    name: 'Test_Branch_Name',
+    version: '1.0.0',
+    branch: 'main'
+  }
+  const testProjectId = 'Test Project ID'
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').throws('Test Error')
+  try {
+    await branchServiceStub.publishVersion(testProjectId, publishVersionMock)
+    t.fail('publish version threw an error')
+  } catch (err) {
+    t.equal(
+      err.toString(),
+      'Error: Failed to publish version: Sinon-provided Test Error',
+      'Actual error matches expected error'
+    )
+  }
+  sandbox.restore()
+  t.end()
+})
+
+function checkProjectIdValidation () {
+  const badData = [
+    {
+      testName: 'No Project ID'
+    },
+    {
+      testName: 'Empty string',
+      projectId: ''
+    },
+    {
+      testName: 'False boolean value',
+      projectId: false
+    },
+    {
+      testName: 'Undefined value',
+      projectId: undefined
+    },
+    {
+      testName: 'Null value',
+      projectId: null
+    }
+  ]
+  for (let ii = 0; ii < badData.length; ii++) {
+    test(`Project ID validation should throw an error when: ${badData[ii].testName} is passed in`, async (t) => {
+      t.plan(1)
+      const responseStub = {
+        success: true,
+        data: 'Test data response'
+      }
+      const publishVersionMock = {
+        name: 'Test_Branch_Name',
+        version: '1.0.0',
+        branch: 'main'
+      }
+      const testProjectId = badData[ii].projectId
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.publishVersion(
+          testProjectId,
+          publishVersionMock
+        )
+        t.fail('Project ID validation threw an error with an invalid value')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          'Error: Project ID is required',
+          `Project ID validation successfully threw an error with: ${badData[ii].testName}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+
+function checkBranchDataNameValidation () {
+  const badData = [
+    {
+      testName: 'No name',
+      branch: 'main'
+    },
+    {
+      testName: 'Empty string',
+      version: '',
+      branch: 'main'
+    },
+    {
+      testName: 'False boolean value',
+      version: false,
+      branch: 'main'
+    },
+    {
+      testName: 'Undefined value',
+      version: undefined,
+      branch: 'main'
+    },
+    {
+      testName: 'Null value',
+      version: null,
+      branch: 'main'
+    }
+  ]
+  for (let ii = 0; ii < badData.length; ii++) {
+    test(`publishData version validation should throw an error when: ${badData[ii].testName} is passed in`, async (t) => {
+      t.plan(1)
+      const responseStub = {
+        success: true,
+        data: 'Test data response'
+      }
+      const testProjectId = 'Test Project ID'
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.publishVersion(testProjectId, badData[ii])
+        t.fail('Branch name validation threw an error with an invalid value')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          'Error: Version is required',
+          `publishData version validation successfully threw an error with: ${badData[ii].testName}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+checkBranchDataNameValidation()
+checkProjectIdValidation()
+// #endregion
+
+// #region Cleanup
+test('teardown', (t) => {
+  sandbox.restore()
+  t.end()
+})
+// #endregion

package/src/services/tests/BranchService/resetBranch.test.js

@@ -0,0 +1,152 @@
+/* eslint-disable no-undefined */
+import test from 'tape'
+import sinon from 'sinon'
+import { BranchService } from '../../BranchService.js'
+
+// #region Setup
+const sandbox = sinon.createSandbox()
+// #endregion
+
+// #region Tests
+test('resetBranch should return response data', async (t) => {
+  t.plan(1)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const branchDataMock = {
+    name: 'Test_Branch_Name',
+    branchName: 'main'
+  }
+  const testProjectId = 'Test Project ID'
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+  const response = await branchServiceStub.resetBranch(
+    testProjectId,
+    branchDataMock.branchName
+  )
+  t.equal(
+    response,
+    responseStub.data,
+    'Actual response matches expected response'
+  )
+  sandbox.restore()
+  t.end()
+})
+
+function checkProjectIdValidation () {
+  const badData = [
+    {
+      testName: 'No Project ID'
+    },
+    {
+      testName: 'Empty string',
+      projectId: ''
+    },
+    {
+      testName: 'False boolean value',
+      projectId: false
+    },
+    {
+      testName: 'Undefined value',
+      projectId: undefined
+    },
+    {
+      testName: 'Null value',
+      projectId: null
+    }
+  ]
+  for (let ii = 0; ii < badData.length; ii++) {
+    test(`Project ID validation should throw an error when: ${badData[ii].testName} is passed in`, async (t) => {
+      t.plan(1)
+      const responseStub = {
+        success: true,
+        data: 'Test data response'
+      }
+      const branchDataMock = {
+        name: 'Test_Branch_Name',
+        branchName: 'main'
+      }
+      const testProjectId = badData[ii].projectId
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.resetBranch(testProjectId, branchDataMock)
+        t.fail('Project ID validation threw an error with an invalid value')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          'Error: Project ID is required',
+          `Project ID validation successfully threw an error with: ${badData[ii].testName}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+
+function checkBranchDataNameValidation () {
+  const badData = [
+    {
+      testName: 'No name'
+    },
+    {
+      testName: 'Empty string',
+      branchName: ''
+    },
+    {
+      testName: 'False boolean value',
+      branchName: false
+    },
+    {
+      testName: 'Undefined value',
+      branchName: undefined
+    },
+    {
+      testName: 'Null value',
+      branchName: null
+    }
+  ]
+  for (let ii = 0; ii < badData.length; ii++) {
+    test(`Branch name validation should throw an error when: ${badData[ii].testName} is passed in`, async (t) => {
+      t.plan(1)
+      const responseStub = {
+        success: true,
+        data: 'Test data response'
+      }
+      const testProjectId = 'Test Project ID'
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.resetBranch(
+          testProjectId,
+          badData[ii].branchName
+        )
+        t.fail('Branch name validation threw an error with an invalid value')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          'Error: Branch name is required',
+          `Branch name validation successfully threw an error with: ${badData[ii].testName}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+
+checkBranchDataNameValidation()
+checkProjectIdValidation()
+// #endregion
+
+// #region Cleanup
+test('teardown', (t) => {
+  sandbox.restore()
+  t.end()
+})
+// #endregion