@fraym/crud 0.7.0 → 0.8.0

package/README.md

@@ -22,6 +22,8 @@ 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`).
 
+Use the `CRUD_NAMESPACE` env variable to restrict all migrations to your namespace. This is useful if multiple apps share the crud service. Note: You cannot name your crud type 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).
 
 ### Config
@@ -31,6 +33,7 @@ Use a `.env` file or env variables to configure cte clients and the command:
 ```env
 CRUD_SERVER_ADDRESS=127.0.0.1:9000
 CRUD_SCHEMA_GLOB=./src/crud/*.graphql
+CRUD_NAMESPACE=
 ```
 
 ## Usage

package/dist/cmd/crud.js

@@ -14,47 +14,60 @@ const dotenv_1 = require("dotenv");
 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("crud").argv;
     let schemaGlob = argv.schemaGlob;
     let serverAddress = argv.serverAddress;
+    let namespace = argv.namespace;
     if (process.env.CRUD_SCHEMA_GLOB) {
         schemaGlob = process.env.CRUD_SCHEMA_GLOB;
     }
     if (process.env.CRUD_SERVER_ADDRESS) {
         serverAddress = process.env.CRUD_SERVER_ADDRESS;
     }
+    if (process.env.CRUD_NAMESPACE) {
+        namespace = process.env.CRUD_NAMESPACE;
+    }
+    if (namespace === "Fraym") {
+        throw new Error("Cannot use Fraym as namespace prefix 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,12 +79,12 @@ const getTypeDefinitionFromGraphQLEnumType = (t) => {
         schema,
     };
 };
-const getTypeDefinitionFromGraphQLObjectType = (t) => {
+const getTypeDefinitionFromGraphQLObjectType = (t, namespace) => {
     var _a, _b, _c, _d, _e, _f, _g;
     const isCrudType = (_c = (((_a = t.astNode) === null || _a === void 0 ? void 0 : _a.directives) &&
         ((_b = t.astNode) === null || _b === void 0 ? void 0 : _b.directives.length) > 0 &&
         t.astNode.directives[0].name.value === "crudType")) !== null && _c !== void 0 ? _c : false;
-    const name = t.toString();
+    const name = `${namespace}${t.toString()}`;
     let objectDirectivesString = "";
     let objectFieldsString = "";
     let nestedTypes = [];
@@ -79,7 +92,7 @@ const getTypeDefinitionFromGraphQLObjectType = (t) => {
         objectDirectivesString += getDirectiveString(d);
     });
     (_g = (_f = t.astNode) === null || _f === void 0 ? void 0 : _f.fields) === null || _g === void 0 ? void 0 : _g.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) {
@@ -94,13 +107,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);
@@ -110,10 +123,11 @@ 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" ||
@@ -124,17 +138,17 @@ const getTypeData = (t) => {
                     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,
@@ -186,9 +200,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 });
-    const existingTypeNames = await managementClient.getAllTypes();
+    const existingTypeNames = (await managementClient.getAllTypes()).filter(name => name.startsWith(namespace));
     let createSchema = "";
     let updateSchema = "";
     const typesToCreate = [];
@@ -244,3 +258,8 @@ const migrateSchemas = async (definitions, serverAddress) => {
         console.log(`Removed ${typesToRemove.length} types`);
     }
 };
+const ensureValidName = (name) => {
+    if (name.startsWith("Fraym")) {
+        throw new Error("Cannot use Fraym as type name prefix as it is reserved for fraym apps");
+    }
+};

package/dist/delivery/getDataList.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCrudDataList = void 0;
-const getProtobufDataFilter = (filter) => {
+const getProtobufEntryFilter = (filter) => {
     const fields = {};
     for (const fieldName in filter.fields) {
         const field = filter.fields[fieldName];
@@ -20,8 +20,8 @@ const getProtobufDataFilter = (filter) => {
     }
     return {
         fields: fields,
-        and: filter.and.map(and => getProtobufDataFilter(and)),
-        or: filter.or.map(or => getProtobufDataFilter(or)),
+        and: filter.and.map(and => getProtobufEntryFilter(and)),
+        or: filter.or.map(or => getProtobufEntryFilter(or)),
     };
 };
 const getCrudDataList = async (tenantId, type, limit, page, filter, serviceClient) => {
@@ -33,7 +33,7 @@ const getCrudDataList = async (tenantId, type, limit, page, filter, serviceClien
             limit,
             page,
             returnEmptyDataIfNotFound: false,
-            filter: getProtobufDataFilter(filter),
+            filter: getProtobufEntryFilter(filter),
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/crud",
-    "version": "0.7.0",
+    "version": "0.8.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.7",
+        "@fraym/crud-proto": "^1.0.0-alpha.8",
         "@graphql-tools/graphql-file-loader": "^7.5.11",
         "@graphql-tools/load": "^7.8.6",
         "@grpc/grpc-js": "^1.7.2",