{"id":19362683,"url":"https://github.com/smartdevicelink/shaidkit_js","last_synced_at":"2025-10-06T17:32:03.983Z","repository":{"id":57357822,"uuid":"95675786","full_name":"smartdevicelink/SHAIDkit_js","owner":"smartdevicelink","description":"A Javascript API wrapper for SHAID","archived":false,"fork":false,"pushed_at":"2023-08-14T17:50:47.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-07T00:46:29.643Z","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":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartdevicelink.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-28T14:09:00.000Z","updated_at":"2023-08-14T17:50:53.000Z","dependencies_parsed_at":"2025-01-08T07:16:17.959Z","dependency_job_id":null,"html_url":"https://github.com/smartdevicelink/SHAIDkit_js","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2FSHAIDkit_js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2FSHAIDkit_js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2FSHAIDkit_js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2FSHAIDkit_js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartdevicelink","download_url":"https://codeload.github.com/smartdevicelink/SHAIDkit_js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240483782,"owners_count":19808632,"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","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-11-10T07:29:54.379Z","updated_at":"2025-10-06T17:31:58.920Z","avatar_url":"https://github.com/smartdevicelink.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SHAIDkit.js\n### A JavaScript wrapper for the SmartDeviceLink SHAID API\n\n## Installation\n```sh\nnpm install shaidkit --save\n```\n\n## Usage\n```js\nvar shaidkit = require(\"shaidkit\");\n\nvar shaid = new shaidkit({\n    \"version\": 2, // we recommend the most recent API version\n    \"public_key\": \"public key here\", // use your public_key\n    \"secret_key\": \"secret key here\" // use your secret_key\n});\n\nshaid.read(\n    shaid.entity[\"application\"],\n    {\n        \"limit\": 2\n    },\n    function(err, result){\n        console.log(err);\n        console.log(result);\n    }\n);\n```\n\n## Entities\nThe object type you wish to perform a CRUD (create, read, update, delete) operation on.\n\nEntities should be declared in your SHAIDkit calls via the `shaidkit.entity[\"ENTITY NAME\"]` enumeration helper.\n\n| Entity Name |\n| ------ |\n| application |\n| application/approval/vendor |\n| category |\n| country |\n| permission |\n| vendor |\n| vendor/key |\n\n## Methods\nWhen using SHAIDkit, you specify the CRUD operation you wish to perform by accessing the corresponding method.\n\n| Method | Description |\n| ------ | ----------- |\n| read() | Retrieves records of the given `entity` |\n| create() | Creates one or more records of the given `entity` |\n| update() | Updates one or more records of the given `entity` |\n| delete() | Deletes one or more records of the given `entity` |\n\nEach method **requires** the following parameters:\n| Parameter | Description |\n| ------ | ----------- |\n| `entity` | The `entity` you are attempting to operate on |\n| `{parameters}` | Creates one or more records of the given `entity` |\n| `callback()` | A callback function in the form of callback(error, result) |\n\nEntities are not guaranteed to support all methods. Please consult the [SHAID API Documentation](https://smartdevicelink.com/en/docs/shaid) for more information and the available parameters for each supported operation.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartdevicelink%2Fshaidkit_js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartdevicelink%2Fshaidkit_js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartdevicelink%2Fshaidkit_js/lists"}