{"id":31391668,"url":"https://github.com/customink/signalerjs","last_synced_at":"2025-09-29T02:48:58.462Z","repository":{"id":44529719,"uuid":"44267373","full_name":"customink/signalerjs","owner":"customink","description":"JavaScript A/B testing feature flag library","archived":false,"fork":false,"pushed_at":"2024-07-18T12:28:20.000Z","size":222,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":81,"default_branch":"master","last_synced_at":"2025-09-18T03:00:51.423Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/customink.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-14T18:17:50.000Z","updated_at":"2024-07-29T09:21:13.000Z","dependencies_parsed_at":"2024-07-17T23:44:19.045Z","dependency_job_id":"7d060a64-7271-4246-9bc8-410dddf0f2f1","html_url":"https://github.com/customink/signalerjs","commit_stats":{"total_commits":32,"total_committers":4,"mean_commits":8.0,"dds":0.40625,"last_synced_commit":"edda3b55419d13d288414cf159d793b37c427f3c"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/customink/signalerjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/customink%2Fsignalerjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/customink%2Fsignalerjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/customink%2Fsignalerjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/customink%2Fsignalerjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/customink","download_url":"https://codeload.github.com/customink/signalerjs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/customink%2Fsignalerjs/sbom","scorecard":{"id":313135,"data":{"date":"2025-08-11","repo":{"name":"github.com/customink/signalerjs","commit":"ff0643644b9f0a9bd70626bfef234f759913432c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Code-Review","score":7,"reason":"Found 7/10 approved changesets -- score normalized to 7","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":"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/stale.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/customink/signalerjs/stale.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction 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":"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":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/stale.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":"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":"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":"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":"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 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":"21 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-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-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","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-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","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-17T23:34:14.256Z","repository_id":44529719,"created_at":"2025-08-17T23:34:14.256Z","updated_at":"2025-08-17T23:34:14.256Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277401975,"owners_count":25812010,"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-09-28T02:00:08.834Z","response_time":79,"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":[],"created_at":"2025-09-29T02:48:55.588Z","updated_at":"2025-09-29T02:48:58.454Z","avatar_url":"https://github.com/customink.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/signalerjs.svg)](http://badge.fury.io/js/signalerjs)\n[![Build Status](https://secure.travis-ci.org/customink/signalerjs.svg?branch=master)](http://travis-ci.org/customink/signalerjs)\n[![Dependency Status](https://david-dm.org/customink/signalerjs.svg)](https://david-dm.org/customink/signalerjs)\n\n# Signalerjs\n\n`Signalerjs` is an [AB testing](https://en.wikipedia.org/wiki/A/B_testing) library. It provides a JavaScript interface to sample users into test groups and specify different logic depending on the test group in which a user has been placed. We will refer to each test as a \"feature\" and the different test groups per \"feature\" as \"feature flags\" (hence the name \"Signaler\").\n\n## Installation\n\n- `npm install --save signalerjs`\n\n## Requirements\n\nNote that if you plan to use `Signalerjs` in browsers that do not have [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) support, you will need to polyfill it yourself with something like [`es6-promise`](https://github.com/jakearchibald/es6-promise).\n\n## Setup\n\n```js\n// es6\nimport Signaler from 'signalerjs';\n\n// es5 with modules\nvar Signaler = require('signalerjs');\n\n// es5 without modules\n// add script tag from node_modules/signalerjs/dist/signalerjs.min.js\nvar Signaler = window.signalerjs;\n```\n\n## Configuration\n\n`Signalerjs` can get feature flag information from a server endpoint or from a JavaScript object on initialization.\n\n### With Server\n\n`Signalerjs` can work in conjunction with a server endpoint that provides JSON data about the features. In this case, the endpoint url needs to be specified in the constructor. [Server endpoint requirements](docs/server_requirements.md).\n\n```js\nvar serverEndpoint = '/features';\nvar signal = new Signaler(serverEndpoint);\n```\n\n### Without Server\n\n`Signalerjs` can also work entirely on the client-side without the need for a server. In this case the features with their possible flags are specified as an object in the constructor. See [feature definition docs](docs/feature_definition.md);\n\n```js\nvar features = {\n  featureOne: {\n    expires: 30,\n    flags: ['test', 'control', 'other'],\n  },\n  featureTwo: {\n    expires: '15 Jan 2016 20:28:44 GMT',\n    flags: ['test', 'control']\n  },\n  featureThree:\n    expires: 30,\n    flags: {\n      flagValue: 0.3,\n      control: 0.7\n    }\n  }\n};\nvar signal = new Signaler(features);\n```\n\n### Other Config\n\nSee [configuration docs](docs/configuration.md) for more details and customizing cookie option settings.\n\n## General API\n\nSee full [API docs](docs/api.md).\n\n```js\n// get feature flags user is opted into\nsignal.featureFlags().then(function (flags) {\n  // flags =\u003e\n  // {\n  //   flagOne: 'test',\n  //   flagTwo: 'control',\n  //   anotherFlag: 'flagValue',\n  //   // user has not yet been sampled into this test group\n  //   yetAnother: undefined\n  // }\n});\n```\n\n## Example AB Test Usage/Reading values\n\n### With Server\n```js\nsignal.featureFlagFromServer('flagOne').then(function(flag) {\n  if (flag === 'test') {\n    // custom logic if user has 'test' flag for feature 'flagOne'\n  else if (flag === 'control') {\n    // custom logic if user has 'control' flag for feature 'flagOne'\n  } else {\n    // other logic\n  }\n});\n```\n\n### Without Server\n```js\nconst flag = signal.featureFlag('flagOne')\nif (flag === 'test') {\n  // custom logic if user has 'test' flag for feature 'flagOne'\nelse if (flag === 'control') {\n  // custom logic if user has 'control' flag for feature 'flagOne'\n} else {\n  // other logic\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustomink%2Fsignalerjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcustomink%2Fsignalerjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustomink%2Fsignalerjs/lists"}