{"id":19197894,"url":"https://github.com/flarebyte/shortquest","last_synced_at":"2026-05-14T13:33:22.451Z","repository":{"id":31282728,"uuid":"34844692","full_name":"flarebyte/shortquest","owner":"flarebyte","description":"HTTP request client supporting shortcut urls ","archived":false,"fork":false,"pushed_at":"2025-09-20T13:46:16.000Z","size":39,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-17T22:41:33.604Z","etag":null,"topics":["dormant","npm-package","unmaintained"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flarebyte.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":"2015-04-30T08:57:17.000Z","updated_at":"2025-09-20T13:47:53.000Z","dependencies_parsed_at":"2022-09-09T04:50:37.519Z","dependency_job_id":null,"html_url":"https://github.com/flarebyte/shortquest","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/flarebyte/shortquest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fshortquest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fshortquest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fshortquest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fshortquest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flarebyte","download_url":"https://codeload.github.com/flarebyte/shortquest/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fshortquest/sbom","scorecard":{"id":402606,"data":{"date":"2025-08-11","repo":{"name":"github.com/flarebyte/shortquest","commit":"b8cc779d537fe50a86c0299978aebdb6092f30c7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":-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":"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/12 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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"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":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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 3 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-18T20:25:09.561Z","repository_id":31282728,"created_at":"2025-08-18T20:25:09.561Z","updated_at":"2025-08-18T20:25:09.561Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33026863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"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":["dormant","npm-package","unmaintained"],"created_at":"2024-11-09T12:19:12.277Z","updated_at":"2026-05-14T13:33:21.666Z","avatar_url":"https://github.com/flarebyte.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image]\n\nRule‑driven HTTP requests with shortcut URIs (curie‑style).\n\nShortquest lets you describe how to transform compact URIs (e.g. `wiki:Picasso`) into full request options using a small declarative rules engine. It can inject headers, auth, SSL, parameters, and more — then execute the request or just return the built options.\n\nKey features\n\n- Shortcut URIs and contextual replacements (e.g., env → stage)\n- Automatic headers/auth/SSL based on rules\n- JSON and form support\n- Streams, callbacks, and Promise API\n- Strong input validation via Joi\n\n## Project Status\n\nThis project is at a crossroads: its future direction and maintenance status are under evaluation. Before adopting in new projects, review modernization options and alternatives in `CODE_ANALYSIS.md`. Contributions are welcome to help decide whether to evolve the library (modern HTTP client, TypeScript, updated tooling) or to archive it in favor of a thin rules layer atop a maintained client.\n\n## Install\n\n```sh\n$ npm install --save shortquest\n```\n\n## Quick Start\n\n```js\nconst shortquest = require(\"shortquest\");\n\nconst rulesConf = {\n  rules: [\n    {\n      when: [{ trigger: \"uri starts with\", value: \"wiki:\" }],\n      then: [\n        { action: \"replace start\", values: [\"wiki:\", \"http://mywiki.com/\"] },\n      ],\n    },\n  ],\n};\n\nconst sq = shortquest(rulesConf);\n\n// Callback style\nsq.request(\"wiki:picasso\", (err, res, body) =\u003e {\n  if (err) return console.error(err);\n  console.log(body); // body for http://mywiki.com/picasso\n});\n\n// Promise/async style\n(async () =\u003e {\n  const [res, body] = await sq.requestAsync(\"wiki:picasso\");\n  console.log(res.statusCode, body);\n})();\n```\n\n## Rules Overview\n\n- All triggers and actions are documented in `RULES.md`.\n- A JSON Schema for rules is available in `shortquest.schema.json`.\n\nExample rule: replace prefix and add a header\n\n```json\n{\n  \"rules\": [\n    {\n      \"when\": [{ \"trigger\": \"uri starts with\", \"value\": \"api:\" }],\n      \"then\": [\n        {\n          \"action\": \"replace start\",\n          \"values\": [\"api:\", \"https://api.example.com/\"]\n        },\n        {\n          \"action\": \"set header parameter\",\n          \"values\": [\"X-Client\", \"shortquest\"]\n        }\n      ]\n    }\n  ]\n}\n```\n\n## Common Examples\n\nPOST JSON (enable JSON handling via rule)\n\n```js\nsq.request(\n  {\n    uri: \"api:articles\",\n    method: \"POST\",\n    body: { title: \"good story\" },\n  },\n  cb\n);\n// Add rule: { action: 'set JSON', values: ['yes'] }\n```\n\nQuery params and forms\n\n```js\nsq.request({ uri: \"wiki:picasso\", parameterObj: { search: \"birth\" } }, cb);\nsq.request(\n  { uri: \"api:submit\", method: \"POST\", formObj: { firstName: \"Pablo\" } },\n  cb\n);\n```\n\nTags (used by rules)\n\n```js\nsq.request(\n  { uri: \"wiki:picasso\", method: \"POST\", tags: [\"sandbox\", \"XML\"] },\n  cb\n);\n```\n\nStreaming/piping\n\n```js\nconst r1 = sq.request(\"curie:latest/123.jpg\");\nconst requests = require(\"request\");\nr1.pipe(requests.request({ uri: \"curie:update/post123.json\", method: \"POST\" }));\n```\n\nSSL from file paths\n\n```js\nconst rulesConf = {\n  rules: [\n    {\n      when: [{ trigger: \"uri starts with\", value: \"curie:\" }],\n      then: [\n        {\n          action: \"set SSL client\",\n          values: [\"test/dummy1.txt\", \"test/dummy2.txt\", \"pass123\"],\n        },\n        {\n          action: \"set SSL Certificate Authority\",\n          values: [\"test/dummy3.txt\"],\n        },\n        { action: \"replace start\", values: [\"curie:\", \"http://myweb.com/\"] },\n      ],\n    },\n  ],\n};\n```\n\nSchema \u0026 docs\n\n- See `RULES.md` for the full list of triggers and actions.\n- See `shortquest.schema.json` for a machine‑readable schema of rules.\n\n## API Surface\n\n- `shortquest(rules)`: factory returning an API.\n- `api.make(quest)`: build request options without executing.\n- `api.request(quest, cb)`: execute with callback.\n- `api.requestAsync(quest)`: Promise that resolves to `[response, body]`.\n- `api.triggersDoc()` / `api.actionsDoc()`: programmatic docs.\n- `api.jsonSchema()`: JSON Schema for rules.\n\n## Development\n\n- Run tests: `npm test`\n- Contributing: see `AGENTS.md`\n- Architecture and modernization notes: see `CODE_ANALYSIS.md`\n\n## License\n\nMIT © [Olivier Huin]()\n\n[npm-url]: https://npmjs.org/package/shortquest\n[npm-image]: https://badge.fury.io/js/shortquest.svg\n[travis-url]: https://travis-ci.org/flarebyte/shortquest\n[travis-image]: https://travis-ci.org/flarebyte/shortquest.svg?branch=master\n[daviddm-url]: https://david-dm.org/flarebyte/shortquest.svg?theme=shields.io\n[daviddm-image]: https://david-dm.org/flarebyte/shortquest\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflarebyte%2Fshortquest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflarebyte%2Fshortquest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflarebyte%2Fshortquest/lists"}