@fraym/projections 0.10.1 → 0.12.0

package/README.md

@@ -20,7 +20,10 @@ 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 projections service instance you use in the `PROJECTIONS_SERVER_ADDRESS` env variable (default: `127.0.0.1:9000`).
+
+Delivery API: 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`).
+
+Management API: You can specify the address (and port) of the projections service instance you use in the `PROJECTIONS_MANAGEMENT_SERVER_ADDRESS` env variable (default: `http://127.0.0.1`). You will also need to set the `PROJECTIONS_MANAGEMENT_API_TOKEN` variable. The value of that token has to match the token configured in the projections service.
 
 You might have a seperate permissions directory or file. As soon as your permissions schema enum is not part of the projections glob you can specify a `PERMISSIONS_SCHEMA_GLOB` env variable. It is empty by default but as soon as you provide it it will add the files in that glob to your projections schema, too.
 
@@ -34,6 +37,8 @@ Use a `.env` file or env variables to configure cte clients and the command:
 
 ```env
 PROJECTIONS_SERVER_ADDRESS=127.0.0.1:9000
+PROJECTIONS_MANAGEMENT_SERVER_ADDRESS=http://127.0.0.1
+PROJECTIONS_MANAGEMENT_API_TOKEN=
 PROJECTIONS_SCHEMA_GLOB=./src/projections/*.graphql
 PERMISSIONS_SCHEMA_GLOB=
 PROJECTIONS_NAMESPACE=
@@ -85,19 +90,90 @@ await managementClient.remove(["YourProjection"]);
 const list = await managementClient.getAll();
 ```
 
-### Get a single projection element
+### Authorization
 
-The name of `YourProjection` has to equal your projection name in your schema (also in casing).
-The `id` has to match the id of the projection element that you want to get.
+All delivery client functions make use of the `AuthData` object.
+This data is used to check access for the desired action.
+
+You can add the `FRAYM_AUTH_OWNER` scope in case you are performing an action that is no subject to restrictions.
+
+Fields:
+
+-   `tenantId`: Id of the tenant to use
+-   `scopes`: Slice of scopes to use for the action
+-   `data`: Data that is used in directives like `@filterFromJwtData`
+
+### Upsert data in projection
+
+In general you upsert data by publishing events on the event stream.
+There are cases where you want to improve performance and get detailed validation output. In these cases you can use the client to directly upsert data. Do not worry, this is still event based under the hood.
 
 ```typescript
-const data = await deliveryClient.getData("tenantId", "YourProjection", "id");
+const response = await client.upsertData<{ fieldName: string }>(
+    "ProjectionName",
+    authData,
+    "dataId",
+    {
+        fieldName: "value",
+    }
+);
+```
+
+The response contains the following fields:
+
+In case of no validation errors:
+
+-   `data`: The new data after your upsert action
+
+In case of validation errors:
+
+-   `validationErrors`: List of global validation errors that are not related to a single field
+-   `fieldValidationErrors`: Validation errors mapped by the name of the field that they relate to
+
+### Delete data from projection
+
+In general you delete data by publishing events on the event stream.
+There are cases where you want to improve performance and get detailed validation output. In these cases you can use the client to directly delete data. Do not worry, this is still event based under the hood.
+
+Delete by Id:
+
+```go
+const numberOfDeletedEntries = await client.deleteDataById("ProjectionName", authData, "dataId")
+```
+
+Delete by filter:
+
+```go
+const numberOfDeletedEntries = client.deleteDataByFilter("ProjectionName", authData, filter)
+```
+
+### Get a single projection element
+
+A filter could look like this:
+
+```go
+const filter := {
+	fields: {
+        fieldName: {
+            operation: "equals",
+            type: "Int",
+            value: 123,
+        },
+    },
+}
 ```
 
-You can specify a fourth parameter if you want to return a empty dataset instead of getting an error when querying a non existing element:
+The name of `YourProjection` has to equal your projection name in your schema (also in casing).
+The `id` has to match the id of the projection element that you want to get.
 
 ```typescript
-const data = await deliveryClient.getData("tenantId", "YourProjection", "id", true);
+const data = await deliveryClient.getData(
+    "YourProjection",
+    authData,
+    "id",
+    filter,
+    returnEmptyDataIfNotFound
+);
 ```
 
 ### Get (paginated / filtered) data
