@opengovsg/confetti 0.0.0

package/build/index.d.ts

@@ -0,0 +1,427 @@
+import * as react0 from "react";
+import { HTMLAttributes, PropsWithChildren } from "react";
+import { z } from "zod/v4/mini";
+import * as react_jsx_runtime1 from "react/jsx-runtime";
+
+//#region ../validators/src/questions/properties.d.ts
+declare const ratingQuestionSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"rating">;
+  scale: z.ZodMiniNumber<number>;
+  labels: z.ZodMiniOptional<z.ZodMiniObject<{
+    lower: z.ZodMiniString<string>;
+    upper: z.ZodMiniString<string>;
+  }, z.core.$strip>>;
+  display: z.ZodMiniOptional<z.ZodMiniLiteral<"number" | "star" | "emoji">>;
+}, z.core.$strip>;
+type RatingQuestion = z.infer<typeof ratingQuestionSchema>;
+declare const textQuestionSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"open-ended">;
+  max: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+type TextQuestion = z.infer<typeof textQuestionSchema>;
+declare const singleSelectQuestionSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"single-select">;
+  options: z.ZodMiniArray<z.ZodMiniObject<{
+    label: z.ZodMiniString<string>;
+    value: z.ZodMiniString<string>;
+  }, z.core.$strip>>;
+  editable: z.ZodMiniNullable<z.ZodMiniObject<{
+    label: z.ZodMiniString<string>;
+    max: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+type SingleSelectQuestion = z.infer<typeof singleSelectQuestionSchema>;
+declare const multiSelectQuestionSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"multi-select">;
+  options: z.ZodMiniArray<z.ZodMiniObject<{
+    label: z.ZodMiniString<string>;
+    value: z.ZodMiniString<string>;
+  }, z.core.$strip>>;
+  editable: z.ZodMiniNullable<z.ZodMiniObject<{
+    label: z.ZodMiniString<string>;
+    max: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+  max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+}, z.core.$strip>;
+type MultiSelectQuestion = z.infer<typeof multiSelectQuestionSchema>;
+//#endregion
+//#region ../validators/src/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">;
+      scale: z.ZodMiniNumber<number>;
+      labels: z.ZodMiniOptional<z.ZodMiniObject<{
+        lower: z.ZodMiniString<string>;
+        upper: z.ZodMiniString<string>;
+      }, z.core.$strip>>;
+      display: z.ZodMiniOptional<z.ZodMiniLiteral<"number" | "star" | "emoji">>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+      type: z.ZodMiniLiteral<"single-select">;
+      options: z.ZodMiniArray<z.ZodMiniObject<{
+        label: z.ZodMiniString<string>;
+        value: z.ZodMiniString<string>;
+      }, z.core.$strip>>;
+      editable: z.ZodMiniNullable<z.ZodMiniObject<{
+        label: z.ZodMiniString<string>;
+        max: z.ZodMiniNumber<number>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+      type: z.ZodMiniLiteral<"open-ended">;
+      max: z.ZodMiniNumber<number>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+      type: z.ZodMiniLiteral<"multi-select">;
+      options: z.ZodMiniArray<z.ZodMiniObject<{
+        label: z.ZodMiniString<string>;
+        value: z.ZodMiniString<string>;
+      }, z.core.$strip>>;
+      editable: z.ZodMiniNullable<z.ZodMiniObject<{
+        label: z.ZodMiniString<string>;
+        max: z.ZodMiniNumber<number>;
+      }, z.core.$strip>>;
+      max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    }, 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>>;
+}, z.core.$strip>;
+type PublicGetSurveyOutput = z.infer<typeof publicGetSurveyOutputSchema>;
+//#endregion
+//#region src/types/index.d.ts
+type Question$1 = {
+  visible: boolean;
+  error?: string;
+} & PublicGetSurveyOutput['questions'][number];
+type Answer = string | number | string[] | undefined;
+interface ConfettiState {
+  questions: Question$1[];
+  current: number;
+  update: ({
+    question,
+    answer
+  }: {
+    question: number;
+    answer: Answer;
+  }) => {
+    next?: number;
+    error?: string;
+  };
+  submit: () => void;
+  isCompleted: boolean;
+  isSubmitted: boolean;
+  errors: Record<Question$1['id'], string>;
+}
+//#endregion
+//#region src/components/ConfettiController.d.ts
+interface ConfettiControllerProps {
+  children: (props: ConfettiState) => React.ReactElement;
+  /**
+   * Control the current question index that is being displayed.
+   * If not provided, the component will manage it internally.
+   */
+  current?: number;
+  shouldAutoSubmit?: boolean;
+  onFinished?: () => void;
+}
+declare const ConfettiController: ({
+  current: currentProp,
+  shouldAutoSubmit,
+  onFinished,
+  children
+}: ConfettiControllerProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/ConfettiProvider.d.ts
+interface ConfettiContextValue {
+  surveyId: string;
+  metadata: Record<string, string>;
+  submit: ({
+    answers
+  }: {
+    answers: Record<Question$1['id'], Answer>;
+  }) => Promise<void>;
+  dismiss: () => Promise<void> | void;
+  survey: PublicGetSurveyOutput | undefined;
+}
+declare const ConfettiContext: react0.Context<ConfettiContextValue | null>;
+interface ConfettiProviderProps {
+  children: React.ReactNode;
+  surveyId: string;
+  publishableKey: string;
+  respondent?: string;
+  metadata: Record<string, string>;
+  apiBaseUrl?: string;
+  isSurveyVisible?: boolean | ((_: {
+    lastRespondedAt: Date | null;
+  }) => boolean);
+}
+declare const ConfettiProvider: ({
+  children,
+  surveyId,
+  publishableKey,
+  respondent,
+  metadata,
+  isSurveyVisible: isSurveyVisibleInput,
+  apiBaseUrl
+}: ConfettiProviderProps) => react_jsx_runtime1.JSX.Element | null;
+declare const useConfetti: () => ConfettiContextValue;
+//#endregion
+//#region src/components/Confetti.d.ts
+interface ConfettiProps extends Omit<ConfettiProviderProps, 'children'>, Pick<ConfettiControllerProps, 'onFinished' | 'shouldAutoSubmit'> {}
+declare const Confetti: ({
+  children,
+  shouldAutoSubmit,
+  ...props
+}: ConfettiProps & Pick<ConfettiControllerProps, "children" | "shouldAutoSubmit">) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/ThankYouMessage.d.ts
+interface ThankYouMessageProps {
+  title?: string;
+  description?: string;
+  classNames?: {
+    question?: string;
+    header?: string;
+    title?: string;
+    description?: string;
+  };
+}
+declare const ThankYouMessage: ({
+  title,
+  description,
+  classNames
+}: ThankYouMessageProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/container/PopoverContainer.d.ts
+interface PopoverContainerProps {
+  closeOnFinishMs?: number;
+  classNames?: {
+    dialog?: string;
+    closeButton?: string;
+    icon?: string;
+  };
+  onDismiss?: () => void;
+  containerProps?: Omit<HTMLAttributes<HTMLDivElement>, 'children'>;
+  children: React.ReactNode | ((props: {
+    setIsFinished: () => void;
+  }) => React.ReactNode);
+}
+declare const PopoverContainer: ({
+  children,
+  classNames,
+  containerProps,
+  onDismiss,
+  closeOnFinishMs
+}: PopoverContainerProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/questions/types.d.ts
+type Question = PublicGetSurveyOutput['questions'][number];
+interface BaseFieldProps {
+  id: string;
+  title: string | null | undefined;
+  description?: string | null | undefined;
+  required?: boolean;
+  onChange: (answer: Answer) => void;
+  error?: string;
+}
+//#endregion
+//#region src/components/questions/factory.d.ts
+interface SurveyQuestionFactoryProps {
+  question: Question;
+  onChange: (answer: Answer) => void;
+  error?: string;
+}
+declare const SurveyQuestionFactory: ({
+  question,
+  onChange,
+  error
+}: SurveyQuestionFactoryProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/questions/Rating.d.ts
+interface RatingProps extends BaseFieldProps {
+  properties: RatingQuestion;
+  classNames?: {
+    question?: string;
+    header?: string;
+    title?: string;
+    description?: string;
+    ratingSection?: string;
+    ratingDisplay?: string;
+    ratingText?: string;
+    ratingTextLower?: string;
+    ratingTextUpper?: string;
+    ratingDisplayStar?: string;
+    ratingStar?: string;
+    ratingDisplayNumber?: string;
+    ratingNumber?: string;
+    ratingDisplayEmoji?: string;
+    ratingEmoji?: string;
+    error?: string;
+  };
+}
+declare const Rating: ({
+  properties,
+  title,
+  description,
+  classNames,
+  onChange,
+  id,
+  error,
+  required
+}: RatingProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/questions/FreeText.d.ts
+interface FreeTextProps extends BaseFieldProps {
+  properties: TextQuestion;
+  classNames?: {
+    question?: string;
+    header?: string;
+    title?: string;
+    description?: string;
+    textarea?: string;
+    error?: string;
+  };
+}
+declare const FreeText: ({
+  id,
+  title,
+  description,
+  properties,
+  onChange,
+  classNames,
+  required,
+  error
+}: FreeTextProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/questions/SingleChoice.d.ts
+interface SingleChoiceProps extends BaseFieldProps {
+  properties: SingleSelectQuestion;
+  classNames?: {
+    question?: string;
+    header?: string;
+    title?: string;
+    description?: string;
+    group?: string;
+    radio?: string;
+    indicator?: string;
+    othersChoice?: string;
+    othersInput?: string;
+    error?: string;
+  };
+}
+declare const SingleChoice: ({
+  title,
+  description,
+  properties,
+  classNames,
+  onChange,
+  id,
+  required,
+  error
+}: SingleChoiceProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/questions/MultiChoice.d.ts
+interface MultiChoiceProps extends BaseFieldProps {
+  properties: MultiSelectQuestion;
+  classNames?: {
+    question?: string;
+    header?: string;
+    title?: string;
+    description?: string;
+    group?: string;
+    checkbox?: string;
+    indicator?: string;
+    svg?: string;
+    othersChoice?: string;
+    othersInput?: string;
+    error?: string;
+  };
+}
+declare const MultiChoice: ({
+  title,
+  description,
+  properties,
+  classNames,
+  onChange,
+  id,
+  required,
+  error
+}: MultiChoiceProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/presentation/Flow.d.ts
+type ChildField = ({
+  onChange
+}: {
+  onChange: (answer: Answer) => void;
+  question: Question;
+  error?: string;
+}) => React.ReactNode;
+interface FlowProps {
+  onSubmit: (answer: Answer) => void;
+  children: ChildField;
+  question: Question;
+}
+declare const Flow: ({
+  onSubmit,
+  children,
+  question
+}: FlowProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/presentation/Embed.d.ts
+declare const Embed: ({
+  isCompleted,
+  onSubmit,
+  children
+}: PropsWithChildren<{
+  isCompleted: boolean;
+  onSubmit: () => void;
+}>) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/templates/EmbeddedConfetti.d.ts
+declare const EmbeddedConfetti: (props: ConfettiProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/templates/StepperConfetti.d.ts
+declare const StepperConfetti: (props: ConfettiProps) => react_jsx_runtime1.JSX.Element;
+//#endregion
+export { Confetti, ConfettiContext, ConfettiController, type ConfettiControllerProps, type ConfettiProps, ConfettiProvider, type ConfettiProviderProps, Embed, EmbeddedConfetti, Flow, FreeText, type FreeTextProps, MultiChoice, type MultiChoiceProps, PopoverContainer, type PopoverContainerProps, Rating, type RatingProps, SingleChoice, type SingleChoiceProps, StepperConfetti, SurveyQuestionFactory, type SurveyQuestionFactoryProps, ThankYouMessage, useConfetti };
+//# sourceMappingURL=index.d.ts.map