@powersync/common 1.6.1

package/lib/db/Column.js

@@ -0,0 +1,26 @@
+// https://www.sqlite.org/lang_expr.html#castexpr
+export var ColumnType;
+(function (ColumnType) {
+    ColumnType["TEXT"] = "TEXT";
+    ColumnType["INTEGER"] = "INTEGER";
+    ColumnType["REAL"] = "REAL";
+})(ColumnType || (ColumnType = {}));
+export class Column {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    get name() {
+        return this.options.name;
+    }
+    get type() {
+        return this.options.type;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            type: this.type
+        };
+    }
+}
+//# sourceMappingURL=Column.js.map

package/lib/db/Column.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Column.js","sourceRoot":"","sources":["../../src/db/Column.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,2BAAa,CAAA;AACf,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAOD,MAAM,OAAO,MAAM;IACK;IAAtB,YAAsB,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;IAAG,CAAC;IAEhD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;CACF"}

package/lib/db/DBAdapter.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Set of generic interfaces to allow PowerSync compatibility with
+ * different SQLite DB implementations.
+ */
+import { BaseListener, BaseObserverInterface } from '../utils/BaseObserver';
+/**
+ * TODO most of these types could be exported to a common `types` package
+ * which is used by the DB adapter libraries as well.
+ */
+/**
+ * Object returned by SQL Query executions.
+ */
+export type QueryResult = {
+    /** Represents the auto-generated row id if applicable. */
+    insertId?: number;
+    /** Number of affected rows if result of a update query. */
+    rowsAffected: number;
+    /** if status is undefined or 0 this object will contain the query results */
+    rows?: {
+        /** Raw array with all dataset */
+        _array: any[];
+        /** The length of the dataset */
+        length: number;
+        /** A convenience function to acess the index based the row object
+         * @param idx the row index
+         * @returns the row structure identified by column names
+         */
+        item: (idx: number) => any;
+    };
+};
+export interface DBGetUtils {
+    /** Execute a read-only query and return results. */
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    /** Execute a read-only query and return the first result, or null if the ResultSet is empty. */
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    /** Execute a read-only query and return the first result, error if the ResultSet is empty. */
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+}
+export interface LockContext extends DBGetUtils {
+    /** Execute a single write statement. */
+    execute: (query: string, params?: any[] | undefined) => Promise<QueryResult>;
+}
+export interface Transaction extends LockContext {
+    /** Commit multiple changes to the local DB using the Transaction context. */
+    commit: () => Promise<QueryResult>;
+    /** Roll back multiple attempted changes using the Transaction context. */
+    rollback: () => Promise<QueryResult>;
+}
+/**
+ * Update table operation numbers from SQLite
+ */
+export declare enum RowUpdateType {
+    SQLITE_INSERT = 18,
+    SQLITE_DELETE = 9,
+    SQLITE_UPDATE = 23
+}
+export interface TableUpdateOperation {
+    opType: RowUpdateType;
+    rowId: number;
+}
+/**
+ * Notification of an update to one or more tables, for the purpose of realtime change notifications.
+ */
+export interface UpdateNotification extends TableUpdateOperation {
+    table: string;
+}
+export interface BatchedUpdateNotification {
+    rawUpdates: UpdateNotification[];
+    tables: string[];
+    groupedUpdates: Record<string, TableUpdateOperation[]>;
+}
+export interface DBAdapterListener extends BaseListener {
+    /**
+     * Listener for table updates.
+     * Allows for single table updates in order to maintain API compatibility
+     * without the need for a major version bump
+     * The DB adapter can also batch update notifications if supported.
+     */
+    tablesUpdated: (updateNotification: BatchedUpdateNotification | UpdateNotification) => void;
+}
+export interface DBLockOptions {
+    timeoutMs?: number;
+}
+export interface DBAdapter extends BaseObserverInterface<DBAdapterListener>, DBGetUtils {
+    close: () => void;
+    execute: (query: string, params?: any[]) => Promise<QueryResult>;
+    executeBatch: (query: string, params?: any[][]) => Promise<QueryResult>;
+    name: string;
+    readLock: <T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions) => Promise<T>;
+    readTransaction: <T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions) => Promise<T>;
+    writeLock: <T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions) => Promise<T>;
+    writeTransaction: <T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions) => Promise<T>;
+}
+export declare function isBatchedUpdateNotification(update: BatchedUpdateNotification | UpdateNotification): update is BatchedUpdateNotification;
+export declare function extractTableUpdates(update: BatchedUpdateNotification | UpdateNotification): string[];

