@qrvey/data-persistence 0.0.2-4-rev-1 → 0.0.2-4-rev-3

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAiE;AAAxD,4HAAA,OAAO,OAAe;AAC/B,mDAAkD;AAAzC,wGAAA,UAAU,OAAA;AAGnB,qDAAgF;AAAvE,0GAAA,WAAW,OAAA;AAAE,8GAAA,eAAe,OAAA;AAAE,wGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAiE;AAAxD,4HAAA,OAAO,OAAe;AAC/B,mDAAkD;AAAzC,wGAAA,UAAU,OAAA;AAWnB,qDAAgF;AAAvE,0GAAA,WAAW,OAAA;AAAE,8GAAA,eAAe,OAAA;AAAE,wGAAA,SAAS,OAAA"}

package/dist/cjs/types/sortDirection.type.js

@@ -1,5 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("../utils/constants");
-const VALID_SORT_DIRECTIONS = Object.values(constants_1.SORT_DIRECTIONS);
 //# sourceMappingURL=sortDirection.type.js.map

package/dist/cjs/types/sortDirection.type.js.map

@@ -1 +1 @@
-{"version":3,"file":"sortDirection.type.js","sourceRoot":"","sources":["../../../src/types/sortDirection.type.ts"],"names":[],"mappings":";;AAAA,kDAAqD;AAErD,MAAM,qBAAqB,GAAsB,MAAM,CAAC,MAAM,CAAC,2BAAe,CAAC,CAAC"}
+{"version":3,"file":"sortDirection.type.js","sourceRoot":"","sources":["../../../src/types/sortDirection.type.ts"],"names":[],"mappings":""}

package/dist/esm/index.mjs

@@ -1,11 +1,25 @@
 import { default as default2 } from "./services/crud.service";
 import { CrudSchema } from "./schemas/crudSchema";
-import { IFindOptions } from "./interfaces";
+import {
+  IFindOptions,
+  ISorting,
+  ICrudService,
+  IFilter,
+  IFindPagination
+} from "./interfaces";
+import { SortDirection, AggregateFunction, FilterInput } from "./types";
 import { buildFilter, buildQueryIndex, buildSort } from "./helpers/crudHelpers";
 export {
+  AggregateFunction,
   CrudSchema,
   default2 as CrudService,
+  FilterInput,
+  ICrudService,
+  IFilter,
   IFindOptions,
+  IFindPagination,
+  ISorting,
+  SortDirection,
   buildFilter,
   buildQueryIndex,
   buildSort

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export { default as CrudService } from './services/crud.service';\nexport { CrudSchema } from './schemas/crudSchema';\nexport { IFindOptions } from './interfaces';\n\nexport { buildFilter, buildQueryIndex, buildSort } from './helpers/crudHelpers';\n"],"mappings":"AAAA,SAAoB,WAAXA,gBAA8B;AACvC,SAAS,kBAAkB;AAC3B,SAAS,oBAAoB;AAE7B,SAAS,aAAa,iBAAiB,iBAAiB;","names":["default"]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export { default as CrudService } from './services/crud.service';\nexport { CrudSchema } from './schemas/crudSchema';\nexport {\n    IFindOptions,\n    ISorting,\n    ICrudService,\n    IFilter,\n    IFindPagination,\n} from './interfaces';\n\nexport { SortDirection, AggregateFunction, FilterInput } from './types';\n\nexport { buildFilter, buildQueryIndex, buildSort } from './helpers/crudHelpers';\n"],"mappings":"AAAA,SAAoB,WAAXA,gBAA8B;AACvC,SAAS,kBAAkB;AAC3B;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAEP,SAAS,eAAe,mBAAmB,mBAAmB;AAE9D,SAAS,aAAa,iBAAiB,iBAAiB;","names":["default"]}

package/dist/types/index.d.ts

@@ -38,6 +38,21 @@ interface IFindResult<T> {
     count: number;
 }
 
+interface IUpdateOptions {
+    replace?: boolean;
+}
+
+interface ICrudService<T> {
+    create(entity: T): Promise<T>;
+    findItem(options?: IFindOptions): Promise<T | null>;
+    find(options?: IFindOptions): Promise<IFindResult<T>>;
+    findAll(options?: IFindOptions): Promise<IFindResult<T>>;
+    findCount(options?: IFindOptions): Promise<number>;
+    update(filters: IFilter[] | ICompoundFilter, data: Partial<T>, options?: IUpdateOptions): Promise<any | null>;
+    remove(filters: IFilter[] | ICompoundFilter): Promise<void>;
+    runQuery(queryCommand: any): Promise<any>;
+}
+
 declare enum SORT_DIRECTIONS {
     ASC = "ASC",
     DESC = "DESC"
@@ -50,8 +65,7 @@ declare enum AGGREGATE_FUNCTIONS {
     COUNT = "COUNT"
 }
 
-declare const VALID_SORT_DIRECTIONS: SORT_DIRECTIONS[];
-type SortDirection = (typeof VALID_SORT_DIRECTIONS)[number];
+type SortDirection = keyof typeof SORT_DIRECTIONS;
 
 interface ITableName {
     name: string;
@@ -66,6 +80,8 @@ interface ITableColumns {
     };
 }
 
+type FilterInput = string | IFilter[] | ICompoundFilter[] | ICompoundFilter;
+
 declare const VALID_FILTER_LOGIC_OPERATORS: FILTER_LOGIC_OPERATORS[];
 type FilterLogicOperator = (typeof VALID_FILTER_LOGIC_OPERATORS)[number];
 
@@ -121,4 +137,4 @@ declare function buildQueryIndex(indexName: string, columns: string[]): {
 };
 declare function buildSort(column: string, direction?: SortDirection): ISorting;
 
-export { CrudSchema, CrudService, IFindOptions, buildFilter, buildQueryIndex, buildSort };
+export { AggregateFunction, CrudSchema, CrudService, FilterInput, ICrudService, IFilter, IFindOptions, IFindPagination, ISorting, SortDirection, buildFilter, buildQueryIndex, buildSort };

package/package.json

@@ -2,7 +2,7 @@
     "name": "@qrvey/data-persistence",
     "types": "dist/types/index.d.ts",
     "main": "dist/cjs/index.js",
-    "version": "0.0.2-4-rev-1",
+    "version": "0.0.2-4-rev-3",
     "license": "MIT",
     "exports": {
         ".": {
@@ -30,10 +30,24 @@
         "publish-package": "yarn prepare-publish && npm publish"
     },
     "peerDependencies": {
-        "@aws-sdk/client-dynamodb": "^3.433.0",
-        "@aws-sdk/lib-dynamodb": "^3.433.0",
-        "pg": "^8.11.4",
-        "pg-format": "^1.0.4"
+        "@aws-sdk/client-dynamodb": "3.x",
+        "@aws-sdk/lib-dynamodb": "3.x",
+        "pg": "8.11.4",
+        "pg-format": "1.0.4"
+    },
+    "peerDependenciesMeta": {
+        "@aws-sdk/client-dynamodb": {
+            "optional": true
+        },
+        "@aws-sdk/lib-dynamodb": {
+            "optional": true
+        },
+        "pg": {
+            "optional": true
+        },
+        "pg-format": {
+            "optional": true
+        }
     },
     "devDependencies": {
         "@types/jest": "^29.5.5",