@webda/postgres 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/postgresstore.service.js

@@ -0,0 +1,327 @@
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+import { EventRepository, InstanceCache, useApplication, useCore, useModel, useModelMetadata } from "@webda/core";
+import pg from "pg";
+import { acquirePool, releasePool } from "./pgpool.js";
+import { PostgresRepository, SQLStore, SQLStoreParameters } from "./sqlstore.js";
+import { useLog } from "@webda/workout";
+/*
+ * Ideas:
+ *  - Make views for each models to have a better query: https://dba.stackexchange.com/questions/151838/postgresql-json-column-to-view
+ *        - CREATE VIEW my_view AS SELECT uuid,data->>'status' as status from table;
+ *            - could auto resolve FK
+ *  - Use STORED generated model to define FK: https://stackoverflow.com/questions/24489647/json-foreign-keys-in-postgresql
+ *  - FKs should be defined based on relationship
+ *  - Define colums dynamically based on the schema -> benchmark to see if it is useful
+ *  - Allow to define indexes on fields
+ */
+/**
+ *
+ */
+export class PostgresParameters extends SQLStoreParameters {
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params) {
+        super.load(params);
+        this.autoCreateTable ?? (this.autoCreateTable = true);
+        this.usePool ?? (this.usePool = false);
+        this.viewPrefix ?? (this.viewPrefix = "");
+        this.views ?? (this.views = [".*"]);
+        this.tables ?? (this.tables = {});
+        return this;
+    }
+}
+/**
+ * Store data within PostgreSQL with JSONB
+ *
+ * The table should be created before with
+ *
+ * ```sql
+ * CREATE TABLE IF NOT EXISTS ${tableName}
+ * (
+ *   uuid uuid NOT NULL,
+ *   data jsonb,
+ *   CONSTRAINT ${tableName}_pkey PRIMARY KEY (uuid)
+ * );
+ * ```
+ *
+ * @WebdaModda
+ */
+let PostgresStore = (() => {
+    var _a;
+    let _classSuper = SQLStore;
+    let _instanceExtraInitializers = [];
+    let _getRepository_decorators;
+    return _a = class PostgresStore extends _classSuper {
+            constructor() {
+                super(...arguments);
+                this.client = __runInitializers(this, _instanceExtraInitializers);
+                /**
+                 * True when {@link client} is a shared pool acquired from the registry.
+                 * Tracked so {@link stop} only releases pools it took a refcount on.
+                 */
+                this.ownsPool = false;
+            }
+            /**
+             * @override
+             */
+            async init() {
+                if (this.parameters.table && (this.parameters.models?.length ?? 0) > 1) {
+                    useLog("WARN", `PostgresStore "${this.getName()}": parameters.table is ignored when more than one model is configured. Use parameters.tables[id] instead.`);
+                }
+                if (this.parameters.usePool) {
+                    this.client = acquirePool(this.parameters.postgresqlServer);
+                    this.ownsPool = true;
+                }
+                else {
+                    this.client = new pg.Client(this.parameters.postgresqlServer);
+                    await this.client.connect();
+                }
+                await this.checkTable();
+                await super.init();
+                return this;
+            }
+            /**
+             * @override
+             */
+            async stop() {
+                if (this.ownsPool) {
+                    this.ownsPool = false;
+                    await releasePool(this.parameters.postgresqlServer);
+                }
+                else if (this.client && "end" in this.client) {
+                    await this.client.end().catch(() => {
+                        /* already ended */
+                    });
+                }
+                this.client = undefined;
+                await super.stop();
+            }
+            /**
+             * Resolve the table name for a given model class.
+             *
+             * Resolution order:
+             * 1. `parameters.tables[meta.Identifier]` — explicit per-model override
+             * 2. Single-model back-compat: when only one model is configured, `parameters.table` maps to it
+             * 3. Default — model identifier lowercased with "/" replaced by "_"
+             *
+             * @param model - the model class to resolve the table for
+             * @returns the table name
+             */
+            resolveTable(model) {
+                const meta = useModelMetadata(model);
+                if (!meta) {
+                    return this.parameters.table;
+                }
+                // Explicit per-model override
+                if (this.parameters.tables?.[meta.Identifier]) {
+                    return this.parameters.tables[meta.Identifier];
+                }
+                // Single-model back-compat: parameters.table maps to the one model
+                if (this.parameters.models?.length === 1 && this.parameters.table) {
+                    return this.parameters.table;
+                }
+                // Default derivation
+                return meta.Identifier.toLowerCase().replace(/\//g, "_");
+            }
+            /**
+             * Ensure all managed model tables exist (one per model in the hierarchy).
+             * When `autoCreateTable` is false, this is a no-op.
+             */
+            async checkTable() {
+                if (!this.parameters.autoCreateTable) {
+                    return;
+                }
+                // Delegate the per-model DDL to each PostgresRepository.setupTable().
+                // Deduplicate by table name so shared-table models don't issue redundant DDL.
+                const done = new Set();
+                for (const repo of this.getRepositories()) {
+                    const table = repo.getTable();
+                    if (done.has(table)) {
+                        continue;
+                    }
+                    done.add(table);
+                    await repo.setupTable();
+                }
+            }
+            /**
+             * Return the postgresql client
+             * @returns the pg client or pool
+             */
+            getClient() {
+                return this.client;
+            }
+            /**
+             * Build and return a PostgresRepository for the given model, using the
+             * per-model table name resolved by `resolveTable`.
+             *
+             * The result is cached per model class via `@InstanceCache`.
+             * @param model - the model class
+             * @returns a repository backed by this store's pg connection
+             */
+            getRepository(model) {
+                const meta = useModelMetadata(model);
+                const table = this.resolveTable(model);
+                const inner = new PostgresRepository(model, meta.PrimaryKey, this.client, table);
+                // Wrap in EventRepository so typed CRUD events fire; consumers reach them
+                // via useRepository(model).on(...).
+                return new EventRepository(model, meta.PrimaryKey, inner);
+            }
+            /**
+             * Return the underlying PostgresRepository for each model this store manages,
+             * unwrapping the EventRepository produced by {@link getRepository}.
+             * @returns the per-model PostgresRepository instances
+             */
+            getRepositories() {
+                const repos = [];
+                for (const modelId of Object.keys(this._modelsHierarchy ?? {})) {
+                    let model;
+                    try {
+                        model = useModel(modelId);
+                    }
+                    catch {
+                        continue;
+                    }
+                    if (!model) {
+                        continue;
+                    }
+                    const repo = this.getRepository(model);
+                    repos.push((repo.repository ?? repo));
+                }
+                return repos;
+            }
+            /**
+             * Create views for each model that is stored in a PostgresStore.
+             *
+             * Creates one SQL VIEW per model (or model subclass) that maps the JSONB
+             * `data` column to typed columns based on the model's stored JSON schema.
+             */
+            async createViews() {
+                const app = useApplication();
+                const models = app.getModels();
+                const viewPatterns = (this.parameters.views ?? [".*"]).map(p => new RegExp(p));
+                const modelMatches = (identifier) => viewPatterns.some(re => re.test(identifier));
+                for (const model of Object.values(models)) {
+                    if (!model)
+                        continue;
+                    const meta = useModelMetadata(model);
+                    if (!meta || !meta.Identifier)
+                        continue;
+                    if (!modelMatches(meta.Identifier))
+                        continue;
+                    // Find the PostgresStore responsible for this model
+                    const allServices = Object.values(useCore().getServices()).filter(s => s instanceof _a);
+                    const store = allServices.find(s => s.handleModel(model) >= 0);
+                    if (!store)
+                        continue;
+                    const schema = meta.Schemas?.Stored;
+                    if (!schema || !schema.properties)
+                        continue;
+                    const plural = meta.Plural || meta.Identifier.split("/").pop().toLowerCase() + "s";
+                    const viewName = `${this.parameters.viewPrefix}${plural}`;
+                    const fields = ["uuid"];
+                    for (const field of Object.keys(schema.properties)) {
+                        if (field === "uuid" || !field.match(/^[0-9a-zA-Z-_$]+$/)) {
+                            continue;
+                        }
+                        let cast = "";
+                        const type = schema.properties[field].type;
+                        if (type === "number") {
+                            cast = "::bigint";
+                        }
+                        else if (type === "boolean") {
+                            cast = "::boolean";
+                        }
+                        else if (type === "string") {
+                            cast = "::text";
+                        }
+                        else if (type === "array") {
+                            cast = "::jsonb";
+                        }
+                        else if (type === "object") {
+                            cast = "::jsonb";
+                        }
+                        fields.push(`(data->>'${field}')${cast} as ${field}`);
+                    }
+                    let query = `CREATE OR REPLACE VIEW ${viewName} AS SELECT ${fields.join(",")} FROM ${store.resolveTable(model)}`;
+                    if (store.handleModel(model) > 0) {
+                        query += ` WHERE (data#>>'{__type}') = '${meta.ShortName || meta.Identifier}'`;
+                    }
+                    try {
+                        this.log("INFO", `Dropping view ${viewName}`);
+                        await store.getClient().query(`DROP VIEW IF EXISTS ${viewName}`);
+                        this.log("INFO", query);
+                        await store.getClient().query(query);
+                    }
+                    catch (err) {
+                        this.log("ERROR", err);
+                    }
+                }
+            }
+            /**
+             * Delete all rows from all managed tables (used in tests).
+             */
+            async __clean() {
+                const tables = new Set([this.parameters.table]);
+                for (const modelId of Object.keys(this._modelsHierarchy ?? {})) {
+                    try {
+                        const model = useModel(modelId);
+                        if (model) {
+                            tables.add(this.resolveTable(model));
+                        }
+                    }
+                    catch {
+                        // skip unreachable models
+                    }
+                }
+                for (const table of tables) {
+                    await this.client.query(`DELETE FROM ${table}`);
+                }
+            }
+        },
+        (() => {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _getRepository_decorators = [InstanceCache()];
+            __esDecorate(_a, null, _getRepository_decorators, { kind: "method", name: "getRepository", static: false, private: false, access: { has: obj => "getRepository" in obj, get: obj => obj.getRepository }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        })(),
+        _a;
+})();
+export { PostgresStore };
+export default PostgresStore;
+//# sourceMappingURL=postgresstore.service.js.map

package/lib/postgresstore.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgresstore.service.js","sourceRoot":"","sources":["../src/postgresstore.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGlH,OAAO,EAAgC,MAAM,IAAI,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;GASG;AAEH;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,kBAAkB;IAqCxD;;;;OAIG;IACH,IAAI,CAAC,MAAW;QACd,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,IAAI,CAAC,eAAe,KAApB,IAAI,CAAC,eAAe,GAAK,IAAI,EAAC;QAC9B,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,KAAK,EAAC;QACvB,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,EAAE,EAAC;QACvB,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,CAAC,IAAI,CAAC,EAAC;QACtB,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,EAAE,EAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;;;;;;;;;;;;GAeG;IACU,aAAa;;sBAA4D,QAAQ;;;sBAAjF,aAAiE,SAAQ,WAAW;;;gBAC/F,WAAM,GADK,mDAAa,CACI;gBAC5B;;;mBAGG;gBACO,aAAQ,GAAG,KAAK,CAAC;YAgO7B,CAAC;YA9NC;;eAEG;YACH,KAAK,CAAC,IAAI;gBACR,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvE,MAAM,CACJ,MAAM,EACN,kBAAkB,IAAI,CAAC,OAAO,EAAE,2GAA2G,CAC5I,CAAC;gBACJ,CAAC;gBACD,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;oBAC5B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,gBAA8B,CAAC,CAAC;oBAC1E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;oBAC9D,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC9B,CAAC;gBACD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC;YACd,CAAC;YAED;;eAEG;YACH,KAAK,CAAC,IAAI;gBACR,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;oBACtB,MAAM,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,gBAA8B,CAAC,CAAC;gBACpE,CAAC;qBAAM,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC/C,MAAO,IAAI,CAAC,MAAoB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;wBAChD,mBAAmB;oBACrB,CAAC,CAAC,CAAC;gBACL,CAAC;gBACD,IAAI,CAAC,MAAM,GAAG,SAAgB,CAAC;gBAC/B,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;YAED;;;;;;;;;;eAUG;YACH,YAAY,CAAC,KAAiB;gBAC5B,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;gBACrC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;gBAC/B,CAAC;gBACD,8BAA8B;gBAC9B,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACjD,CAAC;gBACD,mEAAmE;gBACnE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBAClE,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;gBAC/B,CAAC;gBACD,qBAAqB;gBACrB,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAC3D,CAAC;YAED;;;eAGG;YACH,KAAK,CAAC,UAAU;gBACd,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;oBACrC,OAAO;gBACT,CAAC;gBACD,sEAAsE;gBACtE,8EAA8E;gBAC9E,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC/B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;oBAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBACpB,SAAS;oBACX,CAAC;oBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;oBAChB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED;;;eAGG;YACH,SAAS;gBACP,OAAO,IAAI,CAAC,MAAM,CAAC;YACrB,CAAC;YAED;;;;;;;eAOG;YAEH,aAAa,CAAuB,KAAQ;gBAC1C,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;gBACrC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBACvC,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAI,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAa,EAAE,KAAK,CAAC,CAAC;gBAC3F,0EAA0E;gBAC1E,oCAAoC;gBACpC,OAAO,IAAI,eAAe,CAAI,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAA6B,CAAC;YAC3F,CAAC;YAED;;;;eAIG;YACH,eAAe;gBACb,MAAM,KAAK,GAA8B,EAAE,CAAC;gBAC5C,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,EAAE,CAAC;oBAC/D,IAAI,KAA6B,CAAC;oBAClC,IAAI,CAAC;wBACH,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAC5B,CAAC;oBAAC,MAAM,CAAC;wBACP,SAAS;oBACX,CAAC;oBACD,IAAI,CAAC,KAAK,EAAE,CAAC;wBACX,SAAS;oBACX,CAAC;oBACD,MAAM,IAAI,GAAQ,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC5C,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAA4B,CAAC,CAAC;gBACnE,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED;;;;;eAKG;YACH,KAAK,CAAC,WAAW;gBACf,MAAM,GAAG,GAAG,cAAc,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBAC/B,MAAM,YAAY,GAAa,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAEzF,MAAM,YAAY,GAAG,CAAC,UAAkB,EAAW,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBAEnG,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAiB,EAAE,CAAC;oBAC1D,IAAI,CAAC,KAAK;wBAAE,SAAS;oBACrB,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACrC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU;wBAAE,SAAS;oBAExC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC;wBAAE,SAAS;oBAE7C,oDAAoD;oBACpD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,EAAa,CAAoB,CAAC;oBACtH,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC/D,IAAI,CAAC,KAAK;wBAAE,SAAS;oBAErB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC;oBACpC,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU;wBAAE,SAAS;oBAE5C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAG,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC;oBACpF,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;oBAC1D,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;oBAExB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;wBACnD,IAAI,KAAK,KAAK,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC;4BAC1D,SAAS;wBACX,CAAC;wBACD,IAAI,IAAI,GAAG,EAAE,CAAC;wBACd,MAAM,IAAI,GAAiB,MAAM,CAAC,UAAU,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC;wBAC1D,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;4BACtB,IAAI,GAAG,UAAU,CAAC;wBACpB,CAAC;6BAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;4BAC9B,IAAI,GAAG,WAAW,CAAC;wBACrB,CAAC;6BAAM,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;4BAC7B,IAAI,GAAG,QAAQ,CAAC;wBAClB,CAAC;6BAAM,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;4BAC5B,IAAI,GAAG,SAAS,CAAC;wBACnB,CAAC;6BAAM,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;4BAC7B,IAAI,GAAG,SAAS,CAAC;wBACnB,CAAC;wBACD,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,KAAK,IAAI,OAAO,KAAK,EAAE,CAAC,CAAC;oBACxD,CAAC;oBAED,IAAI,KAAK,GAAG,0BAA0B,QAAQ,cAAc,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjH,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;wBACjC,KAAK,IAAI,iCAAiC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC;oBACjF,CAAC;oBACD,IAAI,CAAC;wBACH,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,QAAQ,EAAE,CAAC,CAAC;wBAC9C,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,uBAAuB,QAAQ,EAAE,CAAC,CAAC;wBACjE,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;wBACxB,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBACvC,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;oBACzB,CAAC;gBACH,CAAC;YACH,CAAC;YAED;;eAEG;YACH,KAAK,CAAC,OAAO;gBACX,MAAM,MAAM,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACxD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,EAAE,CAAC;oBAC/D,IAAI,CAAC;wBACH,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;wBAChC,IAAI,KAAK,EAAE,CAAC;4BACV,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;wBACvC,CAAC;oBACH,CAAC;oBAAC,MAAM,CAAC;wBACP,0BAA0B;oBAC5B,CAAC;gBACH,CAAC;gBACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC;;;;yCAtHA,aAAa,EAAE;YAChB,wLAAA,aAAa,6DAOZ;;;;;SAvHU,aAAa;AAwO1B,eAAe,aAAa,CAAC"}

package/lib/sqlstore.d.ts

@@ -1,78 +1,160 @@
-import { CoreModel, ModelLink, Store, StoreParameters } from "@webda/core";
+import { MemoryRepository, Store, StoreParameters } from "@webda/core";
+import type { ModelClass, Repository } from "@webda/core";
 import * as WebdaQL from "@webda/ql";
+/** Database connection metadata */
 export interface SQLDatabase {
     name: string;
 }
+/** Base parameters for SQL-backed stores */
 export declare class SQLStoreParameters extends StoreParameters {
     table: string;
     database: SQLDatabase;
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params: any): this;
 }
+/** Minimal SQL client interface compatible with pg.Client and pg.Pool */
 export interface SQLClient {
-    query: () => Promise<void>;
+    query: (q: string, values?: any[]) => Promise<{
+        rows: any[];
+        rowCount: number;
+    }>;
 }
+/** Typed result wrapper for SQL queries */
 export interface SQLResult<T> {
     rows: T[];
     rowCount: number;
 }
+/** Extends ComparisonExpression to emit SQL-compatible string literals for JSONB comparisons */
 export declare class SQLComparisonExpression extends WebdaQL.ComparisonExpression {
+    /**
+     * Single quotes are doubled so a value can never close the literal. Backslashes stay
+     * literal: with `standard_conforming_strings` (PostgreSQL default) `\\` is not an
+     * escape character in '...' strings — only LIKE gives it a meaning.
+     *
+     * @override
+     * @param value - the value to stringify
+     * @returns SQL-compatible string literal
+     */
     toStringValue(value: (string | number | boolean) | (string | number | boolean)[]): string;
+    /**
+     * @override
+     * @returns SQL attribute expression with type cast
+     */
     toStringAttribute(): string;
 }
-export declare abstract class SQLStore<T extends CoreModel, K extends SQLStoreParameters = SQLStoreParameters> extends Store<T, K> {
-    sqlQuery(q: string, values?: any[]): Promise<SQLResult<T>>;
+/**
+ * PostgreSQL-backed repository for a single model class.
+ *
+ * Stores every object as a JSONB `data` column alongside a `uuid` primary-key
+ * column. All CRUD operations hit the pg client; the inherited MemoryRepository
+ * serialize/deserialize helpers are reused for JSON ↔ model-instance
+ * conversion.
+ */
+/**
+ * PostgreSQL-backed repository for a single model class.
+ *
+ * Stores every object as a JSONB `data` column alongside a `uuid` primary-key
+ * column. All CRUD operations hit the pg client; the inherited MemoryRepository
+ * serialize/deserialize helpers are reused for JSON to model-instance conversion.
+ */
+export declare class PostgresRepository<T extends ModelClass> extends MemoryRepository<T> {
+    protected readonly client: SQLClient;
+    protected readonly table: string;
     /**
-     * Execute a SQL query
-     * @param q the query
-     * @param values to be added to the query
+     * Create a new PostgresRepository.
+     * @param model - the model class
+     * @param pks - primary key field names
+     * @param client - the pg client or pool
+     * @param table - the table name
+     * @param separator - composite key separator
      */
-    abstract executeQuery(q: string, values?: any[]): Promise<SQLResult<T>>;
+    constructor(model: T, pks: string[], client: SQLClient, table: string, separator?: string);
     /**
-     * Add the SELECT * FROM table if the query is not a full query
-     * @param q query to complete
-     * @returns
+     * The backing table name for this repository's model.
+     * @returns the table name
+     * @internal Not part of the @webda/models Repository interface.
      */
-    completeQuery(q: string): string;
+    getTable(): string;
     /**
-     * @override
+     * Ensure the backing table for this repository's model exists.
+     * Owns the per-model DDL previously held by PostgresStore.checkTable().
+     * @internal Not part of the @webda/models Repository interface.
      */
-    _delete(uid: string, writeCondition: any, writeConditionField: string): Promise<void>;
-    abstract mapExpressionAttribute(attribute: string[]): string;
-    duplicateExpression(expression: WebdaQL.Expression): WebdaQL.Expression;
+    setupTable(): Promise<void>;
     /**
-     * @override
+     * Map an expression attribute path array to a JSONB path expression.
+     * @param attribute - the attribute path
+     * @returns the JSONB path expression
      */
-    find(query: WebdaQL.Query): Promise<{
-        results: T[];
-        continuationToken: string;
-        filter: WebdaQL.Expression;
-    }>;
+    mapExpressionAttribute(attribute: string[]): string;
     /**
-     * @override
+     * Build a SQL WHERE sub-expression from a write-condition.
+     * @param writeCondition - the expected value
+     * @param writeConditionField - the field to check
+     * @param params - the existing params array (will be extended in place)
+     * @returns the SQL AND clause
      */
-    _exists(uid: string): Promise<boolean>;
+    getQueryCondition(writeCondition: any, writeConditionField: string, params: any[]): string;
     /**
-     * @override
+     * Run a raw SQL query and return typed results.
+     * @param q - the SQL query (WHERE clause or full query)
+     * @param values - the query parameters
+     * @returns the raw pg query result
      */
-    _get(uid: string, raiseIfNotFound?: boolean): Promise<T>;
+    protected sqlQuery(q: string, values?: any[]): Promise<{
+        rows: any[];
+        rowCount: number;
+    }>;
     /**
-     * @override
+     * Deserialize a raw JSON object from the database into a model instance.
+     * @param data - the raw JSON object from the JSONB column
+     * @returns the model instance
      */
-    getAll(list?: string[]): Promise<T[]>;
+    protected fromJSON(data: any): InstanceType<T>;
+    /** @override */
+    get(primaryKey: any): Promise<any>;
+    /** @override */
+    create(data: any, _save?: boolean): Promise<any>;
+    /** @override */
+    update(data: any, conditionField?: any, condition?: any): Promise<void>;
+    /** @override */
+    patch(primaryKey: any, data: any, conditionField?: any, condition?: any): Promise<void>;
+    /** @override */
+    delete(primaryKey: any, conditionField?: any, condition?: any): Promise<void>;
+    /** @override */
+    exists(primaryKey: any): Promise<boolean>;
+    /** @override */
+    removeAttribute(primaryKey: any, attribute: any, conditionField?: any, condition?: any): Promise<void>;
+    /** @override */
+    incrementAttributes(primaryKey: any, info: any, _conditionField?: any, _condition?: any): Promise<void>;
+    /** @override */
+    upsertItemToCollection(primaryKey: any, collection: any, item: any, index?: number, itemWriteConditionField?: any, itemWriteCondition?: any): Promise<void>;
+    /** @override */
+    deleteItemFromCollection(primaryKey: any, collection: any, index: number, itemWriteConditionField?: any, itemWriteCondition?: any): Promise<void>;
     /**
-     *
-     * @param itemWriteCondition
-     * @param itemWriteConditionField
-     * @param offset parameter offset
+     * Duplicate and translate a WebdaQL expression into SQL-friendly JSONB path expressions.
+     * @param expression - the WebdaQL expression
+     * @returns the translated expression
      */
-    abstract getQueryCondition(itemWriteCondition: any, itemWriteConditionField: string, values: any[]): any;
-    /**
-     * @override
-     */
-    _update(object: any, uid: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<any>;
-    getUuid(object: T | string | ModelLink<T>): string;
+    duplicateExpression(expression: WebdaQL.Expression): WebdaQL.Expression;
+    /** @override — use SQL WHERE clause instead of in-memory scan */
+    query(queryStr: string): Promise<{
+        results: InstanceType<T>[];
+        continuationToken?: string;
+    }>;
+    /** @override — iterate via paginated SQL queries */
+    iterate(queryStr: string): AsyncGenerator<InstanceType<T>, any, any>;
     /**
-     * @override
+     * Delete all rows from the table (used in tests).
      */
-    _save(object: T): Promise<any>;
     __clean(): Promise<void>;
 }
+/** Abstract base class for SQL-backed stores */
+export declare abstract class SQLStore<K extends SQLStoreParameters = SQLStoreParameters> extends Store<K> {
+    abstract getRepository<T extends ModelClass>(model: T): Repository<T>;
+}
+//# sourceMappingURL=sqlstore.d.ts.map

package/lib/sqlstore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlstore.d.ts","sourceRoot":"","sources":["../src/sqlstore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAsB,eAAe,EAA4B,MAAM,aAAa,CAAC;AACrH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,mCAAmC;AACnC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4CAA4C;AAC5C,qBAAa,kBAAmB,SAAQ,eAAe;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAGtB;CACF;AAED,yEAAyE;AACzE,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClF;AAED,2CAA2C;AAC3C,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,gGAAgG;AAChG,qBAAa,uBAAwB,SAAQ,OAAO,CAAC,oBAAoB;IACvE;;;;;;;;OAQG;IACH,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,MAAM,CAKxF;IAED;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAS1B;CACF;AAED;;;;;;;GAOG;AACH;;;;;;GAMG;AACH,qBAAa,kBAAkB,CAAC,CAAC,SAAS,UAAU,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAY7E,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS;IACpC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM;IAZlC;;;;;;;OAOG;IACH,YACE,KAAK,EAAE,CAAC,EACR,GAAG,EAAE,MAAM,EAAE,EACM,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EAChC,SAAS,CAAC,EAAE,MAAM,EAInB;IAED;;;;OAIG;IACH,QAAQ,IAAI,MAAM,CAEjB;IAED;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAIhC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAElD;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,cAAc,EAAE,GAAG,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAIzF;IAED;;;;;OAKG;IACH,UAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,GAAE,GAAG,EAAO,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAKlG;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAQ7C;IAED,gBAAgB;IACV,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAOvC;IAED,gBAAgB;IACV,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAO3D;IAED,gBAAgB;IACV,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAW5E;IAED,gBAAgB;IACV,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAW5F;IAED,gBAAgB;IACV,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAalF;IAED,gBAAgB;IACV,MAAM,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAI9C;IAED,gBAAgB;IACV,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAe3G;IAED,gBAAgB;IACV,mBAAmB,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB5G;IAED,gBAAgB;IACV,sBAAsB,CAC1B,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,GAAG,EACf,IAAI,EAAE,GAAG,EACT,KAAK,CAAC,EAAE,MAAM,EACd,uBAAuB,CAAC,EAAE,GAAG,EAC7B,kBAAkB,CAAC,EAAE,GAAG,GACvB,OAAO,CAAC,IAAI,CAAC,CAwBf;IAED,gBAAgB;IACV,wBAAwB,CAC5B,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,GAAG,EACf,KAAK,EAAE,MAAM,EACb,uBAAuB,CAAC,EAAE,GAAG,EAC7B,kBAAkB,CAAC,EAAE,GAAG,GACvB,OAAO,CAAC,IAAI,CAAC,CAoBf;IAED;;;;OAIG;IACH,mBAAmB,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAmCtE;IAED,iEAAiE;IAC3D,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAuBjG;IAED,oDAAoD;IAC7C,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAa1E;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAE7B;CACF;AAED,gDAAgD;AAChD,8BAAsB,QAAQ,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IAChG,QAAQ,CAAC,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;CACvE"}