@@ -107,29 +183,42 @@ The name of `YourProjection` has to equal your type name in your schema (also in
 No pagination:
 
 ```typescript
-const data = await deliveryClient.getDataList("tenantId", "YourProjection");
+const dataList = await deliveryClient.getDataList("YourProjection", authData);
 ```
 
+The dataList response contains the following fields:
+
+-   `limit`: The pagination limit
+-   `page`: The pagination page
+-   `total`: The total amount of elements matching the given filter
+-   `data`: The selected data
+
 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 deliveryClient.getDataList("tenantId", "YourProjection", limit, page);
+const dataList = await deliveryClient.getDataList("YourProjection", authData, limit, page);
 ```
 
 With filter:
 
 ```typescript
-const data = await deliveryClient.getDataList("tenantId", "YourProjection", undefined, undefined, {
-    fields: {
-        fieldName: {
-            operation: "equals",
-            type: "Int",
-            value: 123,
+const dataList = await deliveryClient.getDataList(
+    "YourProjection",
+    authData,
+    undefined,
+    undefined,
+    {
+        fields: {
+            fieldName: {
+                operation: "equals",
+                type: "Int",
+                value: 123,
+            },
         },
-    },
-});
+    }
+);
 ```
 
 All `Filter`s are evaluated by:
@@ -176,9 +265,9 @@ With order:
 All order definitions are prioritized in the order that they are defined (the first definition is prioritized over the second).
 
 ```typescript
-const data = await client.getDataList(
-    "tenantId",
+const dataList = await client.getDataList(
     "YourProjection",
+    authData,
     undefined,
     undefined,
     undefined,
@@ -191,7 +280,7 @@ const data = await client.getDataList(
 );
 ```
 
-### Gracefully close the clients
+### Gracefully close the delivery client
 
 You won't lose any data if you don't. Use it for your peace of mind.
 

package/dist/cmd/projections.js

@@ -18,12 +18,14 @@ const run = async () => {
         schemaGlob: "./src/**/*.graphql",
         permissionsSchemaGlob: "",
         serverAddress: "127.0.0.1:9000",
+        apiToken: "",
         namespace: "",
     })
         .pkgConf("projections").argv;
     let schemaGlob = argv.schemaGlob;
     let permissionsSchemaGlob = argv.permissionsSchemaGlob;
     let serverAddress = argv.serverAddress;
+    let apiToken = argv.apiToken;
     let namespace = argv.namespace;
     if (process.env.PROJECTIONS_SCHEMA_GLOB) {
         schemaGlob = process.env.PROJECTIONS_SCHEMA_GLOB;
@@ -31,8 +33,11 @@ const run = async () => {
     if (process.env.PERMISSIONS_SCHEMA_GLOB) {
         permissionsSchemaGlob = process.env.PERMISSIONS_SCHEMA_GLOB;
     }
-    if (process.env.PROJECTIONS_SERVER_ADDRESS) {
-        serverAddress = process.env.PROJECTIONS_SERVER_ADDRESS;
+    if (process.env.PROJECTIONS_MANAGEMENT_SERVER_ADDRESS) {
+        serverAddress = process.env.PROJECTIONS_MANAGEMENT_SERVER_ADDRESS;
+    }
+    if (process.env.PROJECTIONS_MANAGEMENT_API_TOKEN) {
+        apiToken = process.env.PROJECTIONS_MANAGEMENT_API_TOKEN;
     }
     if (process.env.PROJECTIONS_NAMESPACE) {
         namespace = process.env.PROJECTIONS_NAMESPACE;
@@ -48,7 +53,7 @@ const run = async () => {
         loaders: [new graphql_file_loader_1.GraphQLFileLoader()],
     });
     const definitions = getTypeDefinition(schema, namespace);
-    await migrateSchemas(definitions, serverAddress, namespace);
+    await migrateSchemas(definitions, serverAddress, apiToken, namespace);
 };
 run();
 const getTypeDefinition = (schema, namespace) => {
@@ -243,8 +248,8 @@ const addNestedTypesToSchema = (definitions, nestedTypeName, nestedTypes) => {
         nestedTypes: nestedTypes,
     };
 };
-const migrateSchemas = async (definitions, serverAddress, namespace) => {
-    const managementClient = await (0, client_1.newManagementClient)({ serverAddress });
+const migrateSchemas = async (definitions, serverAddress, apiToken, namespace) => {
+    const managementClient = await (0, client_1.newManagementClient)({ serverAddress, apiToken });
     let existingProjections = (await managementClient.getAll()).filter(projectionName => !projectionName.startsWith("Crud") &&
         !projectionName.startsWith("Fraym") &&
         projectionName.startsWith(namespace));
@@ -297,12 +302,12 @@ const migrateSchemas = async (definitions, serverAddress, namespace) => {
     });
     if (projectionsToCreate.length > 0) {
         console.log(`Creating ${projectionsToCreate.length} projections: ${projectionsToCreate}...`);
-        await managementClient.update(createSchema);
+        await managementClient.upsert(createSchema);
         console.log(`Created ${projectionsToCreate.length} projections`);
     }
     if (projectionsToUpdate.length > 0) {
         console.log(`Updating ${projectionsToUpdate.length} projections: ${projectionsToUpdate}...`);
-        await managementClient.update(updateSchema);
+        await managementClient.upsert(updateSchema);
         console.log(`Updated ${projectionsToUpdate.length} projections`);
     }
     if (projectionsToRemove.length > 0) {

package/dist/config/config.d.ts

@@ -1,7 +1,13 @@
-export interface ClientConfig {
+export interface DeliveryClientConfig {
     serverAddress: string;
     keepaliveInterval?: number;
     keepaliveTimeout?: number;
 }
-export declare const getEnvConfig: () => ClientConfig;
-export declare const useConfigDefaults: (config?: ClientConfig) => Required<ClientConfig>;
+export interface ManagementClientConfig {
+    serverAddress: string;
+    apiToken: string;
+}
+export declare const getEnvDeliveryConfig: () => DeliveryClientConfig;
+export declare const getEnvManagementConfig: () => ManagementClientConfig;
+export declare const useDeliveryConfigDefaults: (config?: DeliveryClientConfig) => Required<DeliveryClientConfig>;
+export declare const useManagementConfigDefaults: (config?: ManagementClientConfig) => Required<ManagementClientConfig>;

package/dist/config/config.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useConfigDefaults = exports.getEnvConfig = void 0;
+exports.useManagementConfigDefaults = exports.useDeliveryConfigDefaults = exports.getEnvManagementConfig = exports.getEnvDeliveryConfig = void 0;
 const dotenv_1 = require("dotenv");
-const getEnvConfig = () => {
+const getEnvDeliveryConfig = () => {
     var _a;
     (0, dotenv_1.config)();
     const serverAddress = (_a = process.env.PROJECTIONS_SERVER_ADDRESS) !== null && _a !== void 0 ? _a : "";
@@ -22,11 +22,20 @@ const getEnvConfig = () => {
         keepaliveTimeout,
     };
 };
-exports.getEnvConfig = getEnvConfig;
-const useConfigDefaults = (config) => {
+exports.getEnvDeliveryConfig = getEnvDeliveryConfig;
+const getEnvManagementConfig = () => {
+    var _a, _b;
+    (0, dotenv_1.config)();
+    return {
+        serverAddress: (_a = process.env.PROJECTIONS_MANAGEMENT_SERVER_ADDRESS) !== null && _a !== void 0 ? _a : "",
+        apiToken: (_b = process.env.PROJECTIONS_MANAGEMENT_API_TOKEN) !== null && _b !== void 0 ? _b : "",
+    };
+};
+exports.getEnvManagementConfig = getEnvManagementConfig;
+const useDeliveryConfigDefaults = (config) => {
     var _a, _b;
     if (!config) {
-        config = (0, exports.getEnvConfig)();
+        config = (0, exports.getEnvDeliveryConfig)();
     }
     return {
         serverAddress: config.serverAddress,
@@ -34,4 +43,14 @@ const useConfigDefaults = (config) => {
         keepaliveInterval: (_b = config.keepaliveInterval) !== null && _b !== void 0 ? _b : 40 * 1000,
     };
 };
-exports.useConfigDefaults = useConfigDefaults;
+exports.useDeliveryConfigDefaults = useDeliveryConfigDefaults;
+const useManagementConfigDefaults = (config) => {
+    if (!config) {
+        config = (0, exports.getEnvManagementConfig)();
+    }
+    return {
+        serverAddress: config.serverAddress,
+        apiToken: config.apiToken,
+    };
+};
+exports.useManagementConfigDefaults = useManagementConfigDefaults;

package/dist/delivery/client.d.ts

@@ -1,4 +1,4 @@
-import { ClientConfig } from "../config/config";
+import { DeliveryClientConfig } from "../config/config";
 import { Filter } from "./filter";
 import { GetProjectionDataList } from "./getDataList";
 import { Order } from "./order";
@@ -12,4 +12,4 @@ export interface DeliveryClient {
     deleteDataByFilter: (projection: string, authData: AuthData, filter?: Filter) => Promise<number>;
     close: () => Promise<void>;
 }
-export declare const newDeliveryClient: (config?: ClientConfig) => Promise<DeliveryClient>;
+export declare const newDeliveryClient: (config?: DeliveryClientConfig) => Promise<DeliveryClient>;

package/dist/delivery/client.js

@@ -9,7 +9,7 @@ const getDataList_1 = require("./getDataList");
 const upsert_1 = require("./upsert");
 const delete_1 = require("./delete");
 const newDeliveryClient = async (config) => {
-    config = (0, config_1.useConfigDefaults)(config);
+    config = (0, config_1.useDeliveryConfigDefaults)(config);
     const serviceClient = new projections_proto_1.DeliveryServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
         "grpc.keepalive_time_ms": config.keepaliveInterval,
         "grpc.keepalive_timeout_ms": config.keepaliveTimeout,

package/dist/delivery/getDataList.d.ts

@@ -5,6 +5,7 @@ import { Order } from "./order";
 export interface GetProjectionDataList<T extends {}> {
     limit: number;
     page: number;
+    total: number;
     data: T[];
 }
 export declare const getProjectionDataList: <T extends {}>(projection: string, auth: AuthData, limit: number, page: number, filter: Filter, order: Order[], serviceClient: DeliveryServiceClient) => Promise<GetProjectionDataList<T> | null>;

package/dist/delivery/getDataList.js

@@ -30,6 +30,7 @@ const getProjectionDataList = async (projection, auth, limit, page, filter, orde
             resolve({
                 limit: response.limit,
                 page: response.page,
+                total: response.total,
                 data,
             });
         });

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,9 +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.isUpsertValidationResponse = exports.isUpsertSuccessResponse = exports.getEnvConfig = void 0;
-var config_1 = require("./config/config");
-Object.defineProperty(exports, "getEnvConfig", { enumerable: true, get: function () { return config_1.getEnvConfig; } });
+exports.isUpsertValidationResponse = exports.isUpsertSuccessResponse = void 0;
+__exportStar(require("./config/config"), exports);
 __exportStar(require("./management/client"), exports);
 __exportStar(require("./delivery/client"), exports);
 var upsert_1 = require("./delivery/upsert");

package/dist/management/client.d.ts

@@ -1,9 +1,7 @@
-import { ClientConfig } from "../config/config";
+import { ManagementClientConfig } from "../config/config";
 export interface ManagementClient {
-    create: (schema: string) => Promise<void>;
-    update: (schema: string) => Promise<void>;
+    upsert: (schema: string) => Promise<void>;
     remove: (projectionNames: string[]) => Promise<void>;
     getAll: () => Promise<string[]>;
-    close: () => Promise<void>;
 }
-export declare const newManagementClient: (config?: ClientConfig) => Promise<ManagementClient>;
+export declare const newManagementClient: (config?: ManagementClientConfig) => Promise<ManagementClient>;

package/dist/management/client.js

@@ -1,41 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.newManagementClient = void 0;
-const projections_proto_1 = require("@fraym/projections-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 upsert_1 = require("./upsert");
 const newManagementClient = async (config) => {
-    config = (0, config_1.useConfigDefaults)(config);
-    const serviceClient = new projections_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 create = async (schema) => {
-        await (0, create_1.createProjections)(schema, serviceClient);
-    };
-    const update = async (schema) => {
-        await (0, update_1.updateProjections)(schema, serviceClient);
+    const currentConfig = (0, config_1.useManagementConfigDefaults)(config);
+    const upsert = async (schema) => {
+        await (0, upsert_1.upsertProjections)(schema, currentConfig);
     };
     const remove = async (projectionNames) => {
-        await (0, remove_1.removeProjections)(projectionNames, serviceClient);
+        await (0, remove_1.removeProjections)(projectionNames, currentConfig);
     };
     const getAll = async () => {
-        return await (0, getAll_1.getAllProjections)(serviceClient);
-    };
-    const close = async () => {
-        serviceClient.close();
+        return await (0, getAll_1.getAllProjections)(currentConfig);
     };
     return {
-        create,
-        update,
+        upsert,
         remove,
         getAll,
-        close,
     };
 };
 exports.newManagementClient = newManagementClient;

package/dist/management/getAll.d.ts

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

package/dist/management/getAll.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAllProjections = void 0;
-const getAllProjections = async (serviceClient) => {
-    return new Promise((resolve, reject) => {
-        serviceClient.getProjections({}, (error, response) => {
-            if (error) {
-                reject(error.message);
-                return;
-            }
-            resolve(response.projectionNames);
-        });
+const getAllProjections = async (config) => {
+    const response = await fetch(`${config.serverAddress}/management/projections`, {
+        method: "GET",
+        headers: {
+            Authorization: `Bearer ${config.apiToken}`,
+        },
     });
+    const data = await response.json();
+    return data.projectionNames;
 };
 exports.getAllProjections = getAllProjections;

package/dist/management/remove.d.ts

@@ -1,2 +1,2 @@
-import { ManagementServiceClient } from "@fraym/projections-proto";
-export declare const removeProjections: (projectionNames: string[], serviceClient: ManagementServiceClient) => Promise<void>;
+import { ManagementClientConfig } from "config/config";
+export declare const removeProjections: (projectionNames: string[], config: ManagementClientConfig) => Promise<void>;

package/dist/management/remove.js

@@ -1,17 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeProjections = void 0;
-const removeProjections = async (projectionNames, serviceClient) => {
-    return new Promise((resolve, reject) => {
-        serviceClient.removeProjections({
+const removeProjections = async (projectionNames, config) => {
+    await fetch(`${config.serverAddress}/management/projections`, {
+        method: "DELETE",
+        headers: {
+            Authorization: `Bearer ${config.apiToken}`,
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
             projectionNames,
-        }, error => {
-            if (error) {
-                reject(error.message);
-                return;
-            }
-            resolve();
-        });
+        }),
     });
 };
 exports.removeProjections = removeProjections;

package/dist/management/upsert.d.ts

@@ -0,0 +1,2 @@
+import { ManagementClientConfig } from "config/config";
+export declare const upsertProjections: (schema: string, config: ManagementClientConfig) => Promise<void>;

package/dist/management/upsert.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertProjections = void 0;
+const upsertProjections = async (schema, config) => {
+    await fetch(`${config.serverAddress}/management/projections`, {
+        method: "POST",
+        headers: {
+            Authorization: `Bearer ${config.apiToken}`,
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+            schema,
+        }),
+    });
+};
+exports.upsertProjections = upsertProjections;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/projections",
-    "version": "0.10.1",
+    "version": "0.12.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.14",
+        "@fraym/projections-proto": "^1.0.0-alpha.15",
         "@graphql-tools/graphql-file-loader": "^7.5.16",
         "@graphql-tools/load": "^7.8.13",
         "@grpc/grpc-js": "^1.8.12",

package/dist/management/create.d.ts

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

package/dist/management/create.js

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

package/dist/management/update.d.ts

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

package/dist/management/update.js

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