package/lib/db/DBAdapter.js

@@ -0,0 +1,20 @@
+/**
+ * Set of generic interfaces to allow PowerSync compatibility with
+ * different SQLite DB implementations.
+ */
+/**
+ * Update table operation numbers from SQLite
+ */
+export var RowUpdateType;
+(function (RowUpdateType) {
+    RowUpdateType[RowUpdateType["SQLITE_INSERT"] = 18] = "SQLITE_INSERT";
+    RowUpdateType[RowUpdateType["SQLITE_DELETE"] = 9] = "SQLITE_DELETE";
+    RowUpdateType[RowUpdateType["SQLITE_UPDATE"] = 23] = "SQLITE_UPDATE";
+})(RowUpdateType || (RowUpdateType = {}));
+export function isBatchedUpdateNotification(update) {
+    return 'tables' in update;
+}
+export function extractTableUpdates(update) {
+    return isBatchedUpdateNotification(update) ? update.tables : [update.table];
+}
+//# sourceMappingURL=DBAdapter.js.map

package/lib/db/DBAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DBAdapter.js","sourceRoot":"","sources":["../../src/db/DBAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoDH;;GAEG;AACH,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,oEAAkB,CAAA;IAClB,mEAAiB,CAAA;IACjB,oEAAkB,CAAA;AACpB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AA2CD,MAAM,UAAU,2BAA2B,CACzC,MAAsD;IAEtD,OAAO,QAAQ,IAAI,MAAM,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,MAAsD;IACxF,OAAO,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC"}

package/lib/db/crud/SyncStatus.d.ts

@@ -0,0 +1,38 @@
+export type SyncDataFlowStatus = Partial<{
+    downloading: boolean;
+    uploading: boolean;
+}>;
+export type SyncStatusOptions = {
+    connected?: boolean;
+    dataFlow?: SyncDataFlowStatus;
+    lastSyncedAt?: Date;
+    hasSynced?: boolean;
+};
+export declare class SyncStatus {
+    protected options: SyncStatusOptions;
+    constructor(options: SyncStatusOptions);
+    /**
+     * true if currently connected.
+     */
+    get connected(): boolean;
+    /**
+     *  Time that a last sync has fully completed, if any.
+     *  Currently this is reset to null after a restart.
+     */
+    get lastSyncedAt(): Date | undefined;
+    /**
+     * Indicates whether there has been at least one full sync, if any.
+     * Is undefined when unknown, for example when state is still being loaded from the database.
+     */
+    get hasSynced(): boolean | undefined;
+    /**
+     *  Upload/download status
+     */
+    get dataFlowStatus(): Partial<{
+        downloading: boolean;
+        uploading: boolean;
+    }>;
+    isEqual(status: SyncStatus): boolean;
+    getMessage(): string;
+    toJSON(): SyncStatusOptions;
+}

package/lib/db/crud/SyncStatus.js

@@ -0,0 +1,58 @@
+export class SyncStatus {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    /**
+     * true if currently connected.
+     */
+    get connected() {
+        return this.options.connected ?? false;
+    }
+    /**
+     *  Time that a last sync has fully completed, if any.
+     *  Currently this is reset to null after a restart.
+     */
+    get lastSyncedAt() {
+        return this.options.lastSyncedAt;
+    }
+    /**
+     * Indicates whether there has been at least one full sync, if any.
+     * Is undefined when unknown, for example when state is still being loaded from the database.
+     */
+    get hasSynced() {
+        return this.options.hasSynced;
+    }
+    /**
+     *  Upload/download status
+     */
+    get dataFlowStatus() {
+        return (this.options.dataFlow ?? {
+            /**
+             * true if actively downloading changes.
+             * This is only true when {@link connected} is also true.
+             */
+            downloading: false,
+            /**
+             * true if uploading changes.
+             */
+            uploading: false
+        });
+    }
+    isEqual(status) {
+        return JSON.stringify(this.options) == JSON.stringify(status.options);
+    }
+    getMessage() {
+        const dataFlow = this.dataFlowStatus;
+        return `SyncStatus<connected: ${this.connected} lastSyncedAt: ${this.lastSyncedAt} hasSynced: ${this.hasSynced}. Downloading: ${dataFlow.downloading}. Uploading: ${dataFlow.uploading}`;
+    }
+    toJSON() {
+        return {
+            connected: this.connected,
+            dataFlow: this.dataFlowStatus,
+            lastSyncedAt: this.lastSyncedAt,
+            hasSynced: this.hasSynced
+        };
+    }
+}
+//# sourceMappingURL=SyncStatus.js.map

