@volter/twin-sentry 0.1.36 → 1.0.0

package/dist/generated/pack-facts.json

@@ -0,0 +1,87 @@
+{
+  "//": "GENERATED by scripts/pack-facts.ts — current pack descriptors and explicit world-runtime server backings; no prior-artifact entries are retained.",
+  "packs": {
+    "sentry": {
+      "adoption": {
+        "sdks": [
+          "@sentry/astro",
+          "@sentry/browser",
+          "@sentry/electron",
+          "@sentry/nextjs",
+          "@sentry/node",
+          "@sentry/nestjs",
+          "@sentry/react",
+          "@sentry/react-native",
+          "@sentry/remix",
+          "@sentry/sveltekit",
+          "@sentry/vue",
+          "@sentry/cli"
+        ],
+        "pypi": [
+          "sentry-sdk"
+        ],
+        "envStems": [
+          "APPSMITHSENTRY",
+          "SENTRY"
+        ]
+      },
+      "hosts": [
+        {
+          "host": "sentry.io"
+        },
+        {
+          "host": "us.sentry.io"
+        },
+        {
+          "host": "de.sentry.io"
+        },
+        {
+          "suffix": ".ingest.sentry.io"
+        },
+        {
+          "suffix": ".ingest.us.sentry.io"
+        },
+        {
+          "suffix": ".ingest.de.sentry.io"
+        }
+      ],
+      "archetype": "crud",
+      "protocol": {
+        "declared": "3",
+        "major": 3,
+        "standing": "current"
+      },
+      "transport": "rest",
+      "resources": [
+        "organization",
+        "project",
+        "project_key",
+        "event",
+        "issue",
+        "release",
+        "monitor",
+        "check_in"
+      ],
+      "endpointEnvNone": "an SDK sends to its DSN's host and sentry-cli to SENTRY_URL (sentry.io by default); the DSN the World issues names the World's ingest host, claimed by the host rules",
+      "credentialDoor": {
+        "path": "/_twin/app-credentials",
+        "body": {},
+        "fill": {
+          "SENTRY_DSN": "dsn",
+          "NEXT_PUBLIC_SENTRY_DSN": "dsn",
+          "NEXT_PUBLIC_SENTRY_DSN_CLIENT": "dsn",
+          "SENTRY_FRONT_DSN": "dsn",
+          "SENTRY_DSN_API": "dsn",
+          "VITE_SENTRY_DSN": "dsn",
+          "EXPO_PUBLIC_SENTRY_DSN": "dsn",
+          "SENTRY_AUTH_TOKEN": "auth_token",
+          "SENTRY_ORG": "org",
+          "SENTRY_ORGANIZATION": "org",
+          "SENTRY_PROJECT": "project"
+        }
+      },
+      "serveExport": "createSentryTwinServer"
+    }
+  },
+  "undeclared": []
+}

package/dist/ingest/spec/SOURCE.md

