@fraym/projections 0.12.1 → 0.14.0

package/README.md

@@ -44,6 +44,29 @@ PERMISSIONS_SCHEMA_GLOB=
 PROJECTIONS_NAMESPACE=
 ```
 
+## Env variable placeholders in migrations
+
+You can use placeholders that match environment variables in argument strings in your schema definitions:
+
+In the following example the `{{env.BACKEND_HOSTNAME}}` part will be replaced by the value of the `BACKEND_HOSTNAME` environment variable.
+Please add your used env variables to the `.env` file that is used to [configure the migration command](#config).
+
+```graphql
+type TestType {
+    value: String
+        @webhook(
+            url: "http://{{env.BACKEND_HOSTNAME}}/event-organizing/contingent/projections/frontend/contingent-management/webhook"
+            method: "GET"
+            header: [{ key: "Content-Type", value: "'application/json'" }]
+            body: [
+                { key: "metadata", value: "metadata" }
+                { key: "payload", value: "payload" }
+                { key: "projection", value: "projection" }
+            ]
+        )
+}
+```
+
 ## Usage
 
 ### Create the clients
@@ -103,6 +126,17 @@ Fields:
 -   `scopes`: Slice of scopes to use for the action
 -   `data`: Data that is used in directives like `@filterFromJwtData`
 
+### Event Metadata
+
+You can specify the correlation and causation IDs for the upsert and delete functions. The `eventMetadata` parameter is optional for all these functions and has the following structure:
+
+```typescript
+const eventMetadata = {
+    correlationId: "some-correlation-id",
+    causationId: "some-causation-id",
+};
+```
+
 ### Upsert data in projection
 
 In general you upsert data by publishing events on the event stream.
@@ -115,7 +149,8 @@ const response = await client.upsertData<{ fieldName: string }>(
     "dataId",
     {
         fieldName: "value",
-    }
+    },
+    eventMetadata
 );
 ```
 
@@ -138,13 +173,13 @@ There are cases where you want to improve performance and get detailed validatio
 Delete by Id:
 
 ```go
-const numberOfDeletedEntries = await client.deleteDataById("ProjectionName", authData, "dataId")
+const numberOfDeletedEntries = await client.deleteDataById("ProjectionName", authData, "dataId", eventMetadata)
 ```
 
 Delete by filter:
 
 ```go
-const numberOfDeletedEntries = client.deleteDataByFilter("ProjectionName", authData, filter)
+const numberOfDeletedEntries = client.deleteDataByFilter("ProjectionName", authData, filter, eventMetadata)
 ```
 
 ### Get a single projection element

package/dist/cmd/projections.js

@@ -302,12 +302,12 @@ const migrateSchemas = async (definitions, serverAddress, apiToken, namespace) =
     });
     if (projectionsToCreate.length > 0) {
         console.log(`Creating ${projectionsToCreate.length} projections: ${projectionsToCreate}...`);
-        await managementClient.upsert(createSchema);
+        await managementClient.upsert(replaceWithEnvData(createSchema));
         console.log(`Created ${projectionsToCreate.length} projections`);
     }
     if (projectionsToUpdate.length > 0) {
         console.log(`Updating ${projectionsToUpdate.length} projections: ${projectionsToUpdate}...`);
-        await managementClient.upsert(updateSchema);
+        await managementClient.upsert(replaceWithEnvData(updateSchema));
         console.log(`Updated ${projectionsToUpdate.length} projections`);
     }
     if (projectionsToRemove.length > 0) {
@@ -316,6 +316,23 @@ const migrateSchemas = async (definitions, serverAddress, apiToken, namespace) =
         console.log(`Removed ${projectionsToRemove.length} projections`);
     }
 };
