@powersync/service-types 0.0.0-dev-20240918082156

package/dist/definitions.js

@@ -0,0 +1,121 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstanceSchema = exports.DatabaseSchema = exports.ConnectionStatusV2 = exports.ConnectionStatus = exports.SyncRulesStatus = exports.TableInfo = exports.ReplicationError = void 0;
+const t = __importStar(require("ts-codec"));
+exports.ReplicationError = t.object({
+    /** Warning: Could indicate an issue. Fatal: Prevents replicating. */
+    level: t.literal('warning').or(t.literal('fatal')),
+    message: t.string
+});
+exports.TableInfo = t.object({
+    schema: t.string,
+    name: t.string,
+    /** Specified if this table is part of a wildcard pattern. */
+    pattern: t.string.optional(),
+    /** Usually just ['id'] */
+    replication_id: t.array(t.string),
+    /** Used in data replication */
+    data_queries: t.boolean,
+    /** Used for parameter query replication */
+    parameter_queries: t.boolean,
+    /** Also included in the global errors array. */
+    errors: t.array(exports.ReplicationError)
+});
+exports.SyncRulesStatus = t.object({
+    content: t.string.optional(),
+    connections: t.array(t.object({
+        id: t.string,
+        tag: t.string,
+        /**
+         * PostgreSQL logical replication slot name.
+         */
+        slot_name: t.string,
+        /**
+         * Once initial replication is done, this moves over to
+         * logical replication.
+         */
+        initial_replication_done: t.boolean,
+        /**
+         * The last LSN that has been replicated. This may be in the middle of a transaction.
+         */
+        last_lsn: t.string.optional(),
+        /**
+         * The last time any replication activity was recorded.
+         *
+         * This is typically (but not always) updated together with last_lsn
+         */
+        last_keepalive_ts: t.string.optional(),
+        /**
+         * The last time we created a new checkpoint. In other words, a transaction
+         * was successfully replicated.
+         */
+        last_checkpoint_ts: t.string.optional(),
+        /** Replication lag in bytes. undefined if we cannot calculate this. */
+        replication_lag_bytes: t.number.optional(),
+        tables: t.array(exports.TableInfo)
+    })),
+    /** Sync-rule-level errors */
+    errors: t.array(exports.ReplicationError)
+});
+exports.ConnectionStatus = t.object({
+    id: t.string,
+    postgres_uri: t.string,
+    connected: t.boolean,
+    /** Connection-level errors */
+    errors: t.array(exports.ReplicationError)
+});
+exports.ConnectionStatusV2 = t.object({
+    id: t.string,
+    uri: t.string,
+    connected: t.boolean,
+    /** Connection-level errors */
+    errors: t.array(exports.ReplicationError)
+});
+exports.DatabaseSchema = t.object({
+    name: t.string,
+    tables: t.array(t.object({
+        name: t.string,
+        columns: t.array(t.object({
+            name: t.string,
+            /**
+             * Full type name, e.g. "character varying(255)[]"
+             */
+            type: t.string,
+            /**
+             * Internal postgres type, e.g. "varchar[]".
+             */
+            pg_type: t.string
+        }))
+    }))
+});
+exports.InstanceSchema = t.object({
+    connections: t.array(t.object({
+        id: t.string.optional(),
+        tag: t.string,
+        schemas: t.array(exports.DatabaseSchema)
+    }))
+});
+//# sourceMappingURL=definitions.js.map

