@lix-js/sdk 0.4.6 → 0.5.0-preview.0

package/dist/entity-views/entity-state.js

@@ -0,0 +1,243 @@
+/**
+ * Creates SQL view and CRUD triggers for an entity based on its schema definition (active version only).
+ *
+ * This function generates:
+ * - A view that extracts JSON properties from the state table
+ * - INSERT trigger that serializes entity data to JSON in the state table
+ * - UPDATE trigger that updates the corresponding state record
+ * - DELETE trigger that removes the state record
+ *
+ * @throws Error if schema type is not "object" or x-lix-primary-key is not defined
+ *
+ * @example
+ * ```typescript
+ * // Basic usage for key-value entities
+ * createEntityViewIfNotExists({
+ *   lix,
+ *   schema: LixKeyValueSchema,
+ *   overrideName: "key_value",
+ *   pluginKey: "lix_key_value",
+ *   hardcodedFileId: "lix"
+ * });
+ *
+ * // With default values for account entities
+ * createEntityViewIfNotExists({
+ *   lix,
+ *   schema: LixAccountSchema,
+ *   overrideName: "account",
+ *   pluginKey: "lix_own_entity",
+ *   hardcodedFileId: "lix",
+ *   defaultValues: {
+ *     id: (row) => nanoid()
+ *   }
+ * });
+ * ```
+ */
+export function createEntityStateView(args) {
+    const view_name = args.overrideName ?? args.schema["x-lix-key"];
+    createSingleEntityView({
+        ...args,
+        viewName: view_name,
+        stateTable: "state",
+    });
+}
+function createSingleEntityView(args) {
+    if (!args.schema["x-lix-primary-key"]) {
+        throw new Error(`Schema must define 'x-lix-primary-key' for entity view generation`);
+    }
+    const view_name = args.viewName;
+    const schema_key = args.schema["x-lix-key"];
+    const properties = Object.keys(args.schema.properties);
+    const primaryKeys = args.schema["x-lix-primary-key"];
+    const fileId = args.hardcodedFileId
+        ? `'${args.hardcodedFileId}'`
+        : "NEW.lixcol_file_id";
+    const entityIdNew = primaryKeys.length === 1
+        ? `NEW.${primaryKeys[0]}`
+        : `(${primaryKeys.map((key) => `NEW.${key}`).join(" || '::' || ")})`;
+    const entityIdOld = primaryKeys.length === 1
+        ? `OLD.${primaryKeys[0]}`
+        : `(${primaryKeys.map((key) => `OLD.${key}`).join(" || '::' || ")})`;
+    // Create UDFs for default values
+    if (args.defaultValues) {
+        for (const [prop, defaultFn] of Object.entries(args.defaultValues)) {
+            const udfName = `${schema_key}_default_${prop}`;
+            const needsRow = defaultFn.length > 0; // Check if function expects parameters
+            if (needsRow) {
+                // Function needs row data - use variadic function
+                args.lix.sqlite.createFunction(udfName, (...rowValues) => {
+                    // Reconstruct row object from passed values
+                    // Skip the first argument (pointer/internal value)
+                    const actualValues = rowValues.slice(1);
+                    const row = {};
+                    properties.forEach((prop, index) => {
+                        let value = actualValues[index];
+                        // Try to parse JSON strings
+                        if (typeof value === "string" &&
+                            (value.startsWith("{") || value.startsWith("["))) {
+                            try {
+                                value = JSON.parse(value);
+                            }
+                            catch {
+                                // Keep as string if JSON parsing fails
+                            }
+                        }
+                        row[prop] = value;
+                    });
+                    return defaultFn(row);
+                }, { arity: -1 }); // -1 means variadic
+            }
+            else {
+                // Function doesn't need row data - simple 0-arg function
+                args.lix.sqlite.createFunction(udfName, () => defaultFn(), { arity: 0 });
+            }
+        }
+    }
+    const generateDefaults = (properties) => {
+        if (!args.defaultValues) {
+            return properties
+                .map((prop) => `NEW.${prop} AS ${prop}`)
+                .join(",\n        ");
+        }
+        const rowValuesArgs = properties.map((prop) => `NEW.${prop}`).join(", ");
+        return properties
+            .map((prop) => {
+            const defaultFn = args.defaultValues[prop];
+            if (defaultFn) {
+                const needsRow = defaultFn.length > 0;
+                const fnCall = needsRow
+                    ? `${schema_key}_default_${prop}(${rowValuesArgs})`
+                    : `${schema_key}_default_${prop}()`;
+                return `COALESCE(NEW.${prop}, ${fnCall}) AS ${prop}`;
+            }
+            else {
+                return `NEW.${prop} AS ${prop}`;
+            }
+        })
+            .join(",\n        ");
+    };
+    const defaultsSubquery = generateDefaults(properties);
+    const hasDefaults = args.defaultValues && Object.keys(args.defaultValues).length > 0;
+    // Operational columns for active view (no version_id exposed)
+    const operationalColumns = [
+        "inherited_from_version_id AS lixcol_inherited_from_version_id",
+        "created_at AS lixcol_created_at",
+        "updated_at AS lixcol_updated_at",
+        "file_id AS lixcol_file_id",
+        "change_id AS lixcol_change_id",
+        "untracked AS lixcol_untracked",
+    ];
+    // Handle version_id for active view
+    const versionIdReference = args.hardcodedVersionId
+        ? `'${args.hardcodedVersionId}'`
+        : "(SELECT version_id FROM active_version)";
+    const oldVersionIdReference = args.hardcodedVersionId
+        ? `'${args.hardcodedVersionId}'`
+        : "(SELECT version_id FROM active_version)";
+    // Generate validation SQL
+    const generateValidationSQL = (rules) => {
+        return rules
+            .map((rule) => `
+			SELECT CASE
+				WHEN NOT (${rule.condition})
+				THEN RAISE(FAIL, '${rule.errorMessage.replace(/'/g, "''")}')
+			END;`)
+            .join("\n");
+    };
+    const insertValidationSQL = args.validation?.onInsert
+        ? generateValidationSQL(args.validation.onInsert)
+        : "";
+    const updateValidationSQL = args.validation?.onUpdate
+        ? generateValidationSQL(args.validation.onUpdate)
+        : "";
+    const deleteValidationSQL = args.validation?.onDelete
+        ? generateValidationSQL(args.validation.onDelete)
+        : "";
+    // Generated SQL query - set breakpoint here to inspect the generated SQL during debugging
+    const sqlQuery = `
+    CREATE VIEW IF NOT EXISTS ${view_name} AS
+      SELECT
+        ${Object.keys(args.schema.properties)
+        .map((prop) => `json_extract(snapshot_content, '$.${prop}') AS ${prop}`)
+        .join(",\n        ")},
+        ${operationalColumns.join(",\n        ")}
+      FROM ${args.stateTable}
+      WHERE schema_key = '${schema_key}';
+
+      CREATE TRIGGER IF NOT EXISTS ${view_name}_insert
+      INSTEAD OF INSERT ON ${view_name}
+      BEGIN      
+        ${insertValidationSQL}
+        INSERT INTO state_all (
+          entity_id,
+          schema_key,
+          file_id,
+          plugin_key,
+          snapshot_content,
+          schema_version,
+          version_id,
+          untracked
+        ) ${hasDefaults
+        ? `
+        SELECT 
+          ${entityIdNew.replace(/NEW\./g, "with_default_values.")},
+          '${schema_key}',
+          ${fileId.replace(/NEW\./g, "with_default_values.")},
+          '${args.pluginKey}',
+          json_object(${properties.map((prop) => `'${prop}', with_default_values.${prop}`).join(", ")}),
+          '${args.schema["x-lix-version"]}',
+          ${versionIdReference.replace(/NEW\./g, "with_default_values.")},
+          with_default_values.lixcol_untracked
+        FROM (
+          SELECT
+            ${defaultsSubquery},
+            NEW.lixcol_file_id AS lixcol_file_id,
+            NEW.lixcol_untracked AS lixcol_untracked
+        ) AS with_default_values`
+        : `
+        VALUES (
+          ${entityIdNew},
+          '${schema_key}',
+          ${fileId},
+          '${args.pluginKey}',
+          json_object(${properties.map((prop) => `'${prop}', NEW.${prop}`).join(", ")}),
+          '${args.schema["x-lix-version"]}',
+          ${versionIdReference},
+          NEW.lixcol_untracked
+        )`};
+      END;
+
+      CREATE TRIGGER IF NOT EXISTS ${view_name}_update
+      INSTEAD OF UPDATE ON ${view_name}
+      BEGIN
+        ${updateValidationSQL}
+        UPDATE state_all
+        SET
+          entity_id = ${entityIdNew},
+          schema_key = '${schema_key}',
+          file_id = ${fileId},
+          plugin_key = '${args.pluginKey}',
+          snapshot_content = json_object(${properties.map((prop) => `'${prop}', NEW.${prop}`).join(", ")}),
+          version_id = ${versionIdReference},
+          untracked = NEW.lixcol_untracked
+        WHERE
+          state_all.entity_id = ${entityIdOld}
+          AND state_all.schema_key = '${schema_key}'
+          AND state_all.file_id = ${args.hardcodedFileId ? `'${args.hardcodedFileId}'` : "OLD.lixcol_file_id"}
+          AND state_all.version_id = ${oldVersionIdReference};
+      END;
+
+      CREATE TRIGGER IF NOT EXISTS ${view_name}_delete
+      INSTEAD OF DELETE ON ${view_name}
+      BEGIN
+        ${deleteValidationSQL}
+        DELETE FROM state_all
+        WHERE entity_id = ${entityIdOld}
+        AND schema_key = '${schema_key}'
+        AND file_id = ${args.hardcodedFileId ? `'${args.hardcodedFileId}'` : "OLD.lixcol_file_id"}
+        ${args.hardcodedVersionId ? `AND version_id = '${args.hardcodedVersionId}'` : ""};
+      END;
+    `;
+    args.lix.sqlite.exec(sqlQuery);
+}
+//# sourceMappingURL=entity-state.js.map