+const replaceWithEnvData = (str) => {
+    const regex = /{{env\.([a-zA-Z_]+)}}/g;
+    const matches = str.match(regex);
+    const envData = {};
+    matches === null || matches === void 0 ? void 0 : matches.forEach(match => {
+        var _a;
+        const variable = match.replace("{{env.", "").replace("}}", "");
+        if (!envData[variable]) {
+            envData[variable] = (_a = process.env[variable]) !== null && _a !== void 0 ? _a : "";
+        }
+    });
+    let outputStr = str;
+    Object.keys(envData).forEach(key => {
+        outputStr = outputStr.replaceAll(`{{env.${key}}}`, envData[key]);
+    });
+    return outputStr;
+};
 const ensureValidName = (name) => {
     if (name.startsWith("Fraym")) {
         throw new Error(`Cannot use Fraym as projection name prefix as it is reserved for fraym apps, got ${name}`);

package/dist/delivery/client.d.ts

@@ -4,12 +4,13 @@ import { GetProjectionDataList } from "./getDataList";
 import { Order } from "./order";
 import { AuthData } from "./auth";
 import { UpsertResponse } from "./upsert";
+import { EventMetadata } from "./eventMetadata";
 export interface DeliveryClient {
     getData: <T extends {}>(projection: string, authData: AuthData, id: string, filter?: Filter, returnEmptyDataIfNotFound?: boolean) => Promise<T | null>;
     getDataList: <T extends {}>(projection: string, authData: AuthData, limit?: number, page?: number, filter?: Filter, order?: Order[]) => Promise<GetProjectionDataList<T> | null>;
-    upsertData: <T extends {}>(projection: string, authData: AuthData, dataId: string, payload: T) => Promise<UpsertResponse<T>>;
-    deleteDataById: (projection: string, authData: AuthData, dataId: string) => Promise<number>;
-    deleteDataByFilter: (projection: string, authData: AuthData, filter?: Filter) => Promise<number>;
+    upsertData: <T extends {}>(projection: string, authData: AuthData, dataId: string, payload: T, eventMetadata?: EventMetadata) => Promise<UpsertResponse<T>>;
+    deleteDataById: (projection: string, authData: AuthData, dataId: string, eventMetadata?: EventMetadata) => Promise<number>;
+    deleteDataByFilter: (projection: string, authData: AuthData, filter?: Filter, eventMetadata?: EventMetadata) => Promise<number>;
     close: () => Promise<void>;
 }
 export declare const newDeliveryClient: (config?: DeliveryClientConfig) => Promise<DeliveryClient>;

package/dist/delivery/client.js

@@ -21,14 +21,14 @@ const newDeliveryClient = async (config) => {
     const getDataList = async (projection, auth, limit = 0, page = 1, filter = { fields: {}, and: [], or: [] }, order = []) => {
         return await (0, getDataList_1.getProjectionDataList)(projection, auth, limit, page, filter, order, serviceClient);
     };
-    const upsertData = async (projection, authData, dataId, payload) => {
-        return (0, upsert_1.upsertProjectionData)(projection, authData, dataId, payload, serviceClient);
+    const upsertData = async (projection, authData, dataId, payload, eventMetadata = { causationId: "", correlationId: "" }) => {
+        return (0, upsert_1.upsertProjectionData)(projection, authData, dataId, payload, eventMetadata, serviceClient);
     };
-    const deleteDataById = async (projection, authData, dataId) => {
-        return (0, delete_1.deleteProjectionData)(projection, authData, dataId, { fields: {}, and: [], or: [] }, serviceClient);
+    const deleteDataById = async (projection, authData, dataId, eventMetadata = { causationId: "", correlationId: "" }) => {
+        return (0, delete_1.deleteProjectionData)(projection, authData, dataId, { fields: {}, and: [], or: [] }, eventMetadata, serviceClient);
     };
-    const deleteDataByFilter = async (projection, authData, filter = { fields: {}, and: [], or: [] }) => {
-        return (0, delete_1.deleteProjectionData)(projection, authData, "", filter, serviceClient);
+    const deleteDataByFilter = async (projection, authData, filter = { fields: {}, and: [], or: [] }, eventMetadata = { causationId: "", correlationId: "" }) => {
+        return (0, delete_1.deleteProjectionData)(projection, authData, "", filter, eventMetadata, serviceClient);
     };
     const close = async () => {
         serviceClient.close();

package/dist/delivery/delete.d.ts

@@ -1,4 +1,5 @@
 import { DeliveryServiceClient } from "@fraym/projections-proto";
 import { AuthData } from "./auth";
+import { EventMetadata } from "./eventMetadata";
 import { Filter } from "./filter";
-export declare const deleteProjectionData: (projection: string, auth: AuthData, dataId: string, filter: Filter, serviceClient: DeliveryServiceClient) => Promise<number>;
+export declare const deleteProjectionData: (projection: string, auth: AuthData, dataId: string, filter: Filter, eventMetadata: EventMetadata, serviceClient: DeliveryServiceClient) => Promise<number>;

package/dist/delivery/delete.js

@@ -3,13 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteProjectionData = void 0;
 const auth_1 = require("./auth");
 const filter_1 = require("./filter");
-const deleteProjectionData = async (projection, auth, dataId, filter, serviceClient) => {
+const deleteProjectionData = async (projection, auth, dataId, filter, eventMetadata, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.deleteData({
             projection,
             auth: (0, auth_1.getProtobufAuthData)(auth),
             dataId,
             filter: (0, filter_1.getProtobufDataFilter)(filter),
+            eventMetadata,
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/delivery/eventMetadata.d.ts

@@ -0,0 +1,4 @@
+export interface EventMetadata {
+    correlationId: string;
+    causationId: string;
+}

package/dist/delivery/eventMetadata.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/delivery/upsert.d.ts

@@ -1,5 +1,6 @@
 import { DeliveryServiceClient } from "@fraym/projections-proto";
 import { AuthData } from "./auth";
+import { EventMetadata } from "./eventMetadata";
 export type UpsertResponse<T extends {}> = UpsertSuccessResponse<T> | UpsertValidationResponse;
 export interface UpsertSuccessResponse<T extends {}> {
     data: T;
@@ -10,4 +11,4 @@ export interface UpsertValidationResponse {
 }
 export declare const isUpsertSuccessResponse: <T extends {}>(response: UpsertResponse<T>) => response is UpsertSuccessResponse<T>;
 export declare const isUpsertValidationResponse: <T extends {}>(response: UpsertResponse<T>) => response is UpsertValidationResponse;
-export declare const upsertProjectionData: <T extends {}>(projection: string, auth: AuthData, dataId: string, payload: T, serviceClient: DeliveryServiceClient) => Promise<UpsertResponse<T>>;
+export declare const upsertProjectionData: <T extends {}>(projection: string, auth: AuthData, dataId: string, payload: T, eventMetadata: EventMetadata, serviceClient: DeliveryServiceClient) => Promise<UpsertResponse<T>>;

package/dist/delivery/upsert.js

@@ -10,13 +10,14 @@ const isUpsertValidationResponse = (response) => {
     return !response.hasOwnProperty("data");
 };
 exports.isUpsertValidationResponse = isUpsertValidationResponse;
-const upsertProjectionData = async (projection, auth, dataId, payload, serviceClient) => {
+const upsertProjectionData = async (projection, auth, dataId, payload, eventMetadata, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.upsertData({
             projection,
             auth: (0, auth_1.getProtobufAuthData)(auth),
             dataId,
             payload,
+            eventMetadata,
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/package.json

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