package/dist/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAA8B;AAEjB,QAAA,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,qEAAqE;IACrE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CAAC;AAGU,QAAA,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd,6DAA6D;IAC7D,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAE5B,0BAA0B;IAC1B,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACjC,+BAA+B;IAC/B,YAAY,EAAE,CAAC,CAAC,OAAO;IACvB,2CAA2C;IAC3C,iBAAiB,EAAE,CAAC,CAAC,OAAO;IAE5B,gDAAgD;IAChD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC;CAClC,CAAC,CAAC;AAGU,QAAA,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,KAAK,CAClB,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,CAAC,CAAC,MAAM;QACZ,GAAG,EAAE,CAAC,CAAC,MAAM;QAEb;;WAEG;QACH,SAAS,EAAE,CAAC,CAAC,MAAM;QAEnB;;;WAGG;QACH,wBAAwB,EAAE,CAAC,CAAC,OAAO;QAEnC;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QAE7B;;;;WAIG;QACH,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QAEtC;;;WAGG;QACH,kBAAkB,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QAEvC,uEAAuE;QACvE,qBAAqB,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QAE1C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAS,CAAC;KAC3B,CAAC,CACH;IACD,6BAA6B;IAC7B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC;CAClC,CAAC,CAAC;AAGU,QAAA,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,CAAC,CAAC,MAAM;IACZ,YAAY,EAAE,CAAC,CAAC,MAAM;IACtB,SAAS,EAAE,CAAC,CAAC,OAAO;IACpB,8BAA8B;IAC9B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC;CAClC,CAAC,CAAC;AAGU,QAAA,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,EAAE,EAAE,CAAC,CAAC,MAAM;IACZ,GAAG,EAAE,CAAC,CAAC,MAAM;IACb,SAAS,EAAE,CAAC,CAAC,OAAO;IACpB,8BAA8B;IAC9B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC;CAClC,CAAC,CAAC;AAGU,QAAA,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM;IACd,MAAM,EAAE,CAAC,CAAC,KAAK,CACb,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM;QACd,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,MAAM;YACd;;eAEG;YACH,IAAI,EAAE,CAAC,CAAC,MAAM;YACd;;eAEG;YACH,OAAO,EAAE,CAAC,CAAC,MAAM;SAClB,CAAC,CACH;KACF,CAAC,CACH;CACF,CAAC,CAAC;AAGU,QAAA,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,WAAW,EAAE,CAAC,CAAC,KAAK,CAClB,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QACvB,GAAG,EAAE,CAAC,CAAC,MAAM;QACb,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAc,CAAC;KACjC,CAAC,CACH;CACF,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * as configFile from './config/PowerSyncConfig.js';
+export * from './definitions.js';
+export * from './config/normalize.js';
+export * as internal_routes from './routes.js';

package/dist/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.internal_routes = exports.configFile = void 0;
+exports.configFile = __importStar(require("./config/PowerSyncConfig.js"));
+__exportStar(require("./definitions.js"), exports);
+__exportStar(require("./config/normalize.js"), exports);
+exports.internal_routes = __importStar(require("./routes.js"));
+//# 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,0EAA0D;AAE1D,mDAAiC;AACjC,wDAAsC;AACtC,+DAA+C"}

package/dist/routes.d.ts

