SDK
Introduction

HxDR Platform SDK

The SDK is an inner-source project designed to facilitate application development on the HxDR Platform. It is written in JavaScript/TypeScript and offers a collection of small, composable parts that can be used independently or together.

While it includes solutions specifically for React, it is not exclusively tied to any framework, making it versatile for a wide range of development scenarios. This SDK aims to streamline the process of building applications on the HxDR Platform, providing developers with the tools needed for efficient and effective development on the HxDR Platform.

The JavaScript SDK is currently in preview status. We are actively working on improving the SDK and adding new features. If you have any feedback or suggestions, please let us know! Since this is not a fully stable release, semantic versioning is not yet in effect. We will do our best to avoid breaking changes, but they may occur between patch versions until we hit 1.0.0.

Core SDK Packages

  • Core

    Internal shared SDK helpers and utilities

  • Config

    Global application configuration container and validation

  • Geocoder

    Robust services for managing location-based use cases

  • Connect

    Idiomatic approach to interfacing with the HxDR GraphQL API

  • Schema

    Platform API schema base types

  • Auth

    Identity authentication

  • Account

    Account authorization and profile services

  • Notification

    React based user notification toasts

  • Validation

    Data validation and constraint enforcement

  • Upload

    Low-level S3 multipart file upload

  • Label

    Labeling/Tagging of Projects and Assets

  • Router

    Utilities for advanced routing of React applications

  • Folder

    Interacting with the folder structure of a project

Asset SDK Packages

  • Asset Core

    Core asset management services and types

  • Asset Renderer

    RIA based 3d asset visualization and rendering

  • Asset Filesystem

    Combined Asset/Folder Filesystem

  • Asset Upload

    Simplified asset upload lifecycle