SterlingIndex Docs

Shared Packages

Cross-app contracts, shared packages, and the small set of repo-level seams that connect SterlingIndex applications.

The shared layer in this monorepo is intentionally narrow. SterlingIndex does not hide every implementation detail behind a package; it extracts only the seams that multiple apps must agree on:

  • auth URL construction and return-to behavior,
  • secret path ownership and sync boundaries that keep those URLs deployable across hosts,
  • TypeScript payload contracts shared by frontend callers,
  • a browser-facing product API client for the dashboard,
  • build-time TypeScript defaults that multiple apps compile against.

That makes this section the best bridge between the app docs and the backend docs. If a change crosses repositories, hosts, or user surfaces, the contract usually shows up here.

Deep Dive

How To Use This Section

  • Read this after the frontend pages when you need to trace a login redirect, typed API response, shared client helper, or which secret path actually owns the runtime value.
  • Jump from here to /docs/platform-api when the contract owner is the backend route or worker runtime rather than the shared package itself.
  • Treat package additions cautiously: the existing architecture prefers explicit app ownership over broad utility-package growth.

On this page