@@ -0,0 +1,228 @@
+import * as t from 'ts-codec';
+export declare const GetSchemaRequest: t.ObjectCodec<{}>;
+export type GetSchemaRequest = t.Encoded<typeof GetSchemaRequest>;
+export declare const GetSchemaResponse: t.ObjectCodec<{
+    connections: t.ArrayCodec<t.ObjectCodec<{
+        id: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+        tag: t.IdentityCodec<t.CodecType.String>;
+        schemas: t.ArrayCodec<t.ObjectCodec<{
+            name: t.IdentityCodec<t.CodecType.String>;
+            tables: t.ArrayCodec<t.ObjectCodec<{
+                name: t.IdentityCodec<t.CodecType.String>;
+                columns: t.ArrayCodec<t.ObjectCodec<{
+                    name: t.IdentityCodec<t.CodecType.String>;
+                    type: t.IdentityCodec<t.CodecType.String>;
+                    pg_type: t.IdentityCodec<t.CodecType.String>;
+                }>>;
+            }>>;
+        }>>;
+    }>>;
+}>;
+export type GetSchemaResponse = t.Encoded<typeof GetSchemaResponse>;
+export declare const ExecuteSqlRequest: t.ObjectCodec<{
+    connection_id: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    sql: t.ObjectCodec<{
+        query: t.IdentityCodec<t.CodecType.String>;
+        args: t.ArrayCodec<t.Union<t.Codec<string | number, string | number, string, t.CodecProps>, t.IdentityCodec<t.CodecType.Boolean>>>;
+    }>;
+}>;
+export type ExecuteSqlRequest = t.Encoded<typeof ExecuteSqlRequest>;
+export declare const ExecuteSqlResponse: t.ObjectCodec<{
+    success: t.IdentityCodec<t.CodecType.Boolean>;
+    results: t.ObjectCodec<{
+        columns: t.ArrayCodec<t.IdentityCodec<t.CodecType.String>>;
+        rows: t.ArrayCodec<t.ArrayCodec<t.Union<t.Codec<string | number | boolean, string | number | boolean, string, t.CodecProps>, t.Codec<null, null, t.CodecType.Null, t.CodecProps>>>>;
+    }>;
+    /** Set if success = false */
+    error: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+}>;
+export type ExecuteSqlResponse = t.Encoded<typeof ExecuteSqlResponse>;
+export declare const DiagnosticsRequest: t.ObjectCodec<{
+    sync_rules_content: t.OptionalCodec<t.Codec<boolean, boolean, string, t.CodecProps>>;
+}>;
+export type DiagnosticsRequest = t.Encoded<typeof DiagnosticsRequest>;
+export declare const DiagnosticsResponse: t.ObjectCodec<{
+    /**
+     * Connection-level errors are listed here.
+     */
+    connections: t.ArrayCodec<t.ObjectCodec<{
+        id: t.IdentityCodec<t.CodecType.String>;
+        postgres_uri: t.IdentityCodec<t.CodecType.String>;
+        connected: t.IdentityCodec<t.CodecType.Boolean>;
+        errors: t.ArrayCodec<t.ObjectCodec<{
+            level: t.Union<t.Codec<"warning", "warning", string, t.CodecProps>, t.LiteralCodec<"fatal">>;
+            message: t.IdentityCodec<t.CodecType.String>;
+        }>>;
+    }>>;
+    /**
+     * Present if there are fully-deployed sync rules.
+     *
+     * Sync-rule-level errors are listed here.
+     */
+    active_sync_rules: t.OptionalCodec<t.Codec<{
+        errors: {
+            level: "warning" | "fatal";
+            message: string;
+        }[];
+        connections: {
+            id: string;
+            tag: string;
+            slot_name: string;
+            initial_replication_done: boolean;
+            tables: {
+                schema: string;
+                name: string;
+                replication_id: string[];
+                data_queries: boolean;
+                parameter_queries: boolean;
+                errors: {
+                    level: "warning" | "fatal";
+                    message: string;
+                }[];
+                pattern?: string | undefined;
+            }[];
+            last_lsn?: string | undefined;
+            last_keepalive_ts?: string | undefined;
+            last_checkpoint_ts?: string | undefined;
+            replication_lag_bytes?: number | undefined;
+        }[];
+        content?: string | undefined;
+    }, {
+        errors: {
+            level: "warning" | "fatal";
+            message: string;
+        }[];
+        connections: {
+            id: string;
+            tag: string;
+            slot_name: string;
+            initial_replication_done: boolean;
+            tables: {
+                schema: string;
+                name: string;
+                replication_id: string[];
+                data_queries: boolean;
+                parameter_queries: boolean;
+                errors: {
+                    level: "warning" | "fatal";
+                    message: string;
+                }[];
+                pattern?: string | undefined;
+            }[];
+            last_lsn?: string | undefined;
+            last_keepalive_ts?: string | undefined;
+            last_checkpoint_ts?: string | undefined;
+            replication_lag_bytes?: number | undefined;
+        }[];
+        content?: string | undefined;
+    }, string, t.CodecProps>>;
+    /**
+     * Present if there are sync rules in the process of being deployed / initial replication.
+     *
+     * Once initial replication is done, this will  be placed in `active_sync_rules`.
+     *
+     * Sync-rule-level errors are listed here.
+     */
+    deploying_sync_rules: t.OptionalCodec<t.Codec<{
+        errors: {
+            level: "warning" | "fatal";
+            message: string;
+        }[];
+        connections: {
+            id: string;
+            tag: string;
+            slot_name: string;
+            initial_replication_done: boolean;
+            tables: {
+                schema: string;
+                name: string;
+                replication_id: string[];
+                data_queries: boolean;
+                parameter_queries: boolean;
+                errors: {
+                    level: "warning" | "fatal";
+                    message: string;
+                }[];
+                pattern?: string | undefined;
+            }[];
+            last_lsn?: string | undefined;
+            last_keepalive_ts?: string | undefined;
+            last_checkpoint_ts?: string | undefined;
+            replication_lag_bytes?: number | undefined;
+        }[];
+        content?: string | undefined;
+    }, {
+        errors: {
+            level: "warning" | "fatal";
+            message: string;
+        }[];
+        connections: {
+            id: string;
+            tag: string;
+            slot_name: string;
+            initial_replication_done: boolean;
+            tables: {
+                schema: string;
+                name: string;
+                replication_id: string[];
+                data_queries: boolean;
+                parameter_queries: boolean;
+                errors: {
+                    level: "warning" | "fatal";
+                    message: string;
+                }[];
+                pattern?: string | undefined;
+            }[];
+            last_lsn?: string | undefined;
+            last_keepalive_ts?: string | undefined;
+            last_checkpoint_ts?: string | undefined;
+            replication_lag_bytes?: number | undefined;
+        }[];
+        content?: string | undefined;
+    }, string, t.CodecProps>>;
+}>;
+export type DiagnosticsResponse = t.Encoded<typeof DiagnosticsResponse>;
+export declare const ReprocessRequest: t.ObjectCodec<{}>;
+export type ReprocessRequest = t.Encoded<typeof ReprocessRequest>;
+export declare const ReprocessResponse: t.ObjectCodec<{
+    connections: t.ArrayCodec<t.ObjectCodec<{
+        id: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+        tag: t.IdentityCodec<t.CodecType.String>;
+        slot_name: t.IdentityCodec<t.CodecType.String>;
+    }>>;
+}>;
+export type ReprocessResponse = t.Encoded<typeof ReprocessResponse>;
+export declare const ValidateRequest: t.ObjectCodec<{
+    sync_rules: t.IdentityCodec<t.CodecType.String>;
+}>;
+export type ValidateRequest = t.Encoded<typeof ValidateRequest>;
+export declare const ValidateResponse: t.ObjectCodec<{
+    content: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    connections: t.ArrayCodec<t.ObjectCodec<{
+        id: t.IdentityCodec<t.CodecType.String>;
+        tag: t.IdentityCodec<t.CodecType.String>;
+        slot_name: t.IdentityCodec<t.CodecType.String>;
+        initial_replication_done: t.IdentityCodec<t.CodecType.Boolean>;
+        last_lsn: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+        last_keepalive_ts: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+        last_checkpoint_ts: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+        replication_lag_bytes: t.OptionalCodec<t.Codec<number, number, string, t.CodecProps>>;
+        tables: t.ArrayCodec<t.ObjectCodec<{
+            schema: t.IdentityCodec<t.CodecType.String>;
+            name: t.IdentityCodec<t.CodecType.String>;
+            pattern: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+            replication_id: t.ArrayCodec<t.IdentityCodec<t.CodecType.String>>;
+            data_queries: t.IdentityCodec<t.CodecType.Boolean>;
+            parameter_queries: t.IdentityCodec<t.CodecType.Boolean>;
+            errors: t.ArrayCodec<t.ObjectCodec<{
+                level: t.Union<t.Codec<"warning", "warning", string, t.CodecProps>, t.LiteralCodec<"fatal">>;
+                message: t.IdentityCodec<t.CodecType.String>;
+            }>>;
+        }>>;
+    }>>;
+    errors: t.ArrayCodec<t.ObjectCodec<{
+        level: t.Union<t.Codec<"warning", "warning", string, t.CodecProps>, t.LiteralCodec<"fatal">>;
+        message: t.IdentityCodec<t.CodecType.String>;
+    }>>;
+}>;
+export type ValidateResponse = t.Encoded<typeof ValidateResponse>;

