@powersync/service-schema 1.19.1 → 1.20.0

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 (4) hide show
  1. package/dist/scripts/compile-json-schema.js +4 -2
  2. package/dist/scripts/compile-json-schema.js.map +1 -1
  3. package/json-schema/powersync-config.json +276 -68
  4. package/package.json +16 -8
package/dist/scripts/compile-json-schema.js CHANGED
@@ -1,5 +1,6 @@
1
1
  import { MongoStorageConfig } from '@powersync/service-module-mongodb-storage/types';
2
2
  import { MongoConnectionConfig } from '@powersync/service-module-mongodb/types';
3
+ import { MSSQLConnectionConfig } from '@powersync/service-module-mssql/types';
3
4
  import { MySQLConnectionConfig } from '@powersync/service-module-mysql/types';
4
5
  import { PostgresStorageConfig } from '@powersync/service-module-postgres-storage/types';
5
6
  import { PostgresConnectionConfig } from '@powersync/service-module-postgres/types';
@@ -14,9 +15,10 @@ fs.mkdirSync(schemaDir, { recursive: true });
14
15
  // Merge configs for modules
15
16
  const baseShape = configFile.powerSyncConfig.props.shape;
16
17
  const mergedDataSourceConfig = configFile.genericDataSourceConfig
17
- .or(PostgresConnectionConfig)
18
18
  .or(MongoConnectionConfig)
19
- .or(MySQLConnectionConfig);
19
+ .or(MSSQLConnectionConfig)
20
+ .or(MySQLConnectionConfig)
21
+ .or(PostgresConnectionConfig);
20
22
  const mergedStorageConfig = configFile.GenericStorageConfig.or(PostgresStorageConfig).or(MongoStorageConfig);
