@powersync/service-sync-rules 0.17.10

package/dist/utils.js

@@ -0,0 +1,173 @@
+import { SQLITE_FALSE, SQLITE_TRUE } from './sql_support.js';
+import { JsonContainer } from '@powersync/service-jsonbig';
+import { JSONBig, stringifyRaw } from '@powersync/service-jsonbig';
+export function isSelectStatement(q) {
+    return q.type == 'select';
+}
+export function getBucketId(descriptor_id, bucket_parameters, params) {
+    // Important: REAL and INTEGER values matching the same number needs the same representation in the bucket name.
+    const paramArray = bucket_parameters.map((name) => params[`bucket.${name}`]);
+    return `${descriptor_id}${JSONBucketNameSerialize.stringify(paramArray)}`;
+}
+const DEPTH_LIMIT = 10;
+/**
+ * SqliteRow -> SqliteJsonRow.
+ *
+ * Use wherever data should be persisted.
+ *
+ * Basically just removes Uint8Array.
+ */
+export function filterJsonRow(data) {
+    let record = {};
+    for (let key of Object.keys(data)) {
+        const value = data[key];
+        if (isJsonValue(value)) {
+            record[key] = value;
+        }
+    }
+    return record;
+}
+/**
+ * Convert a parsed JSON scalar value to SqliteValue.
+ *
+ * Types specifically not supported in output are `boolean` and `undefined`.
+ */
+export function jsonValueToSqlite(value) {
+    if (typeof value == 'boolean') {
+        return value ? SQLITE_TRUE : SQLITE_FALSE;
+    }
+    else {
+        return value ?? null;
+    }
+}
+export function isJsonValue(value) {
+    return value == null || typeof value == 'string' || typeof value == 'number' || typeof value == 'bigint';
+}
+function filterJsonData(data, depth = 0) {
+    if (depth > DEPTH_LIMIT) {
+        // This is primarily to prevent infinite recursion
+        throw new Error(`json nested object depth exceeds the limit of ${DEPTH_LIMIT}`);
+    }
+    if (data == null) {
+        return data; // null or undefined
+    }
+    else if (typeof data == 'string' || typeof data == 'number') {
+        return data;
+    }
+    else if (typeof data == 'boolean') {
+        return data ? SQLITE_TRUE : SQLITE_FALSE;
+    }
+    else if (typeof data == 'bigint') {
+        return data;
+    }
+    else if (Array.isArray(data)) {
+        return data.map((element) => filterJsonData(element, depth + 1));
+    }
+    else if (ArrayBuffer.isView(data)) {
+        return undefined;
+    }
+    else if (data instanceof JsonContainer) {
+        // Can be stringified directly when using our JSONBig implementation
+        return data;
+    }
+    else if (typeof data == 'object') {
+        let record = {};
+        for (let key of Object.keys(data)) {
+            record[key] = filterJsonData(data[key], depth + 1);
+        }
+        return record;
+    }
+    else {
+        return undefined;
+    }
+}
+/**
+ * Map database row to SqliteRow for use in sync rules.
+ */
+export function toSyncRulesRow(row) {
+    let record = {};
+    for (let key of Object.keys(row)) {
+        record[key] = toSyncRulesValue(row[key], false, true);
+    }
+    return record;
+}
+/**
+ * Convert parameter query input to a SqliteJsonRow.
+ *
+ * @param parameters Generic JSON input
+ */
+export function toSyncRulesParameters(parameters) {
+    let record = {};
+    for (let key of Object.keys(parameters)) {
+        record[key] = toSyncRulesValue(parameters[key], true, false);
+    }
+    return record;
+}
+/**
+ * Convert to a SQLITE-equivalent value: NULL, TEXT, INTEGER, REAL or BLOB.
+ *
+ * Any object or array is converted to JSON TEXT.
+ */
+export function toSyncRulesValue(data, autoBigNum, keepUndefined) {
+    if (data == null) {
+        // null or undefined
+        if (keepUndefined) {
+            return data;
+        }
+        return null;
+    }
+    else if (typeof data == 'string') {
+        return data;
+    }
+    else if (typeof data == 'number') {
+        if (Number.isInteger(data) && autoBigNum) {
+            return BigInt(data);
+        }
+        else {
+            return data;
+        }
+    }
+    else if (typeof data == 'bigint') {
+        return data;
+    }
+    else if (typeof data == 'boolean') {
+        return data ? SQLITE_TRUE : SQLITE_FALSE;
+    }
+    else if (Array.isArray(data)) {
+        // We may be able to avoid some parse + stringify cycles here for JsonSqliteContainer.
+        return JSONBig.stringify(data.map((element) => filterJsonData(element)));
+    }
+    else if (data instanceof Uint8Array) {
+        return data;
+    }
+    else if (data instanceof JsonContainer) {
+        return data.toString();
+    }
+    else if (typeof data == 'object') {
+        let record = {};
+        for (let key of Object.keys(data)) {
+            record[key] = filterJsonData(data[key]);
+        }
+        return JSONBig.stringify(record);
+    }
+    else {
+        return null;
+    }
+}
+export function normalizeTokenParameters(token_parameters, user_parameters) {
+    return {
+        token_parameters: toSyncRulesParameters(token_parameters),
+        user_parameters: toSyncRulesParameters(user_parameters ?? {})
+    };
+}
+/**
+ * Only use this for serializing bucket names. Bucket names should never be parsed except perhaps for debug purposes.
+ *
+ * Important: REAL and INTEGER values matching the same number needs the same representation in the bucket name.
+ */
+export const JSONBucketNameSerialize = {
+    stringify(value, replacer, space) {
+        return stringifyRaw(value, replacer, space);
+    }
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,YAAY,EAAY,MAAM,4BAA4B,CAAC;AAE7E,MAAM,UAAU,iBAAiB,CAAC,CAAY;IAC5C,OAAO,CAAC,CAAC,IAAI,IAAI,QAAQ,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,aAAqB,EACrB,iBAA2B,EAC3B,MAAuC;IAEvC,gHAAgH;IAChH,MAAM,UAAU,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7E,OAAO,GAAG,aAAa,GAAG,uBAAuB,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAe;IAC3C,IAAI,MAAM,GAAwB,EAAE,CAAC;IACrC,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;YACtB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SACrB;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAA4D;IAC5F,IAAI,OAAO,KAAK,IAAI,SAAS,EAAE;QAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC;KAC3C;SAAM;QACL,OAAO,KAAK,IAAI,IAAI,CAAC;KACtB;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAkB;IAC5C,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,OAAO,KAAK,IAAI,QAAQ,CAAC;AAC3G,CAAC;AAED,SAAS,cAAc,CAAC,IAAS,EAAE,KAAK,GAAG,CAAC;IAC1C,IAAI,KAAK,GAAG,WAAW,EAAE;QACvB,kDAAkD;QAClD,MAAM,IAAI,KAAK,CAAC,iDAAiD,WAAW,EAAE,CAAC,CAAC;KACjF;IACD,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC,CAAC,oBAAoB;KAClC;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAC7D,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,OAAO,IAAI,IAAI,SAAS,EAAE;QACnC,OAAO,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC;KAC1C;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;KAClE;SAAM,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACnC,OAAO,SAAS,CAAC;KAClB;SAAM,IAAI,IAAI,YAAY,aAAa,EAAE;QACxC,oEAAoE;QACpE,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAClC,IAAI,MAAM,GAAwB,EAAE,CAAC;QACrC,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACjC,MAAM,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;SACpD;QACD,OAAO,MAAM,CAAC;KACf;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,GAAqB;IAClD,IAAI,MAAM,GAAc,EAAE,CAAC;IAC3B,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,MAAM,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KACvD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAA+B;IACnE,IAAI,MAAM,GAAkB,EAAE,CAAC;IAC/B,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QACvC,MAAM,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,CAAoB,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAS,EAAE,UAAoB,EAAE,aAAuB;IACvF,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,oBAAoB;QACpB,IAAI,aAAa,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAClC,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,UAAU,EAAE;YACxC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;SACrB;aAAM;YACL,OAAO,IAAI,CAAC;SACb;KACF;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,OAAO,IAAI,IAAI,SAAS,EAAE;QACnC,OAAO,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC;KAC1C;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC9B,sFAAsF;QACtF,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KAC1E;SAAM,IAAI,IAAI,YAAY,UAAU,EAAE;QACrC,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,IAAI,YAAY,aAAa,EAAE;QACxC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;KACxB;SAAM,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QAClC,IAAI,MAAM,GAAwB,EAAE,CAAC;QACrC,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACjC,MAAM,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;QACD,OAAO,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KAClC;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,gBAAqC,EACrC,eAAqC;IAErC,OAAO;QACL,gBAAgB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC;QACzD,eAAe,EAAE,qBAAqB,CAAC,eAAe,IAAI,EAAE,CAAC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,CAAC,KAAU,EAAE,QAAmB,EAAE,KAAuB;QAChE,OAAO,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAE,CAAC;IAC/C,CAAC;CACF,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@powersync/service-sync-rules",
+  "repository": "https://github.com/powersync-ja/powersync-service",
+  "version": "0.17.10",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "FSL-1.1-Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "type": "module",
+  "dependencies": {
+    "@syncpoint/wkx": "^0.5.0",
+    "ajv": "^8.12.0",
+    "pgsql-ast-parser": "^11.1.0",
+    "yaml": "^2.3.1",
+    "@powersync/service-jsonbig": "^0.17.10"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.11"
+  },
+  "scripts": {
+    "clean": "rm -r ./dist && tsc -b --clean",
+    "build": "tsc -b"
+  }
+}