@fraym/crud 0.12.0 → 0.13.0

package/README.md

@@ -106,12 +106,33 @@ await client.update("tenantId", "YourCrudType", "id", {
 ### Delete data
 
 The name of `YourCrudType` has to equal your type name in your schema (also in casing).
-The `id` has to match the id of the data that you want to delete.
+
+Delete all data of a type:
+
+```typescript
+await client.delete("tenantId", "YourCrudType");
+```
+
+Delete data matching a specific ID:
 
 ```typescript
 await client.delete("tenantId", "YourCrudType", "id");
 ```
 
+Delete data matching a filter (see filter parameter for `getDataList` for details):
+
+```typescript
+await client.delete("tenantId", "YourCrudType", undefined, {
+    fields: {
+        fieldName: {
+            operation: "equals",
+            type: "Int",
+            value: 123,
+        },
+    },
+});
+```
+
 ### Get a single data element
 
 The name of `YourCrudType` has to equal your type name in your schema (also in casing).
@@ -127,7 +148,7 @@ You can specify a fourth parameter if you want to return a empty dataset instead
 const data = await client.getData("tenantId", "YourCrudType", "id", true);
 ```
 
-### Get (paginated / filtered) data
+### Get (paginated / filtered / ordered) data
 
 The name of `YourCrudType` has to equal your type name in your schema (also in casing).
 
@@ -198,6 +219,19 @@ Avaliable options for the filter type `Int` and `Float`:
 -   `lessThanOrEqual`
 -   `greaterThanOrEqual`
 
+With order:
+
+All order definitions are prioritized in the order that they are defined (the first definition is prioritized over the second).
+
+```typescript
+const data = await client.getDataList("tenantId", "YourCrudType", undefined, undefined, undefined, [
+    {
+        field: "fieldName",
+        descending: true, // omit this value for asc order
+    },
+]);
+```
+
 ### Gracefully close the clients
 
 You won't lose any data if you don't. Use it for your peace of mind.

package/dist/delivery/client.d.ts

@@ -1,12 +1,14 @@
 import { ClientConfig } from "../config/config";
 import { CreatedCrudData } from "./create";
-import { Filter, GetCrudDataList } from "./getDataList";
+import { GetCrudDataList } from "./getDataList";
+import { Filter } from "./filter";
+import { Order } from "./order";
 export interface DeliveryClient {
     create: (tenantId: string, type: string, data: Record<string, any>, id?: string) => Promise<CreatedCrudData>;
     update: (tenantId: string, type: string, id: string, data: Record<string, any>) => Promise<void>;
-    delete: (tenantId: string, type: string, id: string) => Promise<void>;
+    delete: (tenantId: string, type: string, id?: string, filter?: Filter) => Promise<void>;
     getData: <T extends {}>(tenantId: string, type: string, id: string, returnEmptyDataIfNotFound?: boolean) => Promise<T>;
-    getDataList: <T extends {}>(tenantId: string, type: string, limit?: number, page?: number, filter?: Filter) => Promise<GetCrudDataList<T>>;
+    getDataList: <T extends {}>(tenantId: string, type: string, limit?: number, page?: number, filter?: Filter, order?: Order[]) => Promise<GetCrudDataList<T>>;
     close: () => Promise<void>;
 }
 export declare const newDeliveryClient: (config?: ClientConfig) => Promise<DeliveryClient>;

package/dist/delivery/client.js

@@ -22,14 +22,14 @@ const newDeliveryClient = async (config) => {
     const update = async (tenantId, type, id, data) => {
         return await (0, update_1.updateCrudData)(tenantId, type, id, data, serviceClient);
     };
-    const deleter = async (tenantId, type, id) => {
-        return await (0, delete_1.deleteCrudData)(tenantId, type, id, serviceClient);
+    const deleter = async (tenantId, type, id = "", filter = { fields: {}, and: [], or: [] }) => {
+        return await (0, delete_1.deleteCrudData)(tenantId, type, id, filter, serviceClient);
     };
     const getData = async (tenantId, type, id, returnEmptyDataIfNotFound = false) => {
         return await (0, getData_1.getCrudData)(tenantId, type, id, returnEmptyDataIfNotFound, serviceClient);
     };
-    const getDataList = async (tenantId, type, limit = 0, page = 1, filter = { fields: {}, and: [], or: [] }) => {
-        return await (0, getDataList_1.getCrudDataList)(tenantId, type, limit, page, filter, serviceClient);
+    const getDataList = async (tenantId, type, limit = 0, page = 1, filter = { fields: {}, and: [], or: [] }, order = []) => {
+        return await (0, getDataList_1.getCrudDataList)(tenantId, type, limit, page, filter, order, serviceClient);
     };
     const close = async () => {
         serviceClient.close();

package/dist/delivery/delete.d.ts

@@ -1,2 +1,3 @@
 import { DeliveryServiceClient } from "@fraym/crud-proto";
-export declare const deleteCrudData: (tenantId: string, type: string, id: string, serviceClient: DeliveryServiceClient) => Promise<void>;
+import { Filter } from "./filter";
+export declare const deleteCrudData: (tenantId: string, type: string, id: string, filter: Filter, serviceClient: DeliveryServiceClient) => Promise<void>;

package/dist/delivery/delete.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteCrudData = void 0;
-const deleteCrudData = async (tenantId, type, id, serviceClient) => {
+const filter_1 = require("./filter");
+const deleteCrudData = async (tenantId, type, id, filter, serviceClient) => {
     return new Promise((resolve, reject) => {
-        serviceClient.deleteEntry({
+        serviceClient.deleteEntries({
             tenantId,
             type,
             id,
+            filter: (0, filter_1.getProtobufEntryFilter)(filter),
         }, error => {
             if (error) {
                 reject(error.message);

package/dist/delivery/filter.d.ts

@@ -0,0 +1,12 @@
+import { EntryFilter } from "@fraym/crud-proto";
+export interface Filter {
+    fields: Record<string, FieldFilter>;
+    and?: Filter[];
+    or?: Filter[];
+}
+export interface FieldFilter {
+    type: string;
+    operation: string;
+    value: any;
+}
+export declare const getProtobufEntryFilter: (filter: Filter) => EntryFilter;

package/dist/delivery/filter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProtobufEntryFilter = void 0;
+const getProtobufEntryFilter = (filter) => {
+    const fields = {};
+    for (const fieldName in filter.fields) {
+        const field = filter.fields[fieldName];
+        let value = "";
+        if (field.type === "String" && typeof field.value == "string") {
+            value = field.value;
+        }
+        else {
+            value = JSON.stringify(field.value);
+        }
+        fields[fieldName] = {
+            operation: field.operation,
+            type: field.type,
+            value,
+        };
+    }
+    return {
+        fields: fields,
+        and: filter.and ? filter.and.map(and => (0, exports.getProtobufEntryFilter)(and)) : [],
+        or: filter.or ? filter.or.map(or => (0, exports.getProtobufEntryFilter)(or)) : [],
+    };
+};
+exports.getProtobufEntryFilter = getProtobufEntryFilter;

package/dist/delivery/getData.js

@@ -11,6 +11,7 @@ const getCrudData = async (tenantId, type, id, returnEmptyDataIfNotFound, servic
             page: 0,
             returnEmptyDataIfNotFound,
             filter: { fields: {}, and: [], or: [] },
+            order: [],
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/delivery/getDataList.d.ts

@@ -1,17 +1,9 @@
 import { DeliveryServiceClient } from "@fraym/crud-proto";
+import { Filter } from "./filter";
+import { Order } from "./order";
 export interface GetCrudDataList<T extends {}> {
     limit: number;
     page: number;
     data: T[];
 }
-export interface Filter {
-    fields: Record<string, FieldFilter>;
-    and?: Filter[];
-    or?: Filter[];
-}
-export interface FieldFilter {
-    type: string;
-    operation: string;
-    value: any;
-}
-export declare const getCrudDataList: <T extends {}>(tenantId: string, type: string, limit: number, page: number, filter: Filter, serviceClient: DeliveryServiceClient) => Promise<GetCrudDataList<T>>;
+export declare const getCrudDataList: <T extends {}>(tenantId: string, type: string, limit: number, page: number, filter: Filter, order: Order[], serviceClient: DeliveryServiceClient) => Promise<GetCrudDataList<T>>;

package/dist/delivery/getDataList.js

@@ -1,30 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCrudDataList = void 0;
-const getProtobufEntryFilter = (filter) => {
-    const fields = {};
-    for (const fieldName in filter.fields) {
-        const field = filter.fields[fieldName];
-        let value = "";
-        if (field.type === "String" && typeof field.value == "string") {
-            value = field.value;
-        }
-        else {
-            value = JSON.stringify(field.value);
-        }
-        fields[fieldName] = {
-            operation: field.operation,
-            type: field.type,
-            value,
-        };
-    }
-    return {
-        fields: fields,
-        and: filter.and ? filter.and.map(and => getProtobufEntryFilter(and)) : [],
-        or: filter.or ? filter.or.map(or => getProtobufEntryFilter(or)) : [],
-    };
-};
-const getCrudDataList = async (tenantId, type, limit, page, filter, serviceClient) => {
+const filter_1 = require("./filter");
+const order_1 = require("./order");
+const getCrudDataList = async (tenantId, type, limit, page, filter, order, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.getEntries({
             tenantId,
@@ -33,7 +12,8 @@ const getCrudDataList = async (tenantId, type, limit, page, filter, serviceClien
             limit,
             page,
             returnEmptyDataIfNotFound: false,
-            filter: getProtobufEntryFilter(filter),
+            filter: (0, filter_1.getProtobufEntryFilter)(filter),
+            order: (0, order_1.getProtobufEntryOrder)(order),
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/delivery/order.d.ts

@@ -0,0 +1,6 @@
+import { EntryOrder } from "@fraym/crud-proto";
+export interface Order {
+    field: string;
+    descending?: boolean;
+}
+export declare const getProtobufEntryOrder: (order: Order[]) => EntryOrder[];

package/dist/delivery/order.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProtobufEntryOrder = void 0;
+const getProtobufEntryOrder = (order) => {
+    return order.map(o => {
+        var _a;
+        return ({
+            field: o.field,
+            descending: (_a = o.descending) !== null && _a !== void 0 ? _a : false,
+        });
+    });
+};
+exports.getProtobufEntryOrder = getProtobufEntryOrder;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/crud",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/crud-nodejs",
     "repository": {
@@ -27,7 +27,7 @@
         "crud": "dist/cmd/crud.js"
     },
     "dependencies": {
-        "@fraym/crud-proto": "1.0.0-alpha.11",
+        "@fraym/crud-proto": "1.0.0-alpha.12",
         "@graphql-tools/graphql-file-loader": "^7.5.14",
         "@graphql-tools/load": "^7.8.9",
         "@grpc/grpc-js": "^1.8.7",