@fraym/projections 0.2.0 → 0.4.0

package/README.md

@@ -20,7 +20,9 @@ You need to add the `Tenant-Id` header in order to use the graphQL Endpoint and
 Use the `projections` cli command to automatically apply your projection schemas to the projections service.
 
 Your type schemas have to match the glob you specify in the `PROJECTIONS_SCHEMA_GLOB` env variable (default: `./src/**/*.graphql`).
-You can specify the address (and port) of the crud service instance you use in the `PROJECTIONS_SERVER_ADDRESS` env variable (default: `127.0.0.1:9000`).
+You can specify the address (and port) of the projections service instance you use in the `PROJECTIONS_SERVER_ADDRESS` env variable (default: `127.0.0.1:9000`).
+
+Use the `PROJECTIONS_NAMESPACE` env variable to restrict all migrations to your namespace. This is useful if multiple apps share the projections service. Note: You cannot name your projection or namespace by a `Fraym` prefix. This is a reserved prefix for fraym apps.
 
 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).
 
@@ -31,6 +33,7 @@ Use a `.env` file or env variables to configure cte clients and the command:
 ```env
 PROJECTIONS_SERVER_ADDRESS=127.0.0.1:9000
 PROJECTIONS_SCHEMA_GLOB=./src/projections/*.graphql
+PROJECTIONS_NAMESPACE=
 ```
 
 ## Usage
@@ -94,7 +97,7 @@ You can specify a fourth parameter if you want to return a empty dataset instead
 const data = await deliveryClient.getData("tenantId", "YourProjection", "id", true);
 ```
 
-### Get (paginated) data
+### Get (paginated / filtered) data
 
 The name of `YourProjection` has to equal your type name in your schema (also in casing).
 
@@ -112,6 +115,59 @@ const page = 1; // number of the page you want to select, first page starts at:
 const data = await deliveryClient.getDataList("tenantId", "YourProjection", limit, page);
 ```
 
