@powersync/management-types 0.0.0-dev.84a4b832

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/LICENSE +67 -0
  2. package/README.md +88 -0
  3. package/dist/config/HostedConfig.d.ts +1318 -0
  4. package/dist/config/HostedConfig.js +101 -0
  5. package/dist/config/HostedConfig.js.map +1 -0
  6. package/dist/config/HostedSecret.d.ts +18 -0
  7. package/dist/config/HostedSecret.js +12 -0
  8. package/dist/config/HostedSecret.js.map +1 -0
  9. package/dist/config/connections/ConnectionType.d.ts +6 -0
  10. package/dist/config/connections/ConnectionType.js +8 -0
  11. package/dist/config/connections/ConnectionType.js.map +1 -0
  12. package/dist/config/connections/HostedDatabaseSourceConfig.d.ts +23 -0
  13. package/dist/config/connections/HostedDatabaseSourceConfig.js +18 -0
  14. package/dist/config/connections/HostedDatabaseSourceConfig.js.map +1 -0
  15. package/dist/config/connections/HostedMSSQLConnection.d.ts +308 -0
  16. package/dist/config/connections/HostedMSSQLConnection.js +41 -0
  17. package/dist/config/connections/HostedMSSQLConnection.js.map +1 -0
  18. package/dist/config/connections/HostedMongoConnection.d.ts +33 -0
  19. package/dist/config/connections/HostedMongoConnection.js +10 -0
  20. package/dist/config/connections/HostedMongoConnection.js.map +1 -0
  21. package/dist/config/connections/HostedMySQLConnection.d.ts +46 -0
  22. package/dist/config/connections/HostedMySQLConnection.js +16 -0
  23. package/dist/config/connections/HostedMySQLConnection.js.map +1 -0
  24. package/dist/config/connections/HostedPostgresConnection.d.ts +52 -0
  25. package/dist/config/connections/HostedPostgresConnection.js +21 -0
  26. package/dist/config/connections/HostedPostgresConnection.js.map +1 -0
  27. package/dist/errors.d.ts +11 -0
  28. package/dist/errors.js +14 -0
  29. package/dist/errors.js.map +1 -0
  30. package/dist/index.d.ts +13 -0
  31. package/dist/index.js +14 -0
  32. package/dist/index.js.map +1 -0
  33. package/dist/routes/dashboard-routes.d.ts +13 -0
  34. package/dist/routes/dashboard-routes.js +16 -0
  35. package/dist/routes/dashboard-routes.js.map +1 -0
  36. package/dist/routes/dev-routes.d.ts +602 -0
  37. package/dist/routes/dev-routes.js +97 -0
  38. package/dist/routes/dev-routes.js.map +1 -0
  39. package/dist/routes/general-routes.d.ts +78 -0
  40. package/dist/routes/general-routes.js +57 -0
  41. package/dist/routes/general-routes.js.map +1 -0
  42. package/dist/routes/index.d.ts +6 -0
  43. package/dist/routes/index.js +7 -0
  44. package/dist/routes/index.js.map +1 -0
  45. package/dist/routes/manage-routes.d.ts +1094 -0
  46. package/dist/routes/manage-routes.js +109 -0
  47. package/dist/routes/manage-routes.js.map +1 -0
  48. package/dist/routes/reporting-routes.d.ts +112 -0
  49. package/dist/routes/reporting-routes.js +61 -0
  50. package/dist/routes/reporting-routes.js.map +1 -0
  51. package/dist/routes/schema.d.ts +131 -0
  52. package/dist/routes/schema.js +71 -0
  53. package/dist/routes/schema.js.map +1 -0
  54. package/dist/scripts/compile-json-schema.d.ts +1 -0
  55. package/dist/scripts/compile-json-schema.js +15 -0
  56. package/dist/scripts/compile-json-schema.js.map +1 -0
  57. package/dist/shared.d.ts +17 -0
  58. package/dist/shared.js +17 -0
  59. package/dist/shared.js.map +1 -0
  60. package/dist/utils/pagination.d.ts +12 -0
  61. package/dist/utils/pagination.js +13 -0
  62. package/dist/utils/pagination.js.map +1 -0
  63. package/json-schema/powersync-config.json +880 -0
  64. package/package.json +43 -0