package/lib/db/crud/SyncStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncStatus.js","sourceRoot":"","sources":["../../../src/db/crud/SyncStatus.ts"],"names":[],"mappings":"AAYA,MAAM,OAAO,UAAU;IACC;IAAtB,YAAsB,OAA0B;QAA1B,YAAO,GAAP,OAAO,CAAmB;IAAG,CAAC;IAEpD;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAI,cAAc;QAChB,OAAO,CACL,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI;YACvB;;;eAGG;YACH,WAAW,EAAE,KAAK;YAClB;;eAEG;YACH,SAAS,EAAE,KAAK;SACjB,CACF,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,MAAkB;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,UAAU;QACR,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,OAAO,yBAAyB,IAAI,CAAC,SAAS,kBAAkB,IAAI,CAAC,YAAY,eAAe,IAAI,CAAC,SAAS,kBAAkB,QAAQ,CAAC,WAAW,gBAAgB,QAAQ,CAAC,SAAS,EAAE,CAAC;IAC3L,CAAC;IAED,MAAM;QACJ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,cAAc;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF"}

package/lib/db/crud/UploadQueueStatus.d.ts

@@ -0,0 +1,20 @@
+export declare class UploadQueueStats {
+    /**
+     * Number of records in the upload queue.
+     */
+    count: number;
+    /**
+     * Size of the upload queue in bytes.
+     */
+    size: number | null;
+    constructor(
+    /**
+     * Number of records in the upload queue.
+     */
+    count: number, 
+    /**
+     * Size of the upload queue in bytes.
+     */
+    size?: number | null);
+    toString(): string;
+}

package/lib/db/crud/UploadQueueStatus.js

@@ -0,0 +1,25 @@
+export class UploadQueueStats {
+    count;
+    size;
+    constructor(
+    /**
+     * Number of records in the upload queue.
+     */
+    count, 
+    /**
+     * Size of the upload queue in bytes.
+     */
+    size = null) {
+        this.count = count;
+        this.size = size;
+    }
+    toString() {
+        if (this.size == null) {
+            return `UploadQueueStats<count:${this.count}>`;
+        }
+        else {
+            return `UploadQueueStats<count: $count size: ${this.size / 1024}kB>`;
+        }
+    }
+}
+//# sourceMappingURL=UploadQueueStatus.js.map

package/lib/db/crud/UploadQueueStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UploadQueueStatus.js","sourceRoot":"","sources":["../../../src/db/crud/UploadQueueStatus.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,gBAAgB;IAKlB;IAIA;IART;IACE;;OAEG;IACI,KAAa;IACpB;;OAEG;IACI,OAAsB,IAAI;QAJ1B,UAAK,GAAL,KAAK,CAAQ;QAIb,SAAI,GAAJ,IAAI,CAAsB;IAChC,CAAC;IAEJ,QAAQ;QACN,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACtB,OAAO,0BAA0B,IAAI,CAAC,KAAK,GAAG,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,OAAO,wCAAwC,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC;QACvE,CAAC;IACH,CAAC;CACF"}

package/lib/db/schema/Index.d.ts

@@ -0,0 +1,22 @@
+import { IndexedColumn } from './IndexedColumn';
+import { Table } from './Table';
+export interface IndexOptions {
+    name: string;
+    columns?: IndexedColumn[];
+}
+export declare const DEFAULT_INDEX_OPTIONS: Partial<IndexOptions>;
+export declare class Index {
+    protected options: IndexOptions;
+    static createAscending(options: IndexOptions, columnNames: string[]): Index;
+    constructor(options: IndexOptions);
+    get name(): string;
+    get columns(): IndexedColumn[];
+    toJSON(table: Table): {
+        name: string;
+        columns: {
+            name: string;
+            ascending: boolean | undefined;
+            type: import("../Column").ColumnType;
+        }[];
+    };
+}

