@jeff-aporta/apiservers 0.1.0

package/dist/filter/iss-list-filter.d.ts

@@ -0,0 +1,65 @@
+export declare const ISS_LIST_FILTER_QUERY_PARAM = "f";
+export interface IIssListFilter {
+    search?: string;
+    limit?: number;
+    offset?: number;
+    eq?: Record<string, string | number | boolean>;
+    sort?: string;
+}
+export declare const ISS_LIST_FILTER_DEFAULT_LIMIT = 25;
+export declare const ISS_LIST_FILTER_MAX_LIMIT = 100;
+export declare const ISS_LIST_FILTER_SCHEMA: {
+    readonly type: "object";
+    readonly description: "Filtro ISS para listados (query `f` = JSON en Base64).";
+    readonly properties: {
+        readonly search: {
+            readonly type: "string";
+            readonly description: "Texto libre; el recurso define en qué columnas busca.";
+        };
+        readonly limit: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 100;
+            readonly default: 25;
+        };
+        readonly offset: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly default: 0;
+        };
+        readonly eq: {
+            readonly type: "object";
+            readonly additionalProperties: {
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                }, {
+                    readonly type: "number";
+                }, {
+                    readonly type: "boolean";
+                }];
+            };
+            readonly description: "Filtros de igualdad exacta (AND). Claves permitidas dependen del recurso.";
+        };
+        readonly sort: {
+            readonly type: "string";
+            readonly description: "Campo de orden. Prefijo `-` = descendente.";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare function encodeIssListFilterB64(filter: Record<string, unknown> | IIssListFilter): string;
+export declare function decodeIssListFilterB64(raw: string): string;
+export declare function parseIssListFilterFromQuery(raw: string | null | undefined): IIssListFilter;
+export declare function parseIssListFilter(raw: string | null | undefined): IIssListFilter;
+export declare function normalizeLimit(value: unknown): number;
+export declare function normalizeOffset(value: unknown): number;
+export declare function resolveIssListLimit(filter?: IIssListFilter): number;
+export declare function resolveIssListOffset(filter?: IIssListFilter): number;
+export declare function resolveIssListSort(sort: string | undefined, allowed: Set<string>, defaultField: string): {
+    field: string;
+    desc: boolean;
+};
+export declare function pickEqFilter(eq: Record<string, string | number | boolean> | undefined, allowed: Set<string>): Record<string, string | number | boolean>;
+export declare function escapeLikePattern(search: string): string;
+export declare function likeSearchPattern(search: string): string;
+export declare function likeSearchPrefix(search: string): string;

package/dist/filter/iss-list-filter.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ISS_LIST_FILTER_SCHEMA = exports.ISS_LIST_FILTER_MAX_LIMIT = exports.ISS_LIST_FILTER_DEFAULT_LIMIT = exports.ISS_LIST_FILTER_QUERY_PARAM = void 0;
+exports.encodeIssListFilterB64 = encodeIssListFilterB64;
+exports.decodeIssListFilterB64 = decodeIssListFilterB64;
+exports.parseIssListFilterFromQuery = parseIssListFilterFromQuery;
+exports.parseIssListFilter = parseIssListFilter;
+exports.normalizeLimit = normalizeLimit;
+exports.normalizeOffset = normalizeOffset;
+exports.resolveIssListLimit = resolveIssListLimit;
+exports.resolveIssListOffset = resolveIssListOffset;
+exports.resolveIssListSort = resolveIssListSort;
+exports.pickEqFilter = pickEqFilter;
+exports.escapeLikePattern = escapeLikePattern;
+exports.likeSearchPattern = likeSearchPattern;
+exports.likeSearchPrefix = likeSearchPrefix;
+const ispserver_1 = require("@ingenieria_insoft/ispserver");
+const ispgen_1 = require("@ingenieria_insoft/ispgen");
+exports.ISS_LIST_FILTER_QUERY_PARAM = "f";
+exports.ISS_LIST_FILTER_DEFAULT_LIMIT = 25;
+exports.ISS_LIST_FILTER_MAX_LIMIT = 100;
+exports.ISS_LIST_FILTER_SCHEMA = {
+    type: "object",
+    description: "Filtro ISS para listados (query `f` = JSON en Base64).",
+    properties: {
+        search: { type: "string", description: "Texto libre; el recurso define en qué columnas busca." },
+        limit: { type: "integer", minimum: 1, maximum: exports.ISS_LIST_FILTER_MAX_LIMIT, default: exports.ISS_LIST_FILTER_DEFAULT_LIMIT },
+        offset: { type: "integer", minimum: 0, default: 0 },
+        eq: {
+            type: "object",
+            additionalProperties: { oneOf: [{ type: "string" }, { type: "number" }, { type: "boolean" }] },
+            description: "Filtros de igualdad exacta (AND). Claves permitidas dependen del recurso.",
+        },
+        sort: { type: "string", description: "Campo de orden. Prefijo `-` = descendente." },
+    },
+    additionalProperties: false,
+};
+function encodeIssListFilterB64(filter) {
+    return Buffer.from(JSON.stringify(filter), "utf8").toString("base64");
+}
+function decodeIssListFilterB64(raw) {
+    try {
+        return Buffer.from(String(raw).trim(), "base64").toString("utf8");
+    }
+    catch {
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f (Base64 inválido)");
+    }
+}
+function parseIssListFilterFromQuery(raw) {
+    if (raw == null || !String(raw).trim())
+        return {};
+    const json = decodeIssListFilterB64(raw);
+    return parseIssListFilter(json);
+}
+function parseIssListFilter(raw) {
+    if (raw == null || !String(raw).trim())
+        return {};
+    let parsed;
+    try {
+        parsed = JSON.parse(String(raw).trim());
+    }
+    catch {
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f (JSON inválido)");
+    }
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f (debe ser un objeto JSON)");
+    }
+    const src = parsed;
+    const out = {};
+    if (src.search !== undefined) {
+        const search = String(src.search).trim();
+        if (search)
+            out.search = search.slice(0, 200);
+    }
+    if (src.limit !== undefined)
+        out.limit = normalizeLimit(src.limit);
+    if (src.offset !== undefined)
+        out.offset = normalizeOffset(src.offset);
+    if (src.sort !== undefined) {
+        const sort = String(src.sort).trim();
+        if (sort)
+            out.sort = sort.slice(0, 64);
+    }
+    if (src.eq !== undefined) {
+        if (!src.eq || typeof src.eq !== "object" || Array.isArray(src.eq)) {
+            throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f.eq");
+        }
+        const eq = {};
+        for (const [key, value] of Object.entries(src.eq)) {
+            if (value === null || value === undefined)
+                continue;
+            const t = typeof value;
+            if (t === "string" || t === "number" || t === "boolean") {
+                eq[key] = value;
+            }
+            else {
+                throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, `f.eq.${key}`);
+            }
+        }
+        if (Object.keys(eq).length)
+            out.eq = eq;
+    }
+    const extra = Object.keys(src).filter((k) => !["search", "limit", "offset", "eq", "sort"].includes(k));
+    if (extra.length) {
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, `f (${extra.join(", ")})`);
+    }
+    return out;
+}
+function normalizeLimit(value) {
+    const n = typeof value === "number" ? value : Number(value);
+    if (!Number.isFinite(n))
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f.limit");
+    return Math.min(exports.ISS_LIST_FILTER_MAX_LIMIT, Math.max(1, Math.floor(n)));
+}
+function normalizeOffset(value) {
+    const n = typeof value === "number" ? value : Number(value);
+    if (!Number.isFinite(n) || n < 0)
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f.offset");
+    return Math.floor(n);
+}
+function resolveIssListLimit(filter) {
+    if (!filter?.limit)
+        return exports.ISS_LIST_FILTER_DEFAULT_LIMIT;
+    return normalizeLimit(filter.limit);
+}
+function resolveIssListOffset(filter) {
+    if (!filter?.offset)
+        return 0;
+    return normalizeOffset(filter.offset);
+}
+function resolveIssListSort(sort, allowed, defaultField) {
+    if (!sort)
+        return { field: defaultField, desc: true };
+    const desc = sort.startsWith("-");
+    const field = desc ? sort.slice(1) : sort;
+    if (!allowed.has(field)) {
+        throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, "f.sort");
+    }
+    return { field, desc };
+}
+function pickEqFilter(eq, allowed) {
+    if (!eq)
+        return {};
+    const out = {};
+    for (const [key, value] of Object.entries(eq)) {
+        if (!allowed.has(key)) {
+            throw (0, ispserver_1.Rst400)(ispgen_1.TErr400.paramBody, `f.eq.${key}`);
+        }
+        out[key] = value;
+    }
+    return out;
+}
+function escapeLikePattern(search) {
+    return search.replace(/[%_[\]]/g, (ch) => `[${ch}]`);
+}
+function likeSearchPattern(search) {
+    return `%${escapeLikePattern(search)}%`;
+}
+function likeSearchPrefix(search) {
+    return `${escapeLikePattern(search)}%`;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@jeff-aporta/apiservers",
+  "version": "0.1.0",
+  "description": "Utilidades comunes para backends InSoft / Azure Functions (filtros, convenciones API).",
+  "type": "commonjs",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "typesVersions": {
+    "*": {
+      "filter/iss-list-filter": ["dist/filter/iss-list-filter.d.ts"]
+    }
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    "./filter/iss-list-filter": {
+      "types": "./dist/filter/iss-list-filter.d.ts",
+      "require": "./dist/filter/iss-list-filter.js",
+      "default": "./dist/filter/iss-list-filter.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "publish:npm": "node scripts/publish.mjs",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@ingenieria_insoft/ispgen": "^1.x",
+    "@ingenieria_insoft/ispserver": "^1.x"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.8.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "UNLICENSED",
+  "private": false
+}