package/LICENSE ADDED
@@ -0,0 +1,67 @@
1
+ # Functional Source License, Version 1.1, ALv2 Future License
2
+
3
+ ## Abbreviation
4
+
5
+ FSL-1.1-ALv2
6
+
7
+ ## Notice
8
+
9
+ Copyright 2023-2025 Journey Mobile, Inc.
10
+
11
+ ## Terms and Conditions
12
+
13
+ ### Licensor ("We")
14
+
15
+ The party offering the Software under these Terms and Conditions.
16
+
17
+ ### The Software
18
+
19
+ The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
20
+
21
+ ### License Grant
22
+
23
+ Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
24
+
25
+ ### Permitted Purpose
26
+
27
+ A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
28
+
29
+ 1. substitutes for the Software;
30
+ 2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
31
+ 3. offers the same or substantially similar functionality as the Software.
32
+
33
+ Permitted Purposes specifically include using the Software:
34
+
35
+ 1. for your internal use and access;
36
+ 2. for non-commercial education;
37
+ 3. for non-commercial research; and
38
+ 4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
39
+
40
+ ### Patents
41
+
42
+ To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
43
+
44
+ ### Redistribution
45
+
46
+ The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
47
+ If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
48
+
49
+ ### Disclaimer
50
+
51
+ THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
52
+ IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
53
+
54
+ ### Trademarks
55
+
56
+ Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
57
+
58
+ ## Grant of Future License
59
+
60
+ We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
61
+
62
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
63
+ You may obtain a copy of the License at
64
+
65
+ http://www.apache.org/licenses/LICENSE-2.0
66
+
67
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
package/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # @powersync/management-types
2
+
3
+ TypeScript type definitions, route definitions, and utilities for the PowerSync Management API.
4
+
5
+ **Note** This package is intended for internal usage. Use the PowerSync CLI or Dashboard to manage cloud PowerSync instances.
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install @powersync/management-types
11
+ # or
12
+ pnpm add @powersync/management-types
13
+ # or
14
+ yarn add @powersync/management-types
15
+ ```
16
+
17
+ ## Usage
18
+
19
+ This package provides type definitions and route constants for the PowerSync Management API.
20
+
21
+ ### Type Definitions
22
+
23
+ ```typescript
24
+ import type {
25
+ BasePowerSyncHostedConfig,
26
+ BasePowerSyncHostedConfigDecoded,
27
+ HostedSecret,
28
+ HostedPostgresConnection,
29
+ HostedMySQLConnection,
30
+ HostedMSSQLConnection,
31
+ HostedMongoConnection
32
+ } from '@powersync/management-types';
33
+ ```
34
+
35
+ ### Route Definitions
36
+
37
+ ```typescript
38
+ import { routes } from '@powersync/management-types';
39
+
40
+ // Access route constants
41
+ routes.MANAGE_ROUTES.LIST;
42
+ routes.DEV_ROUTES.TEST_CONNECTION;
43
+ routes.GENERAL_ROUTES.LIST_REGIONS;
44
+ routes.REPORT_ROUTES.GET_CLIENT_CONNECTION_DATA;
45
+ ```
46
+
47
+ ### Request/Response Types
48
+
49
+ ```typescript
50
+ import type {
51
+ ListInstancesRequest,
52
+ ListInstancesResponse,
53
+ CreateInstanceRequest,
54
+ CreateInstanceResponse
55
+ // ... and many more
56
+ } from '@powersync/management-types';
57
+ ```
58
+
59
+ ## Package Contents
60
+
61
+ ### Configuration Types
62
+
63
+ - `BasePowerSyncHostedConfig` - Main configuration type for PowerSync instances
64
+ - `BasePowerSyncHostedConfigDecoded` - Decoded version of the configuration type
65
+ - `HostedSecret` - Secret management types
66
+ - Connection types for various database backends:
67
+ - `HostedPostgresConnection`
68
+ - `HostedMySQLConnection`
69
+ - `HostedMSSQLConnection`
70
+ - `HostedMongoConnection`
71
+
72
+ ### Route Definitions
73
+
74
+ - `MANAGE_ROUTES` - Instance management endpoints
75
+ - `DEV_ROUTES` - Development and testing endpoints
76
+ - `GENERAL_ROUTES` - General utility endpoints
77
+ - `REPORT_ROUTES` - Reporting and analytics endpoints
78
+ - `DASHBOARD_ROUTES` - Dashboard-related endpoints
79
+
80
+ ### Utilities
81
+
82
+ - Pagination utilities
83
+ - Shared types and helpers
84
+ - Error types
85
+
86
+ ## License
87
+
88
+ FSL-1.1-ALv2