21
23
  const mergedConfig = t.object({
22
24
  ...baseShape,
package/dist/scripts/compile-json-schema.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"compile-json-schema.js","sourceRoot":"","sources":["../../src/scripts/compile-json-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;AAE5D,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAE7C,4BAA4B;AAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC;AAEzD,MAAM,sBAAsB,GAAG,UAAU,CAAC,uBAAuB;KAC9D,EAAE,CAAC,wBAAwB,CAAC;KAC5B,EAAE,CAAC,qBAAqB,CAAC;KACzB,EAAE,CAAC,qBAAqB,CAAC,CAAC;AAE7B,MAAM,mBAAmB,GAAG,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE7G,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,GAAG,SAAS;IACZ,WAAW,EAAE,CAAC;SACX,MAAM,CAAC;QACN,GAAG,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK;QACpC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;KACxD,CAAC;SACD,QAAQ,EAAE;IACb,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC,YAAY,EAAE;IAC5D,eAAe,EAAE,IAAI;IACrB,OAAO,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;CACjC,CAAC,CAAC;AAEH,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"compile-json-schema.js","sourceRoot":"","sources":["../../src/scripts/compile-json-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;AAE5D,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAE7C,4BAA4B;AAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC;AAEzD,MAAM,sBAAsB,GAAG,UAAU,CAAC,uBAAuB;KAC9D,EAAE,CAAC,qBAAqB,CAAC;KACzB,EAAE,CAAC,qBAAqB,CAAC;KACzB,EAAE,CAAC,qBAAqB,CAAC;KACzB,EAAE,CAAC,wBAAwB,CAAC,CAAC;AAEhC,MAAM,mBAAmB,GAAG,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE7G,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,GAAG,SAAS;IACZ,WAAW,EAAE,CAAC;SACX,MAAM,CAAC;QACN,GAAG,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK;QACpC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;KACxD,CAAC;SACD,QAAQ,EAAE;IACb,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC,YAAY,EAAE;IAC5D,eAAe,EAAE,IAAI;IACrB,OAAO,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;CACjC,CAAC,CAAC;AAEH,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC"}
package/json-schema/powersync-config.json CHANGED
@@ -39,12 +39,14 @@
39
39
  "properties": {
40
40
  "type": {
41
41
  "type": "string",
42
- "const": "postgresql"
42
+ "const": "mongodb"
43
43
  },
44
44
  "id": {
45
+ "description": "Unique identifier for the connection. Optional when only a single connection is present.",
45
46
  "type": "string"
46
47
  },
47
48
  "tag": {
49
+ "description": "Additional meta tag for the connection, used for categorization or grouping.",
48
50
  "type": "string"
49
51
  },
50
52
  "debug_api": {
@@ -54,86 +56,64 @@
54
56
  "uri": {
55
57
  "type": "string"
56
58
  },
57
- "hostname": {
59
+ "database": {
58
60
  "type": "string"
59
61
  },
60
- "port": {
61
- "description": "A network port value that can be specified as either a number or a string that will be parsed to a number.",
62
- "anyOf": [
63
- {
64
- "type": "number"
65
- },
66
- {
67
- "type": "string"
68
- }
69
- ]
70
- },
71
62
  "username": {
72
63
  "type": "string"
73
64
  },
74
65
  "password": {
75
66
  "type": "string"
76
67
  },
77
- "database": {
78
- "type": "string"
68
+ "reject_ip_ranges": {
69
+ "type": "array",
70
+ "items": {
71
+ "type": "string"
72
+ }
79
73
  },
80
- "sslmode": {
74
+ "post_images": {
81
75
  "anyOf": [
82
76
  {
83
77
  "type": "string",
84
- "const": "verify-full"
78
+ "const": "off"
85
79
  },
86
80
  {
87
81
  "type": "string",
88
- "const": "verify-ca"
82
+ "const": "auto_configure"
89
83
  },
90
84
  {
91
85
  "type": "string",
92
- "const": "disable"
86
+ "const": "read_only"
93
87
  }
94
88
  ]
95
- },
96
- "cacert": {
97
- "type": "string"
98
- },
99
- "client_certificate": {
100
- "type": "string"
101
- },
102
- "client_private_key": {
103
- "type": "string"
104
- },
105
- "tls_servername": {
106
- "type": "string"
107
- },
108
- "reject_ip_ranges": {
109
- "type": "array",
110
- "items": {
111
- "type": "string"
112
- }
113
- },
114
- "slot_name_prefix": {
115
- "type": "string"
116
- },
117
- "max_pool_size": {
118
- "type": "number"
119
89
  }
120
90
  },
121
91
  "additionalProperties": true,
122
92
  "required": [
123
- "type"
93
+ "type",
94
+ "uri"
124
95
  ]
125
96
  },
126
97
  {
127
98
  "type": "object",
128
99
  "properties": {
129
100
  "type": {
130
- "description": "Unique string identifier for the data source type (e.g., \"postgresql\", \"mysql\", etc.).",
101
+ "type": "string",
102
+ "const": "mssql"
103
+ },
104
+ "id": {
105
+ "description": "Unique identifier for the connection. Optional when only a single connection is present.",
131
106
  "type": "string"
132
107
  },
133
- "uri": {
108
+ "tag": {
109
+ "description": "Additional meta tag for the connection, used for categorization or grouping.",
134
110
  "type": "string"
135
111
  },
136
- "database": {
112
+ "debug_api": {
113
+ "description": "When enabled, allows query execution.",
114
+ "type": "boolean"
115
+ },
116
+ "uri": {
137
117
  "type": "string"
138
118
  },
139
119
  "username": {
@@ -142,12 +122,167 @@
142
122
  "password": {
143
123
  "type": "string"
144
124
  },
125
+ "database": {
126
+ "type": "string"
127
+ },
128
+ "schema": {
129
+ "type": "string"
130
+ },
131
+ "hostname": {
132
+ "type": "string"
133
+ },
134
+ "port": {
135
+ "description": "A network port value that can be specified as either a number or a string that will be parsed to a number.",
136
+ "anyOf": [
137
+ {
138
+ "type": "number"
139
+ },
140
+ {
141
+ "type": "string"
142
+ }
143
+ ]
144
+ },
145
+ "authentication": {
146
+ "anyOf": [
147
+ {
148
+ "type": "object",
149
+ "properties": {
150
+ "type": {
151
+ "type": "string",
152
+ "const": "default"
153
+ },
154
+ "options": {
155
+ "type": "object",
156
+ "properties": {
157
+ "userName": {
158
+ "type": "string"
159
+ },
160
+ "password": {
161
+ "type": "string"
162
+ }
163
+ },
164
+ "additionalProperties": true,
165
+ "required": [
166
+ "userName",
167
+ "password"
168
+ ]
169
+ }
170
+ },
171
+ "additionalProperties": true,
172
+ "required": [
173
+ "type",
174
+ "options"
175
+ ]
176
+ },
177
+ {
178
+ "type": "object",
179
+ "properties": {
180
+ "type": {
181
+ "type": "string",
182
+ "const": "azure-active-directory-password"
183
+ },
184
+ "options": {
185
+ "type": "object",
186
+ "properties": {
187
+ "userName": {
188
+ "type": "string"
189
+ },
190
+ "password": {
191
+ "type": "string"
192
+ },
193
+ "clientId": {
194
+ "type": "string"
195
+ },
196
+ "tenantId": {
197
+ "type": "string"
198
+ }
199
+ },
200
+ "additionalProperties": true,
201
+ "required": [
202
+ "userName",
203
+ "password",
204
+ "clientId",
205
+ "tenantId"
206
+ ]
207
+ }
208
+ },
209
+ "additionalProperties": true,
210
+ "required": [
211
+ "type",
212
+ "options"
213
+ ]
214
+ },
215
+ {
216
+ "type": "object",
217
+ "properties": {
218
+ "type": {
219
+ "type": "string",
220
+ "const": "azure-active-directory-service-principal-secret"
221
+ },
222
+ "options": {
223
+ "type": "object",
224
+ "properties": {
225
+ "clientId": {
226
+ "type": "string"
227
+ },
228
+ "clientSecret": {
229
+ "type": "string"
230
+ },
231
+ "tenantId": {
232
+ "type": "string"
233
+ }
234
+ },
235
+ "additionalProperties": true,
236
+ "required": [
237
+ "clientId",
238
+ "clientSecret",
239
+ "tenantId"
240
+ ]
241
+ }
242
+ },
243
+ "additionalProperties": true,
244
+ "required": [
245
+ "type",
246
+ "options"
247
+ ]
248
+ }
249
+ ]
250
+ },
145
251
  "reject_ip_ranges": {
146
252
  "type": "array",
147
253
  "items": {
148
254
  "type": "string"
149
255
  }
150
256
  },
257
+ "additionalConfig": {
258
+ "type": "object",
259
+ "properties": {
260
+ "pollingIntervalMs": {
261
+ "type": "number"
262
+ },
263
+ "pollingBatchSize": {
264
+ "type": "number"
265
+ },
266
+ "trustServerCertificate": {
267
+ "type": "boolean"
268
+ }
269
+ },
270
+ "additionalProperties": true,
271
+ "required": []
272
+ }
273
+ },
274
+ "additionalProperties": true,
275
+ "required": [
276
+ "type"
277
+ ]
278
+ },
279
+ {
280
+ "type": "object",
281
+ "properties": {
282
+ "type": {
283
+ "type": "string",
284
+ "const": "mysql"
285
+ },
151
286
  "id": {
152
287
  "description": "Unique identifier for the connection. Optional when only a single connection is present.",
153
288
  "type": "string"
@@ -160,27 +295,57 @@
160
295
  "description": "When enabled, allows query execution.",
161
296
  "type": "boolean"
162
297
  },
163
- "post_images": {
298
+ "uri": {
299
+ "type": "string"
300
+ },
301
+ "hostname": {
302
+ "type": "string"
303
+ },
304
+ "port": {
305
+ "description": "A network port value that can be specified as either a number or a string that will be parsed to a number.",
164
306
  "anyOf": [
165
307
  {
166
- "type": "string",
167
- "const": "off"
168
- },
169
- {
170
- "type": "string",
171
- "const": "auto_configure"
308
+ "type": "number"
172
309
  },
173
310
  {
174
- "type": "string",
175
- "const": "read_only"
311
+ "type": "string"
176
312
  }
177
313
  ]
314
+ },
315
+ "username": {
316
+ "type": "string"
317
+ },
318
+ "password": {
319
+ "type": "string"
320
+ },
321
+ "database": {
322
+ "type": "string"
323
+ },
324
+ "server_id": {
325
+ "type": "number"
326
+ },
327
+ "cacert": {
328
+ "type": "string"
329
+ },
330
+ "client_certificate": {
331
+ "type": "string"
332
+ },
333
+ "client_private_key": {
334
+ "type": "string"
335
+ },
336
+ "reject_ip_ranges": {
337
+ "type": "array",
338
+ "items": {
339
+ "type": "string"
340
+ }
341
+ },
342
+ "binlog_queue_memory_limit": {
343
+ "type": "number"
178
344
  }
179
345
  },
180
346
  "additionalProperties": true,
181
347
  "required": [
182
- "type",
183
- "uri"
348
+ "type"
184
349
  ]
185
350
  },
186
351
  {
@@ -188,14 +353,12 @@
188
353
  "properties": {
189
354
  "type": {
190
355
  "type": "string",
191
- "const": "mysql"
356
+ "const": "postgresql"
192
357
  },
193
358
  "id": {
194
- "description": "Unique identifier for the connection. Optional when only a single connection is present.",
195
359
  "type": "string"
196
360
  },
197
361
  "tag": {
198
- "description": "Additional meta tag for the connection, used for categorization or grouping.",
199
362
  "type": "string"
200
363
  },
201
364
  "debug_api": {
@@ -228,8 +391,21 @@
228
391
  "database": {
229
392
  "type": "string"
230
393
  },
231
- "server_id": {
232
- "type": "number"
394
+ "sslmode": {
395
+ "anyOf": [
396
+ {
397
+ "type": "string",
398
+ "const": "verify-full"
399
+ },
400
+ {
401
+ "type": "string",
402
+ "const": "verify-ca"
403
+ },
404
+ {
405
+ "type": "string",
406
+ "const": "disable"
407
+ }
408
+ ]
233
409
  },
234
410
  "cacert": {
235
411
  "type": "string"
@@ -240,13 +416,22 @@
240
416
  "client_private_key": {
241
417
  "type": "string"
242
418
  },
419
+ "tls_servername": {
420
+ "type": "string"
421
+ },
243
422
  "reject_ip_ranges": {
244
423
  "type": "array",
245
424
  "items": {
246
425
  "type": "string"
247
426
  }
248
427
  },
249
- "binlog_queue_memory_limit": {
428
+ "slot_name_prefix": {
429
+ "type": "string"
430
+ },
431
+ "max_pool_size": {
432
+ "type": "number"
433
+ },
434
+ "connect_timeout": {
250
435
  "type": "number"
251
436
  }
252
437
  },
@@ -680,6 +865,9 @@
680
865
  "slot_name_prefix": {
681
866
  "type": "string"
682
867
  },
868
+ "connect_timeout": {
869
+ "type": "number"
870
+ },
683
871
  "batch_limits": {
684
872
  "type": "object",
685
873
  "properties": {
@@ -747,20 +935,40 @@
747
935
  }
748
936
  ]
749
937
  },
750
- "sync_rules": {
938
+ "sync_config": {
751
939
  "description": "Configuration for synchronization rules that define data access patterns.",
752
940
  "type": "object",
753
941
  "properties": {
754
942
  "path": {
755
- "description": "Path to the sync rules YAML file.",
943
+ "description": "Path to the sync config YAML file.",
944
+ "type": "string"
945
+ },
946
+ "content": {
947
+ "description": "Inline sync config content as a string.",
948
+ "type": "string"
949
+ },
950
+ "exit_on_error": {
951
+ "description": "Whether to exit the process if there is an error parsing sync config.",
952
+ "type": "boolean"
953
+ }
954
+ },
955
+ "additionalProperties": true,
956
+ "required": []
957
+ },
958
+ "sync_rules": {
959
+ "description": "Deprecated. Use sync_config instead.",
960
+ "type": "object",
961
+ "properties": {
962
+ "path": {
963
+ "description": "Path to the sync config YAML file.",
756
964
  "type": "string"
757
965
  },
758
966
  "content": {
759
- "description": "Inline sync rules content as a string.",
967
+ "description": "Inline sync config content as a string.",
760
968
  "type": "string"
761
969
  },
762
970
  "exit_on_error": {
763
- "description": "Whether to exit the process if there is an error parsing sync rules.",
971
+ "description": "Whether to exit the process if there is an error parsing sync config.",
764
972
  "type": "boolean"
765
973
  }
766
974
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powersync/service-schema",
3
- "version": "1.19.1",
3
+ "version": "1.20.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "FSL-1.1-ALv2",
@@ -12,16 +12,24 @@
12
12
  "dist/**/*",
13
13
  "json-schema/*"
14
14
  ],
15
+ "exports": {
16
+ ".": {
17
+ "import": "./dist/index.js",
18
+ "require": "./dist/index.js",
19
+ "default": "./dist/index.js"
20
+ },
21
+ "./schema.json": "./json-schema/powersync-config.json"
22
+ },
15
23
  "repository": "https://github.com/powersync-ja/powersync-service",
16
- "dependencies": {},
17
24
  "devDependencies": {
18
25
  "ts-codec": "^1.3.0",
19
- "@powersync/service-module-postgres": "0.17.1",
20
- "@powersync/service-module-postgres-storage": "0.11.1",
21
- "@powersync/service-module-mongodb": "0.13.1",
22
- "@powersync/service-module-mongodb-storage": "0.13.1",
23
- "@powersync/service-module-mysql": "0.10.1",
24
- "@powersync/service-types": "0.14.0"
26
+ "@powersync/service-module-postgres": "0.18.0",
27
+ "@powersync/service-module-postgres-storage": "0.12.0",
28
+ "@powersync/service-module-mongodb": "0.14.0",
29
+ "@powersync/service-module-mongodb-storage": "0.14.0",
30
+ "@powersync/service-module-mysql": "0.11.0",
31
+ "@powersync/service-module-mssql": "0.4.0",
32
+ "@powersync/service-types": "0.15.0"
25
33
  },
26
34
  "scripts": {
27
35
  "clean": "rm -r ./dist && tsc -b --clean",