Rename to CustomSqliteValue

Author: simolus3

modules/module-mongodb/src/replication/MongoRelation.ts

@@ -2,7 +2,7 @@ import { mongo } from '@powersync/lib-service-mongodb';
 import { storage } from '@powersync/service-core';
 import { JSONBig, JsonContainer } from '@powersync/service-jsonbig';
 import {
-  CustomSqliteType,
+  CustomSqliteValue,
   SqliteInputRow,
   SqliteInputValue,
   SqliteRow,
@@ -80,7 +80,7 @@ export function toMongoSyncRulesValue(data: any): SqliteInputValue {
   } else if (data instanceof RegExp) {
     return JSON.stringify({ pattern: data.source, options: data.flags });
   } else if (Array.isArray(data)) {
-    return CustomSqliteType.wrapArray(data.map((element) => filterJsonData(element)));
+    return CustomSqliteValue.wrapArray(data.map((element) => filterJsonData(element)));
   } else if (data instanceof Uint8Array) {
     return data;
   } else if (data instanceof JsonContainer) {
@@ -141,7 +141,7 @@ function filterJsonData(data: any, depth = 0): any {
   } else if (data instanceof RegExp) {
     return { pattern: data.source, options: data.flags };
   } else if (Array.isArray(data)) {
-    return CustomSqliteType.wrapArray(data.map((element) => filterJsonData(element, depth + 1)));
+    return CustomSqliteValue.wrapArray(data.map((element) => filterJsonData(element, depth + 1)));
   } else if (ArrayBuffer.isView(data)) {
     return undefined;
   } else if (data instanceof JsonContainer) {

modules/module-mongodb/test/src/mongo_test.test.ts

@@ -1,5 +1,5 @@
 import { mongo } from '@powersync/lib-service-mongodb';
-import { CustomSqliteType, SqliteInputRow, SqliteRow, SqlSyncRules, TimeValue } from '@powersync/service-sync-rules';
+import { CustomSqliteValue, SqliteInputRow, SqliteRow, SqlSyncRules, TimeValue } from '@powersync/service-sync-rules';
 import { describe, expect, test } from 'vitest';
 
 import { MongoRouteAPIAdapter } from '@module/api/MongoRouteAPIAdapter.js';
@@ -211,7 +211,7 @@ describe('mongo data types', () => {
 
     expect(transformed[2]).toMatchObject({
       _id: 3n,
-      date: CustomSqliteType.wrapArray([new TimeValue('2023-03-06 13:47:00.000Z', '2023-03-06T13:47:00.000Z')])
+      date: CustomSqliteValue.wrapArray([new TimeValue('2023-03-06 13:47:00.000Z', '2023-03-06T13:47:00.000Z')])
     });
 
     expect(transformed[3]).toMatchObject({

modules/module-postgres/test/src/pg_test.test.ts

@@ -1,6 +1,6 @@
 import { constructAfterRecord } from '@module/utils/pgwire_utils.js';
 import * as pgwire from '@powersync/service-jpgwire';
-import { CustomSqliteType, SqliteInputRow, SqliteRow, TimeValue } from '@powersync/service-sync-rules';
+import { CustomSqliteValue, SqliteInputRow, SqliteRow, TimeValue } from '@powersync/service-sync-rules';
 import { describe, expect, test } from 'vitest';
 import { clearTestDb, connectPgPool, connectPgWire, TEST_URI } from './util.js';
 import { WalStream } from '@module/replication/WalStream.js';
@@ -235,8 +235,8 @@ VALUES(10, ARRAY['null']::TEXT[]);
       id: 3n,
       date: `["2023-03-06"]`,
       time: `["15:47:00"]`,
-      timestamp: CustomSqliteType.wrapArray([new TimeValue('2023-03-06 15:47:00', '2023-03-06T15:47:00')]),
-      timestamptz: CustomSqliteType.wrapArray([
+      timestamp: CustomSqliteValue.wrapArray([new TimeValue('2023-03-06 15:47:00', '2023-03-06T15:47:00')]),
+      timestamptz: CustomSqliteValue.wrapArray([
         new TimeValue('2023-03-06 13:47:00Z', '2023-03-06T13:47:00Z'),
         new TimeValue('2023-03-06 13:47:00.12345Z', '2023-03-06T13:47:00.12345Z')
       ])

packages/sync-rules/src/index.ts

@@ -22,6 +22,6 @@ export { SyncStream } from './streams/stream.js';
 export { syncStreamFromSql } from './streams/from_sql.js';
 export * from './TablePattern.js';
 export * from './types.js';
-export * from './types/custom_sqlite_type.js';
+export * from './types/custom_sqlite_value.js';
 export * from './types/time.js';
 export * from './utils.js';

packages/sync-rules/src/sql_functions.ts

@@ -8,7 +8,7 @@ import { jsonValueToSqlite } from './utils.js';
 import wkx from '@syncpoint/wkx';
 import { ExpressionType, SqliteType, SqliteValueType, TYPE_INTEGER } from './ExpressionType.js';
 import * as uuid from 'uuid';
-import { CustomSqliteType } from './types/custom_sqlite_type.js';
+import { CustomSqliteValue } from './types/custom_sqlite_value.js';
 
 export const BASIC_OPERATORS = new Set<string>([
   '=',
@@ -647,7 +647,7 @@ export function sqliteTypeOf(arg: SqliteInputValue): SqliteValueType {
     return 'real';
   } else if (arg instanceof Uint8Array) {
     return 'blob';
-  } else if (arg instanceof CustomSqliteType) {
+  } else if (arg instanceof CustomSqliteValue) {
     return arg.sqliteType;
   } else {
     // Should not happen

packages/sync-rules/src/types.ts

@@ -7,7 +7,7 @@ import { toSyncRulesParameters } from './utils.js';
 import { BucketPriority } from './BucketDescription.js';
 import { ParameterLookup } from './BucketParameterQuerier.js';
 import { TimeValue } from './types/time.js';
-import { CustomSqliteType } from './types/custom_sqlite_type.js';
+import { CustomSqliteValue } from './types/custom_sqlite_value.js';
 
 export interface SyncRules {
   evaluateRow(options: EvaluateRowOptions): EvaluationResult[];
@@ -192,7 +192,7 @@ export type SqliteValue = number | string | null | bigint | Uint8Array;
  * A value that is either supported by SQLite natively, or one that can be lowered into a SQLite-value given additional
  * context.
  */
-export type SqliteInputValue = SqliteValue | CustomSqliteType;
+export type SqliteInputValue = SqliteValue | CustomSqliteValue;
 
 /**
  * A set of values that are both SQLite and JSON-compatible.
@@ -225,7 +225,7 @@ export type DatabaseInputValue =
   | boolean
   | DatabaseInputValue[]
   | JsonContainer
-  | CustomSqliteType
+  | CustomSqliteValue
   | { [key: string]: DatabaseInputValue };
 
 /**

…nc-rules/src/types/custom_sqlite_type.ts …c-rules/src/types/custom_sqlite_value.tspackages/sync-rules/src/types/custom_sqlite_type.ts renamed to packages/sync-rules/src/types/custom_sqlite_value.ts packages/sync-rules/src/types/custom_sqlite_type.ts renamed to packages/sync-rules/src/types/custom_sqlite_value.ts

@@ -8,14 +8,14 @@ import { SqliteValueType } from '../ExpressionType.js';
  *
  * This is used to conditionally render some values in different formats depending on compatibility options. For
  * instance, old versions of the sync service used to [encode timestamp values incorrectly](https://github.com/powersync-ja/powersync-service/issues/286).
- * To fix this without breaking backwards-compatibility, we now represent timestamp values as a {@link CustomSqliteType}
+ * To fix this without breaking backwards-compatibility, we now represent timestamp values as a {@link CustomSqliteValue}
  * subtype where `toSqliteValue` returns the old or the new format depending on options.
  *
- * Instances of {@link CustomSqliteType} are always temporary structures that aren't persisted. They are created by the
+ * Instances of {@link CustomSqliteValue} are always temporary structures that aren't persisted. They are created by the
  * replicator implementations, the sync rule implementation will invoke {@link toSqliteValue} to ensure that an
  * {@link EvaluatedRow} only consists of proper SQLite values.
  */
-export abstract class CustomSqliteType {
+export abstract class CustomSqliteValue {
   /**
    * Renders this custom value into a {@link SqliteValue}.
    *
@@ -26,7 +26,7 @@ export abstract class CustomSqliteType {
   abstract get sqliteType(): SqliteValueType;
 
   static wrapArray(elements: DatabaseInputValue[]): SqliteInputValue {
-    const hasCustomValue = elements.some((v) => v instanceof CustomSqliteType);
+    const hasCustomValue = elements.some((v) => v instanceof CustomSqliteValue);
     if (hasCustomValue) {
       // We need access to the compatibility context before encoding contents as JSON.
       return new CustomArray(elements);
@@ -37,7 +37,7 @@ export abstract class CustomSqliteType {
   }
 }
 
-class CustomArray extends CustomSqliteType {
+class CustomArray extends CustomSqliteValue {
   constructor(private readonly elements: DatabaseInputValue[]) {
     super();
   }
@@ -49,7 +49,7 @@ class CustomArray extends CustomSqliteType {
   toSqliteValue(context: CompatibilityContext): SqliteValue {
     return JSONBig.stringify(
       this.elements.map((element) => {
-        return element instanceof CustomSqliteType ? element.toSqliteValue(context) : element;
+        return element instanceof CustomSqliteValue ? element.toSqliteValue(context) : element;
       })
     );
   }

packages/sync-rules/src/types/time.ts

@@ -1,6 +1,6 @@
 import { SqliteValueType } from '../ExpressionType.js';
 import { CompatibilityContext, Quirk } from '../quirks.js';
-import { CustomSqliteType } from './custom_sqlite_type.js';
+import { CustomSqliteValue } from './custom_sqlite_value.js';
 
 /**
  * In old versions of the sync service, timestamp values were formatted with a space between the date and time
@@ -9,7 +9,7 @@ import { CustomSqliteType } from './custom_sqlite_type.js';
  * This is not ISO 6801 compatible, but changing it would be breaking existing users. So, this option is opt-in and
  * disabled by default until a major upgrade.
  */
-export class TimeValue extends CustomSqliteType {
+export class TimeValue extends CustomSqliteValue {
   // YYYY-MM-DD hh:mm:ss.sss / YYYY-MM-DD hh:mm:ss.sssZ
   readonly legacyRepresentation: string;
   // YYYY-MM-DDThh:mm:ss.sss / YYYY-MM-DDThh:mm:ss.sssZ

packages/sync-rules/src/utils.ts

@@ -12,7 +12,7 @@ import {
   SqliteValue
 } from './types.js';
 import { SyncRuleProcessingError as SyncRulesProcessingError } from './errors.js';
-import { CustomSqliteType } from './types/custom_sqlite_type.js';
+import { CustomSqliteValue } from './types/custom_sqlite_value.js';
 import { CompatibilityContext } from './quirks.js';
 
 export function isSelectStatement(q: Statement): q is SelectFromStatement {
@@ -88,7 +88,7 @@ function filterJsonData(data: any, depth = 0): any {
   } else if (typeof data == 'bigint') {
     return data;
   } else if (Array.isArray(data)) {
-    return CustomSqliteType.wrapArray(data.map((element) => filterJsonData(element, depth + 1)));
+    return CustomSqliteValue.wrapArray(data.map((element) => filterJsonData(element, depth + 1)));
   } else if (ArrayBuffer.isView(data)) {
     return undefined;
   } else if (data instanceof JsonContainer) {
@@ -158,8 +158,8 @@ export function toSyncRulesValue(
   } else if (typeof data == 'boolean') {
     return data ? SQLITE_TRUE : SQLITE_FALSE;
   } else if (Array.isArray(data)) {
-    return CustomSqliteType.wrapArray(data.map(filterJsonData));
-  } else if (data instanceof Uint8Array || data instanceof CustomSqliteType) {
+    return CustomSqliteValue.wrapArray(data.map(filterJsonData));
+  } else if (data instanceof Uint8Array || data instanceof CustomSqliteValue) {
     return data;
   } else if (data instanceof JsonContainer) {
     return data.toString();
@@ -175,7 +175,7 @@ export function toSyncRulesValue(
 }
 
 export function applyValueContext(value: SqliteInputValue, context: CompatibilityContext): SqliteValue {
-  if (value instanceof CustomSqliteType) {
+  if (value instanceof CustomSqliteValue) {
     return value.toSqliteValue(context);
   } else {
     return value;

packages/sync-rules/test/src/quirks.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from 'vitest';
-import { CustomSqliteType, SqlSyncRules, TimeValue } from '../../src/index.js';
+import { CustomSqliteValue, SqlSyncRules, TimeValue } from '../../src/index.js';
 
 import { ASSETS, PARSE_OPTIONS } from './util.js';
 
@@ -77,7 +77,7 @@ fixed_quirks:
   });
 
   test('arrays', () => {
-    const data = CustomSqliteType.wrapArray(['static value', new TimeValue('old', 'fixed')]);
+    const data = CustomSqliteValue.wrapArray(['static value', new TimeValue('old', 'fixed')]);
 
     for (const withFixedQuirk of [false, true]) {
       let syncRules = `