@fraym/crud 0.1.0 → 0.2.0

package/README.md

@@ -8,6 +8,23 @@ Client implementation in javascript for the CRUD service [streams](https://githu
 npm i @fraym/crud
 ```
 
+## CLI command
+
+Use the `crud` cli command to automatically apply your crud schemas to the crud service.
+
+The `--config ./path/crud.config.json` flag can be used to configure the pat to your config file.
+
+Your type schemas have to live directly below the path that you specified in `schemaPath` of your config file.
+
+### CLI command config
+
+```json
+{
+    "schemaPath": "./src/crud", // path to your crud schema files
+    "serverAddress": "127.0.0.1:9000" // address of the crud service
+}
+```
+
 ## Usage
 
 ### Create the clients
@@ -17,7 +34,6 @@ delivery client:
 ```typescript
 const deliveryClient = await newDeliveryClient({
     serverAddress: "127.0.0.1:9000",
-    groupId: "your-services-group-identifier",
 });
 ```
 
@@ -26,7 +42,6 @@ management client:
 ```typescript
 const managementClient = await newManagementClient({
     serverAddress: "127.0.0.1:9000",
-    groupId: "your-services-group-identifier",
 });
 ```
 

package/dist/cmd/crud.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/dist/cmd/crud.js

@@ -0,0 +1,84 @@
+#! /usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const yargs_1 = __importDefault(require("yargs/yargs"));
+const helpers_1 = require("yargs/helpers");
+const utilities_1 = require("graphql/utilities");
+const kinds_1 = require("graphql/language/kinds");
+const client_1 = require("../management/client");
+const run = async () => {
+    const argv = await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .config({ schemaPath: "./src", serverAddress: "127.0.0.1:9000" })
+        .pkgConf("crud")
+        .config("config", "Path of your `crud.config.ts`, default: `./crud.config.ts`", configPath => JSON.parse(fs_1.default.readFileSync(configPath, "utf-8"))).argv;
+    const schemaPath = argv.schemaPath;
+    const serverAddress = argv.serverAddress;
+    const schemas = getSchemas(schemaPath);
+    await migrateSchemas(schemas, serverAddress);
+};
+run();
+const getSchemas = (schemaPath) => {
+    const schemaFiles = fs_1.default.readdirSync(schemaPath);
+    const schemas = {};
+    schemaFiles.forEach(fileName => {
+        const astSchema = (0, utilities_1.buildSchema)(fs_1.default.readFileSync(schemaPath + "/" + fileName, "utf-8"));
+        astSchema.toConfig().types.forEach(t => {
+            var _a;
+            if (!((_a = t.astNode) === null || _a === void 0 ? void 0 : _a.kind)) {
+                return;
+            }
+            const name = t.toString();
+            const typeSchema = (0, utilities_1.buildASTSchema)({
+                definitions: [t.astNode],
+                kind: kinds_1.Kind.DOCUMENT,
+            });
+            if (schemas[name]) {
+                throw new Error(`duplicate schema for CRUD type "${name}" detected, try renaming one of them as they have to be unique`);
+            }
+            schemas[name] = (0, utilities_1.printSchema)(typeSchema);
+        });
+    });
+    return schemas;
+};
+const migrateSchemas = async (schemas, serverAddress) => {
+    const managementClient = await (0, client_1.newManagementClient)({ serverAddress });
+    const existingTypeNames = await managementClient.getAllTypes();
+    let createSchema = "";
+    let updateSchema = "";
+    const typesToCreate = [];
+    const typesToUpdate = [];
+    const typesToRemove = [];
+    existingTypeNames.forEach(existingName => {
+        if (!schemas[existingName]) {
+            typesToRemove.push(existingName);
+        }
+        else {
+            typesToUpdate.push(existingName);
+            updateSchema += `\n${schemas[existingName]}`;
+            delete schemas[existingName];
+        }
+    });
+    Object.keys(schemas).forEach(newName => {
+        typesToCreate.push(newName);
+        createSchema += `\n${schemas[newName]}`;
+    });
+    if (typesToRemove.length > 0) {
+        console.log(`Removing ${typesToRemove.length} types: ${typesToRemove}...`);
+        await managementClient.removeTypes(typesToRemove);
+        console.log(`Removed ${typesToRemove.length} types`);
+    }
+    if (typesToUpdate.length > 0) {
+        console.log(`Updating ${typesToUpdate.length} types: ${typesToUpdate}...`);
+        await managementClient.updateTypes(updateSchema);
+        console.log(`Updated ${typesToUpdate.length} types`);
+    }
+    if (typesToCreate.length > 0) {
+        console.log(`Creating ${typesToCreate.length} types: ${typesToCreate}...`);
+        await managementClient.createTypes(createSchema);
+        console.log(`Created ${typesToCreate.length} types`);
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/crud",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/crud-nodejs",
     "repository": {
@@ -12,25 +12,34 @@
         "test": "echo \"Error: no test specified\" && exit 0",
         "format": "prettier --write \"**/*.{ts,tsx,json}\"",
         "lint": "prettier --check \"**/*.{ts,tsx,json}\"",
-        "build": "npm run clean && tsc",
+        "build": "npm run clean && tsc && chmod +x dist/cmd/crud.js",
         "clean": "rm -rf dist",
         "prepublishOnly": "npm test && npm run lint && npm run build",
-        "preversion": "npm run lint"
+        "preversion": "npm run lint",
+        "cmd": "dist/cmd/crud.js",
+        "cmd2": "dist/cmd/crud.js --config .tst/crud.config.json"
     },
     "files": [
         "dist/**/*"
     ],
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
+    "bin": {
+        "crud": "dist/cmd/crud.js"
+    },
     "dependencies": {
         "@fraym/crud-proto": "^1.0.0-alpha.5",
         "@grpc/grpc-js": "^1.7.2",
-        "uuid": "^9.0.0"
+        "fs": "^0.0.1-security",
+        "graphql": "^16.6.0",
+        "yargs": "^17.6.2"
     },
     "devDependencies": {
         "@becklyn/prettier": "^1.0.2",
         "@types/uuid": "^8.3.4",
+        "@types/yargs": "^17.0.13",
         "prettier": "^2.7.1",
+        "uuid": "^9.0.0",
         "typescript": "^4.8.4"
     },
     "prettier": "@becklyn/prettier"