npm - @mirafive/protocol - Versions diffs - 0.0.0-stage → 2.0.1 - Mend

@mirafive/protocol 0.0.0-stage → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

package/LICENSE +21 -0
package/README.md +65 -2
package/dist/cli.d.ts +1 -0
package/dist/cli.js +360 -0
package/dist/helpers.d.ts +35 -0
package/dist/index.d.ts +12 -0
package/dist/index.js +507 -0
package/dist/index.js.map +14 -0
package/dist/properties.d.ts +13 -0
package/dist/uuid.d.ts +1 -0
package/dist/validate.d.ts +14 -0
package/dist/wire.d.ts +163 -0
package/fixtures/batches/invalid/amount-not-integer.json +13 -0
package/fixtures/batches/invalid/currency-not-iso.json +13 -0
package/fixtures/batches/invalid/event-id-not-uuid.json +9 -0
package/fixtures/batches/invalid/location-out-of-range.json +15 -0
package/fixtures/batches/invalid/nested-property.json +14 -0
package/fixtures/batches/invalid/no-events.json +3 -0
package/fixtures/batches/invalid/seq-zero.json +10 -0
package/fixtures/batches/invalid/timestamp-without-offset.json +10 -0
package/fixtures/batches/invalid/too-many-events.json +509 -0
package/fixtures/batches/invalid/touchpoint-without-source.json +12 -0
package/fixtures/batches/invalid/unknown-consent.json +12 -0
package/fixtures/batches/invalid/unknown-external-id.json +13 -0
package/fixtures/batches/valid/browser-t0.json +24 -0
package/fixtures/batches/valid/browser-t1.json +41 -0
package/fixtures/batches/valid/server-revenue.json +60 -0
package/fixtures/event-ids.json +9 -0
package/package.json +63 -4
package/schema/batch.schema.json +444 -0

package/fixtures/batches/invalid/too-many-events.json ADDED Viewed

@@ -0,0 +1,509 @@
+{
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b00",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b01",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b02",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b03",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b04",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b05",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b06",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b07",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b08",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b09",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b10",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b11",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b12",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b13",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b14",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b15",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b16",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b17",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b18",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b19",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b20",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b21",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b22",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b23",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b24",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b25",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b26",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b27",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b28",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b29",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b30",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b31",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b32",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b33",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b34",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b35",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b36",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b37",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b38",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b39",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b40",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b41",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b42",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b43",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b44",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b45",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b46",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b47",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b48",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b49",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b50",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b51",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b52",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b53",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b54",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b55",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b56",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b57",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b58",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b59",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b60",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b61",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b62",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b63",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b64",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b65",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b66",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b67",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b68",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b69",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b70",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b71",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b72",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b73",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b74",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b75",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b76",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b77",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b78",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b79",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b80",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b81",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b82",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b83",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b84",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b85",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b86",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b87",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b88",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b89",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b90",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b91",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b92",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b93",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b94",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b95",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b96",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b97",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b98",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b99",
+      "type": "track",
+      "event": "x"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b00",
+      "type": "track",
+      "event": "x"
+    }
+  ]
+}

package/fixtures/batches/invalid/touchpoint-without-source.json ADDED Viewed

@@ -0,0 +1,12 @@
+{
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b01",
+      "type": "track",
+      "event": "$touchpoint",
+      "properties": {
+        "kind": "survey"
+      }
+    }
+  ]
+}

package/fixtures/batches/invalid/unknown-consent.json ADDED Viewed

@@ -0,0 +1,12 @@
+{
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b01",
+      "type": "track",
+      "event": "x",
+      "consent": {
+        "analytics": "yes"
+      }
+    }
+  ]
+}

package/fixtures/batches/invalid/unknown-external-id.json ADDED Viewed

@@ -0,0 +1,13 @@
+{
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b01",
+      "type": "identify",
+      "event": "$identify",
+      "user_id": "u",
+      "external_ids": {
+        "paypal_customer": "p"
+      }
+    }
+  ]
+}

