{"id":15474940,"url":"https://github.com/linuxbozo/brij-spec","last_synced_at":"2025-10-04T16:45:09.399Z","repository":{"id":23257017,"uuid":"26615190","full_name":"LinuxBozo/brij-spec","owner":"LinuxBozo","description":"Business Rules in JSON - A DSL for common rule definitions parseable by any rule engine","archived":false,"fork":false,"pushed_at":"2015-12-01T21:15:28.000Z","size":33,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-22T21:01:32.316Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LinuxBozo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-14T00:47:04.000Z","updated_at":"2024-06-19T19:08:17.000Z","dependencies_parsed_at":"2022-08-21T22:10:49.138Z","dependency_job_id":null,"html_url":"https://github.com/LinuxBozo/brij-spec","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/LinuxBozo/brij-spec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fbrij-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fbrij-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fbrij-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fbrij-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LinuxBozo","download_url":"https://codeload.github.com/LinuxBozo/brij-spec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fbrij-spec/sbom","scorecard":{"id":84777,"data":{"date":"2025-08-11","repo":{"name":"github.com/LinuxBozo/brij-spec","commit":"f82b55db2ee0c6a8a8faccca1eac70b0feb5c54c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":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":"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":"Code-Review","score":0,"reason":"Found 2/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":"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Creative Commons Zero v1.0 Universal: LICENSE:0"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 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"}}]},"last_synced_at":"2025-08-15T06:41:36.553Z","repository_id":23257017,"created_at":"2025-08-15T06:41:36.553Z","updated_at":"2025-08-15T06:41:36.553Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278343068,"owners_count":25971399,"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-04T02:00:05.491Z","response_time":63,"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":"2024-10-02T03:05:53.333Z","updated_at":"2025-10-04T16:45:09.377Z","avatar_url":"https://github.com/LinuxBozo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# brij-spec\n\n[![Build Status](https://travis-ci.org/LinuxBozo/brij-spec.svg)](https://travis-ci.org/LinuxBozo/brij-spec)\n[![Coverage Status](https://coveralls.io/repos/LinuxBozo/brij-spec/badge.svg)](https://coveralls.io/r/LinuxBozo/brij-spec)\n\nBusiness Rules in JSON. A standard, specification and schema.\n\n\u003e We are currently in 0.x.x [versioning](#versioning): some core changes are still being pushed out. A version 1.0.0 will be released following best practices when identified as final.\n\n## Specification Basics\n\nA BRIJ compliant file is a JSON document that contains an array that is a list of objects for each of your rule definitions. In the simplest form, a BRIJ compliant document looks like this:\n```json\n[\n  {\n    \"rule\": {\n      \"condition\": \"email_address\",\n      \"property\": \"user.email\"\n    }\n  }\n]\n```\n\nEach rule object in the array is defined by the following main properties:\n\n - id: *optional*\n - description: *optional*\n - rule: **required**\n    - property: **required**\n    - condition: **required**\n - actions: *optional*\n\nUnless custom actions are defined, the engine should simply evaluate the defined rule as boolean true or false.\n\n### Defining a Rule\n\n#### Valid Conditions\n\n##### Custom function call\n - call\n  - function\n\n##### Formatting\n\n - email_address\n - zipcode\n - yyyy_mm_dd_hh_mm_ss\n - yyyy_mm_dd_hh_mm\n - yyyy_mm_dd\n - mm_dd_yyyy\n - yyyy\n - hh_mm\n - hh_mm_ss\n - matches_regex\n  - value\n\n##### Value Comparison\n\n###### Numeric\n\n - is_integer\n - is_float\n - equal\n  - value\n - equal_property\n  - value\n - not_equal\n  - value\n - not_equal_property\n  - value\n - greater_than\n  - value\n - greater_than_property\n  - value\n - less_than\n  - value\n - less_than_property\n  - value\n - greater_than_or_equal\n  - value\n - greater_than_or_equal_property\n  - value\n - less_than_or_equal\n  - value\n - less_than_or_equal_property\n  - value\n - between\n  - start\n  - end\n\n###### String\n\n - equal\n  - value\n - equal_property\n  - value\n - not_equal\n  - value\n - not_equal_property\n  - value\n - starts_with\n  - value\n - ends_with\n  - value\n - contains\n  - value\n - not_empty\n - is_empty\n\n###### Boolean\n\n - is_true\n - is_false\n\n###### List\n\n - in\n  - values\n - not_in\n  - values\n - contains\n  - value\n - does_not_contain\n  - value\n - includes_all\n  - values\n - includes_none\n  - values\n\n#### Combining Conditions\n\n - if\n - then\n - and\n - or\n\n### Defining Actions\n\n - callOnTrue\n  - args\n - callOnFalse\n  - args\n - returnOnTrue\n - returnOnFalse\n\n## Examples\n\n - [simple_example.json](../../raw/master/examples/simple_example.json)\n - [advanced_example.json](../../raw/master/examples/advanced_example.json)\n\n## Validation\n\nYou'll probably want to validate that your rules are written correctly, so that an engine that adheres to the BRIJ specification can accurately parse, and evaluate your rules.\n\n### As a node library\n\n```shell\nnpm install --save brij-spec\n```\n\nTo validate your rule\n```javascript\nvar brijSpec = require('brij-spec');\nvar result = brijSpec.validate([{rule: {condition: \"equal\", property: \"myProp\"}}]);\n```\n\nMore likely though, you'll want to validate a file with your rules defined\n```javascript\nvar fs = require('fs'),\n    brijSpec = require('brij-spec');\nvar ruleData = fs.readFileSync('my-rule-file.json', 'utf8').toString();\nvar result = brijSpec.validate(ruleData);\n```\n\n### Command line\n\nThere is also a command line client for your convenience.\n\n```shell\nnpm install -g brij-spec\n```\n\nSee `brij-validate --help` for usage:\n\n```shell\nOptions:\n  --filename, -f  JSON rules file to validate\n  --quiet, -q     less output                  [default: false]\n  --help, -h, -?  this help message\n```\n\n## Getting Involved\nWe encourage anyone who's interested in participating in the formation of this standard to join the [discussions here on GitHub](../../issues). Also feel free to fork this project and submit new ideas to add to the `brij-spec` standard.\n\n## Versioning\n`brij-spec` adheres to [Semantic Versioning 2.0.0](SemVer.org). If there is a violation of this scheme, report it as a bug. Specifically, if a patch or minor version is released and breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Any change that breaks the public API will only be introduced at a major-version release. As a result of this policy, you can (and should) specify any dependency on `brij-spec` by using the Pessimistic Version Constraint with two digits of precision.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxbozo%2Fbrij-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinuxbozo%2Fbrij-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxbozo%2Fbrij-spec/lists"}