@symbo.ls/sdk 2.34.13 → 2.34.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@symbo.ls/sdk",
-  "version": "2.34.13",
+  "version": "2.34.15",
   "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.13",
-    "@domql/utils": "^2.34.13",
+    "@domql/element": "^2.34.15",
+    "@domql/utils": "^2.34.15",
     "@grafana/faro-web-sdk": "^1.19.0",
     "@grafana/faro-web-tracing": "^1.19.0",
-    "@symbo.ls/router": "^2.34.13",
-    "@symbo.ls/socket": "^2.34.13",
+    "@symbo.ls/router": "^2.34.15",
+    "@symbo.ls/socket": "^2.34.15",
     "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": "4b0e55d013de46eda9fc59b029bf46217901282c"
+  "gitHead": "d05a21975a9203c920d4238a26b02d9d0a9ca684"
 }

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

@@ -0,0 +1,153 @@
+/* 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('createBranch should return response data', async t => {
+  t.plan(1)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const branchDataMock = {
+    name: 'Test_Branch_Name',
+    source: '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.createBranch(
+    testProjectId,
+    branchDataMock
+  )
+  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',
+        source: 'main'
+      }
+      const testProjectId = badData[ii].projectId
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.createBranch(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',
+      name: ''
+    },
+    {
+      testName: 'False boolean value',
+      name: false
+    },
+    {
+      testName: 'Undefined value',
+      name: undefined
+    },
+    {
+      testName: 'Null value',
+      name: 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 branchName = {
+        name: badData[ii].name,
+        source: 'main'
+      }
+      const testProjectId = 'Test Project ID'
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.createBranch(testProjectId, 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

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

@@ -0,0 +1,173 @@
+/* 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('deleteBranch should return response data', async t => {
+  t.plan(2)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const branchDataMock = {
+    name: 'Test_Branch_Name',
+    branch: 'not_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.deleteBranch(
+    testProjectId,
+    branchDataMock.branch
+  )
+  t.ok(response.success, 'Response successfully returned')
+  t.equal(
+    response.data,
+    responseStub.data,
+    'Actual response matches expected response'
+  )
+  sandbox.restore()
+  t.end()
+})
+
+test('Branch name validation should throw an error when the branch is main', async t => {
+  t.plan(1)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+  try {
+    await branchServiceStub.deleteBranch('Test Project ID', 'main')
+    t.fail('Branch name validation threw an error with an invalid value')
+  } catch (err) {
+    t.equal(
+      err.toString(),
+      'Error: Cannot delete main branch',
+      'deleteBranch successfully threw an error when the main branch is deleted'
+    )
+  }
+  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',
+        branch: 'not_main'
+      }
+      const testProjectId = badData[ii].projectId
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.deleteBranch(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',
+      name: ''
+    },
+    {
+      testName: 'False boolean value',
+      name: false
+    },
+    {
+      testName: 'Undefined value',
+      name: undefined
+    },
+    {
+      testName: 'Null value',
+      name: 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.deleteBranch(testProjectId, badData[ii].name)
+        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

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

@@ -0,0 +1,87 @@
+/* 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('listBranches should return response data', 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)
+  const response = await branchServiceStub.listBranches(testProjectId)
+  t.equal(
+    response,
+    responseStub.data,
+    'Actual response matches expected response'
+  )
+  sandbox.restore()
+  t.end()
+})
+
+function checkProjectIdValidation () {
+  const badData = [
+    {
+      name: 'No Project ID'
+    },
+    {
+      name: 'Empty string',
+      value: ''
+    },
+    {
+      name: 'False boolean value',
+      value: false
+    },
+    {
+      name: 'Undefined value',
+      value: undefined
+    },
+    {
+      name: 'Null value',
+      value: null
+    }
+  ]
+  for (let ii = 0; ii < badData.length; ii++) {
+    test(`Project ID validation should throw an error when: ${badData[ii].name} is passed in`, async t => {
+      t.plan(1)
+      const responseStub = {
+        success: true,
+        data: 'Test data response'
+      }
+      const testProjectId = badData[ii].value
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.listBranches(testProjectId)
+        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].name}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+checkProjectIdValidation()
+// #endregion
+
+// #region Cleanup
+test('teardown', t => {
+  sandbox.restore()
+  t.end()
+})
+// #endregion

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

@@ -0,0 +1,240 @@
+/* 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('renameBranch should return response data', async t => {
+  t.plan(2)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const branchDataMock = {
+    name: 'Test_Branch_Name',
+    branch: 'not_main'
+  }
+  const testProjectId = 'Test Project ID'
+  const testNewBranchName = 'Test_New_Branch_Name'
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+  const response = await branchServiceStub.renameBranch(
+    testProjectId,
+    branchDataMock.branch,
+    testNewBranchName
+  )
+  t.ok(response.success, 'Response successfully returned')
+  t.equal(
+    response.data,
+    responseStub.data,
+    'Actual response matches expected response'
+  )
+  sandbox.restore()
+  t.end()
+})
+
+test('Branch name validation should throw an error when the branch is main', async t => {
+  t.plan(1)
+  const responseStub = {
+    success: true,
+    data: 'Test data response'
+  }
+  const branchServiceStub = new BranchService()
+  sandbox.stub(branchServiceStub, '_requireReady').resolves()
+  sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+  try {
+    await branchServiceStub.renameBranch(
+      'Test Project ID',
+      'main',
+      'Test_New_Branch_Name'
+    )
+    t.fail('Branch name validation threw an error with an invalid value')
+  } catch (err) {
+    t.equal(
+      err.toString(),
+      'Error: Cannot rename main branch',
+      'renameBranch successfully threw an error when the main branch is deleted'
+    )
+  }
+  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',
+        branch: 'not_main'
+      }
+      const testProjectId = badData[ii].projectId
+      const branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.renameBranch(
+          testProjectId,
+          branchDataMock.branch,
+          'Test_New_Branch_Name'
+        )
+        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',
+      name: ''
+    },
+    {
+      testName: 'False boolean value',
+      name: false
+    },
+    {
+      testName: 'Undefined value',
+      name: undefined
+    },
+    {
+      testName: 'Null value',
+      name: 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.renameBranch(
+          testProjectId,
+          badData[ii].name,
+          'Test_New_Branch_Name'
+        )
+        t.fail('Branch name validation threw an error with an invalid value')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          'Error: Current branch name is required',
+          `Branch name validation successfully threw an error with: ${badData[ii].testName}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+
+function checkNewBranchNameValidation () {
+  const badData = [
+    {
+      testName: 'No name'
+    },
+    {
+      testName: 'Empty string',
+      name: ''
+    },
+    {
+      testName: 'False boolean value',
+      name: false
+    },
+    {
+      testName: 'Undefined value',
+      name: undefined
+    },
+    {
+      testName: 'Null value',
+      name: null
+    }
+  ]
+  for (let ii = 0; ii < badData.length; ii++) {
+    test(`New 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 branchServiceStub = new BranchService()
+      sandbox.stub(branchServiceStub, '_requireReady').resolves()
+      sandbox.stub(branchServiceStub, '_request').resolves(responseStub)
+      try {
+        await branchServiceStub.renameBranch(
+          'Test Project ID',
+          'Test_Branch_Name',
+          badData[ii].name
+        )
+        t.fail('Branch name validation threw an error with an invalid value')
+      } catch (err) {
+        t.equal(
+          err.toString(),
+          'Error: New branch name is required',
+          `Branch name validation successfully threw an error with: ${badData[ii].testName}`
+        )
+      }
+      sandbox.restore()
+      t.end()
+    })
+  }
+}
+
+checkBranchDataNameValidation()
+checkNewBranchNameValidation()
+checkProjectIdValidation()
+// #endregion
+
+// #region Cleanup
+test('teardown', t => {
+  sandbox.restore()
+  t.end()
+})
+// #endregion