+With filter:
+
+```typescript
+const data = await deliveryClient.getDataList("tenantId", "YourProjection", 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/projections.js

@@ -14,47 +14,60 @@ const client_1 = require("../management/client");
 const run = async () => {
     (0, dotenv_1.config)();
     const argv = await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
-        .config({ schemaGlob: "./src/**/*.graphql", serverAddress: "127.0.0.1:9000" })
+        .config({
+        schemaGlob: "./src/**/*.graphql",
+        serverAddress: "127.0.0.1:9000",
+        namespace: "",
+    })
         .pkgConf("projections").argv;
     let schemaGlob = argv.schemaGlob;
     let serverAddress = argv.serverAddress;
+    let namespace = argv.namespace;
     if (process.env.PROJECTIONS_SCHEMA_GLOB) {
         schemaGlob = process.env.PROJECTIONS_SCHEMA_GLOB;
     }
     if (process.env.PROJECTIONS_SERVER_ADDRESS) {
         serverAddress = process.env.PROJECTIONS_SERVER_ADDRESS;
     }
+    if (process.env.PROJECTIONS_NAMESPACE) {
+        namespace = process.env.PROJECTIONS_NAMESPACE;
+    }
+    if (namespace === "Fraym") {
+        throw new Error("Cannot use Fraym as namespace as it is reserved for fraym apps");
+    }
     const schema = await (0, load_1.loadSchema)(`${schemaGlob}`, {
         loaders: [new graphql_file_loader_1.GraphQLFileLoader()],
     });
-    const definitions = getTypeDefinition(schema);
-    await migrateSchemas(definitions, serverAddress);
+    const definitions = getTypeDefinition(schema, namespace);
+    await migrateSchemas(definitions, serverAddress, namespace);
 };
 run();
-const getTypeDefinition = (schema) => {
+const getTypeDefinition = (schema, namespace) => {
     const definitions = {};
     schema.toConfig().types.forEach(t => {
         if (!(t instanceof graphql_1.GraphQLObjectType) && !(t instanceof graphql_1.GraphQLEnumType)) {
             return;
         }
-        const name = t.toString();
+        const name = `${namespace}${t.toString()}`;
+        ensureValidName(name);
         if (definitions[name]) {
             throw new Error(`duplicate definition for type "${name}" detected, try renaming one of them as they have to be uniquely named`);
         }
         if (t instanceof graphql_1.GraphQLObjectType) {
-            definitions[name] = getTypeDefinitionFromGraphQLObjectType(t);
+            definitions[name] = getTypeDefinitionFromGraphQLObjectType(t, namespace);
             return;
         }
         if (t instanceof graphql_1.GraphQLEnumType) {
-            definitions[name] = getTypeDefinitionFromGraphQLEnumType(t);
+            definitions[name] = getTypeDefinitionFromGraphQLEnumType(t, namespace);
             return;
         }
     });
     return definitions;
 };
-const getTypeDefinitionFromGraphQLEnumType = (t) => {
+const getTypeDefinitionFromGraphQLEnumType = (t, namespace) => {
     var _a, _b;
-    const name = t.toString();
+    const name = `${namespace}${t.toString()}`;
+    ensureValidName(name);
     let enumValuesString = "";
     (_b = (_a = t.astNode) === null || _a === void 0 ? void 0 : _a.values) === null || _b === void 0 ? void 0 : _b.forEach(value => {
         enumValuesString += `\n\t${value.name.value}`;
@@ -66,14 +79,15 @@ const getTypeDefinitionFromGraphQLEnumType = (t) => {
         schema,
     };
 };
-const getTypeDefinitionFromGraphQLObjectType = (t) => {
+const getTypeDefinitionFromGraphQLObjectType = (t, namespace) => {
     var _a, _b, _c, _d, _e, _f;
     let isProjection = false;
     if (((_a = t.astNode) === null || _a === void 0 ? void 0 : _a.directives) && ((_b = t.astNode) === null || _b === void 0 ? void 0 : _b.directives.length) > 0) {
         const directiveNames = t.astNode.directives.map(directive => directive.name.value);
         isProjection = directiveNames.includes("upsertOn");
     }
-    const name = t.toString();
+    const name = `${namespace}${t.toString()}`;
+    ensureValidName(name);
     let objectDirectivesString = "";
     let objectFieldsString = "";
     let nestedTypes = [];
@@ -81,7 +95,7 @@ const getTypeDefinitionFromGraphQLObjectType = (t) => {
         objectDirectivesString += getDirectiveString(d);
     });
     (_f = (_e = t.astNode) === null || _e === void 0 ? void 0 : _e.fields) === null || _f === void 0 ? void 0 : _f.forEach(f => {
-        const { str, nestedTypes: newNestedTypes } = getFieldStringAndNestedTypes(f);
+        const { str, nestedTypes: newNestedTypes } = getFieldStringAndNestedTypes(f, namespace);
         objectFieldsString += str;
         newNestedTypes.forEach(nested => {
             if (nestedTypes.indexOf(nested) === -1) {
@@ -96,13 +110,13 @@ const getTypeDefinitionFromGraphQLObjectType = (t) => {
         schema,
     };
 };
-const getFieldStringAndNestedTypes = (f) => {
+const getFieldStringAndNestedTypes = (f, namespace) => {
     var _a;
     let directivesString = "";
     (_a = f.directives) === null || _a === void 0 ? void 0 : _a.forEach(d => {
         directivesString += getDirectiveString(d);
     });
-    const { nestedType, str: typeString } = getTypeData(f.type);
+    const { nestedType, str: typeString } = getTypeData(f.type, namespace);
     const nestedTypes = [];
     if (nestedType) {
         nestedTypes.push(nestedType);
@@ -112,31 +126,33 @@ const getFieldStringAndNestedTypes = (f) => {
         nestedTypes,
     };
 };
-const getTypeData = (t) => {
+const getTypeData = (t, namespace) => {
     switch (t.kind) {
         case graphql_1.Kind.NAMED_TYPE:
             const name = t.name.value;
+            ensureValidName(`${namespace}${name}`);
             return name === "String" ||
                 name === "Float" ||
                 name === "ID" ||
                 name === "Boolean" ||
                 name === "Int" ||
-                name === "DateTime"
+                name === "DateTime" ||
+                name === "EventEnvelope"
                 ? {
                     str: name,
                 }
                 : {
-                    str: name,
-                    nestedType: name,
+                    str: `${namespace}${name}`,
+                    nestedType: `${namespace}${name}`,
                 };
         case graphql_1.Kind.LIST_TYPE:
-            const { nestedType: listNestedType, str: listStr } = getTypeData(t.type);
+            const { nestedType: listNestedType, str: listStr } = getTypeData(t.type, namespace);
             return {
                 str: `[${listStr}]`,
                 nestedType: listNestedType,
             };
         case graphql_1.Kind.NON_NULL_TYPE:
-            const { nestedType: nonNullNestedType, str: nonNullStr } = getTypeData(t.type);
+            const { nestedType: nonNullNestedType, str: nonNullStr } = getTypeData(t.type, namespace);
             return {
                 str: `${nonNullStr}!`,
                 nestedType: nonNullNestedType,
@@ -188,9 +204,9 @@ const getValueString = (v) => {
             throw new Error(`values of kind ${v.kind} are currently not supported`);
     }
 };
-const migrateSchemas = async (definitions, serverAddress) => {
+const migrateSchemas = async (definitions, serverAddress, namespace) => {
     const managementClient = await (0, client_1.newManagementClient)({ serverAddress });
-    let existingProjections = (await managementClient.getAll()).filter(projectionName => !projectionName.startsWith("Crud"));
+    let existingProjections = (await managementClient.getAll()).filter(projectionName => !projectionName.startsWith("Crud") && projectionName.startsWith(namespace));
     let createSchema = "";
     let updateSchema = "";
     const projectionsToCreate = [];
@@ -246,3 +262,8 @@ const migrateSchemas = async (definitions, serverAddress) => {
         console.log(`Removed ${projectionsToRemove.length} projections`);
     }
 };
+const ensureValidName = (name) => {
+    if (name.startsWith("Fraym")) {
+        throw new Error(`Cannot use Fraym as projection name prefix as it is reserved for fraym apps, got ${name}`);
+    }
+};

package/dist/delivery/client.d.ts

@@ -1,9 +1,9 @@
 import { ClientConfig } from "../config/config";
 import { GetProjectionData } from "./getData";
-import { GetProjectionDataList } from "./getDataList";
+import { Filter, GetProjectionDataList } from "./getDataList";
 export interface DeliveryClient {
     getData: (tenantId: string, type: string, id: string, returnEmptyDataIfNotFound?: boolean) => Promise<GetProjectionData | null>;
-    getDataList: (tenantId: string, type: string, limit?: number, page?: number) => Promise<GetProjectionDataList | null>;
+    getDataList: (tenantId: string, type: string, limit?: number, page?: number, filter?: Filter) => Promise<GetProjectionDataList | null>;
     close: () => Promise<void>;
 }
 export declare const newDeliveryClient: (config?: ClientConfig) => Promise<DeliveryClient>;

package/dist/delivery/client.js

@@ -16,8 +16,8 @@ const newDeliveryClient = async (config) => {
     const getData = async (tenantId, projection, id, returnEmptyDataIfNotFound = false) => {
         return await (0, getData_1.getProjectionData)(tenantId, projection, id, returnEmptyDataIfNotFound, serviceClient);
     };
-    const getDataList = async (tenantId, projection, limit = 0, page = 1) => {
-        return await (0, getDataList_1.getProjectionDataList)(tenantId, projection, limit, page, serviceClient);
+    const getDataList = async (tenantId, projection, limit = 0, page = 1, filter = { fields: {}, and: [], or: [] }) => {
+        return await (0, getDataList_1.getProjectionDataList)(tenantId, projection, limit, page, filter, serviceClient);
     };
     const close = async () => {
         serviceClient.close();

package/dist/delivery/getData.js

@@ -10,6 +10,7 @@ const getProjectionData = async (tenantId, projection, dataId, returnEmptyDataIf
             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 GetProjectionDataList {
     page: number;
     data: Record<string, any>[];
 }
-export declare const getProjectionDataList: (tenantId: string, projection: string, limit: number, page: number, serviceClient: DeliveryServiceClient) => Promise<GetProjectionDataList | null>;
+export interface Filter {
+    fields: Record<string, FieldFilter>;
+    and: Filter[];
+    or: Filter[];
+}
+export interface FieldFilter {
+    type: string;
+    operation: string;
+    value: any;
+}
+export declare const getProjectionDataList: (tenantId: string, projection: string, limit: number, page: number, filter: Filter, serviceClient: DeliveryServiceClient) => Promise<GetProjectionDataList | null>;

package/dist/delivery/getDataList.js

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

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./management/client";
 export * from "./delivery/client";
+export { Filter, FieldFilter } from "./delivery/getDataList";
 export { ClientConfig } from "./config/config";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/projections",
-    "version": "0.2.0",
+    "version": "0.4.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/projections-nodejs",
     "repository": {
@@ -27,7 +27,7 @@
         "projections": "dist/cmd/projections.js"
     },
     "dependencies": {
-        "@fraym/projections-proto": "^1.0.0-alpha.9",
+        "@fraym/projections-proto": "^1.0.0-alpha.11",
         "@graphql-tools/graphql-file-loader": "^7.5.11",
         "@graphql-tools/load": "^7.8.6",
         "@grpc/grpc-js": "^1.7.2",