{"id":28088954,"url":"https://github.com/situmtech/situm-sdk-js","last_synced_at":"2026-03-08T00:31:31.686Z","repository":{"id":57160582,"uuid":"440516135","full_name":"situmtech/situm-sdk-js","owner":"situmtech","description":"JS/TS library to build your own cartographic applications using the Situm services","archived":false,"fork":false,"pushed_at":"2026-03-04T16:50:25.000Z","size":1324,"stargazers_count":8,"open_issues_count":2,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-03-04T22:59:32.972Z","etag":null,"topics":["documentation","geolocation","javascript","mapping","maps","sdk","situm","typescript"],"latest_commit_sha":null,"homepage":"https://situm.com/docs/websdk-javascript-sdk-quickstart-guide/","language":"TypeScript","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/situmtech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY-POLICY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-12-21T12:53:08.000Z","updated_at":"2026-03-04T16:52:40.000Z","dependencies_parsed_at":"2026-03-04T18:02:22.262Z","dependency_job_id":null,"html_url":"https://github.com/situmtech/situm-sdk-js","commit_stats":{"total_commits":13,"total_committers":5,"mean_commits":2.6,"dds":0.6153846153846154,"last_synced_commit":"3903017a6d152d5603a416b253006312e590e33a"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"purl":"pkg:github/situmtech/situm-sdk-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/situmtech%2Fsitum-sdk-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/situmtech%2Fsitum-sdk-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/situmtech%2Fsitum-sdk-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/situmtech%2Fsitum-sdk-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/situmtech","download_url":"https://codeload.github.com/situmtech/situm-sdk-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/situmtech%2Fsitum-sdk-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30238854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T00:30:53.000Z","status":"ssl_error","status_checked_at":"2026-03-08T00:30:44.061Z","response_time":53,"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":["documentation","geolocation","javascript","mapping","maps","sdk","situm","typescript"],"created_at":"2025-05-13T12:52:45.341Z","updated_at":"2026-03-08T00:31:31.678Z","avatar_url":"https://github.com/situmtech.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e \u003cimg width=\"233\" src=\"https://situm.com/wp-content/themes/situm/img/logo-situm.svg\" style=\"margin-bottom:1rem\" /\u003e \u003ch1 align=\"center\"\u003eSitum SDK JS\u003c/h1\u003e \u003c/p\u003e\n\n\u003cp align=\"center\" style=\"text-align:center\"\u003e\n\nA JavaScript library to interact with the Situm REST APIs to build your own applications with the power of\n[SITUM](https://www.situm.com/).\n\n\u003c/p\u003e\n\n\u003cdiv align=\"center\" style=\"text-align:center\"\u003e\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n![Latest version:](https://img.shields.io/npm/v/@situm/sdk-js/latest)\n![Node compatibility:](https://img.shields.io/node/v/@situm/sdk-js)\n[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)\n\n\u003c/div\u003e\n\n## Getting Started\n\nThe SITUM SDK JS is Javascript library to create web applications using the REST API from Situm. This will allow you to fetch geospacial information and create your own js-based applications. We aim to make it easy to use for you and to keep your focus on creating your business logic over our services.\n\nThe best way to get started is to navigate through the Situm SDK JS documentation site:\n\n- [Guide](https://situm.com/docs/websdk-javascript-sdk-quickstart-guide/) will give you a good overview of the library.\n- [API Reference](https://developers.situm.com/sdk_documentation/sdk-js/index.html) will help you use a particular class or method.\n- [Examples](https://github.com/situmtech/situm-sdk-js/tree/main/examples) will demo some specific features.\n- [Support](https://situm.com/en/docs/) might answer some of your questions.\n\nThis library is organized into distinct domains, each targeting a specific aspect of indoor mapping and positioning. This separation helps you focus on relevant functionality for your application. The main domains are:\n\n| Name           | Explanation                                                                 | Example                                 |\n|----------------|-----------------------------------------------------------------------------|-----------------------------------------|\n| **Cartography**| Handles map data, such as buildings, floors, and points of interest.        | `sdk.cartography.getBuildings()`        |\n| **Realtime**   | Manages real-time location tracking and positioning.                        | `sdk.realtime.getPositions()`           |\n| **Viewer**     | Provides tools to render interactive maps and visualizations in your web application. | `sdk.viewer.create({})`           |\n| **User**       | Manages user accounts and authentication.                                   | `sdk.user.createUser()`                 |\n| **Reports**    | Accesses analytics and reporting features, such as visit or usage reports.  | `sdk.reports.getTrajectory()`         |\n| **Images**     | Handles image retrieval and management, such as map or POI images.          | `sdk.images.uploadImage()`         |\n\nEach domain exposes its own set of classes and methods, making it easier to work with geospacial data, live positioning, or map rendering independently.\n\n### Examples\n\nFetching all the buildings from the api\n\n```typescript\nconst sdk = new Situm({auth: {apiKey: YOUR_API_KEY});\nconst buildings = sdk.cartography.getBuildings();\n```\n\nFetching realtime positions from the api\n\n```typescript\nconst sdk = new Situm({auth: {apiKey: YOUR_API_KEY});\nconst positions = sdk.realtime.getPositions();\n```\n\nRender an interactive viewer on a div:\n\n```html\n\u003cdiv id=\"viewer1\"\u003e\u003c/div\u003e\n```\n\n```typescript\nconst sdk = new Situm({auth: {apiKey: YOUR_API_KEY});\nconst viewer = sdk.viewer.create({\n  domElement: document.querySelector(\"#viewer1\");\n});\n\nviewer.on(ViewerEventType.MAP_IS_READY, () =\u003e\n  console.log(\"viewer1: map is ready\")\n);\n```\n\nCheck the examples folder on the repository to see more examples.\n\n## Documentation\n\n### General documentation\n\nYou can read the general documentation that is published at [https://situm.com/docs/websdk-javascript-sdk-quickstart-guide/](https://situm.com/docs/websdk-javascript-sdk-quickstart-guide/).\n\n### Guides\n\nThe folder `docs/guides` contains general information about the Situm SDK JS library.\n\n- Quick start: get started quickly following this tutorial.\n- Upgrade considerations: if you have experience with previous versions of Situm SDK JS, this is the place to learn the differences between the former library and the newest one.\n- Glossary: terms that appear throughout the documentation.\n\n### API Reference\n\nYou can find a published api reference at [https://developers.situm.com/sdk_documentation/sdk-js/index.html](https://developers.situm.com/sdk_documentation/sdk-js/index.html)\n\nOr run `yarn doc` at the repository to build the API reference documentation from jsdoc annotations.\n\nOnce the task is done, you can visit `docs/public/index.html` to check the reference\n\n### Examples\n\nIn the folder `examples/` you can find several folders with example for every feature of Situm SDK JS.\n\nRun them with:\n\n```shell\nnpx tsx examples/filename.ts\n```\n\n## Development\n\nSee [DEVELOPMENT.md](DEVELOPMENT.md) for more information.\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning.\n\nPlease refer to [CHANGELOG.md](CHANGELOG.md) for a list of notables changes for each version of the library.\n\nYou can also see the [tags on this repository](https://github.com/situmtech/situm-sdk-js/tags).\n\n\n## Submitting Contributions\n\nYou will need to sign a Contributor License Agreement (CLA) before making a submission. [Learn more here.](https://situm.com/contributions/)\n\n## License\n\nThis project is licensed under the MIT - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitumtech%2Fsitum-sdk-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsitumtech%2Fsitum-sdk-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitumtech%2Fsitum-sdk-js/lists"}