@domino-sdk/relay 1.11.1 → 1.14.0

package/dist/{referral-reward-kinds-M3f0PdiR.d.ts → referral-reward-kinds-DnvQXL8L.d.ts}

@@ -1,6 +1,7 @@
-import { ar as PublishedRelease, ac as OpenIdentityKind, u as TrackerSource, a7 as TrackerDataSchema, aO as TrackerSourceResponse, at as QuestDescription } from './schema-DEM8y8Fm.js';
+import { ar as PublishedRelease, O as OpenIdentityKind, n as TrackerSource, a0 as TrackerDataSchema, aO as TrackerSourceResponse, at as QuestDescription } from './schema-K-Pg5lPz.js';
 import { z } from 'zod';
-import { d as ImageFields, g as ImageRequest } from './images-aw6W7vFZ.js';
+import { d as ImageFields, g as ImageRequest } from './images-D5kpqHxv.js';
+import { R as RequestError, b as RequestErrorKind } from './request-error-D_dUPLwo.js';
 
 /** Older releases did not record ownership. Preserve every value, including defaults. */
 declare function questConfiguration(release: PublishedRelease): {
@@ -140,6 +141,102 @@ declare function isParticipantRoute(path: string, method: string): boolean;
  */
 declare function isIntegrationParticipantPath(path: string): boolean;
 
+/**
+ * How a management call failed, as in every Domino client error (see `RequestError`):
+ * - `http`: the server answered with an error status. `message`, `code` and `details` are its own.
+ * - `network`: no usable answer arrived: the connection failed before a response, or broke while
+ *   the body was read.
+ * - `timeout`: the call's deadline passed (`timeout`, 30 seconds unless the client or call sets
+ *   another), retries included.
+ * - `aborted`: the caller's `signal` cancelled the call.
+ * - `invalid-response`: the server answered 2xx, but the body was not JSON or did not match the
+ *   response this client expects.
+ * - `client`: the call never left: its input, its options or the client's `getToken` failed.
+ */
+type ManagementErrorKind = RequestErrorKind;
+/** The codes the client itself sets; with kind `http`, `code` is the server's own. */
+declare const ManagementErrorCode: {
+    /** The input or an option failed validation before anything was sent (kind `client`). */
+    readonly InvalidInput: "invalid-input";
+    /** The client's `getToken` failed before anything was sent (kind `client` or `network`). */
+    readonly Credential: "credential";
+    readonly Network: "network";
+    readonly Timeout: "timeout";
+    readonly Aborted: "aborted";
+    readonly InvalidResponse: "invalid-response";
+};
+/**
+ * The management API's error body: the message in `error`, a machine-readable `code`, and any
+ * other fields (such as `moved`), which a `ManagementError` keeps as `details`. `code` is open:
+ * the API adds codes over time, and a client keeps one it does not know.
+ */
+declare const managementErrorSchema: z.ZodObject<{
+    error: z.ZodString;
+    code: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type ManagementErrorInit = {
+    kind: ManagementErrorKind;
+    message: string;
+    /** The request's method and path, once a request was formed. */
+    method?: string;
+    path?: string;
+    status?: number;
+    code?: string;
+    details?: Record<string, unknown>;
+    /** The action ID the request body carried; the error reports it as `operationId`. */
+    actionId?: string;
+    /** Whether the route keeps a receipt that makes repeating the action safe. */
+    replaySafe?: boolean;
+    /** Overrides the default: set false when the request was never sent. */
+    uncertain?: boolean;
+    /** The answer's `Retry-After`, in milliseconds. */
+    retryAfter?: number;
+    cause?: unknown;
+};
+declare const managementErrorBrand: unique symbol;
+/** Whether `value` is a `ManagementError` from any copy of the SDK. Prefer it to `instanceof`. */
+declare function isManagementError(value: unknown): value is ManagementError;
+/**
+ * Every failure of a typed management call, including input refused before sending (`client`):
+ * the shared `RequestError` fields, plus the request's `method`, `path` and the server's `details`.
+ *
+ * When `uncertain` is true, a write may have been applied, and `recovery` says what to do:
+ * `replay` repeats the same call with the same `operationId` (the request's `actionId`), which the
+ * server applies at most once; `reconcile` reads the resource before deciding.
+ *
+ * @compat sealed
+ */
+declare class ManagementError extends RequestError {
+    readonly name: string;
+    readonly [managementErrorBrand] = true;
+    /** The rest of the server's error body besides `error` and `code`, such as `moved`; absent when there is none. */
+    readonly details: Readonly<Record<string, unknown>> | undefined;
+    /** The request's method; absent when the call failed before forming a request. */
+    readonly method: string | undefined;
+    /** The management API path, below `/management/v1`, without its query; absent like `method`. */
+    readonly path: string | undefined;
+    constructor(init: ManagementErrorInit);
+}
+/**
+ * Per-call options every typed management method accepts as its last argument.
+ *
+ * @compat input
+ */
+type ManagementCallOptions = {
+    /**
+     * Cancels the call; it then fails with a `ManagementError` of kind `aborted`. Cancelling stops
+     * any retry; a write already sent stays `uncertain`, since the server may have applied it.
+     */
+    signal?: AbortSignal;
+    /**
+     * The call's deadline in milliseconds, covering every attempt, the waits between them and the
+     * answer's body. Replaces the client's `timeout` for this call.
+     */
+    timeout?: number;
+};
+/** The deadline a call gets when neither the client nor the call sets `timeout`. */
+declare const DEFAULT_MANAGEMENT_TIMEOUT = 30000;
+
 /**
  * How Relay reads back a cursor it issued over a numeric position. Clients treat cursors as
  * opaque strings (`pageCursorSchema`); only the server parses them, so the format can change.
@@ -168,4 +265,4 @@ declare const REFERRAL_INTEGRATION_REWARD_ERROR = "Referral programs can grant p
 /** Detect the unsupported reward in loose authoring, published, or reward-list shapes. */
 declare function containsReferralIntegrationReward(value: unknown): boolean;
 
-export { type IdentityKindClaim as I, type ParticipantRoute as P, REFERRAL_INTEGRATION_REWARD_ERROR as R, identityIntegrationSchema as a, identityIntegrationSecretSchema as b, containsReferralIntegrationReward as c, identityKindClaimSchema as d, isIntegrationParticipantPath as e, isParticipantRoute as f, parseImageResult as g, participantExchangeSchema as h, identityIntegrationInputSchema as i, participantRoutePattern as j, participantRoutes as k, sourceDataSchema as l, sourceRoles as m, parseImageExtraction as p, questConfiguration as q, sequenceCursorSchema as s, validateQuestShape as v };
+export { DEFAULT_MANAGEMENT_TIMEOUT as D, type IdentityKindClaim as I, type ManagementCallOptions as M, type ParticipantRoute as P, REFERRAL_INTEGRATION_REWARD_ERROR as R, identityIntegrationSchema as a, identityIntegrationSecretSchema as b, containsReferralIntegrationReward as c, identityKindClaimSchema as d, isIntegrationParticipantPath as e, isParticipantRoute as f, parseImageResult as g, participantExchangeSchema as h, identityIntegrationInputSchema as i, participantRoutePattern as j, participantRoutes as k, sourceDataSchema as l, sourceRoles as m, ManagementError as n, ManagementErrorCode as o, parseImageExtraction as p, questConfiguration as q, type ManagementErrorInit as r, sequenceCursorSchema as s, type ManagementErrorKind as t, isManagementError as u, validateQuestShape as v, managementErrorSchema as w };

package/dist/{schema-DEM8y8Fm.d.ts → schema-K-Pg5lPz.d.ts}

@@ -5726,4 +5726,4 @@ declare const contentPerformancePageSchema: z.ZodObject<{
     nextCursor: z.ZodNullable<z.ZodString>;
 }, z.core.$strict>;
 
-export { type TrackerTriggerMode as $, type Attempt as A, type SourceRoles as B, type LedgerHandle as C, xSearchSourceSchema as D, type Entitlement as E, type XContentMetric as F, type GroupHandle as G, type TrackerTriggerPolicy as H, type IdentityKind as I, type Where as J, type KnownAttemptStatus as K, type LedgerReference as L, type MemberProgress as M, type MemberIdentity as N, type TrackerTriggerContext as O, type PhotoResult as P, type QuestBudgetView as Q, type Reward as R, type SubmissionEvidence as S, type TieredRewardReference as T, type TrackerReader as U, type TextReviewInput as V, type WithRecordData as W, type XTweet as X, type TextResult as Y, type Decision as Z, rewardSchema as _, AttemptStatus as a, batchReleaseSchema as a$, type RoleOf as a0, type WhereSetting as a1, type ContentBody as a2, type ContentMetricName as a3, triggerSchema as a4, type TieredRewardDefinition as a5, type LedgerSetting as a6, type TrackerDataSchema as a7, type TrackerPage as a8, type TrackerReadQuery as a9, type TrackerBound as aA, type TrackerCondition as aB, type TrackerContent as aC, type TrackerContentQuery as aD, type TrackerDataIssue as aE, type TrackerDefinition as aF, type TrackerDefinitionResponse as aG, type TrackerOutcome as aH, type TrackerOutcomeQuery as aI, type TrackerPreview as aJ, type TrackerPreviewInput as aK, type TrackerQuery as aL, type TrackerRecord as aM, type TrackerSourceKind as aN, type TrackerSourceResponse as aO, type TrackerStatus as aP, type TrackerTriggerOutcomePage as aQ, type TrackerTriggerOutcomeQuery as aR, type TrackerWhere as aS, type TriggerEnrollment as aT, type TriggerHistorical as aU, type TriggerSince as aV, type TypedTrackerRecord as aW, accountRoleSchema as aX, appIdentityKindSchema as aY, artifactSchema as aZ, attemptSchema as a_, trackerDataSchema as aa, trackerTriggerContextSchema as ab, type OpenIdentityKind as ac, type AccountRole as ad, type AppIdentityKind as ae, type Bound as af, type CompletionSource as ag, CompletionSourceKind as ah, type Condition as ai, type ContentPerformanceSnapshot as aj, type DataLeaves as ak, type EntitlementCorrection as al, type EntitlementState as am, type KnownCompletionSourceKind as an, type KnownIdentityKind as ao, type MemberPage as ap, type PickupAvailability as aq, type PublishedRelease as ar, type QuestAvailability as as, type QuestDescription as at, type QuestSettingsInput as au, type ReleaseInput as av, type ReviewPage as aw, type Snapshot as ax, type TrackerAccount as ay, type TrackerAttribution as az, type EvaluatorProgress as b, sourceIdentities as b$, beginHandoverSchema as b0, beneficiaryRole as b1, completionRecordSchema as b2, completionSourceSchema as b3, configurePickupSchema as b4, confirmHandoverSchema as b5, contentMetricNameSchema as b6, contentPerformancePageSchema as b7, contentPerformanceQuerySchema as b8, contentPerformanceSnapshotSchema as b9, photoResultSchema as bA, pickupAllocationSchema as bB, pickupAvailabilitySchema as bC, pickupCatalogSchema as bD, pickupPolicySchema as bE, pickupSelectionSchema as bF, pointsRewardSchema as bG, publishedReleaseSchema as bH, publishedTrackerSchema as bI, questAvailabilitySchema as bJ, questBudgetViewSchema as bK, questDescriptionSchema as bL, questPresentationSchema as bM, questProfileSchema as bN, questSettingsInputSchema as bO, quizAnswersSchema as bP, quizEvidenceSchema as bQ, releaseSchema as bR, reservationSchema as bS, reviewItemSchema as bT, reviewListSchema as bU, reviewModeSchema as bV, reviewPageSchema as bW, rewardBundleSchema as bX, rewardKey as bY, snapshotSchema as bZ, sourceContent as b_, createStockItemSchema as ba, customContentSchema as bb, decisionSchema as bc, defaultTriggerMode as bd, deferPolicy as be, entitlementCorrectionSchema as bf, entitlementRecoverySchema as bg, entitlementSchema as bh, entitlementStateSchema as bi, errorSchema as bj, evaluatorProgressSchema as bk, evaluatorProtocol as bl, evaluatorProtocolSchema as bm, eventSchema as bn, evidenceSchema as bo, identityKindSchema as bp, integrationRewardSchema as bq, isAppIdentityKind as br, isKnownTrackerSource as bs, knownIdentityKinds as bt, mediaUrlSchema as bu, memberIdentitySchema as bv, memberListSchema as bw, memberPageSchema as bx, memberProgressSchema as by, openIdentityKindSchema as bz, type KnownTrackerSkipCode as c, xTweetSchema as c$, staffDecisionSchema as c0, stockItemSchema as c1, stockSchema as c2, storedQuestDescriptionSchema as c3, storedReviewModeSchema as c4, submissionEvidenceSchema as c5, submitSchema as c6, templateSchema as c7, textResultSchema as c8, textReviewInputSchema as c9, trackerPreviewLimits as cA, trackerPreviewSchema as cB, trackerQuerySchema as cC, trackerRecordAccountSchema as cD, trackerRecordInputSchema as cE, trackerRecordSchema as cF, trackerSkipCodes as cG, trackerSourceKinds as cH, trackerSourceResponseSchema as cI, trackerSourceSchema as cJ, trackerStatusSchema as cK, trackerSummarySchema as cL, trackerTriggerModeSchema as cM, trackerTriggerOutcomePageSchema as cN, trackerTriggerOutcomeQuerySchema as cO, trackerTriggerPolicySchema as cP, trackerTriggerRecordSchema as cQ, trackerWhereSchema as cR, triggerAdmission as cS, triggerEnrollmentSchema as cT, triggerHistoricalSchema as cU, triggerMode as cV, triggerSinceSchema as cW, whereConditions as cX, whereSettings as cY, xAccountRoles as cZ, xContentMetrics as c_, tierRewardSchema as ca, tieredRewardDefinitionSchema as cb, tieredRewardReferenceSchema as cc, trackerAccountSchema as cd, trackerArtifactSchema as ce, trackerAttributionSchema as cf, trackerBoundSchema as cg, trackerConditionSchema as ch, trackerContentQuerySchema as ci, trackerContentReadSchema as cj, trackerContentSchema as ck, trackerContentStageSchema as cl, trackerControlSchema as cm, trackerDataMaxBranches as cn, trackerDataMaxEntries as co, trackerDataSchemaSchema as cp, trackerDefinitionResponseSchema as cq, trackerEvidenceSchema as cr, trackerIngestResultSchema as cs, trackerIngestSchema as ct, trackerOutcomePageSchema as cu, trackerOutcomeQuerySchema as cv, trackerOutcomeRetrySchema as cw, trackerOutcomeSchema as cx, trackerPageSchema as cy, trackerPreviewInputSchema as cz, type QuestPresentation as d, type QuestProfile as e, type QuizEvidence as f, type SubmitInput as g, type TrackerSkipCode as h, type TrackerDataBudget as i, trackerDataIssue as j, trackerDataIssues as k, trackerDataPathTypes as l, trackerDataRecordSteps as m, type ResourceHandle as n, customSourceSchema as o, type WithContent as p, type WithAccountRoles as q, type QuestHandle as r, schemaCheckedReader as s, trackerDataBatchSteps as t, type TrackerSource as u, trackerDefinitionSchema as v, whereSchemaIssue as w, xContentBodySchema as x, type Tracker as y, type TrackerData as z };
+export { type LedgerSetting as $, type Attempt as A, type TrackerReader as B, type TextReviewInput as C, type TextResult as D, type Entitlement as E, type Decision as F, type GroupHandle as G, rewardSchema as H, type IdentityKind as I, type TrackerTriggerMode as J, type KnownAttemptStatus as K, type LedgerReference as L, type MemberProgress as M, type RoleOf as N, type OpenIdentityKind as O, type PhotoResult as P, type QuestBudgetView as Q, type Reward as R, type SubmissionEvidence as S, type TieredRewardReference as T, type WhereSetting as U, type ContentBody as V, type WithRecordData as W, type XTweet as X, type ContentMetricName as Y, triggerSchema as Z, type TieredRewardDefinition as _, AttemptStatus as a, batchReleaseSchema as a$, type TrackerDataSchema as a0, type TrackerPage as a1, type TrackerReadQuery as a2, trackerDataSchema as a3, trackerTriggerContextSchema as a4, type TrackerDataBudget as a5, schemaCheckedReader as a6, trackerDataBatchSteps as a7, trackerDataIssue as a8, trackerDataIssues as a9, type TrackerBound as aA, type TrackerCondition as aB, type TrackerContent as aC, type TrackerContentQuery as aD, type TrackerDataIssue as aE, type TrackerDefinition as aF, type TrackerDefinitionResponse as aG, type TrackerOutcome as aH, type TrackerOutcomeQuery as aI, type TrackerPreview as aJ, type TrackerPreviewInput as aK, type TrackerQuery as aL, type TrackerRecord as aM, type TrackerSourceKind as aN, type TrackerSourceResponse as aO, type TrackerStatus as aP, type TrackerTriggerOutcomePage as aQ, type TrackerTriggerOutcomeQuery as aR, type TrackerWhere as aS, type TriggerEnrollment as aT, type TriggerHistorical as aU, type TriggerSince as aV, type TypedTrackerRecord as aW, accountRoleSchema as aX, appIdentityKindSchema as aY, artifactSchema as aZ, attemptSchema as a_, trackerDataPathTypes as aa, trackerDataRecordSteps as ab, whereSchemaIssue as ac, type AccountRole as ad, type AppIdentityKind as ae, type Bound as af, type CompletionSource as ag, CompletionSourceKind as ah, type Condition as ai, type ContentPerformanceSnapshot as aj, type DataLeaves as ak, type EntitlementCorrection as al, type EntitlementState as am, type KnownCompletionSourceKind as an, type KnownIdentityKind as ao, type MemberPage as ap, type PickupAvailability as aq, type PublishedRelease as ar, type QuestAvailability as as, type QuestDescription as at, type QuestSettingsInput as au, type ReleaseInput as av, type ReviewPage as aw, type Snapshot as ax, type TrackerAccount as ay, type TrackerAttribution as az, type EvaluatorProgress as b, sourceIdentities as b$, beginHandoverSchema as b0, beneficiaryRole as b1, completionRecordSchema as b2, completionSourceSchema as b3, configurePickupSchema as b4, confirmHandoverSchema as b5, contentMetricNameSchema as b6, contentPerformancePageSchema as b7, contentPerformanceQuerySchema as b8, contentPerformanceSnapshotSchema as b9, photoResultSchema as bA, pickupAllocationSchema as bB, pickupAvailabilitySchema as bC, pickupCatalogSchema as bD, pickupPolicySchema as bE, pickupSelectionSchema as bF, pointsRewardSchema as bG, publishedReleaseSchema as bH, publishedTrackerSchema as bI, questAvailabilitySchema as bJ, questBudgetViewSchema as bK, questDescriptionSchema as bL, questPresentationSchema as bM, questProfileSchema as bN, questSettingsInputSchema as bO, quizAnswersSchema as bP, quizEvidenceSchema as bQ, releaseSchema as bR, reservationSchema as bS, reviewItemSchema as bT, reviewListSchema as bU, reviewModeSchema as bV, reviewPageSchema as bW, rewardBundleSchema as bX, rewardKey as bY, snapshotSchema as bZ, sourceContent as b_, createStockItemSchema as ba, customContentSchema as bb, decisionSchema as bc, defaultTriggerMode as bd, deferPolicy as be, entitlementCorrectionSchema as bf, entitlementRecoverySchema as bg, entitlementSchema as bh, entitlementStateSchema as bi, errorSchema as bj, evaluatorProgressSchema as bk, evaluatorProtocol as bl, evaluatorProtocolSchema as bm, eventSchema as bn, evidenceSchema as bo, identityKindSchema as bp, integrationRewardSchema as bq, isAppIdentityKind as br, isKnownTrackerSource as bs, knownIdentityKinds as bt, mediaUrlSchema as bu, memberIdentitySchema as bv, memberListSchema as bw, memberPageSchema as bx, memberProgressSchema as by, openIdentityKindSchema as bz, type KnownTrackerSkipCode as c, xTweetSchema as c$, staffDecisionSchema as c0, stockItemSchema as c1, stockSchema as c2, storedQuestDescriptionSchema as c3, storedReviewModeSchema as c4, submissionEvidenceSchema as c5, submitSchema as c6, templateSchema as c7, textResultSchema as c8, textReviewInputSchema as c9, trackerPreviewLimits as cA, trackerPreviewSchema as cB, trackerQuerySchema as cC, trackerRecordAccountSchema as cD, trackerRecordInputSchema as cE, trackerRecordSchema as cF, trackerSkipCodes as cG, trackerSourceKinds as cH, trackerSourceResponseSchema as cI, trackerSourceSchema as cJ, trackerStatusSchema as cK, trackerSummarySchema as cL, trackerTriggerModeSchema as cM, trackerTriggerOutcomePageSchema as cN, trackerTriggerOutcomeQuerySchema as cO, trackerTriggerPolicySchema as cP, trackerTriggerRecordSchema as cQ, trackerWhereSchema as cR, triggerAdmission as cS, triggerEnrollmentSchema as cT, triggerHistoricalSchema as cU, triggerMode as cV, triggerSinceSchema as cW, whereConditions as cX, whereSettings as cY, xAccountRoles as cZ, xContentMetrics as c_, tierRewardSchema as ca, tieredRewardDefinitionSchema as cb, tieredRewardReferenceSchema as cc, trackerAccountSchema as cd, trackerArtifactSchema as ce, trackerAttributionSchema as cf, trackerBoundSchema as cg, trackerConditionSchema as ch, trackerContentQuerySchema as ci, trackerContentReadSchema as cj, trackerContentSchema as ck, trackerContentStageSchema as cl, trackerControlSchema as cm, trackerDataMaxBranches as cn, trackerDataMaxEntries as co, trackerDataSchemaSchema as cp, trackerDefinitionResponseSchema as cq, trackerEvidenceSchema as cr, trackerIngestResultSchema as cs, trackerIngestSchema as ct, trackerOutcomePageSchema as cu, trackerOutcomeQuerySchema as cv, trackerOutcomeRetrySchema as cw, trackerOutcomeSchema as cx, trackerPageSchema as cy, trackerPreviewInputSchema as cz, type QuestPresentation as d, type QuestProfile as e, type QuizEvidence as f, type SubmitInput as g, type TrackerSkipCode as h, type ResourceHandle as i, customSourceSchema as j, type WithContent as k, type WithAccountRoles as l, type QuestHandle as m, type TrackerSource as n, type Tracker as o, type TrackerData as p, type SourceRoles as q, type LedgerHandle as r, xSearchSourceSchema as s, trackerDefinitionSchema as t, type XContentMetric as u, type TrackerTriggerPolicy as v, type Where as w, xContentBodySchema as x, type MemberIdentity as y, type TrackerTriggerContext as z };