@walkeros/server-destination-aws 4.7.0-next-1790722899482 → 4.7.0

package/dist/examples/index.mjs

@@ -17,19 +17,27 @@ __export(env_exports, {
   push: () => push,
   simulation: () => simulation
 });
+function hasRecords(value) {
+  return typeof value === "object" && value !== null && "Records" in value && Array.isArray(value.Records);
+}
 var MockFirehoseClient = class {
   config;
   constructor(config) {
     this.config = config;
   }
-  async send(_command) {
+  async send(command) {
+    const input = "input" in command ? command.input : void 0;
+    const records = hasRecords(input) ? input.Records : [];
     return {
-      RecordId: "mock-record-id",
-      ResponseMetadata: {
-        RequestId: "mock-request-id"
-      }
+      FailedPutCount: 0,
+      Encrypted: false,
+      RequestResponses: records.map((_, index) => ({
+        RecordId: `mock-record-id-${index}`
+      }))
     };
   }
+  destroy() {
+  }
 };
 var MockPutRecordBatchCommand = class {
   input;
@@ -41,7 +49,6 @@ var MockPutRecordBatchCommand = class {
   }
 };
 var push = {
-  // Environment for push operations
   AWS: {
     FirehoseClient: MockFirehoseClient,
     PutRecordBatchCommand: MockPutRecordBatchCommand
@@ -53,110 +60,122 @@ var simulation = ["call:AWS.FirehoseClient.send"];
 var step_exports = {};
 __export(step_exports, {
   firehoseRecord: () => firehoseRecord,
+  init: () => init,
+  mappedRecord: () => mappedRecord,
   orderEvent: () => orderEvent,
   userSignupEvent: () => userSignupEvent
 });
 import { getEvent } from "@walkeros/core";
-var firehoseRecord = {
-  title: "Page view record",
-  description: "A page view is sent to Kinesis Firehose as a single record with the full event JSON-stringified into the Data buffer.",
-  in: getEvent("page view", {
-    id: "ev-1700001000",
-    timestamp: 1700001e3,
-    data: { title: "Home", url: "https://example.com/" },
-    source: { type: "express", platform: "server" }
-  }),
-  mapping: void 0,
+
+// src/lib/payload.ts
+import { isObject } from "@walkeros/core";
+
+// src/firehose/lib/records.ts
+function toRecordData(payload, newline = true) {
+  const json = JSON.stringify(payload);
+  if (typeof json !== "string")
+    throw new TypeError("The payload does not serialize to JSON.");
+  return Buffer.from(newline ? `${json}
+` : json);
+}
+
+// src/firehose/examples/step.ts
+var STREAM = "walkeros-events";
+var init = {
+  title: "Initialization",
+  description: "Init builds one FirehoseClient for the stream region with the credentials from config.credentials and a 2500 ms per-attempt timeout. Nothing is sent until the first event.",
+  in: {
+    settings: { streamName: STREAM, region: "eu-central-1" },
+    credentials: {
+      accessKeyId: "$secret.AWS_ACCESS_KEY_ID",
+      secretAccessKey: "$secret.AWS_SECRET_ACCESS_KEY"
+    }
+  },
   out: [
     [
-      "client.send",
+      "new FirehoseClient",
       {
-        DeliveryStreamName: "walkeros-events",
-        Records: [
-          {
-            Data: Buffer.from(
-              JSON.stringify(
-                getEvent("page view", {
-                  id: "ev-1700001000",
-                  timestamp: 1700001e3,
-                  data: { title: "Home", url: "https://example.com/" },
-                  source: { type: "express", platform: "server" }
-                })
-              )
-            )
-          }
-        ]
+        region: "eu-central-1",
+        credentials: {
+          accessKeyId: "$secret.AWS_ACCESS_KEY_ID",
+          secretAccessKey: "$secret.AWS_SECRET_ACCESS_KEY"
+        },
+        requestHandler: { requestTimeout: 2500, throwOnRequestTimeout: true }
       }
     ]
   ]
 };
-var orderEvent = {
-  title: "Order record",
-  description: "An order complete event is serialized and delivered to Firehose as a batch record for downstream storage.",
-  in: getEvent("order complete", {
-    id: "ev-1700001001",
-    timestamp: 1700001001,
-    data: { id: "ORD-400", total: 99.99, currency: "EUR" },
-    source: { type: "express", platform: "server" }
-  }),
-  mapping: void 0,
-  out: [
+var pageEvent = getEvent("page view", {
+  id: "ev-1700001000",
+  timestamp: 1700001e3,
+  data: { title: "Home", url: "https://example.com/" },
+  source: { type: "express", platform: "server" }
+});
+var orderEvt = getEvent("order complete", {
+  id: "ev-1700001001",
+  timestamp: 1700001001,
+  data: { id: "ORD-400", total: 99.99, currency: "EUR" },
+  source: { type: "express", platform: "server" }
+});
+var signupEvt = getEvent("user signup", {
+  id: "ev-1700001002",
+  timestamp: 1700001002,
+  data: { plan: "pro", source: "landing-page" },
+  user: { id: "usr-789", email: "new@example.com" },
+  source: { type: "express", platform: "server" }
+});
+function sent(payload) {
+  return [
     [
       "client.send",
       {
-        DeliveryStreamName: "walkeros-events",
-        Records: [
-          {
-            Data: Buffer.from(
-              JSON.stringify(
-                getEvent("order complete", {
-                  id: "ev-1700001001",
-                  timestamp: 1700001001,
-                  data: { id: "ORD-400", total: 99.99, currency: "EUR" },
-                  source: { type: "express", platform: "server" }
-                })
-              )
-            )
-          }
-        ]
+        DeliveryStreamName: STREAM,
+        Records: [{ Data: toRecordData(payload) }]
       }
     ]
-  ]
+  ];
+}
+var firehoseRecord = {
+  title: "Page view record",
+  description: "A page view is sent to Firehose as one record: the full event as JSON followed by a newline.",
+  in: pageEvent,
+  mapping: void 0,
+  out: sent(pageEvent)
+};
+var orderEvent = {
+  title: "Order record",
+  description: "An order complete event is serialized and delivered to Firehose as one newline-terminated record.",
+  in: orderEvt,
+  mapping: void 0,
+  out: sent(orderEvt)
 };
 var userSignupEvent = {
   title: "User signup record",
   description: "A user signup event including user fields is streamed to Firehose as a JSON record.",
-  in: getEvent("user signup", {
-    id: "ev-1700001002",
-    timestamp: 1700001002,
-    data: { plan: "pro", source: "landing-page" },
-    user: { id: "usr-789", email: "new@example.com" },
-    source: { type: "express", platform: "server" }
-  }),
+  in: signupEvt,
   mapping: void 0,
-  out: [
-    [
-      "client.send",
-      {
-        DeliveryStreamName: "walkeros-events",
-        Records: [
-          {
-            Data: Buffer.from(
-              JSON.stringify(
-                getEvent("user signup", {
-                  id: "ev-1700001002",
-                  timestamp: 1700001002,
-                  data: { plan: "pro", source: "landing-page" },
-                  user: { id: "usr-789", email: "new@example.com" },
-                  source: { type: "express", platform: "server" }
-                })
-              )
-            )
-          }
-        ]
+  out: sent(signupEvt)
+};
+var mappedRecord = {
+  title: "Mapped record",
+  description: "A mapping that produces an object sends that object as the record instead of the full event. Keep the event id in it for deduplication.",
+  in: orderEvt,
+  mapping: {
+    data: {
+      map: {
+        id: "id",
+        name: "name",
+        order_id: "data.id",
+        total: "data.total"
       }
-    ]
-  ]
+    }
+  },
+  out: sent({
+    id: "ev-1700001001",
+    name: "order complete",
+    order_id: "ORD-400",
+    total: 99.99
+  })
 };
 
 // src/sns/examples/index.ts
@@ -216,6 +235,8 @@ var MockSNSClient = class {
       return { MessageId: "mock-message-id" };
     return {};
   }
+  destroy() {
+  }
 };
 var MockSTSClient = class {
   constructor(config) {
@@ -223,7 +244,12 @@ var MockSTSClient = class {
   }
   config;
   async send() {
-    return { Account: "123456789012" };
+    return {
+      Account: "123456789012",
+      Arn: "arn:aws:iam::123456789012:user/walkeros"
+    };
+  }
+  destroy() {
   }
 };
 var push2 = {
@@ -243,17 +269,45 @@ var simulation2 = ["call:AWS.SNSClient.send"];
 var step_exports2 = {};
 __export(step_exports2, {
   attributedPublish: () => attributedPublish,
+  init: () => init2,
+  mappedMessage: () => mappedMessage,
   orderEvent: () => orderEvent2,
   pageView: () => pageView
 });
 import { getEvent as getEvent2 } from "@walkeros/core";
-var pageEvent = getEvent2("page view", {
+var TOPIC_ARN2 = "arn:aws:sns:eu-central-1:123456789012:walkeros-events";
+var FIFO_ARN = "arn:aws:sns:eu-central-1:123456789012:walkeros-events.fifo";
+var init2 = {
+  title: "Initialization",
+  description: "Init builds one SNSClient in the region of the topic ARN with the credentials from config.credentials and a 2500 ms per-attempt timeout. No topic is created and nothing is sent until the first event.",
+  in: {
+    settings: { topicArn: TOPIC_ARN2 },
+    credentials: {
+      accessKeyId: "$secret.AWS_ACCESS_KEY_ID",
+      secretAccessKey: "$secret.AWS_SECRET_ACCESS_KEY"
+    }
+  },
+  out: [
+    [
+      "new SNSClient",
+      {
+        region: "eu-central-1",
+        credentials: {
+          accessKeyId: "$secret.AWS_ACCESS_KEY_ID",
+          secretAccessKey: "$secret.AWS_SECRET_ACCESS_KEY"
+        },
+        requestHandler: { requestTimeout: 2500, throwOnRequestTimeout: true }
+      }
+    ]
+  ]
+};
+var pageEvent2 = getEvent2("page view", {
   id: "ev-1700001000",
   timestamp: 1700001e3,
   data: { title: "Home", url: "https://example.com/" },
   source: { type: "express", platform: "server" }
 });
-var orderEvt = getEvent2("order complete", {
+var orderEvt2 = getEvent2("order complete", {
   id: "ev-1700001001",
   timestamp: 1700001001,
   data: { id: "ORD-400", total: 99.99, currency: "EUR" },
@@ -269,30 +323,31 @@ var productViewEvt = getEvent2("product view", {
 var pageView = {
   title: "Page view publish",
   description: "A page view event is JSON-stringified and published as the Message of an SNS Publish call.",
-  in: pageEvent,
+  in: pageEvent2,
   mapping: void 0,
   out: [
     [
       "client.send",
       {
-        TopicArn: "arn:aws:sns:eu-central-1:000000000000:walkeros-events",
-        Message: JSON.stringify(pageEvent)
+        TopicArn: TOPIC_ARN2,
+        Message: JSON.stringify(pageEvent2)
       }
     ]
   ]
 };
 var orderEvent2 = {
   title: "Order publish with FIFO group (path-resolved)",
-  description: 'An order complete event is published with a FIFO messageGroupId resolved from the event via the mapping path "user.id". `messageGroupId` is a `Mapping.Value`, so a string path is sufficient; no literal is hard-coded.',
-  in: orderEvt,
+  description: 'An order complete event is published to a FIFO topic with a messageGroupId resolved from the event via the mapping path "user.id". The deduplication id defaults to the event id.',
+  in: orderEvt2,
   mapping: { settings: { messageGroupId: "user.id" } },
   out: [
     [
       "client.send",
       {
-        TopicArn: "arn:aws:sns:eu-central-1:000000000000:walkeros-events.fifo",
-        Message: JSON.stringify(orderEvt),
-        MessageGroupId: "usr-789"
+        TopicArn: FIFO_ARN,
+        Message: JSON.stringify(orderEvt2),
+        MessageGroupId: "usr-789",
+        MessageDeduplicationId: "ev-1700001001"
       }
     ]
   ]
@@ -313,7 +368,7 @@ var attributedPublish = {
     [
       "client.send",
       {
-        TopicArn: "arn:aws:sns:eu-central-1:000000000000:walkeros-events",
+        TopicArn: TOPIC_ARN2,
         Message: JSON.stringify(productViewEvt),
         MessageAttributes: {
           schema_version: { DataType: "String", StringValue: "v4" },
@@ -323,6 +378,30 @@ var attributedPublish = {
     ]
   ]
 };
+var mappedMessage = {
+  title: "Mapped message",
+  description: "A mapping that produces an object publishes that object as the Message instead of the full event. Keep the event id in it for deduplication.",
+  in: orderEvt2,
+  mapping: {
+    data: {
+      map: { id: "id", name: "name", order_id: "data.id", total: "data.total" }
+    }
+  },
+  out: [
+    [
+      "client.send",
+      {
+        TopicArn: TOPIC_ARN2,
+        Message: JSON.stringify({
+          id: "ev-1700001001",
+          name: "order complete",
+          order_id: "ORD-400",
+          total: 99.99
+        })
+      }
+    ]
+  ]
+};
 export {
   env_exports as env,
   examples_exports as firehose,