package/dist/routes.js

@@ -0,0 +1,82 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidateResponse = exports.ValidateRequest = exports.ReprocessResponse = exports.ReprocessRequest = exports.DiagnosticsResponse = exports.DiagnosticsRequest = exports.ExecuteSqlResponse = exports.ExecuteSqlRequest = exports.GetSchemaResponse = exports.GetSchemaRequest = void 0;
+const t = __importStar(require("ts-codec"));
+const definitions_1 = require("./definitions");
+exports.GetSchemaRequest = t.object({});
+exports.GetSchemaResponse = definitions_1.InstanceSchema;
+exports.ExecuteSqlRequest = t.object({
+    connection_id: t.string.optional(),
+    sql: t.object({
+        query: t.string,
+        args: t.array(t.string.or(t.number).or(t.boolean))
+    })
+});
+exports.ExecuteSqlResponse = t.object({
+    success: t.boolean,
+    results: t.object({
+        columns: t.array(t.string),
+        rows: t.array(t.array(t.string.or(t.number).or(t.boolean).or(t.Null)))
+    }),
+    /** Set if success = false */
+    error: t.string.optional()
+});
+exports.DiagnosticsRequest = t.object({
+    sync_rules_content: t.boolean.optional()
+});
+exports.DiagnosticsResponse = t.object({
+    /**
+     * Connection-level errors are listed here.
+     */
+    connections: t.array(definitions_1.ConnectionStatus),
+    /**
+     * Present if there are fully-deployed sync rules.
+     *
+     * Sync-rule-level errors are listed here.
+     */
+    active_sync_rules: definitions_1.SyncRulesStatus.optional(),
+    /**
+     * Present if there are sync rules in the process of being deployed / initial replication.
+     *
+     * Once initial replication is done, this will  be placed in `active_sync_rules`.
+     *
+     * Sync-rule-level errors are listed here.
+     */
+    deploying_sync_rules: definitions_1.SyncRulesStatus.optional()
+});
+exports.ReprocessRequest = t.object({});
+exports.ReprocessResponse = t.object({
+    connections: t.array(t.object({
+        id: t.string.optional(),
+        tag: t.string,
+        slot_name: t.string
+    }))
+});
+exports.ValidateRequest = t.object({
+    sync_rules: t.string
+});
+exports.ValidateResponse = definitions_1.SyncRulesStatus;
+//# sourceMappingURL=routes.js.map

