{"id":41380135,"url":"https://github.com/ddo/orchestrate-client","last_synced_at":"2026-01-23T10:54:34.894Z","repository":{"id":21878881,"uuid":"25202523","full_name":"ddo/orchestrate-client","owner":"ddo","description":"orchestrate.io nodejs client","archived":false,"fork":false,"pushed_at":"2014-10-15T05:23:19.000Z","size":148,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-28T07:07:28.366Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ddo.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-10-14T11:06:54.000Z","updated_at":"2015-03-28T17:35:45.000Z","dependencies_parsed_at":"2022-08-20T01:31:24.188Z","dependency_job_id":null,"html_url":"https://github.com/ddo/orchestrate-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ddo/orchestrate-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddo%2Forchestrate-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddo%2Forchestrate-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddo%2Forchestrate-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddo%2Forchestrate-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ddo","download_url":"https://codeload.github.com/ddo/orchestrate-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddo%2Forchestrate-client/sbom","scorecard":{"id":330315,"data":{"date":"2025-08-11","repo":{"name":"github.com/ddo/orchestrate-client","commit":"5f9340df4ae7e3e4e832dbe00a6731885831fade"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"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":"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/23 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":"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":"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":"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":"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":"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":"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":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":"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"}}]},"last_synced_at":"2025-08-18T03:24:32.101Z","repository_id":21878881,"created_at":"2025-08-18T03:24:32.101Z","updated_at":"2025-08-18T03:24:32.101Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28689078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"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-23T10:54:33.842Z","updated_at":"2026-01-23T10:54:34.880Z","avatar_url":"https://github.com/ddo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"orchestrate-client [![Build Status](http://img.shields.io/travis/ddo/orchestrate-client.svg?style=flat-square)](https://travis-ci.org/ddo/orchestrate-client)\n==================\n\n\u003e [orchestrate.io](http://orchestrate.io/) NodeJS client\n\n[![NPM version](http://img.shields.io/npm/v/orchestrate-client.svg?style=flat-square)](https://www.npmjs.org/package/orchestrate-client) [![Dependency Status](http://img.shields.io/david/ddo/orchestrate-client.svg?style=flat-square)](https://david-dm.org/ddo/orchestrate-client)\n\n##installation\n\n```bash\nnpm i orchestrate-client\n```\n\n##usage\n\ninit\n```js\nvar orchestrate = require('orchestrate-client');\nvar db = orchestrate(\u003cyour token here\u003e);\n```\n\nget all the users in the \"users\" collection\n```js\ndb.get('users', function(err, header, users) {\n});\n```\n\nget the user with key = 1\n```js\ndb.get('users', 1, function(err, header, user) {\n});\n```\n\nsearch \u0026 limit\n```js\ndb.get('users', {\n    query: 'name:ddo',\n    limit: 10\n}, function(err, header, users) {\n});\n```\n\ncreate\n```js\ndb.post('users', {\n    name: 'ddo',\n    age: 25,\n    game: 'csgo, dota'\n}, function(err, header) {\n});\n```\n\nread the api below for more details\n\n##api\n\n* [ping](#ping)\n* [get](#get)\n* [post](#post)\n* [put](#put)\n* [del](#del)\n\nrefs\n\n* [get](#refget)\n\nevents\n\n* [get](#eventget)\n* [post](#eventpost)\n* [put](#eventput)\n* [del](#eventdel)\n\ngraph\n\n* [get](#graphget)\n* [put](#graphput)\n* [del](#graphdel)\n\n###ping\n\u003e validate your token(API key)\n\n```js\ndb.ping(function(err, header) {\n});\n```\n\n###get\n\u003e get, search, query, list documents\n\nparameters:\n\n* collection **``required``** ``string``\n* key ``string|number``\n* opt ``object`` option (limit, query...) check [orchestrate.io docs](http://orchestrate.io/docs/apiref)\n\nexample:\n\nlist\n```js\ndb.get('users', function(err, header, users) {\n});\n```\n\nlist with option\n```js\ndb.get('users', {\n    limit: 5\n}, function(err, header, users) {\n});\n```\n\nget a document by key\n```js\ndb.get('users', key, function(err, header, user) {\n});\n```\n\nsearch\n```js\ndb.get('users', {\n    query: 'game:csgo',\n    sort: 'value.name:asc',\n    limit: 5\n}, function(err, header, users) {\n});\n```\n\n###post\n\u003e create document, auto generate new key\n\nparameters:\n\n* collection **``required``** ``string``\n* data ``object``\n\nexample:\n\ncreate\n```js\ndb.post('user', {\n    name: 'ddo',\n    age: 25,\n    game: 'csgo, dota'\n}, function(err, header) {\n});\n```\n\ncreate empty document\n```js\ndb.post('user', function(err, header) {\n});\n```\n\n###put\n\u003e create/update document\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* data ``object``\n\nexample:\n\ncreate/update document\n```js\ndb.put('user', 1, {\n    name: 'ddooooooo',\n    age: 25,\n    game: 'csgo, dota, minecraftttt'\n}, function(err, header) {\n});\n```\n\n###del\n\u003e delete document\n\nparameters:\n\n* collection **``required``** ``string``\n* key ``string|number``\n* opt ``object``\n\nexample:\n\ndelete document by key\n```js\ndb.del('user', 1, function(err, header) {\n});\n```\n\ndelete collection **need force=true**\n```js\ndb.del('user', {\n    force: true\n}, function(err, header) {\n});\n```\n\n###ref.get\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* ref ``string|number``\n* opt ``object``\n\nexample:\n\nget data of a ref\n```js\ndb.ref.get('user', 1, 'any_ref', function(err, header, data) {\n});\n```\n\nlist all refs of a document\n```js\ndb.ref.get('user', 1, function(err, header, data) {\n});\n```\n\nlist refs with option\n```js\ndb.ref.get('user', 1, {\n    limit: 5\n}, function(err, header, data) {\n});\n```\n\n###event.get\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* type **``required``** ``string``\n* opt ``object``\n\nexample:\n\nget data of a event\n```js\ndb.event.get('user', 1, 'login', function(err, header, data) {\n});\n```\n\nget data of a event\n```js\ndb.event.get('user', 1, 'login', {\n    timestamp: 1413215674842,\n    ordinal: '05bf1e5dda086000', //must be a ordinal string\n    limit: 1\n}, function(err, header, data) {\n});\n```\n\n###event.post\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* type **``required``** ``string``\n* timestamp ``number``\n* data ``object``\n\nexample:\n\n```js\ndb.event.post('user', 1, 'login', function(err, header) {\n});\n```\n\n```js\ndb.event.post('user', 1, 'login', {\n    ip: '3.3.3.3'\n}, function(err, header) {\n});\n```\n\n```js\ndb.event.post('user', 1, 'login', 1413215674842, function(err, header) {\n});\n```\n\n```js\ndb.event.post('user', 1, 'login', 1413215674842, {\n    login: '4.4.4.4'\n}, function(err, header) {\n});\n```\n\n###event.put\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* type **``required``** ``string``\n* data ``object``\n\nexample:\n\n```js\ndb.event.put('user', 1, 'login', {\n    timestamp: 1413215674842,\n    ordinal: '05bf1e5dda086000'\n}, {\n    ip: '5.5.5.5'\n}, function(err, header) {\n});\n```\n\nempty data\n```js\ndb.event.put('user', 1, 'login', {\n    timestamp: 1413215674842,\n    ordinal: '05bf1e5dda086000'\n}, function(err, header) {\n});\n```\n\n###event.del\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* type **``required``** ``string``\n* opt ``object``\n\nexample:\n\n**need opt purge=true**\n\n```js\ndb.event.del('user', 1, 'login', {\n    timestamp: 1413211094000,\n    ordinal: '05bed877f0086000',\n    purge: true\n}, function(err, header) {\n});\n```\n\n###graph.get\n\nparameters:\n\n* collection **``required``** ``string``\n* key **``required``** ``string|number``\n* kind **``required``** ``string|array`` relations\n* opt ``object``\n\nexample:\n\n```js\ndb.graph.get('user', 1, 'like', function(err, header, data) {\n});\n```\n\n```js\ndb.graph.get('user', 1, ['like', 'relationship'], function(err, header, data) {\n});\n```\n\n```js\ndb.graph.get('user', 1, ['like', 'relationship'], {\n    limit: 5\n}, function(err, header, data) {\n});\n```\n\n###graph.put\n\nparameters:\n\n* from **``required``** ``object`` with collection name and key\n* kind **``required``** ``string`` relation\n* to **``required``** ``object`` with collection name and key\n\nexample:\n\n```js\ndb.graph.put({\n    collection: 'user',\n    key: 1\n}, 'like', {\n    collection: 'user',\n    key: 2\n}, function(err, header) {\n});\n```\n\n```js\ndb.graph.put({\n    from: {\n        collection: 'user',\n        key: 1\n    }, \n    kind: 'like', \n    to: {\n        collection: 'user',\n        key: 2\n    }\n}, function(err, header) {\n});\n```\n\n###graph.del\n\nparameters:\n\n* from **``required``** ``object`` with collection name and key\n* kind **``required``** ``string`` relation\n* to **``required``** ``object`` with collection name and key\n* opt ``object``\n\nexample:\n\n**need purge=true**\n```js\ndb.graph.del({\n    collection: 'user',\n    key: 1\n}, 'like', {\n    collection: 'user',\n    key: 2\n}, {\n    purge: true\n}, function(err, header) {\n});\n```\n\n##note\n\n* you can pass to all api with 2 params: (``option``, ``callback``)\n\nexample\n\n```js\ndb.get({\n    collection: 'user',\n    key: 1,\n    opt: {\n        query: 'game:csgo',\n        sort: 'value.name:asc'\n    }\n}, function(err, header, data) {\n});\n\ndb.graph.del({\n    from: {\n        collection: 'user',\n        key: 1\n    }, \n    kind: 'like', \n    to: {\n        collection: 'user',\n        key: 2\n    },\n    opt: {\n        purge: true\n    }\n}, function(err, header) {\n});\n```\n\n##[changelog](https://github.com/ddo/orchestrate-client/releases)\n\n##testing\n\nset ``env.ORCHESTRATE_TOKEN=\u003cyour token\u003e``\n\n```bash\n$ npm test\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddo%2Forchestrate-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fddo%2Forchestrate-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddo%2Forchestrate-client/lists"}