@domino-sdk/relay 1.0.0-next.9 → 1.0.0

package/dist/pages-BBYD21IE.d.ts

@@ -0,0 +1,359 @@
+import { z } from 'zod';
+
+declare const authScopeSchema: z.ZodObject<{
+    organization: z.ZodString;
+    project: z.ZodString;
+    environment: z.ZodEnum<{
+        test: "test";
+        live: "live";
+    }>;
+}, z.core.$strict>;
+declare const principalSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"member">;
+    member: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"staff">;
+    subject: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"operator">;
+    subject: z.ZodString;
+}, z.core.$strip>], "kind">;
+declare const sessionSchema: z.ZodObject<{
+    id: z.ZodString;
+    principal: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"member">;
+        member: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"staff">;
+        subject: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"operator">;
+        subject: z.ZodString;
+    }, z.core.$strip>], "kind">;
+    expiresAt: z.ZodNumber;
+    organization: z.ZodString;
+    project: z.ZodString;
+    environment: z.ZodEnum<{
+        test: "test";
+        live: "live";
+    }>;
+}, z.core.$strip>;
+type Session = z.infer<typeof sessionSchema>;
+/**
+ * A session's principal as the participant client reads it: a known kind, or `{ kind }` alone for
+ * a kind a newer Relay added, so reading the session never fails on it.
+ */
+declare const participantPrincipalSchema: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"member">;
+    member: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"staff">;
+    subject: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"operator">;
+    subject: z.ZodString;
+}, z.core.$strip>], "kind">, z.ZodObject<{
+    kind: z.ZodString;
+}, z.core.$strip>]>;
+type ParticipantPrincipal = z.infer<typeof participantPrincipalSchema>;
+/** The session the participant client returns (`auth.session()`). */
+declare const participantSessionSchema: z.ZodObject<{
+    id: z.ZodString;
+    principal: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"member">;
+        member: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"staff">;
+        subject: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"operator">;
+        subject: z.ZodString;
+    }, z.core.$strip>], "kind">, z.ZodObject<{
+        kind: z.ZodString;
+    }, z.core.$strip>]>;
+    expiresAt: z.ZodNumber;
+    organization: z.ZodString;
+    project: z.ZodString;
+    environment: z.ZodEnum<{
+        test: "test";
+        live: "live";
+    }>;
+}, z.core.$strip>;
+type ParticipantSession = z.infer<typeof participantSessionSchema>;
+/** The member a session signs in, or null for a signed-out visitor or another principal kind. */
+declare function sessionMember(session: {
+    principal: ParticipantPrincipal;
+} | null | undefined): string | null;
+/**
+ * The signed-in member (`GET /v1/me`). `avatarSeed` seeds the member's generated avatar
+ * (`defaultAvatar`): an HMAC of the member ID under a per-project secret, so it is stable in the
+ * project, whatever the member links, and reveals nothing. Not strict: newer servers may add fields.
+ */
+declare const memberSummarySchema: z.ZodObject<{
+    member: z.ZodString;
+    avatarSeed: z.ZodString;
+}, z.core.$strip>;
+type MemberSummary = z.infer<typeof memberSummarySchema>;
+declare const exchangeSchema: z.ZodObject<{
+    organization: z.ZodString;
+    project: z.ZodString;
+    environment: z.ZodEnum<{
+        test: "test";
+        live: "live";
+    }>;
+    identity: z.ZodObject<{
+        issuer: z.ZodString;
+        subject: z.ZodString;
+    }, z.core.$strict>;
+    role: z.ZodEnum<{
+        member: "member";
+        staff: "staff";
+        operator: "operator";
+    }>;
+}, z.core.$strict>;
+type ExchangeInput = z.infer<typeof exchangeSchema>;
+declare const exchangeResultSchema: z.ZodObject<{
+    token: z.ZodString;
+    session: z.ZodObject<{
+        id: z.ZodString;
+        principal: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"member">;
+            member: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"staff">;
+            subject: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"operator">;
+            subject: z.ZodString;
+        }, z.core.$strip>], "kind">;
+        expiresAt: z.ZodNumber;
+        organization: z.ZodString;
+        project: z.ZodString;
+        environment: z.ZodEnum<{
+            test: "test";
+            live: "live";
+        }>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+
+declare const knownRelayEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"attempt.accepted">;
+    quest: z.ZodString;
+    attempt: z.ZodString;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"attempt.rejected">;
+    quest: z.ZodString;
+    attempt: z.ZodString;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"attempt.review">;
+    quest: z.ZodString;
+    attempt: z.ZodString;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"points.awarded">;
+    entry: z.ZodString;
+    ledger: z.ZodString;
+    amount: z.ZodNumber;
+    quest: z.ZodNullable<z.ZodString>;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"entitlement.granted">;
+    entitlement: z.ZodString;
+    tier: z.ZodString;
+    status: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"entitlement.collected">;
+    entitlement: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"delivery.updated">;
+    delivery: z.ZodString;
+    quest: z.ZodString;
+    completion: z.ZodString;
+    status: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"referral.qualified">;
+    program: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>], "kind">;
+declare const relayEventSchema: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"attempt.accepted">;
+    quest: z.ZodString;
+    attempt: z.ZodString;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"attempt.rejected">;
+    quest: z.ZodString;
+    attempt: z.ZodString;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"attempt.review">;
+    quest: z.ZodString;
+    attempt: z.ZodString;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"points.awarded">;
+    entry: z.ZodString;
+    ledger: z.ZodString;
+    amount: z.ZodNumber;
+    quest: z.ZodNullable<z.ZodString>;
+    completion: z.ZodNullable<z.ZodString>;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"entitlement.granted">;
+    entitlement: z.ZodString;
+    tier: z.ZodString;
+    status: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"entitlement.collected">;
+    entitlement: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"delivery.updated">;
+    delivery: z.ZodString;
+    quest: z.ZodString;
+    completion: z.ZodString;
+    status: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"referral.qualified">;
+    program: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>], "kind">, z.ZodPipe<z.ZodObject<{
+    kind: z.ZodString;
+    id: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$catchall<z.ZodJSONSchema>>, z.ZodTransform<{
+    kind: "unknown";
+    reportedKind: string;
+    id: string;
+    at: number;
+}, {
+    [x: string]: z.core.util.JSONType;
+    kind: string;
+    id: string;
+    at: number;
+}>>]>;
+declare const participantActivityQuerySchema: z.ZodObject<{
+    cursor: z.ZodOptional<z.ZodString>;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>;
+declare const participantActivitySchema: z.ZodObject<{
+    member: z.ZodString;
+    items: z.ZodArray<z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"attempt.accepted">;
+        quest: z.ZodString;
+        attempt: z.ZodString;
+        completion: z.ZodNullable<z.ZodString>;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"attempt.rejected">;
+        quest: z.ZodString;
+        attempt: z.ZodString;
+        completion: z.ZodNullable<z.ZodString>;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"attempt.review">;
+        quest: z.ZodString;
+        attempt: z.ZodString;
+        completion: z.ZodNullable<z.ZodString>;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"points.awarded">;
+        entry: z.ZodString;
+        ledger: z.ZodString;
+        amount: z.ZodNumber;
+        quest: z.ZodNullable<z.ZodString>;
+        completion: z.ZodNullable<z.ZodString>;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"entitlement.granted">;
+        entitlement: z.ZodString;
+        tier: z.ZodString;
+        status: z.ZodString;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"entitlement.collected">;
+        entitlement: z.ZodString;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"delivery.updated">;
+        delivery: z.ZodString;
+        quest: z.ZodString;
+        completion: z.ZodString;
+        status: z.ZodString;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"referral.qualified">;
+        program: z.ZodString;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>], "kind">, z.ZodPipe<z.ZodObject<{
+        kind: z.ZodString;
+        id: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$catchall<z.ZodJSONSchema>>, z.ZodTransform<{
+        kind: "unknown";
+        reportedKind: string;
+        id: string;
+        at: number;
+    }, {
+        [x: string]: z.core.util.JSONType;
+        kind: string;
+        id: string;
+        at: number;
+    }>>]>>;
+    nextCursor: z.ZodString;
+}, z.core.$strip>;
+type RelayEvent = z.infer<typeof relayEventSchema>;
+type ParticipantActivity = z.infer<typeof participantActivitySchema>;
+
+/** A cursor as a client passes it back. */
+declare const pageCursorSchema: z.ZodString;
+/** A query that pages by cursor only. */
+declare const pageQuerySchema: z.ZodObject<{
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+type PageQuery = z.input<typeof pageQuerySchema>;
+/** One page of a paged read. */
+type Page<T> = {
+    items: T[];
+    nextCursor: string | null;
+};
+
+export { type ExchangeInput as E, type MemberSummary as M, type Page as P, type RelayEvent as R, type Session as S, type PageQuery as a, type ParticipantActivity as b, type ParticipantPrincipal as c, type ParticipantSession as d, authScopeSchema as e, exchangeResultSchema as f, exchangeSchema as g, pageQuerySchema as h, participantActivityQuerySchema as i, participantActivitySchema as j, knownRelayEventSchema as k, participantPrincipalSchema as l, memberSummarySchema as m, participantSessionSchema as n, principalSchema as o, pageCursorSchema as p, sessionSchema as q, relayEventSchema as r, sessionMember as s };