@fraym/crud 0.5.0 → 0.7.0

package/README.md

@@ -1,6 +1,6 @@
 # crud-nodejs
 
-Client implementation in javascript for the CRUD service [streams](https://github.com/fraym/crud).
+Client implementation in javascript for the [CRUD service](https://github.com/fraym/crud).
 
 ## Installation
 
@@ -22,9 +22,11 @@ Use the `crud` cli command to automatically apply your crud schemas to the crud
 Your type schemas have to match the glob you specify in the `CRUD_SCHEMA_GLOB` env variable (default: `./src/**/*.graphql`).
 You can specify the address (and port) of the crud service instance you use in the `CRUD_SERVER_ADDRESS` env variable (default: `127.0.0.1:9000`).
 
+You need to add a file that contains all built-in directives to your type schemas. The latest version of this file can be found [here](default.graphql).
+
 ### Config
 
-use a `.env` file or env variables to configure cte clients and the command:
+Use a `.env` file or env variables to configure cte clients and the command:
 
 ```env
 CRUD_SERVER_ADDRESS=127.0.0.1:9000
@@ -110,13 +112,19 @@ await client.delete("tenantId", "YourCrudType", "id");
 ### Get a single data element
 
 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.
+The `id` has to match the id of the data that you want to get.
 
 ```typescript
 const data = await client.getData("tenantId", "YourCrudType", "id");
 ```
 
-### Get (paginated) data
+You can specify a fourth parameter if you want to return a empty dataset instead of getting an error when querying a non existing element:
+
+```typescript
+const data = await client.getData("tenantId", "YourCrudType", "id", true);
+```
+
+### Get (paginated / filtered) data
 
 The name of `YourCrudType` has to equal your type name in your schema (also in casing).
 
@@ -134,6 +142,59 @@ const page = 1; // number of the page you want to select, first page starts at:
 const data = await client.getDataList("tenantId", "YourCrudType", limit, page);
 ```
 
+With filter:
+
+```typescript
+const data = await client.getDataList("tenantId", "YourCrudType", undefined, undefined, {
+    fields: {
+        fieldName: {
+            operation: "equals",
+            type: "Int",
+            value: 123,
+        },
+    },
+});
+```
+
+All `Filter`s are evaluated by:
+
+-   checking that all field filters match
+-   checking that all `and` filters match
+-   checking that one of the `or` filters match
+
+Avaliable types:
+
+-   `String`
+-   `ID`
+-   `DateTime`
+-   `Int`
+-   `Float`
+-   `Boolean`
+
+Avaliable operators for all types:
+
+-   `equals`
+-   `notEquals`
+
+Avaliable options for the filter type `DateTime`:
+
+-   `inArray`
+-   `notInArray`
+-   `after`
+-   `before`
+
+Avaliable options for the filter type `String` and `ID`:
+
+-   `inArray`
+-   `notInArray`
+
+Avaliable options for the filter type `Int` and `Float`:
+
+-   `lessThan`
+-   `greaterThan`
+-   `lessThanOrEqual`
+-   `greaterThanOrEqual`
+
 ### Gracefully close the clients
 
 You won't lose any data if you don't. Use it for your peace of mind.

package/dist/cmd/crud.js

@@ -118,7 +118,8 @@ const getTypeData = (t) => {
                 name === "Float" ||
                 name === "ID" ||
                 name === "Boolean" ||
-                name === "Int"
+                name === "Int" ||
+                name === "DateTime"
                 ? {
                     str: name,
                 }

package/dist/delivery/client.d.ts

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

package/dist/delivery/client.js

@@ -28,8 +28,8 @@ const newDeliveryClient = async (config) => {
     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) => {
-        return await (0, getDataList_1.getCrudDataList)(tenantId, type, limit, page, 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 close = async () => {
         serviceClient.close();

package/dist/delivery/getData.js

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

package/dist/delivery/getDataList.d.ts

@@ -4,4 +4,14 @@ export interface GetCrudDataList {
     page: number;
     data: Record<string, any>[];
 }
-export declare const getCrudDataList: (tenantId: string, type: string, limit: number, page: number, serviceClient: DeliveryServiceClient) => Promise<GetCrudDataList | null>;
+export interface Filter {
+    fields: Record<string, FieldFilter>;
+    and: Filter[];
+    or: Filter[];
+}
+export interface FieldFilter {
+    type: string;
+    operation: string;
+    value: any;
+}
+export declare const getCrudDataList: (tenantId: string, type: string, limit: number, page: number, filter: Filter, serviceClient: DeliveryServiceClient) => Promise<GetCrudDataList | null>;

package/dist/delivery/getDataList.js

@@ -1,7 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCrudDataList = void 0;
-const getCrudDataList = async (tenantId, type, limit, page, serviceClient) => {
+const getProtobufDataFilter = (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.map(and => getProtobufDataFilter(and)),
+        or: filter.or.map(or => getProtobufDataFilter(or)),
+    };
+};
+const getCrudDataList = async (tenantId, type, limit, page, filter, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.getEntries({
             tenantId,
@@ -10,6 +33,7 @@ const getCrudDataList = async (tenantId, type, limit, page, serviceClient) => {
             limit,
             page,
             returnEmptyDataIfNotFound: false,
+            filter: getProtobufDataFilter(filter),
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/crud",
-    "version": "0.5.0",
+    "version": "0.7.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/crud-nodejs",
     "repository": {
@@ -27,12 +27,11 @@
         "crud": "dist/cmd/crud.js"
     },
     "dependencies": {
-        "@fraym/crud-proto": "^1.0.0-alpha.6",
+        "@fraym/crud-proto": "^1.0.0-alpha.7",
         "@graphql-tools/graphql-file-loader": "^7.5.11",
         "@graphql-tools/load": "^7.8.6",
         "@grpc/grpc-js": "^1.7.2",
         "dotenv": "^16.0.3",
-        "fs": "^0.0.1-security",
         "graphql": "^16.6.0",
         "yargs": "^17.6.2"
     },