@oconde/radar 0.1.0 → 0.2.0

package/dist/protocol/index.d.ts

@@ -1,5 +1,9 @@
 declare const PROTOCOL_VERSION = 1;
 declare const INGEST_PATH = "/api/v1/events";
+declare const CHECKIN_PATH = "/api/v1/checkins/";
+declare const RELEASES_PATH = "/api/v1/releases/";
+declare const CHECKIN_SLUG: RegExp;
+declare const CHECKIN_STATUSES: readonly ["in_progress", "ok", "error"];
 declare const LIMITS: {
     readonly batchBytes: 1000000;
     readonly batchEvents: 500;
@@ -16,6 +20,7 @@ declare const LIMITS: {
     readonly depth: 6;
     readonly arrayItems: 50;
     readonly requestIdLength: 128;
+    readonly checkInIdLength: 64;
 };
 type LogLevel = 'debug' | 'info' | 'warn' | 'error';
 type EventBatch = {
@@ -100,12 +105,32 @@ type IngestResponse = {
     accepted: number;
     dropped: number;
 };
-type IngestErrorCode = 'invalid_key' | 'account_disabled' | 'payload_too_large' | 'invalid_batch' | 'quota_exceeded' | 'rate_limited';
+type IngestErrorCode = 'invalid_key' | 'account_disabled' | 'payload_too_large' | 'invalid_batch' | 'quota_exceeded' | 'rate_limited' | 'unknown_monitor' | 'invalid_checkin';
 type IngestError = {
     error: {
         code: IngestErrorCode;
         message: string;
     };
 };
+type CheckInStatus = (typeof CHECKIN_STATUSES)[number];
+type CheckInPayload = {
+    status: CheckInStatus;
+    checkInId?: string;
+    durationMs?: number;
+    environment?: string;
+    release?: string;
+};
+type ReleaseSummary = {
+    release: string;
+    firstSeen: string | null;
+    newIssues: number;
+    events: number;
+    issues: {
+        title: string;
+        culprit: string | null;
+        count: number;
+        url: string;
+    }[];
+};
 
-export { type ErrorEvent, type EventBatch, type ExceptionInfo, INGEST_PATH, type IngestError, type IngestErrorCode, type IngestResponse, LIMITS, type LogEvent, type LogLevel, PROTOCOL_VERSION, type RadarEvent, type RequestInfo, type RuntimeInfo, type StackFrame, type UserInfo };
+export { CHECKIN_PATH, CHECKIN_SLUG, CHECKIN_STATUSES, type CheckInPayload, type CheckInStatus, type ErrorEvent, type EventBatch, type ExceptionInfo, INGEST_PATH, type IngestError, type IngestErrorCode, type IngestResponse, LIMITS, type LogEvent, type LogLevel, PROTOCOL_VERSION, RELEASES_PATH, type RadarEvent, type ReleaseSummary, type RequestInfo, type RuntimeInfo, type StackFrame, type UserInfo };

package/dist/protocol/index.js

@@ -1,6 +1,10 @@
 // src/protocol/index.ts
 var PROTOCOL_VERSION = 1;
 var INGEST_PATH = "/api/v1/events";
+var CHECKIN_PATH = "/api/v1/checkins/";
+var RELEASES_PATH = "/api/v1/releases/";
+var CHECKIN_SLUG = /^[a-z0-9][a-z0-9-]{0,63}$/;
+var CHECKIN_STATUSES = ["in_progress", "ok", "error"];
 var LIMITS = {
   batchBytes: 1e6,
   batchEvents: 500,
@@ -16,11 +20,16 @@ var LIMITS = {
   causeDepth: 5,
   depth: 6,
   arrayItems: 50,
-  requestIdLength: 128
+  requestIdLength: 128,
+  checkInIdLength: 64
 };
 export {
+  CHECKIN_PATH,
+  CHECKIN_SLUG,
+  CHECKIN_STATUSES,
   INGEST_PATH,
   LIMITS,
-  PROTOCOL_VERSION
+  PROTOCOL_VERSION,
+  RELEASES_PATH
 };
 //# sourceMappingURL=index.js.map

package/dist/protocol/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/protocol/index.ts"],"sourcesContent":["export const PROTOCOL_VERSION = 1;\n\nexport const INGEST_PATH = '/api/v1/events';\n\nexport const LIMITS = {\n  batchBytes: 1_000_000,\n  batchEvents: 500,\n  messageLength: 2000,\n  stringLength: 2000,\n  attrsBytes: 16_384,\n  bodyBytes: 16_384,\n  headers: 50,\n  frames: 50,\n  contextFrames: 10,\n  contextLines: 5,\n  contextLineLength: 300,\n  causeDepth: 5,\n  depth: 6,\n  arrayItems: 50,\n  requestIdLength: 128,\n} as const;\n\nexport type LogLevel = 'debug' | 'info' | 'warn' | 'error';\n\nexport type EventBatch = {\n  v: 1;\n  sdk: { name: string; version: string };\n  environment?: string;\n  release?: string;\n  dropped?: number;\n  events: RadarEvent[];\n};\n\nexport type RadarEvent = LogEvent | ErrorEvent;\n\nexport type LogEvent = {\n  type: 'log';\n  ts: number;\n  level: LogLevel;\n  message: string;\n  requestId?: string;\n  attrs?: Record<string, unknown>;\n  request?: RequestInfo;\n  user?: UserInfo;\n};\n\nexport type ErrorEvent = {\n  type: 'error';\n  ts: number;\n  level: 'error' | 'fatal';\n  handled: boolean;\n  requestId?: string;\n  exception: ExceptionInfo;\n  request?: RequestInfo;\n  user?: UserInfo;\n  runtime?: RuntimeInfo;\n  attrs?: Record<string, unknown>;\n};\n\nexport type ExceptionInfo = {\n  type: string;\n  message: string;\n  frames: StackFrame[];\n  cause?: ExceptionInfo;\n};\n\nexport type StackFrame = {\n  fn?: string;\n  file: string;\n  line?: number;\n  col?: number;\n  inApp: boolean;\n  context?: { pre: string[]; line: string; post: string[] };\n};\n\nexport type RequestInfo = {\n  method: string;\n  url: string;\n  route?: string;\n  params?: Record<string, string>;\n  query?: Record<string, unknown>;\n  headers?: Record<string, string>;\n  body?: unknown;\n  ip?: string;\n  userAgent?: string;\n  status?: number;\n  durationMs?: number;\n};\n\nexport type UserInfo = { id?: string; email?: string; name?: string };\n\nexport type RuntimeInfo = {\n  name: 'node';\n  version: string;\n  host?: string;\n  pid?: number;\n  memoryMb?: number;\n  uptimeS?: number;\n};\n\nexport type IngestResponse = { accepted: number; dropped: number };\n\nexport type IngestErrorCode =\n  | 'invalid_key'\n  | 'account_disabled'\n  | 'payload_too_large'\n  | 'invalid_batch'\n  | 'quota_exceeded'\n  | 'rate_limited';\n\nexport type IngestError = { error: { code: IngestErrorCode; message: string } };\n"],"mappings":";AAAO,IAAM,mBAAmB;AAEzB,IAAM,cAAc;AAEpB,IAAM,SAAS;AAAA,EACpB,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,eAAe;AAAA,EACf,cAAc;AAAA,EACd,YAAY;AAAA,EACZ,WAAW;AAAA,EACX,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,eAAe;AAAA,EACf,cAAc;AAAA,EACd,mBAAmB;AAAA,EACnB,YAAY;AAAA,EACZ,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,iBAAiB;AACnB;","names":[]}
+{"version":3,"sources":["../../src/protocol/index.ts"],"sourcesContent":["export const PROTOCOL_VERSION = 1;\n\nexport const INGEST_PATH = '/api/v1/events';\n\nexport const CHECKIN_PATH = '/api/v1/checkins/';\n\nexport const RELEASES_PATH = '/api/v1/releases/';\n\nexport const CHECKIN_SLUG = /^[a-z0-9][a-z0-9-]{0,63}$/;\n\nexport const CHECKIN_STATUSES = ['in_progress', 'ok', 'error'] as const;\n\nexport const LIMITS = {\n  batchBytes: 1_000_000,\n  batchEvents: 500,\n  messageLength: 2000,\n  stringLength: 2000,\n  attrsBytes: 16_384,\n  bodyBytes: 16_384,\n  headers: 50,\n  frames: 50,\n  contextFrames: 10,\n  contextLines: 5,\n  contextLineLength: 300,\n  causeDepth: 5,\n  depth: 6,\n  arrayItems: 50,\n  requestIdLength: 128,\n  checkInIdLength: 64,\n} as const;\n\nexport type LogLevel = 'debug' | 'info' | 'warn' | 'error';\n\nexport type EventBatch = {\n  v: 1;\n  sdk: { name: string; version: string };\n  environment?: string;\n  release?: string;\n  dropped?: number;\n  events: RadarEvent[];\n};\n\nexport type RadarEvent = LogEvent | ErrorEvent;\n\nexport type LogEvent = {\n  type: 'log';\n  ts: number;\n  level: LogLevel;\n  message: string;\n  requestId?: string;\n  attrs?: Record<string, unknown>;\n  request?: RequestInfo;\n  user?: UserInfo;\n};\n\nexport type ErrorEvent = {\n  type: 'error';\n  ts: number;\n  level: 'error' | 'fatal';\n  handled: boolean;\n  requestId?: string;\n  exception: ExceptionInfo;\n  request?: RequestInfo;\n  user?: UserInfo;\n  runtime?: RuntimeInfo;\n  attrs?: Record<string, unknown>;\n};\n\nexport type ExceptionInfo = {\n  type: string;\n  message: string;\n  frames: StackFrame[];\n  cause?: ExceptionInfo;\n};\n\nexport type StackFrame = {\n  fn?: string;\n  file: string;\n  line?: number;\n  col?: number;\n  inApp: boolean;\n  context?: { pre: string[]; line: string; post: string[] };\n};\n\nexport type RequestInfo = {\n  method: string;\n  url: string;\n  route?: string;\n  params?: Record<string, string>;\n  query?: Record<string, unknown>;\n  headers?: Record<string, string>;\n  body?: unknown;\n  ip?: string;\n  userAgent?: string;\n  status?: number;\n  durationMs?: number;\n};\n\nexport type UserInfo = { id?: string; email?: string; name?: string };\n\nexport type RuntimeInfo = {\n  name: 'node';\n  version: string;\n  host?: string;\n  pid?: number;\n  memoryMb?: number;\n  uptimeS?: number;\n};\n\nexport type IngestResponse = { accepted: number; dropped: number };\n\nexport type IngestErrorCode =\n  | 'invalid_key'\n  | 'account_disabled'\n  | 'payload_too_large'\n  | 'invalid_batch'\n  | 'quota_exceeded'\n  | 'rate_limited'\n  | 'unknown_monitor'\n  | 'invalid_checkin';\n\nexport type IngestError = { error: { code: IngestErrorCode; message: string } };\n\nexport type CheckInStatus = (typeof CHECKIN_STATUSES)[number];\n\nexport type CheckInPayload = {\n  status: CheckInStatus;\n  checkInId?: string;\n  durationMs?: number;\n  environment?: string;\n  release?: string;\n};\n\nexport type ReleaseSummary = {\n  release: string;\n  firstSeen: string | null;\n  newIssues: number;\n  events: number;\n  issues: { title: string; culprit: string | null; count: number; url: string }[];\n};\n"],"mappings":";AAAO,IAAM,mBAAmB;AAEzB,IAAM,cAAc;AAEpB,IAAM,eAAe;AAErB,IAAM,gBAAgB;AAEtB,IAAM,eAAe;AAErB,IAAM,mBAAmB,CAAC,eAAe,MAAM,OAAO;AAEtD,IAAM,SAAS;AAAA,EACpB,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,eAAe;AAAA,EACf,cAAc;AAAA,EACd,YAAY;AAAA,EACZ,WAAW;AAAA,EACX,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,eAAe;AAAA,EACf,cAAc;AAAA,EACd,mBAAmB;AAAA,EACnB,YAAY;AAAA,EACZ,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,iBAAiB;AAAA,EACjB,iBAAiB;AACnB;","names":[]}