@@ -0,0 +1,30 @@
+# Sentry ingest
+
+- **Why this document:** Sentry publishes no OpenAPI document for its ingestion endpoint (Relay's). This one is written
+  from Sentry's SDK developer documentation, getsentry/sentry-docs at `3ec4e139711af82b38a3c2c17261f5f5cdb66dfc`
+  (read 2026-09-30): `develop-docs/sdk/foundations/envelopes/index.mdx` (the endpoint, its headers, its authentication
+  and its size limits), `envelopes/envelope-items.mdx` (the item types), `transport/authentication.mdx` (the DSN and
+  `X-Sentry-Auth`), `transport/index.mdx` (the answer) and `transport/rate-limiting.mdx`.
+- **Its one operation:** `POST /api/<project_id>/envelope/`, at the DSN's host (`o<org id>.ingest[.<region>].sentry.io`).
+- **Corrections:** none.
+
+- **Vendored document SHA-256** (openapi.json, decompressed bytes where gzipped): `f5f0151cb49d36d435404491c130ecaafd3b520762cb54478565b267d6e78906`.
+- **Read by:** Codex contributor.
+
+## Offline derivation
+
+`write-spec.ts` reads the retained reference bytes below and writes `openapi.json` without network access.
+
+- `envelopes.mdx.gz`, decompressed SHA-256: `d3dba9159ea9ca150c551629c9d7eae8514e72f98656afd6f6a79fb2d184a130`.
+
+- `envelope-items.mdx.gz`, decompressed SHA-256: `95fbf84df1c6d2481e72cd20a96574a226d919adf687f4bd908a78fa2cedcf8c`.
+
+- `transport.mdx.gz`, decompressed SHA-256: `5e22a8f52cbfbe39ca85f5202022541be5afae0061f6baac04d77e9aebcbeec8`.
+
+- `authentication.mdx.gz`, decompressed SHA-256: `ed0a7df5e3bbfec47df29a07ba6f3109eba99dbd62270b8e0cd08dd316616816`.
+
+- `compression.mdx.gz`, decompressed SHA-256: `2fdae4a2362ff90931403d1efe96623526823d7ce3ae67ca456d3cbfb2d62223`.
+
+- `rate-limiting.mdx.gz`, decompressed SHA-256: `22b10f68810b813cfef32ba3eadbdb17e05d679e4384ddcd5810bfa3d55c8145`.
+
+`compression.mdx.gz` retains `transport/compression.mdx`, including gzip, deflate, br and zstd.

package/dist/ingest/spec/doc-examples.json

@@ -0,0 +1,216 @@
+[
+  {
+    "title": "Envelope with 2 Items",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"event_id\":\"9ec79c33ec9942ab8353589fcb2e04dc\",\"dsn\":\"https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42\"}\n{\"type\":\"attachment\",\"length\":10,\"content_type\":\"text/plain\",\"filename\":\"hello.txt\"}\n\ufeffHello\r\n\n{\"type\":\"event\",\"length\":41,\"content_type\":\"application/json\",\"filename\":\"application.log\"}\n{\"message\":\"hello world\",\"level\":\"error\"}\n",
+    "output": {
+      "id": "9ec79c33ec9942ab8353589fcb2e04dc"
+    },
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Envelope with 2 Items, last newline omitted",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"event_id\":\"9ec79c33ec9942ab8353589fcb2e04dc\",\"dsn\":\"https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42\"}\n{\"type\":\"attachment\",\"length\":10,\"content_type\":\"text/plain\",\"filename\":\"hello.txt\"}\n\ufeffHello\r\n\n{\"type\":\"event\",\"length\":41,\"content_type\":\"application/json\",\"filename\":\"application.log\"}\n{\"message\":\"hello world\",\"level\":\"error\"}",
+    "output": {
+      "id": "9ec79c33ec9942ab8353589fcb2e04dc"
+    },
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Envelope with 2 empty attachments",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"event_id\":\"9ec79c33ec9942ab8353589fcb2e04dc\"}\n{\"type\":\"attachment\",\"length\":0}\n\n{\"type\":\"attachment\",\"length\":0}\n\n",
+    "output": {
+      "id": "9ec79c33ec9942ab8353589fcb2e04dc"
+    },
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Envelope with 2 empty attachments, last newline omitted",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"event_id\":\"9ec79c33ec9942ab8353589fcb2e04dc\"}\n{\"type\":\"attachment\",\"length\":0}\n\n{\"type\":\"attachment\",\"length\":0}\n",
+    "output": {
+      "id": "9ec79c33ec9942ab8353589fcb2e04dc"
+    },
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Item with implicit length, terminated by newline",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"event_id\":\"9ec79c33ec9942ab8353589fcb2e04dc\"}\n{\"type\":\"attachment\"}\nhelloworld\n",
+    "output": {
+      "id": "9ec79c33ec9942ab8353589fcb2e04dc"
+    },
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Item with implicit length, last newline omitted, terminated by EOF",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"event_id\":\"9ec79c33ec9942ab8353589fcb2e04dc\"}\n{\"type\":\"attachment\"}\nhelloworld",
+    "output": {
+      "id": "9ec79c33ec9942ab8353589fcb2e04dc"
+    },
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Envelope without headers, implicit length, last newline omitted, terminated by EOF",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{}\n{\"type\":\"session\"}\n{\"started\": \"2020-02-07T14:16:00Z\",\"attrs\":{\"release\":\"sentry-test@1.0.0\"}}",
+    "output": {},
+    "means": "The full envelope format accepts these exact items and optional trailing newline. DSN fields stand for the receiving project.",
+    "status": 200,
+    "placeholders": {
+      "names": [
+        "https://e12d836b15bb49d7bbf99e64295d995b:@sentry.io/42"
+      ],
+      "quote": "set the \"dsn\" Envelope header to the full DSN string"
+    }
+  },
+  {
+    "title": "Missing authentication",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{}\n",
+    "output": {},
+    "status": 403,
+    "means": "If both are missing, the Envelope is rejected with status code 403 Forbidden."
+  },
+  {
+    "title": "Conflicting authentication",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{\"dsn\":\"https://different@sentry.io/42\"}\n",
+    "output": {},
+    "status": 403,
+    "means": "If multiple forms of authentication are given, the endpoint validates that the information matches and otherwise rejects the request."
+  },
+  {
+    "title": "Truncated payload",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{}\n{\"type\":\"attachment\",\"length\":12}\nshort",
+    "output": {},
+    "status": 400,
+    "means": "If length cannot be consumed, that is, the Envelope is EOF before the number of bytes has been consumed, then the Envelope is malformed."
+  },
+  {
+    "title": "Missing item header type",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{}\n{}\npayload\n",
+    "output": {},
+    "status": 400,
+    "means": "type: String, required. Specifies the type of this Item and its contents."
+  },
+  {
+    "title": "Wrong length boundary",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{}\n{\"type\":\"attachment\",\"length\":1}\nab",
+    "output": {},
+    "status": 400,
+    "means": "Length-prefixed payloads must terminate with newline or EOF. Any other character, including whitespace, means the Envelope is malformed."
+  },
+  {
+    "title": "Unknown items are skipped and retained",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "input": "{}\n{\"type\":\"future-item\",\"length\":9,\"future_header\":true}\nhello\nraw\n",
+    "output": {},
+    "status": 200,
+    "means": "Implementations must gracefully skip and retain Items of unknown type, along with their payload. Unknown attributes must be forwarded to the upstream."
+  },
+  {
+    "title": "Event item size limit",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "status": 413,
+    "output": {},
+    "means": "1 MiB for event errors and transactions envelope items."
+  },
+  {
+    "title": "Session count limit",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "status": 413,
+    "output": {},
+    "means": "100 sessions per envelope"
+  },
+  {
+    "title": "Aggregated bucket limit",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "status": 413,
+    "output": {},
+    "means": "100 pre-aggregated session buckets per each sessions item"
+  },
+  {
+    "title": "Metric item limit",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx",
+    "operation": "sendEnvelope",
+    "status": 413,
+    "output": {},
+    "means": "2 KiB for each metric within an envelope. Relay discards the entire envelope if the one of the metrics exceeds 2 KiB."
+  },
+  {
+    "title": "Envelope event ID takes precedence",
+    "source": "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/envelope-items.mdx",
+    "operation": "sendEnvelope",
+    "status": 200,
+    "input": "{\"event_id\":\"11111111111141118111111111111111\"}\n{\"type\":\"event\"}\n{\"event_id\":\"22222222222242228222222222222222\",\"message\":\"header takes precedence\",\"platform\":\"javascript\"}\n",
+    "output": {
+      "id": "11111111111141118111111111111111"
+    },
+    "means": "If the identifier mismatches between the Envelope and payload, the Envelope header takes precedence."
+  }
+]

package/dist/ingest/spec/openapi.json

@@ -0,0 +1,178 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Sentry ingest (Relay): the envelope endpoint",
+    "version": "sentry-docs 3ec4e139",
+    "description": "Written from Sentry's SDK developer documentation (spec/SOURCE.md): the one endpoint every Sentry SDK sends its data to. Sentry publishes no OpenAPI document for it."
+  },
+  "servers": [
+    {
+      "url": "https://o0.ingest.us.sentry.io",
+      "description": "the DSN's host: o<org id>.ingest[.<region>].sentry.io"
+    }
+  ],
+  "paths": {
+    "/api/{project_id}/envelope/": {
+      "post": {
+        "operationId": "sendEnvelope",
+        "summary": "Ingest an envelope",
+        "description": "The main ingestion endpoint for Envelopes. An envelope is a header line and items, each an item header line and its payload (an event, a transaction, a session, an attachment, a replay, a profile, a check-in, feedback, logs, a client report).",
+        "tags": [
+          "Ingest"
+        ],
+        "parameters": [
+          {
+            "name": "project_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "pattern": "^[0-9]+$"
+            },
+            "description": "The DSN's project id"
+          },
+          {
+            "name": "sentry_key",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The DSN's public key, where the X-Sentry-Auth header cannot be sent"
+          },
+          {
+            "name": "sentry_version",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "sentry_client",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Sentry-Auth",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Sentry sentry_version=7, sentry_client=<name/version>, sentry_key=<public key>"
+          },
+          {
+            "name": "Content-Encoding",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "gzip",
+                "deflate",
+                "br",
+                "zstd"
+              ]
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/x-sentry-envelope": {
+              "schema": {
+                "type": "string",
+                "format": "binary"
+              }
+            },
+            "text/plain": {
+              "schema": {
+                "type": "string",
+                "format": "binary"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The envelope was accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "the envelope's event_id, when it has one"
+                    }
+                  }
+                },
+                "example": {
+                  "id": "fc6d8c0c43fc4630ad850ee518f1b9d0"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "The envelope could not be read",
+            "headers": {
+              "X-Sentry-Error": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "detail": {
+                      "type": "string"
+                    },
+                    "causes": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "No authentication, or a key the project does not have"
+          },
+          "413": {
+            "description": "The envelope or an item exceeds its size limit"
+          },
+          "429": {
+            "description": "Rate limited",
+            "headers": {
+              "Retry-After": {
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "X-Sentry-Rate-Limits": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Ingest"
+    }
+  ]
+}

package/dist/ingest/spec/sources.json

@@ -0,0 +1,25 @@
+{
+  "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/envelopes/index.mdx": {
+    "status": 200,
+    "checked": "2026-10-03",
+    "quotes": {
+      "*200 MiB* for an envelope after decompression including all envelope items.": true,
+      "*1 MiB* for event (errors and transactions), span, log, and metric (statsd, buckets, meta) envelope items.": true,
+      "Implementations **must gracefully skip and retain** Items of unknown type": true
+    }
+  },
+  "https://raw.githubusercontent.com/getsentry/sentry-docs/3ec4e139711af82b38a3c2c17261f5f5cdb66dfc/develop-docs/sdk/foundations/transport/compression.mdx": {
+    "status": 200,
+    "checked": "2026-10-03",
+    "quotes": {
+      "The following content encodings are accepted by Relay and Sentry:": true
+    }
+  },
+  "https://raw.githubusercontent.com/getsentry/sentry/2efdd4760a75a3d395e3534b7f66a7fbb0c3f22e/src/sentry/monitors/serializers.py": {
+    "status": 200,
+    "checked": "2026-10-03",
+    "quotes": {
+      "str(obj.guid)": true
+    }
+  }
+}