package/lib/db/schema/Index.js

@@ -0,0 +1,30 @@
+import { IndexedColumn } from './IndexedColumn';
+export const DEFAULT_INDEX_OPTIONS = {
+    columns: []
+};
+export class Index {
+    options;
+    static createAscending(options, columnNames) {
+        return new Index({
+            ...options,
+            columns: columnNames.map((name) => IndexedColumn.createAscending(name))
+        });
+    }
+    constructor(options) {
+        this.options = options;
+        this.options = { ...DEFAULT_INDEX_OPTIONS, ...options };
+    }
+    get name() {
+        return this.options.name;
+    }
+    get columns() {
+        return this.options.columns ?? [];
+    }
+    toJSON(table) {
+        return {
+            name: this.name,
+            columns: this.columns.map((c) => c.toJSON(table))
+        };
+    }
+}
+//# sourceMappingURL=Index.js.map

package/lib/db/schema/Index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Index.js","sourceRoot":"","sources":["../../../src/db/schema/Index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAQhD,MAAM,CAAC,MAAM,qBAAqB,GAA0B;IAC1D,OAAO,EAAE,EAAE;CACZ,CAAC;AAEF,MAAM,OAAO,KAAK;IAQM;IAPtB,MAAM,CAAC,eAAe,CAAC,OAAqB,EAAE,WAAqB;QACjE,OAAO,IAAI,KAAK,CAAC;YACf,GAAG,OAAO;YACV,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;SACxE,CAAC,CAAC;IACL,CAAC;IAED,YAAsB,OAAqB;QAArB,YAAO,GAAP,OAAO,CAAc;QACzC,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,qBAAqB,EAAE,GAAG,OAAO,EAAE,CAAC;IAC1D,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,KAAY;QACjB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAClD,CAAC;IACJ,CAAC;CACF"}

package/lib/db/schema/IndexedColumn.d.ts

@@ -0,0 +1,19 @@
+import { ColumnType } from '../Column';
+import { Table } from './Table';
+export interface IndexColumnOptions {
+    name: string;
+    ascending?: boolean;
+}
+export declare const DEFAULT_INDEX_COLUMN_OPTIONS: Partial<IndexColumnOptions>;
+export declare class IndexedColumn {
+    protected options: IndexColumnOptions;
+    static createAscending(column: string): IndexedColumn;
+    constructor(options: IndexColumnOptions);
+    get name(): string;
+    get ascending(): boolean | undefined;
+    toJSON(table: Table): {
+        name: string;
+        ascending: boolean | undefined;
+        type: ColumnType;
+    };
+}

package/lib/db/schema/IndexedColumn.js

@@ -0,0 +1,30 @@
+import { ColumnType } from '../Column';
+export const DEFAULT_INDEX_COLUMN_OPTIONS = {
+    ascending: true
+};
+export class IndexedColumn {
+    options;
+    static createAscending(column) {
+        return new IndexedColumn({
+            name: column,
+            ascending: true
+        });
+    }
+    constructor(options) {
+        this.options = { ...DEFAULT_INDEX_COLUMN_OPTIONS, ...options };
+    }
+    get name() {
+        return this.options.name;
+    }
+    get ascending() {
+        return this.options.ascending;
+    }
+    toJSON(table) {
+        return {
+            name: this.name,
+            ascending: this.ascending,
+            type: table.columns.find((column) => column.name === this.name)?.type ?? ColumnType.TEXT
+        };
+    }
+}
+//# sourceMappingURL=IndexedColumn.js.map

package/lib/db/schema/IndexedColumn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedColumn.js","sourceRoot":"","sources":["../../../src/db/schema/IndexedColumn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAQvC,MAAM,CAAC,MAAM,4BAA4B,GAAgC;IACvE,SAAS,EAAE,IAAI;CAChB,CAAC;AAEF,MAAM,OAAO,aAAa;IACd,OAAO,CAAqB;IAEtC,MAAM,CAAC,eAAe,CAAC,MAAc;QACnC,OAAO,IAAI,aAAa,CAAC;YACvB,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAY,OAA2B;QACrC,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,4BAA4B,EAAE,GAAG,OAAO,EAAE,CAAC;IACjE,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,KAAY;QACjB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,UAAU,CAAC,IAAI;SACzF,CAAC;IACJ,CAAC;CACF"}