package/dist/entity-views/entity-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-state.js","sourceRoot":"","sources":["../../src/entity-views/entity-state.ts"],"names":[],"mappings":"AAuLA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAkBrC;IACA,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAEhE,sBAAsB,CAAC;QACtB,GAAG,IAAI;QACP,QAAQ,EAAE,SAAS;QACnB,UAAU,EAAE,OAAO;KACnB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,IAkB/B;IACA,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CACd,mEAAmE,CACnE,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;IAChC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAE,IAAI,CAAC,MAAc,CAAC,UAAU,CAAC,CAAC;IAChE,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAErD,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe;QAClC,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,GAAG;QAC7B,CAAC,CAAC,oBAAoB,CAAC;IACxB,MAAM,WAAW,GAChB,WAAW,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE;QACzB,CAAC,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;IACvE,MAAM,WAAW,GAChB,WAAW,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE;QACzB,CAAC,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;IAEvE,iCAAiC;IACjC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;QACxB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACpE,MAAM,OAAO,GAAG,GAAG,UAAU,YAAY,IAAI,EAAE,CAAC;YAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,uCAAuC;YAE9E,IAAI,QAAQ,EAAE,CAAC;gBACd,kDAAkD;gBAClD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAC7B,OAAO,EACP,CAAC,GAAG,SAAgB,EAAE,EAAE;oBACvB,4CAA4C;oBAC5C,mDAAmD;oBACnD,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACxC,MAAM,GAAG,GAAwB,EAAE,CAAC;oBAEpC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;wBAClC,IAAI,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;wBAEhC,4BAA4B;wBAC5B,IACC,OAAO,KAAK,KAAK,QAAQ;4BACzB,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAC/C,CAAC;4BACF,IAAI,CAAC;gCACJ,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;4BAC3B,CAAC;4BAAC,MAAM,CAAC;gCACR,uCAAuC;4BACxC,CAAC;wBACF,CAAC;wBAED,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;oBACnB,CAAC,CAAC,CAAC;oBAEH,OAAQ,SAAkD,CAAC,GAAG,CAAC,CAAC;gBACjE,CAAC,EACD,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CACb,CAAC,CAAC,oBAAoB;YACxB,CAAC;iBAAM,CAAC;gBACP,yDAAyD;gBACzD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAC7B,OAAO,EACP,GAAG,EAAE,CAAE,SAA0B,EAAE,EACnC,EAAE,KAAK,EAAE,CAAC,EAAE,CACZ,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,UAAoB,EAAE,EAAE;QACjD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACzB,OAAO,UAAU;iBACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,OAAO,IAAI,EAAE,CAAC;iBACvC,IAAI,CAAC,aAAa,CAAC,CAAC;QACvB,CAAC;QAED,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzE,OAAO,UAAU;aACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,MAAM,SAAS,GAAG,IAAI,CAAC,aAAc,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,SAAS,EAAE,CAAC;gBACf,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;gBACtC,MAAM,MAAM,GAAG,QAAQ;oBACtB,CAAC,CAAC,GAAG,UAAU,YAAY,IAAI,IAAI,aAAa,GAAG;oBACnD,CAAC,CAAC,GAAG,UAAU,YAAY,IAAI,IAAI,CAAC;gBACrC,OAAO,gBAAgB,IAAI,KAAK,MAAM,QAAQ,IAAI,EAAE,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACP,OAAO,OAAO,IAAI,OAAO,IAAI,EAAE,CAAC;YACjC,CAAC;QACF,CAAC,CAAC;aACD,IAAI,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,WAAW,GAChB,IAAI,CAAC,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAElE,8DAA8D;IAC9D,MAAM,kBAAkB,GAAG;QAC1B,+DAA+D;QAC/D,iCAAiC;QACjC,iCAAiC;QACjC,2BAA2B;QAC3B,+BAA+B;QAC/B,+BAA+B;KAC/B,CAAC;IAEF,oCAAoC;IACpC,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB;QACjD,CAAC,CAAC,IAAI,IAAI,CAAC,kBAAkB,GAAG;QAChC,CAAC,CAAC,yCAAyC,CAAC;IAE7C,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB;QACpD,CAAC,CAAC,IAAI,IAAI,CAAC,kBAAkB,GAAG;QAChC,CAAC,CAAC,yCAAyC,CAAC;IAE7C,0BAA0B;IAC1B,MAAM,qBAAqB,GAAG,CAAC,KAAuB,EAAU,EAAE;QACjE,OAAO,KAAK;aACV,GAAG,CACH,CAAC,IAAI,EAAE,EAAE,CAAC;;gBAEE,IAAI,CAAC,SAAS;wBACN,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;QACrD,CACJ;aACA,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ;QACpD,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,CAAC,CAAC,EAAE,CAAC;IAEN,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ;QACpD,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,CAAC,CAAC,EAAE,CAAC;IAEN,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ;QACpD,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,CAAC,CAAC,EAAE,CAAC;IAEN,0FAA0F;IAC1F,MAAM,QAAQ,GAAG;gCACc,SAAS;;UAE/B,MAAM,CAAC,IAAI,CAAE,IAAI,CAAC,MAAc,CAAC,UAAU,CAAC;SAChD,GAAG,CACH,CAAC,IAAI,EAAE,EAAE,CAAC,qCAAqC,IAAI,SAAS,IAAI,EAAE,CAClE;SACA,IAAI,CAAC,aAAa,CAAC;UACf,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC;aACnC,IAAI,CAAC,UAAU;4BACA,UAAU;;qCAED,SAAS;6BACjB,SAAS;;UAE5B,mBAAmB;;;;;;;;;;YAWxB,WAAW;QACV,CAAC,CAAC;;YAEI,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,sBAAsB,CAAC;aACpD,UAAU;YACX,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,sBAAsB,CAAC;aAC/C,IAAI,CAAC,SAAS;wBACH,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,0BAA0B,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;aACxF,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC7B,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,sBAAsB,CAAC;;;;cAI1D,gBAAgB;;;iCAGG;QAC3B,CAAC,CAAC;;YAEI,WAAW;aACV,UAAU;YACX,MAAM;aACL,IAAI,CAAC,SAAS;wBACH,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;aACxE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC7B,kBAAkB;;UAG1B;;;qCAGiC,SAAS;6BACjB,SAAS;;UAE5B,mBAAmB;;;wBAGL,WAAW;0BACT,UAAU;sBACd,MAAM;0BACF,IAAI,CAAC,SAAS;2CACG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;yBAC/E,kBAAkB;;;kCAGT,WAAW;wCACL,UAAU;oCACd,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,oBAAoB;uCACtE,qBAAqB;;;qCAGvB,SAAS;6BACjB,SAAS;;UAE5B,mBAAmB;;4BAED,WAAW;4BACX,UAAU;wBACd,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,oBAAoB;UACvF,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,qBAAqB,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAC,CAAC,EAAE;;KAEnF,CAAC;IAEL,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAChC,CAAC"}

package/dist/entity-views/entity-state.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entity-state.test.d.ts.map

package/dist/entity-views/entity-state.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-state.test.d.ts","sourceRoot":"","sources":["../../src/entity-views/entity-state.test.ts"],"names":[],"mappings":""}