@powersync/management-client 0.0.0-dev-20260225123311

package/dist/index.js

@@ -0,0 +1,427 @@
+import * as sdk from '@journeyapps-labs/common-sdk';
+import { routes } from '@powersync/management-types';
+const dev = routes.DEV_ROUTES;
+const manage = routes.MANAGE_ROUTES;
+const general = routes.GENERAL_ROUTES;
+const report = routes.REPORT_ROUTES;
+const dashboard = routes.SYNC_DASHBOARD_ROUTES;
+export class PowerSyncManagementClient extends sdk.SDKClient {
+    /**
+     * Lists all PowerSync instances for a given organization and application.
+     *
+     * @returns Promise resolving to a list of instances with their IDs, names, config status, and deployability
+     * @example
+     * ```typescript
+     * const response = await client.listInstances({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456'
+     * });
+     * console.log(response.instances); // Array of instance objects
+     * ```
+     */
+    listInstances = this.createEndpoint({
+        path: manage.LIST
+    });
+    /**
+     * Creates a new PowerSync instance.
+     *
+     * @returns Promise resolving to the created instance ID
+     * @example
+     * ```typescript
+     * const response = await client.createInstance({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   name: 'my-instance',
+     *   region: 'us'
+     * });
+     * console.log(response.id); // The new instance ID
+     * ```
+     */
+    createInstance = this.createEndpoint({
+        path: manage.CREATE
+    });
+    /**
+     * Destroys a PowerSync instance. This is a permanent operation.
+     *
+     * @returns Promise resolving to the destroyed instance ID and optional operation ID
+     * @example
+     * ```typescript
+     * const response = await client.destroyInstance({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.id); // The destroyed instance ID
+     * ```
+     */
+    destroyInstance = this.createEndpoint({
+        path: manage.DESTROY
+    });
+    /**
+     * Deactivates a PowerSync instance without destroying it.
+     *
+     * @returns Promise resolving to the deactivated instance ID and optional operation ID
+     * @example
+     * ```typescript
+     * const response = await client.deactivateInstance({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.id); // The deactivated instance ID
+     * ```
+     */
+    deactivateInstance = this.createEndpoint({
+        path: manage.DEACTIVATE
+    });
+    /**
+     * Deploys a PowerSync instance with the specified configuration.
+     *
+     * @returns Promise resolving to the instance ID and operation ID for tracking deployment
+     * @example
+     * ```typescript
+     * const response = await client.deployInstance({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   name: 'my-instance',
+     *   config: {
+     *     region: 'us',
+     *     replication: {
+     *       connections: [/* connection config *\/]
+     *     }
+     *   },
+     *   sync_rules: 'SELECT * FROM users',
+     *   program_version: {
+     *     channel: 'stable',
+     *     version_range: '^1.0.0'
+     *   }
+     * });
+     * console.log(response.operation_id); // Track deployment progress
+     * ```
+     */
+    deployInstance = this.createEndpoint({
+        path: manage.DEPLOY
+    });
+    /**
+     * Retrieves the configuration for a PowerSync instance.
+     * This endpoint is retryable.
+     *
+     * @returns Promise resolving to the instance configuration including config, sync_rules, and program_version
+     * @example
+     * ```typescript
+     * const response = await client.getInstanceConfig({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.config); // The instance configuration
+     * console.log(response.sync_rules); // The sync rules
+     * ```
+     */
+    getInstanceConfig = this.createEndpoint({
+        path: manage.CONFIG,
+        retryable: true
+    });
+    /**
+     * Gets the provisioning status and deployment operations for a PowerSync instance.
+     * This endpoint is retryable.
+     *
+     * @returns Promise resolving to instance status including provisioned flag, operations array, and optional instance_url
+     * @example
+     * ```typescript
+     * const response = await client.getInstanceStatus({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.provisioned); // true if instance is provisioned
+     * console.log(response.operations); // Array of deployment operations
+     * ```
+     */
+    getInstanceStatus = this.createEndpoint({
+        path: manage.STATUS,
+        retryable: true
+    });
+    /**
+     * Gets diagnostic information for a PowerSync instance.
+     * Only works if the instance is already provisioned.
+     * This endpoint is retryable.
+     *
+     * @returns Promise resolving to diagnostic information
+     * @example
+     * ```typescript
+     * const response = await client.getInstanceDiagnostics({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * // Diagnostic information about the instance
+     * ```
+     */
+    getInstanceDiagnostics = this.createEndpoint({
+        path: manage.DIAGNOSTICS,
+        retryable: true
+    });
+    /**
+     * Triggers a compaction operation on a PowerSync instance.
+     *
+     * @returns Promise resolving to the instance ID and optional operation ID
+     * @example
+     * ```typescript
+     * const response = await client.compact({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.operation_id); // Track compaction progress
+     * ```
+     */
+    compact = this.createEndpoint({
+        path: manage.COMPACT
+    });
+    /**
+     * Tests a database connection without deploying an instance.
+     * Validates connectivity and configuration for the specified connection.
+     *
+     * @returns Promise resolving to connection test results including success status, connection details, and optional configuration details
+     * @example
+     * ```typescript
+     * const response = await client.testConnection({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   connection: {
+     *     type: 'postgres',
+     *     uri: 'postgresql://user:pass@host:5432/db'
+     *   }
+     * });
+     * console.log(response.success); // true if connection test passed
+     * console.log(response.connection.reachable); // true if TCP connection works
+     * ```
+     */
+    testConnection = this.createEndpoint({
+        path: dev.TEST_CONNECTION
+    });
+    /**
+     * Gets the database schema for a PowerSync instance.
+     * Only works if the instance is already provisioned.
+     * This endpoint is retryable.
+     *
+     * @returns Promise resolving to the instance schema including connections, tables, and columns
+     * @example
+     * ```typescript
+     * const response = await client.getInstanceSchema({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.connections); // Array of connection schemas
+     * ```
+     */
+    getInstanceSchema = this.createEndpoint({
+        path: dev.GET_SCHEMA,
+        retryable: true
+    });
+    /**
+     * Executes SQL queries on a PowerSync instance.
+     * Only works if the instance is already provisioned.
+     *
+     * @returns Promise resolving to SQL execution results
+     * @example
+     * ```typescript
+     * const response = await client.executeSql({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   sql: 'SELECT * FROM users WHERE id = ?',
+     *   parameters: ['user-123']
+     * });
+     * // SQL query results
+     * ```
+     */
+    executeSql = this.createEndpoint({
+        path: dev.EXECUTE_SQL
+    });
+    /**
+     * Validates sync rules for a PowerSync instance.
+     * Only works if the instance is already provisioned.
+     *
+     * @returns Promise resolving to validation results
+     * @example
+     * ```typescript
+     * const response = await client.validateSyncRules({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   sync_rules: 'SELECT * FROM users'
+     * });
+     * // Validation results
+     * ```
+     */
+    validateSyncRules = this.createEndpoint({
+        path: dev.VALIDATE_SYNC_RULES
+    });
+    /**
+     * Reprocesses sync rules for a PowerSync instance.
+     * Only works if the instance is already provisioned.
+     *
+     * @returns Promise resolving to reprocessing results
+     * @example
+     * ```typescript
+     * const response = await client.reprocessSyncRules({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   sync_rules: 'SELECT * FROM users'
+     * });
+     * // Reprocessing results
+     * ```
+     */
+    reprocessSyncRules = this.createEndpoint({
+        path: dev.REPROCESS_SYNC_RULES
+    });
+    /**
+     * Generates a development token for a PowerSync instance.
+     *
+     * @returns Promise resolving to the generated JWT token
+     * @example
+     * ```typescript
+     * const response = await client.generateDevToken({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   subject: 'user-123',
+     *   expiresInSeconds: 3600
+     * });
+     * console.log(response.token); // The JWT token
+     * ```
+     */
+    generateDevToken = this.createEndpoint({
+        path: dev.GENERATE_DEV_TOKEN
+    });
+    /**
+     * Generates a dashboard token used for connecting to the Dashboard's dedicated PowerSync Service
+     *
+     * @returns Promise resolving to the generated dashboard JWT token
+     * @example
+     * ```typescript
+     * const response = await client.generateDashboardToken({
+     *  org_id: 'org-123'
+     *  });
+     *  console.log(response.token); // The dashboard JWT token
+     *  ```
+     */
+    generateDashboardToken = this.createEndpoint({
+        path: dashboard.GET_TOKEN
+    });
+    /**
+     * Lists available regions for PowerSync deployments.
+     * Returns region information including IP addresses for whitelisting.
+     *
+     * @returns Promise resolving to a list of regions with their names, deployability status, and IP addresses
+     * @example
+     * ```typescript
+     * const response = await client.listRegions({});
+     * console.log(response.regions); // Array of region objects with IPs for whitelisting
+     * ```
+     */
+    listRegions = this.createEndpoint({
+        path: general.LIST_REGIONS,
+        method: 'get'
+    });
+    /**
+     * Lists available PowerSync program versions for a channel.
+     *
+     * @returns Promise resolving to an array of versions with their status (current, available, or deprecated)
+     * @example
+     * ```typescript
+     * const response = await client.listVersionsV({
+     *   channel: 'stable'
+     * });
+     * console.log(response); // Array of version objects with status
+     * ```
+     */
+    listVersions = this.createEndpoint({
+        path: general.LIST_VERSIONS_V2
+    });
+    /**
+     * Gets client connection reports for a PowerSync instance within a date range.
+     *
+     * @returns Promise resolving to connection report data including user counts and SDK breakdowns
+     * @example
+     * ```typescript
+     * const response = await client.getClientConnectionReports({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   start: '2024-01-01T00:00:00Z',
+     *   end: '2024-01-31T23:59:59Z'
+     * });
+     * console.log(response.users); // Total number of users
+     * console.log(response.sdks); // Array of SDK connection reports
+     * ```
+     */
+    getClientConnectionReports = this.createEndpoint({
+        path: report.GET_CLIENT_CONNECTION_DATA
+    });
+    /**
+     * Gets currently connected clients for a PowerSync instance.
+     *
+     * @returns Promise resolving to current connection data including user counts and SDK breakdowns
+     * @example
+     * ```typescript
+     * const response = await client.getConnectedClients({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789'
+     * });
+     * console.log(response.users); // Number of currently connected users
+     * console.log(response.sdks); // Array of current SDK connections
+     * ```
+     */
+    getConnectedClients = this.createEndpoint({
+        path: report.GET_CURRENT_CONNECTIONS
+    });
+    /**
+     * Gets paginated general client connection analytics for a PowerSync instance.
+     * Returns connection events including connect/disconnect times, user agents, and SDK information.
+     *
+     * @returns Promise resolving to paginated connection analytics events. Also includes a `paginate` method for iterating through all pages.
+     * @example
+     * ```typescript
+     * // Single page request
+     * const response = await client.getGeneralClientConnectionAnalytics({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   date_range: {
+     *     start: '2024-01-01T00:00:00Z',
+     *     end: '2024-01-31T23:59:59Z'
+     *   },
+     *   limit: 100
+     * });
+     * console.log(response.items); // Array of connection events
+     * console.log(response.total); // Total number of events
+     * console.log(response.more); // true if there are more pages
+     * console.log(response.cursor); // cursor for the next page
+     *
+     * // Iterate through all pages
+     * for await (const page of client.getGeneralClientConnectionAnalytics.paginate({
+     *   org_id: 'org-123',
+     *   app_id: 'app-456',
+     *   id: 'instance-789',
+     *   date_range: {
+     *     start: '2024-01-01T00:00:00Z',
+     *     end: '2024-01-31T23:59:59Z'
+     *   },
+     *   limit: 100
+     * })) {
+     *   console.log(page.items); // Process each page
+     * }
+     * ```
+     */
+    getGeneralClientConnectionAnalytics = sdk.createPaginatedEndpoint(this.createEndpoint({
+        path: report.GET_GENERAL_CLIENT_ANALYTICS
+    }));
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAErD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC;AAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;AACpC,MAAM,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC;AACtC,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;AACpC,MAAM,SAAS,GAAG,MAAM,CAAC,qBAAqB,CAAA;AAE9C,MAAM,OAAO,yBAA2E,SAAQ,GAAG,CAAC,SAAY;IAC9G;;;;;;;;;;;;OAYG;IACH,aAAa,GAAG,IAAI,CAAC,cAAc,CAA4D;QAC7F,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;OAcG;IACH,cAAc,GAAG,IAAI,CAAC,cAAc,CAA8D;QAChG,IAAI,EAAE,MAAM,CAAC,MAAM;KACpB,CAAC,CAAC;IAEH;;;;;;;;;;;;;OAaG;IACH,eAAe,GAAG,IAAI,CAAC,cAAc,CAAgE;QACnG,IAAI,EAAE,MAAM,CAAC,OAAO;KACrB,CAAC,CAAC;IAEH;;;;;;;;;;;;;OAaG;IACH,kBAAkB,GAAG,IAAI,CAAC,cAAc,CAAsE;QAC5G,IAAI,EAAE,MAAM,CAAC,UAAU;KACxB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAAc,GAAG,IAAI,CAAC,cAAc,CAA8D;QAChG,IAAI,EAAE,MAAM,CAAC,MAAM;KACpB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAA8D;QACnG,IAAI,EAAE,MAAM,CAAC,MAAM;QACnB,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAA8D;QACnG,IAAI,EAAE,MAAM,CAAC,MAAM;QACnB,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,GAAG,IAAI,CAAC,cAAc,CAAwE;QAClH,IAAI,EAAE,MAAM,CAAC,WAAW;QACxB,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH;;;;;;;;;;;;;OAaG;IACH,OAAO,GAAG,IAAI,CAAC,cAAc,CAAgE;QAC3F,IAAI,EAAE,MAAM,CAAC,OAAO;KACrB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,GAAG,IAAI,CAAC,cAAc,CAA8D;QAChG,IAAI,EAAE,GAAG,CAAC,eAAe;KAC1B,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAoD;QACzF,IAAI,EAAE,GAAG,CAAC,UAAU;QACpB,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,GAAG,IAAI,CAAC,cAAc,CAAsD;QACpF,IAAI,EAAE,GAAG,CAAC,WAAW;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAoE;QACzG,IAAI,EAAE,GAAG,CAAC,mBAAmB;KAC9B,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,GAAG,IAAI,CAAC,cAAc,CAAsE;QAC5G,IAAI,EAAE,GAAG,CAAC,oBAAoB;KAC/B,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,GAAG,IAAI,CAAC,cAAc,CAAkE;QACtG,IAAI,EAAE,GAAG,CAAC,kBAAkB;KAC7B,CAAC,CAAC;IAEH;;;;;;;;;;;OAWG;IACH,sBAAsB,GAAG,IAAI,CAAC,cAAc,CAAsE;QAChH,IAAI,EAAE,SAAS,CAAC,SAAS;KAC1B,CAAC,CAAA;IAEF;;;;;;;;;;OAUG;IACH,WAAW,GAAG,IAAI,CAAC,cAAc,CAAmC;QAClE,IAAI,EAAE,OAAO,CAAC,YAAY;QAC1B,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IAEH;;;;;;;;;;;OAWG;IACH,YAAY,GAAG,IAAI,CAAC,cAAc,CAA8D;QAC9F,IAAI,EAAE,OAAO,CAAC,gBAAgB;KAC/B,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,0BAA0B,GAAG,IAAI,CAAC,cAAc,CAG9C;QACA,IAAI,EAAE,MAAM,CAAC,0BAA0B;KACxC,CAAC,CAAC;IAEH;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,GAAG,IAAI,CAAC,cAAc,CAA2E;QAClH,IAAI,EAAE,MAAM,CAAC,uBAAuB;KACrC,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,mCAAmC,GAAG,GAAG,CAAC,uBAAuB,CAC/D,IAAI,CAAC,cAAc,CAAyF;QAC1G,IAAI,EAAE,MAAM,CAAC,4BAA4B;KAC1C,CAAC,CACH,CAAC;CACH"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@powersync/management-client",
+  "version": "0.0.0-dev-20260225123311",
+  "description": "A TypeScript client for the PowerSync Management Service API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "license": "FSL-1.1-ALv2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [],
+  "author": "POWERSYNC",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/journeyapps-platform/powersync.git",
+    "directory": "public-packages/client"
+  },
+  "dependencies": {
+    "@journeyapps-labs/common-sdk": "^1.0.2",
+    "@powersync/management-types": "^0.0.0-dev-20260225123311"
+  },
+  "devDependencies": {
+    "@types/json-schema": "^7.0.15"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "rm -rf ./dist && tsc -b --clean"
+  }
+}