@fraym/crud 0.3.0 → 0.4.0

package/README.md

@@ -8,22 +8,27 @@ Client implementation in javascript for the CRUD service [streams](https://githu
 npm i @fraym/crud
 ```
 
+## GraphQL
+
+You can access the graphQL api at `http://crud:3000/delivery/graphql`.
+There is a sandbox available at `http://crud:3000/delivery/graphql/sandbox`.
+
+You need to add the `Tenant-Id` header in order to use the graphQL Endpoint and the sandbox.
+
 ## 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 path of your config file.
+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`).
 
-Your type schemas have to match the glob you specify in `schemaGlob` of he config file (default: `./src/**/*.graphql`).
-You can specify the address (and port) of the crud service instance you use in `serverAddress` of the config file (default: `127.0.0.1:9000`).
+### Config
 
-### CLI command config
+use a `.env` file or env variables to configure cte clients and the command:
 
-```json
-{
-    "schemaGlob": "./src/crud/*.graphql", // path to your crud schema files
-    "serverAddress": "127.0.0.1:9000" // address of the crud service
-}
+```env
+CRUD_SERVER_ADDRESS=127.0.0.1:9000
+CRUD_SCHEMA_GLOB=./src/crud/*.graphql
 ```
 
 ## Usage
@@ -33,17 +38,13 @@ You can specify the address (and port) of the crud service instance you use in `
 delivery client:
 
 ```typescript
-const deliveryClient = await newDeliveryClient({
-    serverAddress: "127.0.0.1:9000",
-});
+const deliveryClient = await newDeliveryClient();
 ```
 
 management client:
 
 ```typescript
-const managementClient = await newManagementClient({
-    serverAddress: "127.0.0.1:9000",
-});
+const managementClient = await newManagementClient();
 ```
 
 ### Create one or multipe CRUD types

package/dist/cmd/crud.js

@@ -4,20 +4,26 @@ 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 client_1 = require("../management/client");
 const load_1 = require("@graphql-tools/load");
 const graphql_file_loader_1 = require("@graphql-tools/graphql-file-loader");
 const graphql_1 = require("graphql");
+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" })
-        .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 schemaGlob = argv.schemaGlob;
-    const serverAddress = argv.serverAddress;
+        .pkgConf("crud").argv;
+    let schemaGlob = argv.schemaGlob;
+    let serverAddress = argv.serverAddress;
+    if (process.env.CRUD_SCHEMA_GLOB) {
+        schemaGlob = process.env.CRUD_SCHEMA_GLOB;
+    }
+    if (process.env.CRUD_SERVER_ADDRESS) {
+        serverAddress = process.env.CRUD_SERVER_ADDRESS;
+    }
     const schema = await (0, load_1.loadSchema)(`${schemaGlob}`, {
         loaders: [new graphql_file_loader_1.GraphQLFileLoader()],
     });
@@ -200,19 +206,19 @@ const migrateSchemas = async (definitions, serverAddress) => {
             nestedTypesToCreate.push(nestedTypeName);
         });
     });
-    if (typesToRemove.length > 0) {
-        console.log(`Removing ${typesToRemove.length} types: ${typesToRemove}...`);
-        await managementClient.removeTypes(typesToRemove).catch(console.log);
-        console.log(`Removed ${typesToRemove.length} types`);
+    if (typesToCreate.length > 0) {
+        console.log(`Creating ${typesToCreate.length} types: ${typesToCreate}...`);
+        await managementClient.createTypes(createSchema).catch(console.log);
+        console.log(`Created ${typesToCreate.length} types`);
     }
     if (typesToUpdate.length > 0) {
         console.log(`Updating ${typesToUpdate.length} types: ${typesToUpdate}...`);
         await managementClient.updateTypes(updateSchema).catch(console.log);
         console.log(`Updated ${typesToUpdate.length} types`);
     }
-    if (typesToCreate.length > 0) {
-        console.log(`Creating ${typesToCreate.length} types: ${typesToCreate}...`);
-        await managementClient.createTypes(createSchema).catch(console.log);
-        console.log(`Created ${typesToCreate.length} types`);
+    if (typesToRemove.length > 0) {
+        console.log(`Removing ${typesToRemove.length} types: ${typesToRemove}...`);
+        await managementClient.removeTypes(typesToRemove).catch(console.log);
+        console.log(`Removed ${typesToRemove.length} types`);
     }
 };

package/dist/config/config.d.ts

@@ -3,4 +3,5 @@ export interface ClientConfig {
     keepaliveInterval?: number;
     keepaliveTimeout?: number;
 }
-export declare const useConfigDefaults: (config: ClientConfig) => Required<ClientConfig>;
+export declare const getEnvConfig: () => ClientConfig;
+export declare const useConfigDefaults: (config?: ClientConfig) => Required<ClientConfig>;

package/dist/config/config.js

@@ -1,8 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useConfigDefaults = void 0;
+exports.useConfigDefaults = exports.getEnvConfig = void 0;
+const dotenv_1 = require("dotenv");
+const getEnvConfig = () => {
+    var _a;
+    (0, dotenv_1.config)();
+    const serverAddress = (_a = process.env.CRUD_SERVER_ADDRESS) !== null && _a !== void 0 ? _a : "";
+    let keepaliveInterval;
+    let keepaliveTimeout;
+    const keepaliveIntervalString = process.env.CRUD_CONNECTION_KEEPALIVE_INTERVAL;
+    const keepaliveTimeoutString = process.env.CRUD_CONNECTION_KEEPALIVE_INTERVAL;
+    if (keepaliveIntervalString) {
+        keepaliveInterval = parseInt(keepaliveIntervalString, 10);
+    }
+    if (keepaliveTimeoutString) {
+        keepaliveTimeout = parseInt(keepaliveTimeoutString, 10);
+    }
+    return {
+        serverAddress,
+        keepaliveInterval,
+        keepaliveTimeout,
+    };
+};
+exports.getEnvConfig = getEnvConfig;
 const useConfigDefaults = (config) => {
     var _a, _b;
+    if (!config) {
+        config = (0, exports.getEnvConfig)();
+    }
+    console.log(config);
     return {
         serverAddress: config.serverAddress,
         keepaliveTimeout: (_a = config.keepaliveTimeout) !== null && _a !== void 0 ? _a : 3 * 1000,

package/dist/delivery/client.d.ts

@@ -6,8 +6,8 @@ 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) => Promise<GetCrudData | null>;
+    getData: (tenantId: string, type: string, id: string, returnEmptyDataIfNotFound?: boolean) => Promise<GetCrudData | null>;
     getDataList: (tenantId: string, type: string, limit?: number, page?: number) => Promise<GetCrudDataList | null>;
     close: () => Promise<void>;
 }
-export declare const newDeliveryClient: (config: ClientConfig) => Promise<DeliveryClient>;
+export declare const newDeliveryClient: (config?: ClientConfig) => Promise<DeliveryClient>;

package/dist/delivery/client.js

@@ -25,8 +25,8 @@ const newDeliveryClient = async (config) => {
     const deleter = async (tenantId, type, id) => {
         return await (0, delete_1.deleteCrudData)(tenantId, type, id, serviceClient);
     };
-    const getData = async (tenantId, type, id) => {
-        return await (0, getData_1.getCrudData)(tenantId, type, id, 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) => {
         return await (0, getDataList_1.getCrudDataList)(tenantId, type, limit, page, serviceClient);

package/dist/delivery/getData.d.ts

@@ -1,3 +1,3 @@
 import { DeliveryServiceClient } from "@fraym/crud-proto";
 export declare type GetCrudData = Record<string, any>;
-export declare const getCrudData: (tenantId: string, type: string, id: string, serviceClient: DeliveryServiceClient) => Promise<GetCrudData | null>;
+export declare const getCrudData: (tenantId: string, type: string, id: string, returnEmptyDataIfNotFound: boolean, serviceClient: DeliveryServiceClient) => Promise<GetCrudData | null>;

package/dist/delivery/getData.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCrudData = void 0;
-const getCrudData = async (tenantId, type, id, serviceClient) => {
+const getCrudData = async (tenantId, type, id, returnEmptyDataIfNotFound, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.getEntries({
             tenantId,
@@ -9,6 +9,7 @@ const getCrudData = async (tenantId, type, id, serviceClient) => {
             id,
             limit: 0,
             page: 0,
+            returnEmptyDataIfNotFound,
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/delivery/getDataList.js

@@ -9,6 +9,7 @@ const getCrudDataList = async (tenantId, type, limit, page, serviceClient) => {
             id: "",
             limit,
             page,
+            returnEmptyDataIfNotFound: false,
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,5 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvConfig = void 0;
 __exportStar(require("./delivery/client"), exports);
 __exportStar(require("./management/client"), exports);
+var config_1 = require("./config/config");
+Object.defineProperty(exports, "getEnvConfig", { enumerable: true, get: function () { return config_1.getEnvConfig; } });

package/dist/management/client.d.ts

@@ -6,4 +6,4 @@ export interface ManagementClient {
     getAllTypes: () => Promise<string[]>;
     close: () => Promise<void>;
 }
-export declare const newManagementClient: (config: ClientConfig) => Promise<ManagementClient>;
+export declare const newManagementClient: (config?: ClientConfig) => Promise<ManagementClient>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/crud",
-    "version": "0.3.0",
+    "version": "0.4.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/crud-nodejs",
     "repository": {
@@ -28,10 +28,11 @@
         "crud": "dist/cmd/crud.js"
     },
     "dependencies": {
-        "@fraym/crud-proto": "^1.0.0-alpha.5",
+        "@fraym/crud-proto": "^1.0.0-alpha.6",
         "@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"