package/dist/routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAA8B;AAC9B,+CAAkF;AAErE,QAAA,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAGhC,QAAA,iBAAiB,GAAG,4BAAc,CAAC;AAGnC,QAAA,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAClC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,KAAK,EAAE,CAAC,CAAC,MAAM;QACf,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;KACnD,CAAC;CACH,CAAC,CAAC;AAGU,QAAA,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,OAAO;IAClB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAC1B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;KACvE,CAAC;IACF,6BAA6B;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAGU,QAAA,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAGU,QAAA,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,8BAAgB,CAAC;IAEtC;;;;OAIG;IACH,iBAAiB,EAAE,6BAAe,CAAC,QAAQ,EAAE;IAE7C;;;;;;OAMG;IACH,oBAAoB,EAAE,6BAAe,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC;AAGU,QAAA,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAGhC,QAAA,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,WAAW,EAAE,CAAC,CAAC,KAAK,CAClB,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QACvB,GAAG,EAAE,CAAC,CAAC,MAAM;QACb,SAAS,EAAE,CAAC,CAAC,MAAM;KACpB,CAAC,CACH;CACF,CAAC,CAAC;AAGU,QAAA,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,UAAU,EAAE,CAAC,CAAC,MAAM;CACrB,CAAC,CAAC;AAGU,QAAA,gBAAgB,GAAG,6BAAe,CAAC"}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@powersync/service-types",
+  "version": "0.0.0-dev-20240918082156",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "FSL-1.1-Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "https://github.com/powersync-ja/powersync-service",
+  "dependencies": {
+    "ts-codec": "^1.2.2",
+    "uri-js": "^4.4.1"
+  },
+  "scripts": {
+    "clean": "rm -r ./dist && tsc -b --clean",
+    "build": "tsc -b"
+  }
+}

package/src/config/PowerSyncConfig.ts