package/lib/db/schema/Schema.d.ts

@@ -0,0 +1,38 @@
+import { Table as ClassicTable } from './Table';
+import { RowType, TableV2 } from './TableV2';
+type SchemaType = Record<string, TableV2<any>>;
+type SchemaTableType<S extends SchemaType> = {
+    [K in keyof S]: RowType<S[K]>;
+};
+/**
+ * A schema is a collection of tables. It is used to define the structure of a database.
+ */
+export declare class Schema<S extends SchemaType = SchemaType> {
+    tables: ClassicTable[] | S;
+    readonly types: SchemaTableType<S>;
+    readonly props: S;
+    constructor(tables: ClassicTable[] | S);
+    validate(): void;
+    toJSON(): {
+        tables: {
+            name: string;
+            view_name: string;
+            local_only: boolean;
+            insert_only: boolean;
+            columns: {
+                name: string;
+                type: import("../Column").ColumnType | undefined;
+            }[];
+            indexes: {
+                name: string;
+                columns: {
+                    name: string;
+                    ascending: boolean | undefined;
+                    type: import("../Column").ColumnType;
+                }[];
+            }[];
+        }[];
+    };
+    private convertToClassicTables;
+}
+export {};

package/lib/db/schema/Schema.js

@@ -0,0 +1,38 @@
+import { Table as ClassicTable } from './Table';
+/**
+ * A schema is a collection of tables. It is used to define the structure of a database.
+ */
+export class Schema {
+    tables;
+    /*
+      Only available when constructing with mapped typed definition columns
+    */
+    types;
+    props;
+    constructor(tables) {
+        this.tables = tables;
+        if (Array.isArray(tables)) {
+            this.tables = tables;
+        }
+        else {
+            this.props = tables;
+            this.tables = this.convertToClassicTables(this.props);
+        }
+    }
+    validate() {
+        for (const table of this.tables) {
+            table.validate();
+        }
+    }
+    toJSON() {
+        return {
+            tables: this.tables.map((t) => t.toJSON())
+        };
+    }
+    convertToClassicTables(props) {
+        return Object.entries(props).map(([name, table]) => {
+            return ClassicTable.createTable(name, table);
+        });
+    }
+}
+//# sourceMappingURL=Schema.js.map

package/lib/db/schema/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../../src/db/schema/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,SAAS,CAAC;AAShD;;GAEG;AACH,MAAM,OAAO,MAAM;IAME;IALnB;;MAEE;IACO,KAAK,CAAqB;IAC1B,KAAK,CAAI;IAClB,YAAmB,MAA0B;QAA1B,WAAM,GAAN,MAAM,CAAoB;QAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,MAAW,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAED,QAAQ;QACN,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAwB,EAAE,CAAC;YAClD,KAAK,CAAC,QAAQ,EAAE,CAAC;QACnB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO;YACL,MAAM,EAAG,IAAI,CAAC,MAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;IAEO,sBAAsB,CAAC,KAAQ;QACrC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;YACjD,OAAO,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/db/schema/Table.d.ts

@@ -0,0 +1,51 @@
+import { Column } from '../Column';
+import type { Index } from './Index';
+import { TableV2 } from './TableV2';
+export interface TableOptions {
+    /**
+     * The synced table name, matching sync rules
+     */
+    name: string;
+    columns: Column[];
+    indexes?: Index[];
+    localOnly?: boolean;
+    insertOnly?: boolean;
+    viewName?: string;
+}
+export declare const DEFAULT_TABLE_OPTIONS: Partial<TableOptions>;
+export declare const InvalidSQLCharacters: RegExp;
+export declare class Table {
+    protected options: TableOptions;
+    static createLocalOnly(options: TableOptions): Table;
+    static createInsertOnly(options: TableOptions): Table;
+    static createTable(name: string, table: TableV2): Table;
+    constructor(options: TableOptions);
+    get name(): string;
+    get viewNameOverride(): string | undefined;
+    get viewName(): string;
+    get columns(): Column[];
+    get indexes(): Index[];
+    get localOnly(): boolean;
+    get insertOnly(): boolean;
+    get internalName(): string;
+    get validName(): boolean;
+    validate(): void;
+    toJSON(): {
+        name: string;
+        view_name: string;
+        local_only: boolean;
+        insert_only: boolean;
+        columns: {
+            name: string;
+            type: import("../Column").ColumnType | undefined;
+        }[];
+        indexes: {
+            name: string;
+            columns: {
+                name: string;
+                ascending: boolean | undefined;
+                type: import("../Column").ColumnType;
+            }[];
+        }[];
+    };
+}

