@dwtechs/antity-pgsql 0.9.0 → 0.10.0

package/README.md

@@ -62,11 +62,11 @@ const entity = new SQLEntity("consumers", [
     type: "integer",
     min: 0,
     max: 120,
-    typeCheck: true,
-    filter: true,
-    need: ["PUT"],
+    isTypeChecked: true,
+    isFilterable: true,
+    requiredFor: ["PUT"],
     operations: ["SELECT", "UPDATE"],
-    send: true,
+    isPrivate: false,
     sanitizer: null,
     normalizer: null,
     validator: null,
@@ -76,11 +76,11 @@ const entity = new SQLEntity("consumers", [
     type: "string",
     min: 0,
     max: 255,
-    typeCheck: true,
-    filter: false,
-    need: ["POST", "PUT"],
+    isTypeChecked: true,
+    isFilterable: false,
+    requiredFor: ["POST", "PUT"],
     operations: ["SELECT", "UPDATE"],
-    send: true,
+    isPrivate: false,
     sanitizer: null,
     normalizer: normalizeName,
     validator: null,
@@ -90,11 +90,11 @@ const entity = new SQLEntity("consumers", [
     type: "string",
     min: 0,
     max: 255,
-    typeCheck: true,
-    filter: false,
-    need: ["POST", "PUT"],
+    isTypeChecked: true,
+    isFilterable: false,
+    requiredFor: ["POST", "PUT"],
     operations: ["SELECT", "UPDATE"],
-    send: true,
+    isPrivate: false,
     sanitizer: null,
     normalizer: normalizeName,
     validator: null,
@@ -104,11 +104,11 @@ const entity = new SQLEntity("consumers", [
     type: "string",
     min: 0,
     max: 255,
-    typeCheck: true,
-    filter: true,
-    need: ["POST", "PUT"],
+    isTypeChecked: true,
+    isFilterable: true,
+    requiredFor: ["POST", "PUT"],
     operations: ["SELECT", "UPDATE"],
-    send: true,
+    isPrivate: false,
     sanitizer: null,
     normalizer: normalizeNickname,
     validator: null,
@@ -125,10 +125,10 @@ router.put("/", ...entity.updateArraySubstack);
 router.post("/manual", entity.normalizeArray, entity.validateArray, ..., entity.add);
 router.put("/manual", entity.normalizeArray, entity.validateArray, ..., entity.update);
 
-router.put("/archive", ..., entity.archive);
+router.patch("/archive", ..., entity.archive);
 router.delete("/", ..., entity.delete);
 router.delete("/archived", ..., entity.deleteArchive);
-router.get("/history", ..., entity.getHistory);
+router.get("/:id/history", ..., entity.getHistory);
 
 ```
 
@@ -175,7 +175,7 @@ class SQLEntity {
   get name(): string;
   get table(): string;
   get schema(): string;
-  get unsafeProps(): string[];
+  get privateProps(): string[];
   get properties(): Property[];
   set name(name: string);
   set table(table: string);
@@ -360,10 +360,10 @@ Any of these can be passed into the options object for each function.
 | type            |  Type                     | Type of the property                              |
 | min             |  number \| Date           | Minimum value                                     | 0 \| 1900-01-01
 | max             |  number \| Date           | Maximum value                                     | 999999999 \| 2200-12-31
-| need            |  Method[]                 | property is validated for the listed methods only | ["PATCH", "PUT", "POST"]
-| send            |  boolean                  | Property is sent in the response                  | true
-| typeCheck       |  boolean                  | Type is checked during validation                 | false
-| filter          |  boolean                  | property is filterable in a SELECT operation      | true
+| requiredFor     |  Method[]                 | property is required for the listed methods only  | ["PATCH", "PUT", "POST"]
+| isPrivate       |  boolean                  | Property is unsafe to send in the response        | true
+| isTypeChecked   |  boolean                  | Type is checked during validation                 | false
+| isFilterable    |  boolean                  | property is filterable in a SELECT operation      | true
 | operations      |  Operation[]              | Property is used for the DML operations only      | ["SELECT", "INSERT", "UPDATE"]
 | sanitizer       |  ((v:any) => any) \| null | Custom sanitizer function if sanitize is true     | null
 | normalizer      |  ((v:any) => any) \| null | Custom Normalizer function if normalize is true   | null

package/dist/antity-pgsql.d.ts

@@ -24,12 +24,12 @@ SOFTWARE.
 https://github.com/DWTechs/Antity-pgsql.js
 */
 
-import { Entity } from "@dwtechs/antity";
-import { Type } from "@dwtechs/antity";
-import { Property } from './property';
+import { Entity, Property as BaseProperty } from "@dwtechs/antity";
+import type { Type, Method } from "@dwtechs/antity";
 import type { Request, Response, NextFunction } from 'express';
+import type { Pool, PoolClient } from 'pg';
 
-export type Operation = "SELECT" | "INSERT" | "UPDATE" | "DELETE";
+export type Operation = "SELECT" | "INSERT" | "UPDATE";
 export type Sort = "ASC" | "DESC";
 export type Filters = {
   [key: string]: Filter;
@@ -39,7 +39,27 @@ export type Filter = {
   subProps?: string[];
   matchMode?: MatchMode;
 };
-export { Type };
+export type { Type };
+
+export declare class Property extends BaseProperty {
+  filter: boolean;
+  operations: Operation[];
+  constructor(
+    key: string,
+    type: Type,
+    min: number | Date | null,
+    max: number | Date | null,
+    requiredFor: Method[],
+    isPrivate: boolean,
+    isTypeChecked: boolean,
+    isFilterable: boolean,
+    operations: Operation[] | undefined,
+    sanitizer: ((v: unknown) => unknown) | null,
+    normalizer: ((v: unknown) => unknown) | null,
+    validator: ((v: unknown) => unknown) | null
+  );
+}
+
 export type LogicalOperator = "AND" | "OR";
 export type Comparator = "=" | "<" | ">" | "<=" | ">=" | "<>" | "IS" | "IS NOT" | "IN" | "LIKE" | "NOT LIKE";
 export type MatchMode = "startsWith" | "endsWith" | "contains" | "notContains" | "equals" | "notEquals" | "between" | "in" | "lt" | "lte" | "gt" | "gte" | "is" | "isNot" | "before" | "after" | "st_contains" | "st_dwithin";
@@ -72,12 +92,12 @@ type ExpressMiddleware = (req: Request, res: Response, next: NextFunction) => vo
 type ExpressMiddlewareAsync = (req: Request, res: Response, next: NextFunction) => Promise<void>;
 type SubstackTuple = [ExpressMiddleware, ExpressMiddleware, ExpressMiddlewareAsync];
 
-export class SQLEntity extends Entity {
+export declare class SQLEntity extends Entity {
   private _table: string;
   private _schema: string;
-  private sel: any;
-  private ins: any;
-  private upd: any;
+  private sel: unknown;
+  private ins: unknown;
+  private upd: unknown;
   
   constructor(name: string, properties: Property[], schema?: string);
   
@@ -142,7 +162,7 @@ export class SQLEntity extends Entity {
   getHistory(req: Request, res: Response, next: NextFunction): void;
 }
 
-declare function filter(
+export declare function filter(
   first: number,
   rows: number | null,
   sortField: string | null,
@@ -150,16 +170,9 @@ declare function filter(
   filters: Filters | null,
 ): { filterClause: string, args: (Filter["value"])[] };
   
-declare function execute(
+export declare function execute(
   query: string, 
   args: (string | number | boolean | Date | number[])[], 
-  client: any
+  client: Pool | PoolClient | null
 ): Promise<PGResponse>;
 
-export { 
-  SQLEntity,
-  Property,
-  filter,
-  execute,
-};
-

package/dist/antity-pgsql.js

@@ -459,7 +459,7 @@ function cleanFilters(filters, properties) {
                 delete filters[k];
                 continue;
             }
-            if (!prop.filter) {
+            if (!prop.isFilterable) {
                 log.warn(`${LOGS_PREFIX}Filters: skipping unfilterable property: ${k}`);
                 delete filters[k];
                 continue;
@@ -497,10 +497,10 @@ function generateSummary(name, table, properties) {
         lines.push(`│ │ ├─ Type: ${p.type}`);
         lines.push(`│ │ ├─ Min: ${p.min}`);
         lines.push(`│ │ ├─ Max: ${p.max}`);
-        lines.push(`│ │ ├─ need: ${p.need}`);
-        lines.push(`│ │ ├─ Safe: ${p.safe}`);
-        lines.push(`│ │ ├─ TypeCheck: ${p.typeCheck}`);
-        lines.push(`│ │ ├─ Filter: ${p.filter}`);
+        lines.push(`│ │ ├─ RequiredFor: ${p.requiredFor}`);
+        lines.push(`│ │ ├─ IsPrivate: ${p.isPrivate}`);
+        lines.push(`│ │ ├─ IsTypeChecked: ${p.isTypeChecked}`);
+        lines.push(`│ │ ├─ IsFilterable: ${p.isFilterable}`);
         lines.push(`│ │ ├─ Operations: [${p.operations.join(', ')}]`);
         lines.push(`│ │ ├─ Sanitize: ${p.sanitize}`);
         lines.push(`│ │ ├─ Normalize: ${p.normalize}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity-pgsql",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Open source library to add PostgreSQL support to @dwtechs/Antity entities.",
   "keywords": [
     "entities"
@@ -38,7 +38,7 @@
   "dependencies": {
     "@dwtechs/checkard": "3.6.0",
     "@dwtechs/winstan": "0.5.0",
-    "@dwtechs/antity": "0.15.0",
+    "@dwtechs/antity": "0.16.0",
     "@dwtechs/sparray": "0.2.1",
     "pg": "8.13.1"
   },