@opengovsg/confetti 0.5.2 → 0.6.0

package/build/types-C-q5VrLk.d.ts

@@ -1,333 +0,0 @@
-import { ReactNode } from "react";
-import { z } from "zod/v4/mini";
-
-//#region ../validators/dist/questions/routing.d.ts
-declare const binaryOperatorConditionSchema: z.ZodMiniObject<{
-  type: z.ZodMiniLiteral<"binary-operator">;
-  operator: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"equal">, z.ZodMiniLiteral<"not-equal">, z.ZodMiniLiteral<"greater">, z.ZodMiniLiteral<"greater-or-equal">, z.ZodMiniLiteral<"less">, z.ZodMiniLiteral<"less-or-equal">, z.ZodMiniLiteral<"contains">, z.ZodMiniLiteral<"not-contains">]>;
-  value: z.ZodMiniObject<{
-    type: z.ZodMiniLiteral<"value">;
-    value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>;
-  }, z.core.$strip>;
-  target: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
-    type: z.ZodMiniLiteral<"next">;
-  }, z.core.$strip>, z.ZodMiniObject<{
-    type: z.ZodMiniLiteral<"jump">;
-    target: z.ZodMiniNumber<number>;
-  }, z.core.$strip>, z.ZodMiniObject<{
-    type: z.ZodMiniLiteral<"end">;
-  }, z.core.$strip>], "type">;
-}, z.core.$strip>;
-type BinaryOperatorCondition = z.infer<typeof binaryOperatorConditionSchema>;
-//#endregion
-//#region ../validators/dist/questions/properties.d.ts
-declare const ratingQuestionPropertiesSchema: z.ZodMiniObject<{
-  type: z.ZodMiniLiteral<"rating">;
-  buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  shouldAutoProgress: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
-  scale: z.ZodMiniNumber<number>;
-  labels: z.ZodMiniOptional<z.ZodMiniObject<{
-    lower: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string | undefined, string>>>;
-    upper: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string | undefined, string>>>;
-  }, z.core.$strip>>;
-  display: z.ZodMiniOptional<z.ZodMiniLiteral<"number" | "star" | "emoji">>;
-}, z.core.$strip>;
-type RatingQuestionProperties = z.infer<typeof ratingQuestionPropertiesSchema>;
-declare const textQuestionPropertiesSchema: z.ZodMiniObject<{
-  type: z.ZodMiniLiteral<"open-ended">;
-  placeholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  max: z.ZodMiniNumber<number>;
-}, z.core.$strip>;
-type TextQuestionProperties = z.infer<typeof textQuestionPropertiesSchema>;
-declare const singleSelectQuestionPropertiesSchema: z.ZodMiniObject<{
-  type: z.ZodMiniLiteral<"single-select">;
-  shouldAutoProgress: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
-  options: z.ZodMiniArray<z.ZodMiniObject<{
-    value: z.ZodMiniString<string>;
-    description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  }, z.core.$strip>>;
-  buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  editable: z.ZodMiniNullable<z.ZodMiniObject<{
-    label: z.ZodMiniString<string>;
-    max: z.ZodMiniNumber<number>;
-    description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  }, z.core.$strip>>;
-}, z.core.$strip>;
-type SingleSelectQuestionProperties = z.infer<typeof singleSelectQuestionPropertiesSchema>;
-declare const multiSelectQuestionPropertiesSchema: z.ZodMiniObject<{
-  type: z.ZodMiniLiteral<"multi-select">;
-  buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  options: z.ZodMiniArray<z.ZodMiniObject<{
-    value: z.ZodMiniString<string>;
-    description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  }, z.core.$strip>>;
-  editable: z.ZodMiniNullable<z.ZodMiniObject<{
-    label: z.ZodMiniString<string>;
-    max: z.ZodMiniNumber<number>;
-    description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  }, z.core.$strip>>;
-  max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-  display: z.ZodMiniOptional<z.ZodMiniLiteral<"checkbox" | "tag">>;
-}, z.core.$strip>;
-type MultiSelectQuestionProperties = z.infer<typeof multiSelectQuestionPropertiesSchema>;
-declare const statementQuestionPropertiesSchema: z.ZodMiniObject<{
-  type: z.ZodMiniLiteral<"statement">;
-  buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  buttonUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
-}, z.core.$strip>;
-type StatementQuestionProperties = z.infer<typeof statementQuestionPropertiesSchema>;
-//#endregion
-//#region ../validators/dist/questions/answers.d.ts
-declare const bugReportAnswerSchema: z.ZodMiniObject<{
-  title: z.ZodMiniString<string>;
-  description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  screenshotDataUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  recordingEventsJson: z.ZodMiniOptional<z.ZodMiniString<string>>;
-  metadata: z.ZodMiniOptional<z.ZodMiniObject<{
-    userAgent: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    screenResolution: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    viewportSize: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    pageUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    pageTitle: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    referrer: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    datadogTraceId: z.ZodMiniOptional<z.ZodMiniOptional<z.ZodMiniString<string>>>;
-    datadogSessionId: z.ZodMiniOptional<z.ZodMiniOptional<z.ZodMiniString<string>>>;
-    datadogSessionReplayLink: z.ZodMiniOptional<z.ZodMiniOptional<z.ZodMiniString<string>>>;
-  }, z.core.$catchall<z.ZodMiniOptional<z.ZodMiniString<string>>>>>;
-}, z.core.$strip>;
-type BugReportAnswer = z.infer<typeof bugReportAnswerSchema>;
-declare const ratingAnswerSchemaFactory: ({
-  scale
-}: {
-  scale: number;
-}, {
-  required
-}: {
-  required: boolean;
-}) => z.ZodMiniNumber<number> | z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-type RatingAnswer = z.infer<ReturnType<typeof ratingAnswerSchemaFactory>>;
-declare const singleSelectAnswerSchemaFactory: ({
-  maxLength
-}: {
-  maxLength?: number;
-}, {
-  required
-}: {
-  required: boolean;
-}) => z.ZodMiniString<string> | z.ZodMiniOptional<z.ZodMiniString<string>>;
-type SingleSelectAnswer = z.infer<ReturnType<typeof singleSelectAnswerSchemaFactory>>;
-declare const multiSelectAnswerSchemaFactory: ({
-  maxSelected,
-  maxLength
-}: {
-  maxSelected?: number;
-  maxLength?: number;
-}, {
-  required
-}: {
-  required: boolean;
-}) => z.ZodMiniArray<z.ZodMiniString<string>>;
-type MultiSelectAnswer = z.infer<ReturnType<typeof multiSelectAnswerSchemaFactory>>;
-//#endregion
-//#region ../validators/dist/survey.d.ts
-declare const publicGetSurveyOutputSchema: z.ZodMiniObject<{
-  title: z.ZodMiniString<string>;
-  description: z.ZodMiniNullable<z.ZodMiniString<string>>;
-  questions: z.ZodMiniArray<z.ZodMiniObject<{
-    id: z.ZodMiniString<string>;
-    title: z.ZodMiniString<string>;
-    description: z.ZodMiniNullable<z.ZodMiniString<string>>;
-    position: z.ZodMiniNumber<number>;
-    required: z.ZodMiniBoolean<boolean>;
-    properties: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"rating">;
-      buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      shouldAutoProgress: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
-      scale: z.ZodMiniNumber<number>;
-      labels: z.ZodMiniOptional<z.ZodMiniObject<{
-        lower: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string | undefined, string>>>;
-        upper: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string | undefined, string>>>;
-      }, z.core.$strip>>;
-      display: z.ZodMiniOptional<z.ZodMiniLiteral<"number" | "star" | "emoji">>;
-    }, z.core.$strip>, z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"single-select">;
-      shouldAutoProgress: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
-      options: z.ZodMiniArray<z.ZodMiniObject<{
-        value: z.ZodMiniString<string>;
-        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      }, z.core.$strip>>;
-      buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      editable: z.ZodMiniNullable<z.ZodMiniObject<{
-        label: z.ZodMiniString<string>;
-        max: z.ZodMiniNumber<number>;
-        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      }, z.core.$strip>>;
-    }, z.core.$strip>, z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"open-ended">;
-      placeholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      max: z.ZodMiniNumber<number>;
-    }, z.core.$strip>, z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"multi-select">;
-      buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      options: z.ZodMiniArray<z.ZodMiniObject<{
-        value: z.ZodMiniString<string>;
-        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      }, z.core.$strip>>;
-      editable: z.ZodMiniNullable<z.ZodMiniObject<{
-        label: z.ZodMiniString<string>;
-        max: z.ZodMiniNumber<number>;
-        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      }, z.core.$strip>>;
-      max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-      display: z.ZodMiniOptional<z.ZodMiniLiteral<"checkbox" | "tag">>;
-    }, z.core.$strip>, z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"statement">;
-      buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      buttonUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    }, z.core.$strip>, z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"bug-report">;
-      placeholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      buttonLabel: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      enableScreenshot: z.ZodMiniBoolean<boolean>;
-      enableRecording: z.ZodMiniBoolean<boolean>;
-      detailsLabel: z.ZodMiniString<string>;
-      detailsPlaceholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
-      redactClasses: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
-    }, z.core.$strip>], "type">;
-    routingLogic: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"always">;
-      target: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"next">;
-      }, z.core.$strip>, z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"jump">;
-        target: z.ZodMiniNumber<number>;
-      }, z.core.$strip>, z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"end">;
-      }, z.core.$strip>], "type">;
-    }, z.core.$strip>, z.ZodMiniObject<{
-      type: z.ZodMiniLiteral<"switch">;
-      cases: z.ZodMiniArray<z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"binary-operator">;
-        operator: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"equal">, z.ZodMiniLiteral<"not-equal">, z.ZodMiniLiteral<"greater">, z.ZodMiniLiteral<"greater-or-equal">, z.ZodMiniLiteral<"less">, z.ZodMiniLiteral<"less-or-equal">, z.ZodMiniLiteral<"contains">, z.ZodMiniLiteral<"not-contains">]>;
-        value: z.ZodMiniObject<{
-          type: z.ZodMiniLiteral<"value">;
-          value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>;
-        }, z.core.$strip>;
-        target: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
-          type: z.ZodMiniLiteral<"next">;
-        }, z.core.$strip>, z.ZodMiniObject<{
-          type: z.ZodMiniLiteral<"jump">;
-          target: z.ZodMiniNumber<number>;
-        }, z.core.$strip>, z.ZodMiniObject<{
-          type: z.ZodMiniLiteral<"end">;
-        }, z.core.$strip>], "type">;
-      }, z.core.$strip>>;
-      default: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"next">;
-      }, z.core.$strip>, z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"jump">;
-        target: z.ZodMiniNumber<number>;
-      }, z.core.$strip>, z.ZodMiniObject<{
-        type: z.ZodMiniLiteral<"end">;
-      }, z.core.$strip>], "type">;
-    }, z.core.$strip>], "type">;
-  }, z.core.$strip>>;
-  confirmation: z.ZodMiniObject<{
-    title: z.ZodMiniString<string>;
-    description: z.ZodMiniString<string>;
-    buttonText: z.ZodMiniString<string>;
-  }, z.core.$strip>;
-}, z.core.$strip>;
-type PublicGetSurveyOutput = z.infer<typeof publicGetSurveyOutputSchema>;
-//#endregion
-//#region src/core/types.d.ts
-type Question = {
-  visible: boolean;
-  error?: string;
-} & PublicGetSurveyOutput['questions'][number];
-type Answer = BugReportAnswer | RatingAnswer | MultiSelectAnswer | SingleSelectAnswer;
-interface ConfettiState {
-  questions: Question[];
-  current: number;
-  update: ({
-    question,
-    answer
-  }: {
-    question: number;
-    answer: Answer;
-  }) => {
-    next?: number;
-    error?: string;
-  };
-  submit: () => void;
-  isCompleted: boolean;
-  isSubmitted: boolean;
-  errors: Record<Question['id'], string>;
-}
-interface Proxyable {
-  /**
-   * Origin of the proxy that forwards Confetti API requests. The hosted
-   * templates also load the widget bundle and stylesheet from it.
-   */
-  proxyUrl?: string;
-}
-type WithProxyable<T> = Omit<T, 'apiBaseUrl'> & Proxyable;
-interface Finishable {
-  /**
-   * Callback is invoked after the survey response is submitted and the
-   * submission network call settles.
-   */
-  onFinished?: () => void;
-}
-interface Closable {
-  /**
-   * Callback is invoked whenever the survey closes, regardless of how it was closed.
-   */
-  onClose?: () => void;
-}
-/**
- * Wraps the rendered survey in a consumer-provided container. Receives an
- * object holding the survey node and returns the wrapped tree. The object
- * shape leaves room to pass extra render data in the future.
- */
-type ConfettiContainer = (props: {
-  survey: ReactNode;
-}) => ReactNode;
-interface Containable {
-  /**
-   * Wraps the rendered survey in a consumer-provided container for theming.
-   * Only invoked once the survey passes its visibility gates, so the container
-   * never renders while the survey is hidden, and unmounts when the survey
-   * closes.
-   *
-   * Prefer an inline function. To carry state or animation, render your own
-   * component inside it: `container={({ survey }) => <BrandShell>{survey}</BrandShell>}`.
-   */
-  container?: ConfettiContainer;
-}
-interface Dismissable extends Closable {
-  /**
-   * The widget will automatically close this many milliseconds
-   * after the survey is finished.
-   * Set to `null` to disable automatic closing.
-   * @default 3000
-   */
-  closeOnFinishMs?: number | null;
-  /**
-   * Callback is invoked when the user dismisses the survey before submitting.
-   * Closing after submission is not a dismissal and does not invoke this.
-   */
-  onDismiss?: () => void;
-}
-interface OptionallyDismissable extends Dismissable {
-  /**
-   * Allows the user to dismiss the modal via the close button and the
-   * overlay.
-   * @default true
-   */
-  isDismissable?: boolean;
-}
-//#endregion
-export { TextQuestionProperties as _, Containable as a, OptionallyDismissable as c, WithProxyable as d, PublicGetSurveyOutput as f, StatementQuestionProperties as g, SingleSelectQuestionProperties as h, ConfettiState as i, Proxyable as l, RatingQuestionProperties as m, Closable as n, Dismissable as o, MultiSelectQuestionProperties as p, ConfettiContainer as r, Finishable as s, Answer as t, Question as u, BinaryOperatorCondition as v };