Update sync config schema reference

.changeset/sunny-sloths-dance.md

@@ -0,0 +1,7 @@
+---
+'@powersync/cli-core': patch
+'@powersync/cli-schemas': patch
+'powersync': patch
+---
+
+Update YAML schema reference towards Sync Config definitions.

cli/package.json

@@ -24,7 +24,7 @@
     "@powersync/management-types": "catalog:",
     "@powersync/service-sync-rules": "catalog:",
     "@powersync/service-types": "catalog:",
-    "@powersync/sync-config-tools": "^0.1.2",
+    "@powersync/sync-config-tools": "^0.1.4",
     "bson": "^7.2.0",
     "diff": "^8.0.4",
     "fastify": "^5.8.5",

cli/src/commands/migrate/sync-rules.ts

@@ -52,7 +52,7 @@ export default class MigrateSyncRules extends SharedInstanceCommand {
 
       case 'success': {
         const outputContent = output.result;
-        await writeFile(syncOutputPath, YAML_SYNC_RULES_SCHEMA + outputContent);
+        await writeFile(syncOutputPath, `${YAML_SYNC_RULES_SCHEMA}\n${outputContent}`);
         this.log(ux.colorize('green', `Wrote ${syncOutputPath} with migrated sync streams.`));
         break;
       }

cli/test/commands/migrate.test.ts

@@ -15,8 +15,7 @@ describe('migrate', () => {
     const outputFile = join(testDirectory, 'output.yaml');
     writeFileSync(
       inputFile,
-      `
-bucket_definitions:
+      `bucket_definitions:
   user_lists:
     parameters: SELECT request.user_id() as user_id
     data:
@@ -32,7 +31,7 @@ bucket_definitions:
     const transformed = readFileSync(outputFile).toString('utf8');
     expect(transformed)
       .toStrictEqual(`# Adds YAML Schema support for VSCode users with the YAML extension installed. This enables features like validation and autocompletion based on the provided schema.
-# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_rules.json
+# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_config.json
 config:
   edition: 3
 streams:

examples/self-hosted/local-basic-supabase/powersync/sync-config.yaml

@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_rules.json
+# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_config.json
 #
 # See Documentation for more information:
 # https://docs.powersync.com/sync/overview

examples/self-hosted/local-postgres-node/powersync/sync-config.yaml

@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_rules.json
+# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_config.json
 #
 # See Documentation for more information:
 # https://docs.powersync.com/sync/overview

examples/self-hosted/local-postgres/powersync/sync-config.yaml

@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_rules.json
+# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_config.json
 #
 # See Documentation for more information:
 # https://docs.powersync.com/sync/overview

packages/cli-core/src/utils/yaml.ts

@@ -3,7 +3,7 @@ import * as yaml from 'yaml';
 
 export const YAML_SYNC_RULES_SCHEMA = /* yaml */ `
 # Adds YAML Schema support for VSCode users with the YAML extension installed. This enables features like validation and autocompletion based on the provided schema.
-# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_rules.json
+# yaml-language-server: $schema=https://unpkg.com/@powersync/service-sync-rules@latest/schema/sync_config.json
 `.trim();
 
 export const YAML_SERVICE_SCHEMA = /* yaml */ `

packages/schemas/src/scripts/create-schemas.ts

@@ -1,20 +1,16 @@
-import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import _SyncSchema from '@powersync/service-sync-rules/schema/sync_config.json' with { type: 'json' };
+import { mkdirSync, writeFileSync } from 'node:fs';
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 import { CLIConfigSchema } from '../CLIConfig.js';
 import { ServiceConfigSchema } from '../ServiceConfig.js';
 
-// todo: Import '@powersync/service-sync-rules/schema/sync_config.json' after https://github.com/powersync-ja/powersync-service/pull/824.
-const syncRulesIndex = import.meta.resolve('@powersync/service-sync-rules'); // resolves to dist/index.js
-const schemaFile = fileURLToPath(new URL('../schema/sync_rules.json', syncRulesIndex));
-const syncConfigSchema = JSON.parse(readFileSync(schemaFile, { encoding: 'utf8' }));
-
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const schemaDir = join(__dirname, '..', '..', 'json-schema');
 
 mkdirSync(schemaDir, { recursive: true });
 
 writeFileSync(join(schemaDir, 'cli-config.json'), JSON.stringify(CLIConfigSchema, null, 2));
 writeFileSync(join(schemaDir, 'service-config.json'), JSON.stringify(ServiceConfigSchema, null, 2));
-writeFileSync(join(schemaDir, 'sync-config.json'), JSON.stringify(syncConfigSchema, null, 2));
+writeFileSync(join(schemaDir, 'sync-config.json'), JSON.stringify(_SyncSchema, null, 2));

pnpm-workspace.yaml

@@ -28,10 +28,10 @@ catalog:
   '@oclif/core': ^4.10.6
   '@powersync/management-client': ^0.1.7
   '@powersync/management-types': ^0.3.0
-  '@powersync/service-client': ^0.0.10
-  '@powersync/service-schema': ^1.26.1
-  '@powersync/service-sync-rules': ^0.42.0
-  '@powersync/service-types': ^0.18.0
+  '@powersync/service-client': ^0.0.11
+  '@powersync/service-schema': ^1.27.0
+  '@powersync/service-sync-rules': ^0.43.0
+  '@powersync/service-types': ^0.19.0
   oclif: ^6.0.2
 
 patchedDependencies: