{"id":24199571,"url":"https://github.com/fivepoint-0/ociconnection","last_synced_at":"2025-10-07T08:09:07.063Z","repository":{"id":57313301,"uuid":"298364878","full_name":"fivepoint-0/ociconnection","owner":"fivepoint-0","description":"This is a library to help connect to a Broadsoft Application Server running the OCI-Provisioning XML-based API (Open Client Interface – Provisioning). With this library, you instantiate it by creating an OCIConnection instance in your code.","archived":false,"fork":false,"pushed_at":"2024-01-24T20:56:57.000Z","size":393,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-14T22:36:10.356Z","etag":null,"topics":["broadsoft","ocip","typescript-library","xml"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fivepoint-0.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-24T18:36:32.000Z","updated_at":"2024-01-24T20:51:22.000Z","dependencies_parsed_at":"2024-10-03T17:11:29.332Z","dependency_job_id":"fd0c82de-ac22-48d8-bd11-b783e2fbd532","html_url":"https://github.com/fivepoint-0/ociconnection","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fivepoint-0/ociconnection","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivepoint-0%2Fociconnection","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivepoint-0%2Fociconnection/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivepoint-0%2Fociconnection/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivepoint-0%2Fociconnection/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fivepoint-0","download_url":"https://codeload.github.com/fivepoint-0/ociconnection/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivepoint-0%2Fociconnection/sbom","scorecard":{"id":401757,"data":{"date":"2025-08-11","repo":{"name":"github.com/fivepoint-0/ociconnection","commit":"4fa03c9f0b8fc3b6d99da2fc5ff5b36b789a833b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"24 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T20:14:11.721Z","repository_id":57313301,"created_at":"2025-08-18T20:14:11.721Z","updated_at":"2025-08-18T20:14:11.721Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278740839,"owners_count":26037481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broadsoft","ocip","typescript-library","xml"],"created_at":"2025-01-13T20:37:05.707Z","updated_at":"2025-10-07T08:09:07.034Z","avatar_url":"https://github.com/fivepoint-0.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to the Broadsoft OCI Application Server Helper Class!\n\n## Changes:\n\n### 1.1.1: adding dist for 1.1.0 \n\n### 1.1.0: fixing sentenceToCamelCase function to work on words that are uppercase acronyms like MAC and converts them to i.e. mac instead of mAC \n\n### .1.0: fixing sentenceToCamelCase function to work on words that are uppercase acronyms like MAC and converts them to i.e. mac instead of mAC \n\n### .1.0: fixing sentenceToCamelCase function to work on words that are uppercase acronyms like MAC and converts them to i.e. mac instead of mAC \n\n### 1.0.39: Making host property public \n\n### 1.0.38: Changing sessionId code. The sessionId does not appear to be showing up in debug. \n\n### 1.0.37: Fixing completeData. Thinking about changing XML parsers. \n\n### 1.0.36: Attempt to fix log in OCIConnection class (3) \n\n### 1.0.35: Attempt to fix log in OCIConnection class (2) \n\n### 1.0.34: Attempt to fix log in OCIConnection class \n\n### 1.0.33: Nothing much changed. \n\n### 1.0.32: Added logging next to debug in the constructor \n\n### 1.0.31: Fixed output type for OCIConnection.command() \n\n### 1.0.30: Changing xml2js function to get rid of saxjs error \n\n### 1.0.29: Fixing SAX-JS error with text root outside of node showing up \n\n### 1.0.28: testing new method for xml helper \n\n### 1.0.27: Fixed isError function again \n\n### 1.0.26: Added extra check on the isError function \n\n### 1.0.25: No changes to code \n\n### 1.0.: No changes to code \n\n### 1.0.24: No code changes for patch 24 \n\n### 1.0.23: No code changes for patch 23 \n\n### 1.0.22: Now building project automatically before publishing.\n\n### 1.0.21: Built project.\n\n### 1.0.20: No breaking changes yet. Had to update the isError function. \n\n### 1.0.19: Added debug function to OCIConnection class. The next version will be a breaking change. \n\nChangelog:\n- Added `setDebug(boolean)` function to the OCIConenction class. This will output the command XML and response XML when `command()` is called.\n- Copied the `isError()` function from the `OCIConnection` class to the `BroadsoftDataUtility` class. In the next version, that function will be removed from the `OCIConnection` class, causing a possible breaking change for some.\n\n### 1.0.18: Added _dist/_ folder again because of type declarations.\n\n### 1.0.17: Fixed parseOciTable and removed _dist/_ folder.\n\n### 1.0.16: Added another data utility function for parseOciTable. \n\nAn example of the arguments would be from a response like ServiceProviderServicePackGetUtilizationListResponse:\n\n```ts\nconst commandResponse = ServiceProviderServicePackGetUtilizationListResponse\n  .BroadsoftDocument\n  .command[0]\n\nconst table = commandResponse.serviceUtilizationTable\nconst names = commandResponse.servicePackNames\n\nconst tableData = BroadsoftDataUtility.parseOciTable(table, names)\n\n// Example format for output:\n\nlet response = [\n  {\n    \"name\": \"ServicePack1\",\n    \"items\": [\n        {\n            \"group\": \"GROUP_ONE\",\n            \"totalPacks\": \"3\",\n            \"assigned\": \"3\"\n        },\n        {\n            \"group\": \"GROUP_THREE\",\n            \"totalPacks\": \"3\",\n            \"assigned\": \"3\"\n        }\n    ]\n  },\n  {\n    \"name\": \"ServicePack2\",\n    \"items\": [\n        {\n            \"group\": \"GROUP_TWO\",\n            \"totalPacks\": \"10\",\n            \"assigned\": \"10\"\n        }\n    ]\n  }\n]\n```\n\n### 1.0.12: Added _dotenv_ and _jest_ to test Broadsoft data utility and main class function calls for better development. Planning to add easy docker deployment to this project for 1.0.13.\n\nEasy Setup for project using _dotenv_ and _ociconnection_:\n\n`.env` File Setup:\n```dotenv\nBROADSOFT_TEST_HOST=\u003cIP ADDRESS/HOST NAME OF OCI SERVER HERE\u003e\nBROADSOFT_TEST_PORT=\u003cPORT FOR APPLICATION SERVER API\u003e\nBROADSOFT_TEST_USERNAME=\u003cOCI_USERNAME_HERE\u003e\nBROADSOFT_TEST_PASSWORD=\u003cOCI_PASSWORD_HERE\u003e\n```\n\n\n`index.ts` Minimal File Setup:\n```ts\nimport { OCIConnection } from 'ociconnection'\n\nconst main = async () =\u003e {\n\n  const ociConnection = new OCIConnection(\n    \u003cstring\u003eprocess.env.BROADSOFT_TEST_HOST,\n    \u003cstring\u003eprocess.env.BROADSOFT_TEST_PORT,\n    \u003cstring\u003eprocess.env.BROADSOFT_TEST_USERNAME,\n    \u003cstring\u003eprocess.env.BROADSOFT_TEST_PASSWORD\n  )\n\n  await ociConnection.login()\n}\n\nmain()\n```\n\n### 1.0.10: Added a data utility to help with return data from BroadWorks\n\n- Added OCITable helper static function `BroadsoftDataUtility.parseOciTable` to convert e.g. `ociResponse.BroadsoftDocument.command[0].userTable[0]` from \n```ts\nimport { OCIConnection } from 'ociconnection'\nimport BroadsoftDataUtility from 'ociconnection'\n\nconst ociConnection = new OCIConnection('1.1.1.1', '3333', 'broadworks_user', 'broadworks_password')\n\nawait ociConnection.login()\n/*\nOr instead of `await ociConnection.login()`:\n  const loggedIn = ociConnection.login()\n  loggedIn\n    .then(() =\u003e {\n    / * code that happens after successful response from server * /\n    })\n    .catch(() =\u003e {\n    / * code that happens after failed response from server * /\n    })\n\n*/\nconst ociResponse = await ociConnection.command('UserGetListInServiceProviderRequest', {\n    serviceProviderId: \u003cstring\u003eenterpriseId\n})\n/*\nOr instead of using `await` here:\n  const ociResponse = ociConnection.command(...)\n\n  ociResponse\n    .then(response =\u003e / * Deal with XML/object response here * /)\n    .catch(serverError =\u003e / * Deal with server error here * /)\n*/\n\nconst table = BroadsoftDataUtility.parseOciTable(ociResponse.BroadsoftDocument.command[0].userTable[0])\n\nconsole.log(table) \n\n```\n\n### 1.0.8: Had an issue with receiving entire BroadsoftDocument in parser under the `command` function.\n\n### 1.0.4: Added 'isError' static function to OCIConnection class. Took out console logs.\nHi! And welcome. **ociconnection** is a module used to connect to a Broadsoft/BroadWorks Application Server. This package is available at npmjs.org \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivepoint-0%2Fociconnection","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffivepoint-0%2Fociconnection","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivepoint-0%2Fociconnection/lists"}