package/lib/db/schema/Table.js

@@ -0,0 +1,114 @@
+import { Column } from '../Column';
+export const DEFAULT_TABLE_OPTIONS = {
+    indexes: [],
+    insertOnly: false,
+    localOnly: false
+};
+export const InvalidSQLCharacters = /["'%,.#\s[\]]/;
+export class Table {
+    options;
+    static createLocalOnly(options) {
+        return new Table({ ...options, localOnly: true, insertOnly: false });
+    }
+    static createInsertOnly(options) {
+        return new Table({ ...options, localOnly: false, insertOnly: true });
+    }
+    static createTable(name, table) {
+        return new Table({
+            name,
+            columns: Object.entries(table.columns).map(([name, col]) => new Column({ name, type: col.type })),
+            indexes: table.indexes,
+            localOnly: table.options.localOnly,
+            insertOnly: table.options.insertOnly,
+            viewName: table.options.viewName
+        });
+    }
+    constructor(options) {
+        this.options = { ...DEFAULT_TABLE_OPTIONS, ...options };
+    }
+    get name() {
+        return this.options.name;
+    }
+    get viewNameOverride() {
+        return this.options.viewName;
+    }
+    get viewName() {
+        return this.viewNameOverride ?? this.name;
+    }
+    get columns() {
+        return this.options.columns;
+    }
+    get indexes() {
+        return this.options.indexes ?? [];
+    }
+    get localOnly() {
+        return this.options.localOnly ?? false;
+    }
+    get insertOnly() {
+        return this.options.insertOnly ?? false;
+    }
+    get internalName() {
+        if (this.options.localOnly) {
+            return `ps_data_local__${this.name}`;
+        }
+        return `ps_data__${this.name}`;
+    }
+    get validName() {
+        if (InvalidSQLCharacters.test(this.name)) {
+            return false;
+        }
+        if (this.viewNameOverride != null && InvalidSQLCharacters.test(this.viewNameOverride)) {
+            return false;
+        }
+        return true;
+    }
+    validate() {
+        if (InvalidSQLCharacters.test(this.name)) {
+            throw new Error(`Invalid characters in table name: ${this.name}`);
+        }
+        if (this.viewNameOverride && InvalidSQLCharacters.test(this.viewNameOverride)) {
+            throw new Error(`Invalid characters in view name: ${this.viewNameOverride}`);
+        }
+        const columnNames = new Set();
+        columnNames.add('id');
+        for (const column of this.columns) {
+            const { name: columnName } = column;
+            if (column.name == 'id') {
+                throw new Error(`${this.name}: id column is automatically added, custom id columns are not supported`);
+            }
+            if (columnNames.has(columnName)) {
+                throw new Error(`Duplicate column ${columnName}`);
+            }
+            if (InvalidSQLCharacters.test(columnName)) {
+                throw new Error(`Invalid characters in column name: $name.${column}`);
+            }
+            columnNames.add(columnName);
+        }
+        const indexNames = new Set();
+        for (const index of this.indexes) {
+            if (indexNames.has(index.name)) {
+                throw new Error(`Duplicate index $name.${index}`);
+            }
+            if (InvalidSQLCharacters.test(index.name)) {
+                throw new Error(`Invalid characters in index name: $name.${index}`);
+            }
+            for (const column of index.columns) {
+                if (!columnNames.has(column.name)) {
+                    throw new Error(`Column ${column.name} not found for index ${index.name}`);
+                }
+            }
+            indexNames.add(index.name);
+        }
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            view_name: this.viewName,
+            local_only: this.localOnly,
+            insert_only: this.insertOnly,
+            columns: this.columns.map((c) => c.toJSON()),
+            indexes: this.indexes.map((e) => e.toJSON(this))
+        };
+    }
+}
+//# sourceMappingURL=Table.js.map