@fraym/crud 0.1.0

package/README.md

@@ -0,0 +1,161 @@
+# crud-nodejs
+
+Client implementation in javascript for the CRUD service [streams](https://github.com/fraym/crud).
+
+## Installation
+
+```shell
+npm i @fraym/crud
+```
+
+## Usage
+
+### Create the clients
+
+delivery client:
+
+```typescript
+const deliveryClient = await newDeliveryClient({
+    serverAddress: "127.0.0.1:9000",
+    groupId: "your-services-group-identifier",
+});
+```
+
+management client:
+
+```typescript
+const managementClient = await newManagementClient({
+    serverAddress: "127.0.0.1:9000",
+    groupId: "your-services-group-identifier",
+});
+```
+
+### Create one or multipe CRUD types
+
+Crud types are defined by schemas. A schema can contain more than one type definition. See [SCHEMA.md](SCHEMA.md) for a reference.
+
+```typescript
+await managementClient.createTypes("your schema here");
+```
+
+### Update one or multipe CRUD types
+
+Crud types are defined by schemas. A schema can contain more than one type definition. See [SCHEMA.md](SCHEMA.md) for a reference.
+
+```typescript
+await managementClient.updateTypes("your schema here");
+```
+
+### Remove one or multipe CRUD types
+
+The name of `YourCrudType` has to equal your type name in your schema (also in casing).
+
+```typescript
+await managementClient.removeTypes(["YourCrudType"]);
+```
+
+### Get list of existing CRUD types
+
+```typescript
+const list = await managementClient.getAllTypes();
+```
+
+### Create data
+
+The name of `YourCrudType` has to equal your type name in your schema (also in casing).
+
+```typescript
+const { id } = await client.create("tenantId", "YourCrudType", {
+    // values here
+});
+```
+
+### Update data
+
+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 update.
+
+```typescript
+await client.update("tenantId", "YourCrudType", "id", {
+    // values here
+});
+```
+
+### Delete data
+
+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.
+
+```typescript
+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.
+
+```typescript
+const data = await client.getData("tenantId", "YourCrudType", "id");
+```
+
+### Get (paginated) data
+
+The name of `YourCrudType` has to equal your type name in your schema (also in casing).
+
+No pagination:
+
+```typescript
+const data = await client.getDataList("tenantId", "YourCrudType");
+```
+
+With pagination:
+
+```typescript
+const limit = 50; // elements to query per page
+const page = 1; // number of the page you want to select, first page starts at: 1
+const data = await client.getDataList("tenantId", "YourCrudType", limit, page);
+```
+
+### Gracefully close the clients
+
+You won't lose any data if you don't. Use it for your peace of mind.
+
+```typescript
+client.close();
+```
+
+## Development
+
+You'll need the following apps for a smooth development experience:
+
+-   minikube
+-   lens
+-   okteto
+-   helm
+
+### Running the dev environment
+
+-   Start minikube if not already done:
+
+```shell
+minikube start
+```
+
+-   add mongodb and minio to your lokal kubernetes
+    -   use Makefiles in `./.dev/*`
+-   copy `.env.build` to `.env.build.local`
+    -   add your personal access token (needs read access for private fraym org repositories)
+-   deploy the app to your cluster
+
+```
+make init
+```
+
+-   start okteto
+
+```
+make dev
+```
+
+-   connect your IDE to that okteto instance

package/dist/config/config.d.ts

@@ -0,0 +1,6 @@
+export interface ClientConfig {
+    serverAddress: string;
+    keepaliveInterval?: number;
+    keepaliveTimeout?: number;
+}
+export declare const useConfigDefaults: (config: ClientConfig) => Required<ClientConfig>;

package/dist/config/config.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useConfigDefaults = void 0;
+const useConfigDefaults = (config) => {
+    var _a, _b;
+    return {
+        serverAddress: config.serverAddress,
+        keepaliveTimeout: (_a = config.keepaliveTimeout) !== null && _a !== void 0 ? _a : 3 * 1000,
+        keepaliveInterval: (_b = config.keepaliveInterval) !== null && _b !== void 0 ? _b : 40 * 1000,
+    };
+};
+exports.useConfigDefaults = useConfigDefaults;

package/dist/delivery/client.d.ts

@@ -0,0 +1,13 @@
+import { ClientConfig } from "../config/config";
+import { CreatedCrudData } from "./create";
+import { GetCrudData } from "./getData";
+import { 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) => 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>;

package/dist/delivery/client.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newDeliveryClient = void 0;
+const config_1 = require("../config/config");
+const crud_proto_1 = require("@fraym/crud-proto");
+const grpc_js_1 = require("@grpc/grpc-js");
+const create_1 = require("./create");
+const update_1 = require("./update");
+const delete_1 = require("./delete");
+const getData_1 = require("./getData");
+const getDataList_1 = require("./getDataList");
+const newDeliveryClient = async (config) => {
+    config = (0, config_1.useConfigDefaults)(config);
+    const serviceClient = new crud_proto_1.DeliveryServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
+        "grpc.keepalive_time_ms": config.keepaliveInterval,
+        "grpc.keepalive_timeout_ms": config.keepaliveTimeout,
+        "grpc.keepalive_permit_without_calls": 1,
+    });
+    const create = async (tenantId, type, data) => {
+        return await (0, create_1.createCrudData)(tenantId, type, data, serviceClient);
+    };
+    const update = async (tenantId, type, id, data) => {
+        return await (0, update_1.updateCrudData)(tenantId, type, id, data, serviceClient);
+    };
+    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 getDataList = async (tenantId, type, limit = 0, page = 1) => {
+        return await (0, getDataList_1.getCrudDataList)(tenantId, type, limit, page, serviceClient);
+    };
+    const close = async () => {
+        serviceClient.close();
+    };
+    return {
+        create,
+        update,
+        delete: deleter,
+        getData,
+        getDataList,
+        close,
+    };
+};
+exports.newDeliveryClient = newDeliveryClient;

package/dist/delivery/create.d.ts

@@ -0,0 +1,5 @@
+import { DeliveryServiceClient } from "@fraym/crud-proto";
+export interface CreatedCrudData {
+    id: string;
+}
+export declare const createCrudData: (tenantId: string, type: string, data: Record<string, any>, serviceClient: DeliveryServiceClient) => Promise<CreatedCrudData>;

package/dist/delivery/create.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCrudData = void 0;
+const createCrudData = async (tenantId, type, data, serviceClient) => {
+    const requestData = {};
+    for (const key in data) {
+        if (typeof data[key] === "string") {
+            requestData[key] = data[key];
+        }
+        else {
+            requestData[key] = JSON.stringify(data[key]);
+        }
+    }
+    return new Promise((resolve, reject) => {
+        serviceClient.createEntry({
+            tenantId,
+            type,
+            data: requestData,
+        }, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve({
+                id: response.id,
+            });
+        });
+    });
+};
+exports.createCrudData = createCrudData;

package/dist/delivery/delete.d.ts

@@ -0,0 +1,2 @@
+import { DeliveryServiceClient } from "@fraym/crud-proto";
+export declare const deleteCrudData: (tenantId: string, type: string, id: string, serviceClient: DeliveryServiceClient) => Promise<void>;

package/dist/delivery/delete.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteCrudData = void 0;
+const deleteCrudData = async (tenantId, type, id, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.deleteEntry({
+            tenantId,
+            type,
+            id,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.deleteCrudData = deleteCrudData;

package/dist/delivery/getData.d.ts

@@ -0,0 +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>;

package/dist/delivery/getData.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCrudData = void 0;
+const getCrudData = async (tenantId, type, id, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.getEntries({
+            tenantId,
+            type,
+            id,
+            limit: 0,
+            page: 0,
+        }, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            if (response.result.length !== 1) {
+                resolve(null);
+                return;
+            }
+            const data = {};
+            const resultData = response.result[0].data;
+            for (const key in resultData) {
+                data[key] = JSON.parse(resultData[key]);
+            }
+            resolve(data);
+        });
+    });
+};
+exports.getCrudData = getCrudData;

package/dist/delivery/getDataList.d.ts

@@ -0,0 +1,7 @@
+import { DeliveryServiceClient } from "@fraym/crud-proto";
+export interface GetCrudDataList {
+    limit: number;
+    page: number;
+    data: Record<string, any>[];
+}
+export declare const getCrudDataList: (tenantId: string, type: string, limit: number, page: number, serviceClient: DeliveryServiceClient) => Promise<GetCrudDataList | null>;

package/dist/delivery/getDataList.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCrudDataList = void 0;
+const getCrudDataList = async (tenantId, type, limit, page, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.getEntries({
+            tenantId,
+            type,
+            id: "",
+            limit,
+            page,
+        }, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            const data = [];
+            for (const result of response.result) {
+                const dataRecord = {};
+                const resultData = result.data;
+                for (const key in resultData) {
+                    dataRecord[key] = JSON.parse(resultData[key]);
+                }
+                data.push(dataRecord);
+            }
+            resolve({
+                limit: response.limit,
+                page: response.page,
+                data,
+            });
+        });
+    });
+};
+exports.getCrudDataList = getCrudDataList;

package/dist/delivery/update.d.ts

@@ -0,0 +1,2 @@
+import { DeliveryServiceClient } from "@fraym/crud-proto";
+export declare const updateCrudData: (tenantId: string, type: string, id: string, data: Record<string, any>, serviceClient: DeliveryServiceClient) => Promise<void>;

package/dist/delivery/update.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateCrudData = void 0;
+const updateCrudData = async (tenantId, type, id, data, serviceClient) => {
+    const requestData = {};
+    for (const key in data) {
+        if (typeof data[key] === "string") {
+            requestData[key] = data[key];
+        }
+        else {
+            requestData[key] = JSON.stringify(data[key]);
+        }
+    }
+    return new Promise((resolve, reject) => {
+        serviceClient.updateEntry({
+            tenantId,
+            type,
+            id,
+            data: requestData,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.updateCrudData = updateCrudData;

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./delivery/client"), exports);
+__exportStar(require("./management/client"), exports);

package/dist/management/client.d.ts

@@ -0,0 +1,9 @@
+import { ClientConfig } from "../config/config";
+export interface ManagementClient {
+    createTypes: (schema: string) => Promise<void>;
+    updateTypes: (schema: string) => Promise<void>;
+    removeTypes: (typeNames: string[]) => Promise<void>;
+    getAllTypes: () => Promise<string[]>;
+    close: () => Promise<void>;
+}
+export declare const newManagementClient: (config: ClientConfig) => Promise<ManagementClient>;

package/dist/management/client.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newManagementClient = void 0;
+const crud_proto_1 = require("@fraym/crud-proto");
+const grpc_js_1 = require("@grpc/grpc-js");
+const config_1 = require("../config/config");
+const create_1 = require("./create");
+const getAll_1 = require("./getAll");
+const remove_1 = require("./remove");
+const update_1 = require("./update");
+const newManagementClient = async (config) => {
+    config = (0, config_1.useConfigDefaults)(config);
+    const serviceClient = new crud_proto_1.ManagementServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
+        "grpc.keepalive_time_ms": config.keepaliveInterval,
+        "grpc.keepalive_timeout_ms": config.keepaliveTimeout,
+        "grpc.keepalive_permit_without_calls": 1,
+    });
+    const createTypes = async (schema) => {
+        await (0, create_1.createCrudTypes)(schema, serviceClient);
+    };
+    const updateTypes = async (schema) => {
+        await (0, update_1.updateCrudTypes)(schema, serviceClient);
+    };
+    const removeTypes = async (typeNames) => {
+        await (0, remove_1.removeCrudTypes)(typeNames, serviceClient);
+    };
+    const getAllTypes = async () => {
+        return await (0, getAll_1.getAllCrudTypes)(serviceClient);
+    };
+    const close = async () => {
+        serviceClient.close();
+    };
+    return {
+        createTypes,
+        updateTypes,
+        removeTypes,
+        getAllTypes,
+        close,
+    };
+};
+exports.newManagementClient = newManagementClient;

package/dist/management/create.d.ts

@@ -0,0 +1,2 @@
+import { ManagementServiceClient } from "@fraym/crud-proto";
+export declare const createCrudTypes: (schema: string, serviceClient: ManagementServiceClient) => Promise<void>;

package/dist/management/create.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCrudTypes = void 0;
+const createCrudTypes = async (schema, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.createTypes({
+            schema,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.createCrudTypes = createCrudTypes;

package/dist/management/getAll.d.ts

@@ -0,0 +1,2 @@
+import { ManagementServiceClient } from "@fraym/crud-proto";
+export declare const getAllCrudTypes: (serviceClient: ManagementServiceClient) => Promise<string[]>;

package/dist/management/getAll.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllCrudTypes = void 0;
+const getAllCrudTypes = async (serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.getTypes({}, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve(response.typeNames);
+        });
+    });
+};
+exports.getAllCrudTypes = getAllCrudTypes;

package/dist/management/remove.d.ts

@@ -0,0 +1,2 @@
+import { ManagementServiceClient } from "@fraym/crud-proto";
+export declare const removeCrudTypes: (typeNames: string[], serviceClient: ManagementServiceClient) => Promise<void>;

package/dist/management/remove.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeCrudTypes = void 0;
+const removeCrudTypes = async (typeNames, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.removeTypes({
+            typeNames,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.removeCrudTypes = removeCrudTypes;

package/dist/management/update.d.ts

@@ -0,0 +1,2 @@
+import { ManagementServiceClient } from "@fraym/crud-proto";
+export declare const updateCrudTypes: (schema: string, serviceClient: ManagementServiceClient) => Promise<void>;

package/dist/management/update.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateCrudTypes = void 0;
+const updateCrudTypes = async (schema, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.updateTypes({
+            schema,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.updateCrudTypes = updateCrudTypes;

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "@fraym/crud",
+    "version": "0.1.0",
+    "license": "UNLICENSED",
+    "homepage": "https://github.com/fraym/crud-nodejs",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fraym/crud-nodejs.git"
+    },
+    "description": "nodejs client implementation for our crud service",
+    "scripts": {
+        "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",
+        "clean": "rm -rf dist",
+        "prepublishOnly": "npm test && npm run lint && npm run build",
+        "preversion": "npm run lint"
+    },
+    "files": [
+        "dist/**/*"
+    ],
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@fraym/crud-proto": "^1.0.0-alpha.5",
+        "@grpc/grpc-js": "^1.7.2",
+        "uuid": "^9.0.0"
+    },
+    "devDependencies": {
+        "@becklyn/prettier": "^1.0.2",
+        "@types/uuid": "^8.3.4",
+        "prettier": "^2.7.1",
+        "typescript": "^4.8.4"
+    },
+    "prettier": "@becklyn/prettier"
+}