@sylphx/contract 0.2.0

package/dist/schemas/session-replay.d.ts

@@ -0,0 +1,285 @@
+/**
+ * Session Replay — Console-plane playback viewer + admin endpoints. SDK
+ * upload endpoints remain on tRPC / runtime and are not part of this
+ * contract; these endpoints operate on the platform-side session catalogue.
+ *
+ * Mirrors the wire shapes served at `/session-replay/*` in
+ * `apps/api/src/server/platform/routes/session-replay.ts`.
+ */
+import { Schema } from 'effect';
+export declare const SessionMarker: Schema.Struct<{
+    type: typeof Schema.String;
+    timestamp: typeof Schema.Number;
+    payload: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+}>;
+export type SessionMarker = typeof SessionMarker.Type;
+export declare const RageClick: Schema.Struct<{
+    timestamp: typeof Schema.Number;
+    element: typeof Schema.String;
+    selector: Schema.optional<typeof Schema.String>;
+    clickCount: typeof Schema.Number;
+    duration: Schema.optional<typeof Schema.Number>;
+    x: Schema.optional<typeof Schema.Number>;
+    y: Schema.optional<typeof Schema.Number>;
+}>;
+export type RageClick = typeof RageClick.Type;
+export declare const DeadClick: Schema.Struct<{
+    timestamp: typeof Schema.Number;
+    element: typeof Schema.String;
+    selector: Schema.optional<typeof Schema.String>;
+    expectedAction: Schema.optional<typeof Schema.String>;
+    x: Schema.optional<typeof Schema.Number>;
+    y: Schema.optional<typeof Schema.Number>;
+    waitTime: Schema.optional<typeof Schema.Number>;
+}>;
+export type DeadClick = typeof DeadClick.Type;
+export declare const NetworkRequest: Schema.Struct<{
+    timestamp: typeof Schema.Number;
+    method: typeof Schema.String;
+    url: typeof Schema.String;
+    status: typeof Schema.Number;
+    duration: typeof Schema.Number;
+}>;
+export type NetworkRequest = typeof NetworkRequest.Type;
+export declare const ConsoleLog: Schema.Struct<{
+    timestamp: typeof Schema.Number;
+    level: Schema.Literal<["log", "info", "warn", "error"]>;
+    message: typeof Schema.String;
+    stack: Schema.optional<typeof Schema.String>;
+}>;
+export type ConsoleLog = typeof ConsoleLog.Type;
+/** Summary shape used for the list view. */
+export declare const SessionReplaySummary: Schema.Struct<{
+    id: typeof Schema.String;
+    sessionId: typeof Schema.String;
+    userId: Schema.NullOr<typeof Schema.String>;
+    url: Schema.NullOr<typeof Schema.String>;
+    userAgent: Schema.NullOr<typeof Schema.String>;
+    screenWidth: Schema.NullOr<typeof Schema.Number>;
+    screenHeight: Schema.NullOr<typeof Schema.Number>;
+    devicePixelRatio: Schema.NullOr<typeof Schema.Number>;
+    timezone: Schema.NullOr<typeof Schema.String>;
+    language: Schema.NullOr<typeof Schema.String>;
+    duration: Schema.NullOr<typeof Schema.Number>;
+    eventCount: typeof Schema.Number;
+    bytesStored: typeof Schema.Number;
+    hasErrors: typeof Schema.Boolean;
+    errorIds: Schema.Array$<typeof Schema.String>;
+    hasRageClicks: typeof Schema.Boolean;
+    hasDeadClicks: typeof Schema.Boolean;
+    rageClickCount: typeof Schema.Number;
+    deadClickCount: typeof Schema.Number;
+    networkRequestCount: typeof Schema.Number;
+    consoleLogCount: typeof Schema.Number;
+    markers: Schema.Array$<Schema.Struct<{
+        type: typeof Schema.String;
+        timestamp: typeof Schema.Number;
+        payload: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    }>>;
+    isComplete: typeof Schema.Boolean;
+    startedAt: typeof Schema.String;
+    endedAt: Schema.NullOr<typeof Schema.String>;
+    createdAt: typeof Schema.String;
+    updatedAt: typeof Schema.String;
+}>;
+export type SessionReplaySummary = typeof SessionReplaySummary.Type;
+/** Full playback payload — summary + decompressed rrweb events + enrichments. */
+export declare const SessionReplayFull: Schema.Struct<{
+    id: typeof Schema.String;
+    sessionId: typeof Schema.String;
+    userId: Schema.NullOr<typeof Schema.String>;
+    url: Schema.NullOr<typeof Schema.String>;
+    userAgent: Schema.NullOr<typeof Schema.String>;
+    screenWidth: Schema.NullOr<typeof Schema.Number>;
+    screenHeight: Schema.NullOr<typeof Schema.Number>;
+    devicePixelRatio: Schema.NullOr<typeof Schema.Number>;
+    timezone: Schema.NullOr<typeof Schema.String>;
+    language: Schema.NullOr<typeof Schema.String>;
+    duration: Schema.NullOr<typeof Schema.Number>;
+    eventCount: typeof Schema.Number;
+    bytesStored: typeof Schema.Number;
+    hasErrors: typeof Schema.Boolean;
+    errorIds: Schema.Array$<typeof Schema.String>;
+    hasRageClicks: typeof Schema.Boolean;
+    hasDeadClicks: typeof Schema.Boolean;
+    rageClickCount: typeof Schema.Number;
+    deadClickCount: typeof Schema.Number;
+    networkRequestCount: typeof Schema.Number;
+    consoleLogCount: typeof Schema.Number;
+    markers: Schema.Array$<Schema.Struct<{
+        type: typeof Schema.String;
+        timestamp: typeof Schema.Number;
+        payload: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    }>>;
+    isComplete: typeof Schema.Boolean;
+    startedAt: typeof Schema.String;
+    endedAt: Schema.NullOr<typeof Schema.String>;
+    createdAt: typeof Schema.String;
+    updatedAt: typeof Schema.String;
+    events: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    rageClicks: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        element: typeof Schema.String;
+        selector: Schema.optional<typeof Schema.String>;
+        clickCount: typeof Schema.Number;
+        duration: Schema.optional<typeof Schema.Number>;
+        x: Schema.optional<typeof Schema.Number>;
+        y: Schema.optional<typeof Schema.Number>;
+    }>>;
+    deadClicks: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        element: typeof Schema.String;
+        selector: Schema.optional<typeof Schema.String>;
+        expectedAction: Schema.optional<typeof Schema.String>;
+        x: Schema.optional<typeof Schema.Number>;
+        y: Schema.optional<typeof Schema.Number>;
+        waitTime: Schema.optional<typeof Schema.Number>;
+    }>>;
+    networkRequests: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        method: typeof Schema.String;
+        url: typeof Schema.String;
+        status: typeof Schema.Number;
+        duration: typeof Schema.Number;
+    }>>;
+    consoleLogs: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        level: Schema.Literal<["log", "info", "warn", "error"]>;
+        message: typeof Schema.String;
+        stack: Schema.optional<typeof Schema.String>;
+    }>>;
+}>;
+export type SessionReplayFull = typeof SessionReplayFull.Type;
+/**
+ * List filters arrive as strings on the wire (query-string coercion
+ * happens in the handler); kept as optional strings to match transport.
+ */
+export declare const ListSessionsQuery: Schema.Struct<{
+    hasErrors: Schema.optional<typeof Schema.String>;
+    hasRageClicks: Schema.optional<typeof Schema.String>;
+    hasDeadClicks: Schema.optional<typeof Schema.String>;
+    userId: Schema.optional<typeof Schema.String>;
+    startDate: Schema.optional<typeof Schema.String>;
+    endDate: Schema.optional<typeof Schema.String>;
+    limit: Schema.optional<typeof Schema.String>;
+    offset: Schema.optional<typeof Schema.String>;
+}>;
+export type ListSessionsQuery = typeof ListSessionsQuery.Type;
+export declare const ListSessionsResult: Schema.Struct<{
+    sessions: Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        sessionId: typeof Schema.String;
+        userId: Schema.NullOr<typeof Schema.String>;
+        url: Schema.NullOr<typeof Schema.String>;
+        userAgent: Schema.NullOr<typeof Schema.String>;
+        screenWidth: Schema.NullOr<typeof Schema.Number>;
+        screenHeight: Schema.NullOr<typeof Schema.Number>;
+        devicePixelRatio: Schema.NullOr<typeof Schema.Number>;
+        timezone: Schema.NullOr<typeof Schema.String>;
+        language: Schema.NullOr<typeof Schema.String>;
+        duration: Schema.NullOr<typeof Schema.Number>;
+        eventCount: typeof Schema.Number;
+        bytesStored: typeof Schema.Number;
+        hasErrors: typeof Schema.Boolean;
+        errorIds: Schema.Array$<typeof Schema.String>;
+        hasRageClicks: typeof Schema.Boolean;
+        hasDeadClicks: typeof Schema.Boolean;
+        rageClickCount: typeof Schema.Number;
+        deadClickCount: typeof Schema.Number;
+        networkRequestCount: typeof Schema.Number;
+        consoleLogCount: typeof Schema.Number;
+        markers: Schema.Array$<Schema.Struct<{
+            type: typeof Schema.String;
+            timestamp: typeof Schema.Number;
+            payload: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+        }>>;
+        isComplete: typeof Schema.Boolean;
+        startedAt: typeof Schema.String;
+        endedAt: Schema.NullOr<typeof Schema.String>;
+        createdAt: typeof Schema.String;
+        updatedAt: typeof Schema.String;
+    }>>;
+    total: typeof Schema.Number;
+    hasMore: typeof Schema.Boolean;
+}>;
+export type ListSessionsResult = typeof ListSessionsResult.Type;
+export declare const GetSessionResult: Schema.Struct<{
+    id: typeof Schema.String;
+    sessionId: typeof Schema.String;
+    userId: Schema.NullOr<typeof Schema.String>;
+    url: Schema.NullOr<typeof Schema.String>;
+    userAgent: Schema.NullOr<typeof Schema.String>;
+    screenWidth: Schema.NullOr<typeof Schema.Number>;
+    screenHeight: Schema.NullOr<typeof Schema.Number>;
+    devicePixelRatio: Schema.NullOr<typeof Schema.Number>;
+    timezone: Schema.NullOr<typeof Schema.String>;
+    language: Schema.NullOr<typeof Schema.String>;
+    duration: Schema.NullOr<typeof Schema.Number>;
+    eventCount: typeof Schema.Number;
+    bytesStored: typeof Schema.Number;
+    hasErrors: typeof Schema.Boolean;
+    errorIds: Schema.Array$<typeof Schema.String>;
+    hasRageClicks: typeof Schema.Boolean;
+    hasDeadClicks: typeof Schema.Boolean;
+    rageClickCount: typeof Schema.Number;
+    deadClickCount: typeof Schema.Number;
+    networkRequestCount: typeof Schema.Number;
+    consoleLogCount: typeof Schema.Number;
+    markers: Schema.Array$<Schema.Struct<{
+        type: typeof Schema.String;
+        timestamp: typeof Schema.Number;
+        payload: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    }>>;
+    isComplete: typeof Schema.Boolean;
+    startedAt: typeof Schema.String;
+    endedAt: Schema.NullOr<typeof Schema.String>;
+    createdAt: typeof Schema.String;
+    updatedAt: typeof Schema.String;
+    events: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    rageClicks: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        element: typeof Schema.String;
+        selector: Schema.optional<typeof Schema.String>;
+        clickCount: typeof Schema.Number;
+        duration: Schema.optional<typeof Schema.Number>;
+        x: Schema.optional<typeof Schema.Number>;
+        y: Schema.optional<typeof Schema.Number>;
+    }>>;
+    deadClicks: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        element: typeof Schema.String;
+        selector: Schema.optional<typeof Schema.String>;
+        expectedAction: Schema.optional<typeof Schema.String>;
+        x: Schema.optional<typeof Schema.Number>;
+        y: Schema.optional<typeof Schema.Number>;
+        waitTime: Schema.optional<typeof Schema.Number>;
+    }>>;
+    networkRequests: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        method: typeof Schema.String;
+        url: typeof Schema.String;
+        status: typeof Schema.Number;
+        duration: typeof Schema.Number;
+    }>>;
+    consoleLogs: Schema.Array$<Schema.Struct<{
+        timestamp: typeof Schema.Number;
+        level: Schema.Literal<["log", "info", "warn", "error"]>;
+        message: typeof Schema.String;
+        stack: Schema.optional<typeof Schema.String>;
+    }>>;
+}>;
+export type GetSessionResult = typeof GetSessionResult.Type;
+export declare const SessionStatsResult: Schema.Struct<{
+    totalSessions: typeof Schema.Number;
+    sessionsThisMonth: typeof Schema.Number;
+    sessionsThisWeek: typeof Schema.Number;
+    sessionsWithErrors: typeof Schema.Number;
+    sessionsWithRageClicks: typeof Schema.Number;
+    totalStorageBytes: typeof Schema.Number;
+}>;
+export type SessionStatsResult = typeof SessionStatsResult.Type;
+export declare const DeleteSessionResult: Schema.Struct<{
+    success: typeof Schema.Boolean;
+}>;
+export type DeleteSessionResult = typeof DeleteSessionResult.Type;
+//# sourceMappingURL=session-replay.d.ts.map