package/fixtures/batches/valid/browser-t0.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "sent_at": "2026-11-08T12:00:00.000Z",
+  "stream": "s1",
+  "seq": 1,
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b01",
+      "type": "page",
+      "event": "$pageview",
+      "timestamp": "2026-11-08T12:00:00.000Z",
+      "context": {
+        "page": {
+          "url": "https://shop.example/?utm_source=news",
+          "referrer": "https://www.google.com/"
+        },
+        "locale": "de"
+      },
+      "consent": {
+        "analytics": "unknown",
+        "marketing": "unknown"
+      }
+    }
+  ]
+}

package/fixtures/batches/valid/browser-t1.json ADDED Viewed

@@ -0,0 +1,41 @@
+{
+  "stream": "s1",
+  "seq": 2,
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b02",
+      "type": "track",
+      "event": "signup_started",
+      "anonymous_id": "0192d4a8-0000-7000-8000-000000000001",
+      "properties": {
+        "plan": "pro",
+        "plan.seats": 3
+      },
+      "context": {
+        "screen": {
+          "width": 1440,
+          "height": 900,
+          "density": 2
+        },
+        "timezone": "Europe/Berlin"
+      },
+      "consent": {
+        "analytics": "granted",
+        "marketing": "denied"
+      }
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b03",
+      "type": "track",
+      "event": "$touchpoint",
+      "properties": {
+        "kind": "survey",
+        "source": "podcast",
+        "answer": "A podcast"
+      },
+      "consent": {
+        "analytics": "granted"
+      }
+    }
+  ]
+}

package/fixtures/batches/valid/server-revenue.json ADDED Viewed

@@ -0,0 +1,60 @@
+{
+  "sent_at": "2026-11-08T12:00:00.000Z",
+  "events": [
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b04",
+      "type": "identify",
+      "event": "$identify",
+      "user_id": "user_42",
+      "traits": {
+        "plan": "pro",
+        "email": "ada@example.com"
+      },
+      "external_ids": {
+        "stripe_customer": "cus_1"
+      },
+      "consent": "not_applicable"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b05",
+      "type": "track",
+      "event": "$revenue",
+      "user_id": "user_42",
+      "revenue": {
+        "amount": 999,
+        "currency": "EUR",
+        "entry_id": "stripe:in_1",
+        "fee": 150,
+        "tax": 160,
+        "product": "premium_monthly",
+        "subscription": {
+          "id": "sub_1",
+          "interval": "month"
+        }
+      },
+      "consent": "not_applicable"
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b06",
+      "type": "track",
+      "event": "$revenue",
+      "user_id": "user_42",
+      "revenue": {
+        "amount": -999,
+        "currency": "EUR",
+        "kind": "refund",
+        "entry_id": "stripe:in_1:refund",
+        "refund_of": "stripe:in_1"
+      }
+    },
+    {
+      "event_id": "0192d4a8-7b1c-7e8a-9c1d-2b3e4f5a6b07",
+      "type": "group",
+      "event": "$group",
+      "group_id": "acme",
+      "traits": {
+        "name": "Acme GmbH"
+      }
+    }
+  ]
+}

package/fixtures/event-ids.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "description": "eventIdFor(key) must give these ids in every MIRA FIVE SDK, in every language: UUIDv8 from the first 122 bits of SHA-256 of the UTF-8 key.",
+  "cases": [
+    { "key": "order:123:paid", "id": "dc7e1871-544e-8ba6-bf35-0db3d8768abf" },
+    { "key": "survey:response_77", "id": "65abb77f-67f1-8ada-9aa0-0ab0e47adedd" },
+    { "key": "", "id": "e3b0c442-98fc-8c14-9afb-f4c8996fb924" },
+    { "key": "ü→🙂", "id": "4e30d08c-1c9b-8cd4-87af-24e700d3708b" }
+  ]
+}