@@ -0,0 +1,142 @@
+import * as t from 'ts-codec';
+
+/**
+ * Users might specify ports as strings if using YAML custom tag environment substitutions
+ */
+export const portCodec = t.codec<number, number | string>(
+  'Port',
+  (value) => value,
+  (value) => (typeof value == 'number' ? value : parseInt(value))
+);
+
+/**
+ * This gets used whenever generating a JSON schema
+ */
+export const portParser = {
+  tag: portCodec._tag,
+  parse: () => ({
+    anyOf: [{ type: 'number' }, { type: 'string' }]
+  })
+};
+
+export const dataSourceConfig = t.object({
+  // Unique string identifier for the data source
+  type: t.string,
+  /** Unique identifier for the connection - optional when a single connection is present. */
+  id: t.string.optional(),
+  /** Additional meta tag for connection */
+  tag: t.string.optional(),
+  /**
+   * Allows for debug query execution
+   */
+  debug_api: t.boolean.optional()
+});
+
+export type DataSourceConfig = t.Decoded<typeof dataSourceConfig>;
+
+/**
+ * This essentially allows any extra fields on this type
+ */
+export const genericDataSourceConfig = dataSourceConfig.and(t.record(t.any));
+export type GenericDataSourceConfig = t.Decoded<typeof genericDataSourceConfig>;
+
+export const jwkRSA = t.object({
+  kty: t.literal('RSA'),
+  kid: t.string,
+  n: t.string,
+  e: t.string,
+  alg: t.literal('RS256').or(t.literal('RS384')).or(t.literal('RS512')).optional(),
+  use: t.string.optional()
+});
+
+export const jwkHmac = t.object({
+  kty: t.literal('oct'),
+  /**
+   * undefined kid indicates it can match any JWT, with or without a kid.
+   * Use a kid wherever possible.
+   */
+  kid: t.string.optional(),
+  k: t.string,
+  alg: t.literal('HS256').or(t.literal('HS384')).or(t.literal('HS512')),
+  use: t.string.optional()
+});
+
+const jwk = t.union(jwkRSA, jwkHmac);
+
+export const strictJwks = t.object({
+  keys: t.array(jwk)
+});
+
+export type StrictJwk = t.Decoded<typeof jwk>;
+
+export const storageConfig = t.object({
+  type: t.literal('mongodb'),
+  uri: t.string,
+  database: t.string.optional(),
+  username: t.string.optional(),
+  password: t.string.optional()
+});
+
+export type StorageConfig = t.Decoded<typeof storageConfig>;
+
+export const powerSyncConfig = t.object({
+  replication: t
+    .object({
+      // This uses the generic config which may have additional fields
+      connections: t.array(genericDataSourceConfig).optional()
+    })
+    .optional(),
+
+  dev: t
+    .object({
+      demo_auth: t.boolean.optional(),
+      demo_password: t.string.optional(),
+      crud_api: t.boolean.optional(),
+      demo_client: t.boolean.optional()
+    })
+    .optional(),
+
+  client_auth: t
+    .object({
+      jwks_uri: t.string.or(t.array(t.string)).optional(),
+      block_local_jwks: t.boolean.optional(),
+      jwks: strictJwks.optional(),
+      supabase: t.boolean.optional(),
+      audience: t.array(t.string).optional()
+    })
+    .optional(),
+
+  api: t
+    .object({
+      tokens: t.array(t.string).optional()
+    })
+    .optional(),
+
+  storage: storageConfig,
+
+  port: portCodec.optional(),
+  sync_rules: t
+    .object({
+      path: t.string.optional(),
+      content: t.string.optional()
+    })
+    .optional(),
+
+  metadata: t.record(t.string).optional(),
+
+  migrations: t
+    .object({
+      disable_auto_migration: t.boolean.optional()
+    })
+    .optional(),
+
+  telemetry: t
+    .object({
+      disable_telemetry_sharing: t.boolean,
+      internal_service_endpoint: t.string.optional()
+    })
+    .optional()
+});
+
+export type PowerSyncConfig = t.Decoded<typeof powerSyncConfig>;
+export type SerializedPowerSyncConfig = t.Encoded<typeof powerSyncConfig>;