package/dist/schemas/session-replay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay.d.ts","sourceRoot":"","sources":["../../src/schemas/session-replay.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAI/B,eAAO,MAAM,aAAa;;;;EAIxB,CAAA;AACF,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAErD,eAAO,MAAM,SAAS;;;;;;;;EAQpB,CAAA;AACF,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAE7C,eAAO,MAAM,SAAS;;;;;;;;EAQpB,CAAA;AACF,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAE7C,eAAO,MAAM,cAAc;;;;;;EAMzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD,eAAO,MAAM,UAAU;;;;;EAKrB,CAAA;AACF,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAI/C,4CAA4C;AAC5C,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4B/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAEnE,iFAAiF;AACjF,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiC5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAA;AAI7D;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;EAS5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAA;AAI7D,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAI7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAA;AAE/D,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAoB,CAAA;AACjD,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAA;AAE3D,eAAO,MAAM,kBAAkB;;;;;;;EAO7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAA;AAE/D,eAAO,MAAM,mBAAmB;;EAE9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA"}

package/dist/schemas/session-replay.js

@@ -0,0 +1,145 @@
+/**
+ * Session Replay — Console-plane playback viewer + admin endpoints. SDK
+ * upload endpoints remain on tRPC / runtime and are not part of this
+ * contract; these endpoints operate on the platform-side session catalogue.
+ *
+ * Mirrors the wire shapes served at `/session-replay/*` in
+ * `apps/api/src/server/platform/routes/session-replay.ts`.
+ */
+import { Schema } from 'effect';
+// ── Event sub-shapes ──────────────────────────────────────────────────────
+export const SessionMarker = Schema.Struct({
+    type: Schema.String,
+    timestamp: Schema.Number,
+    payload: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+});
+export const RageClick = Schema.Struct({
+    timestamp: Schema.Number,
+    element: Schema.String,
+    selector: Schema.optional(Schema.String),
+    clickCount: Schema.Number,
+    duration: Schema.optional(Schema.Number),
+    x: Schema.optional(Schema.Number),
+    y: Schema.optional(Schema.Number),
+});
+export const DeadClick = Schema.Struct({
+    timestamp: Schema.Number,
+    element: Schema.String,
+    selector: Schema.optional(Schema.String),
+    expectedAction: Schema.optional(Schema.String),
+    x: Schema.optional(Schema.Number),
+    y: Schema.optional(Schema.Number),
+    waitTime: Schema.optional(Schema.Number),
+});
+export const NetworkRequest = Schema.Struct({
+    timestamp: Schema.Number,
+    method: Schema.String,
+    url: Schema.String,
+    status: Schema.Number,
+    duration: Schema.Number,
+});
+export const ConsoleLog = Schema.Struct({
+    timestamp: Schema.Number,
+    level: Schema.Literal('log', 'info', 'warn', 'error'),
+    message: Schema.String,
+    stack: Schema.optional(Schema.String),
+});
+// ── Session records ──────────────────────────────────────────────────────
+/** Summary shape used for the list view. */
+export const SessionReplaySummary = Schema.Struct({
+    id: Schema.String,
+    sessionId: Schema.String,
+    userId: Schema.NullOr(Schema.String),
+    url: Schema.NullOr(Schema.String),
+    userAgent: Schema.NullOr(Schema.String),
+    screenWidth: Schema.NullOr(Schema.Number),
+    screenHeight: Schema.NullOr(Schema.Number),
+    devicePixelRatio: Schema.NullOr(Schema.Number),
+    timezone: Schema.NullOr(Schema.String),
+    language: Schema.NullOr(Schema.String),
+    duration: Schema.NullOr(Schema.Number),
+    eventCount: Schema.Number,
+    bytesStored: Schema.Number,
+    hasErrors: Schema.Boolean,
+    errorIds: Schema.Array(Schema.String),
+    hasRageClicks: Schema.Boolean,
+    hasDeadClicks: Schema.Boolean,
+    rageClickCount: Schema.Number,
+    deadClickCount: Schema.Number,
+    networkRequestCount: Schema.Number,
+    consoleLogCount: Schema.Number,
+    markers: Schema.Array(SessionMarker),
+    isComplete: Schema.Boolean,
+    startedAt: Schema.String,
+    endedAt: Schema.NullOr(Schema.String),
+    createdAt: Schema.String,
+    updatedAt: Schema.String,
+});
+/** Full playback payload — summary + decompressed rrweb events + enrichments. */
+export const SessionReplayFull = Schema.Struct({
+    id: Schema.String,
+    sessionId: Schema.String,
+    userId: Schema.NullOr(Schema.String),
+    url: Schema.NullOr(Schema.String),
+    userAgent: Schema.NullOr(Schema.String),
+    screenWidth: Schema.NullOr(Schema.Number),
+    screenHeight: Schema.NullOr(Schema.Number),
+    devicePixelRatio: Schema.NullOr(Schema.Number),
+    timezone: Schema.NullOr(Schema.String),
+    language: Schema.NullOr(Schema.String),
+    duration: Schema.NullOr(Schema.Number),
+    eventCount: Schema.Number,
+    bytesStored: Schema.Number,
+    hasErrors: Schema.Boolean,
+    errorIds: Schema.Array(Schema.String),
+    hasRageClicks: Schema.Boolean,
+    hasDeadClicks: Schema.Boolean,
+    rageClickCount: Schema.Number,
+    deadClickCount: Schema.Number,
+    networkRequestCount: Schema.Number,
+    consoleLogCount: Schema.Number,
+    markers: Schema.Array(SessionMarker),
+    isComplete: Schema.Boolean,
+    startedAt: Schema.String,
+    endedAt: Schema.NullOr(Schema.String),
+    createdAt: Schema.String,
+    updatedAt: Schema.String,
+    events: Schema.Array(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+    rageClicks: Schema.Array(RageClick),
+    deadClicks: Schema.Array(DeadClick),
+    networkRequests: Schema.Array(NetworkRequest),
+    consoleLogs: Schema.Array(ConsoleLog),
+});
+// ── Requests ──────────────────────────────────────────────────────────────
+/**
+ * List filters arrive as strings on the wire (query-string coercion
+ * happens in the handler); kept as optional strings to match transport.
+ */
+export const ListSessionsQuery = Schema.Struct({
+    hasErrors: Schema.optional(Schema.String),
+    hasRageClicks: Schema.optional(Schema.String),
+    hasDeadClicks: Schema.optional(Schema.String),
+    userId: Schema.optional(Schema.String),
+    startDate: Schema.optional(Schema.String),
+    endDate: Schema.optional(Schema.String),
+    limit: Schema.optional(Schema.String),
+    offset: Schema.optional(Schema.String),
+});
+// ── Responses ──────────────────────────────────────────────────────────────
+export const ListSessionsResult = Schema.Struct({
+    sessions: Schema.Array(SessionReplaySummary),
+    total: Schema.Number,
+    hasMore: Schema.Boolean,
+});
+export const GetSessionResult = SessionReplayFull;
+export const SessionStatsResult = Schema.Struct({
+    totalSessions: Schema.Number,
+    sessionsThisMonth: Schema.Number,
+    sessionsThisWeek: Schema.Number,
+    sessionsWithErrors: Schema.Number,
+    sessionsWithRageClicks: Schema.Number,
+    totalStorageBytes: Schema.Number,
+});
+export const DeleteSessionResult = Schema.Struct({
+    success: Schema.Boolean,
+});