{"id":38593580,"url":"https://github.com/intersective/settings-sdk","last_synced_at":"2026-01-17T08:25:58.166Z","repository":{"id":42665060,"uuid":"341039042","full_name":"intersective/settings-sdk","owner":"intersective","description":"SDK for the preferences API","archived":false,"fork":false,"pushed_at":"2023-01-07T05:36:53.000Z","size":288,"stargazers_count":0,"open_issues_count":9,"forks_count":0,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-07-07T01:51:52.141Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/intersective.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}},"created_at":"2021-02-22T00:48:28.000Z","updated_at":"2021-11-18T09:25:47.000Z","dependencies_parsed_at":"2023-02-06T13:00:54.437Z","dependency_job_id":null,"html_url":"https://github.com/intersective/settings-sdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/intersective/settings-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersective%2Fsettings-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersective%2Fsettings-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersective%2Fsettings-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersective%2Fsettings-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intersective","download_url":"https://codeload.github.com/intersective/settings-sdk/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersective%2Fsettings-sdk/sbom","scorecard":{"id":491588,"data":{"date":"2025-08-11","repo":{"name":"github.com/intersective/settings-sdk","commit":"108f25ddb1e6f344684b22ef821ff1dc250b9ee7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Code-Review","score":0,"reason":"Found 0/11 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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/code-security.yml:1","Warn: no topLevel permission defined: .github/workflows/dependabotautomerge.yml:1","Warn: no topLevel permission defined: .github/workflows/lint_unitest-develop.yml:1","Warn: no topLevel permission defined: .github/workflows/lint_unitest-feature.yml:1","Warn: no topLevel permission defined: .github/workflows/lint_unitest-release.yml:1","Warn: no topLevel permission defined: .github/workflows/lint_unitest-trunk.yml:1","Warn: no topLevel permission defined: .github/workflows/npm_package_publish.yml:1","Info: no jobLevel write permissions found"],"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":"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":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code-security.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/code-security.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code-security.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/code-security.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code-security.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/code-security.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/code-security.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/code-security.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependabotautomerge.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/dependabotautomerge.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependabotautomerge.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/dependabotautomerge.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-develop.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-develop.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-develop.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-develop.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-develop.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-develop.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-develop.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-develop.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-feature.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-feature.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-feature.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-feature.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-feature.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-feature.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-feature.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-feature.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-release.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-release.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-release.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-release.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-release.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-release.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-trunk.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-trunk.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint_unitest-trunk.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-trunk.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-trunk.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-trunk.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint_unitest-trunk.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/lint_unitest-trunk.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm_package_publish.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/npm_package_publish.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm_package_publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/npm_package_publish.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm_package_publish.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/intersective/settings-sdk/npm_package_publish.yml/develop?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/lint_unitest-develop.yml:54","Warn: npmCommand not pinned by hash: .github/workflows/lint_unitest-feature.yml:47","Warn: npmCommand not pinned by hash: .github/workflows/lint_unitest-release.yml:47","Warn: npmCommand not pinned by hash: .github/workflows/lint_unitest-trunk.yml:48","Warn: npmCommand not pinned by hash: .github/workflows/npm_package_publish.yml:17","Info:   0 out of  14 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  11 third-party GitHubAction dependencies pinned","Info:   0 out of   5 npmCommand dependencies pinned"],"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":"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":"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":"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":"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":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33","Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959","Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","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-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"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-19T19:18:31.601Z","repository_id":42665060,"created_at":"2025-08-19T19:18:31.601Z","updated_at":"2025-08-19T19:18:31.601Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28504364,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-01-17T08:25:58.076Z","updated_at":"2026-01-17T08:25:58.155Z","avatar_url":"https://github.com/intersective.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @practera/settings-sdk\n\nFacilitates the communication with the Practera preferences API.\n\n## Health\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=intersective_settings-sdk\u0026metric=alert_status\u0026token=19814e72d32dd8ab193bb168320116a41f84beb3)](https://sonarcloud.io/dashboard?id=intersective_settings-sdk)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=intersective_settings-sdk\u0026metric=coverage\u0026token=19814e72d32dd8ab193bb168320116a41f84beb3)](https://sonarcloud.io/dashboard?id=intersective_settings-sdk)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=intersective_settings-sdk\u0026metric=security_rating\u0026token=19814e72d32dd8ab193bb168320116a41f84beb3)](https://sonarcloud.io/dashboard?id=intersective_settings-sdk)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=intersective_settings-sdk\u0026metric=sqale_rating\u0026token=19814e72d32dd8ab193bb168320116a41f84beb3)](https://sonarcloud.io/dashboard?id=intersective_settings-sdk)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=intersective_settings-sdk\u0026metric=bugs\u0026token=19814e72d32dd8ab193bb168320116a41f84beb3)](https://sonarcloud.io/dashboard?id=intersective_settings-sdk)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=intersective_settings-sdk\u0026metric=code_smells\u0026token=19814e72d32dd8ab193bb168320116a41f84beb3)](https://sonarcloud.io/dashboard?id=intersective_settings-sdk)\n\n\n## Install\n\n```\n$ npm install @practera/settings-sdk\n```\n\n## Usage\n\n### setting up the client\nJavaScript:\n```js\nconst Settings = require(\"@practera/settings-sdk\");\n```\n\nTypeScript:\n```js\nimport { Settings } from \"@practera/settings-sdk\";\n```\n\n### Getting and setting settings\n\nGiven this response from the server\n```js\ncategories: [\n  {\n    name: 'Sample Notifications',\n    order: 1,\n    settings: [\n      {\n        description: 'Sample notifications',\n        key: 'sample-key',\n        name: 'Notify me',\n        options: [\n          {\n            locked: false,\n            locked_name: '',\n            medium: 'email',\n            name: 'Email',\n            value: true\n          },\n          {\n            locked: false,\n            locked_name: '',\n            medium: 'sms',\n            name: 'SMS',\n            value: false\n          }\n        ],\n        remarks: 'sample remarks'\n      }\n    ]\n  }\n]\n```\n\nYou can query the result in multiple ways.\n\n```js\nconst client = new Settings(\n  privateKey, // the private key used to sign the request\n  service, // this will identify what public key to use to validate the token, the variable called ${service}_JWT will be used. The variable should contain a key called public and the public key as the value.\n  url, // the URL of the settings API, leave empty for production\n);\n\n// to perform the api call for the data, note this does not return the data but a reference to self. This allows to chain requests if you want.\nclient.get('[uuid]');\n\n// to get the actual data you can\nclient.get('[uuid]');\nexistingSettings = client.data; // the entire response from above\n// or \nexistingSettings = client.get('[uuid]').data; // the entire response from above\n\n\n// to search for a setting in our normal json response \nclient.get('[uuid]');\nexistingSettingEmail = client.findSetting('sample-key', 'email'); // true\nexistingSettingSMS = client.findSetting('sample-key', 'sms'); // false\n// or \nexistingSettingEmail = client.get('[uuid]').findSetting('sample-key', 'email'); // true\nexistingSettingSMS = client.findSetting('sample-key', 'sms'); // false\n\n\n// to search for a specific value in the array you can use a regular expression\nclient.get('[uuid]');\nexistingSettings = client.findValue(/^categories\\.0\\.settings\\.0\\.options\\.1\\.medium$/); // sms\n// or \nexistingSettings = client.get('[uuid]').findValue(/^categories\\.0\\.settings\\.0\\.options\\.1\\.medium$/); // sms\n\n\n// to search for a neighbor or a specific key, you can use. This basically searches all the mediums for the value email then returns the field next to it called 'value'\nclient.get('[uuid]');\nexistingSettings = client.findNeighbor(/^categories\\.0\\.settings\\.0\\.options\\.[0-9]\\.medium$/, \"email\", \"value\"); // true\n// or \nexistingSettings = client.get('[uuid]').findValue(/^categories\\.0\\.settings\\.0\\.options\\.[0-9]\\.medium$/, \"email\", \"value\"); // false\n\n\n// to save data base to the settings\nclient.save('[uuid]', settingsJson);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersective%2Fsettings-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersective%2Fsettings-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersective%2Fsettings-sdk/lists"}