@powersync/management-types

TypeScript type definitions, route definitions, and utilities for the PowerSync Management API.

Note This package is intended for internal usage. Use the PowerSync CLI or Dashboard to manage cloud PowerSync instances.

Installation

npm install @powersync/management-types
# or
pnpm add @powersync/management-types
# or
yarn add @powersync/management-types

Usage

This package provides type definitions and route constants for the PowerSync Management API.

Type Definitions

import type {
  BasePowerSyncHostedConfig,
  BasePowerSyncHostedConfigDecoded,
  HostedSecret,
  HostedPostgresConnection,
  HostedMySQLConnection,
  HostedMSSQLConnection,
  HostedMongoConnection
} from '@powersync/management-types';

Route Definitions

import { routes } from '@powersync/management-types';

// Access route constants
routes.MANAGE_ROUTES.LIST;
routes.DEV_ROUTES.TEST_CONNECTION;
routes.GENERAL_ROUTES.LIST_REGIONS;
routes.REPORT_ROUTES.GET_CLIENT_CONNECTION_DATA;

Request/Response Types

import type {
  ListInstancesRequest,
  ListInstancesResponse,
  CreateInstanceRequest,
  CreateInstanceResponse
  // ... and many more
} from '@powersync/management-types';

Package Contents

Configuration Types

• BasePowerSyncHostedConfig - Main configuration type for PowerSync instances
• BasePowerSyncHostedConfigDecoded - Decoded version of the configuration type
• HostedSecret - Secret management types
• Connection types for various database backends:
  • HostedPostgresConnection
  • HostedMySQLConnection
  • HostedMSSQLConnection
  • HostedMongoConnection

Route Definitions

• MANAGE_ROUTES - Instance management endpoints
• DEV_ROUTES - Development and testing endpoints
• GENERAL_ROUTES - General utility endpoints
• REPORT_ROUTES - Reporting and analytics endpoints
• DASHBOARD_ROUTES - Dashboard-related endpoints

Utilities

• Pagination utilities
• Shared types and helpers
• Error types

License

FSL-1.1-ALv2