heartraite 1.0.174 → 1.0.176

package/dist/types/dq.types.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Discovery Questions (DQ) - Client-Facing Types
+ *
+ * IMPORTANT: Only types needed by the frontend should be here.
+ * Internal backend details (psychometrics, scoring, etc.) belong in backend only.
+ */
+import { Locale } from "../enum/localization.enum";
+/**
+ * DQ locale codes for question content
+ * Currently supports Swedish and Danish
+ */
+export type DQLocaleCode = "sv" | "da";
+export type QuestionType = "scale" | "multiple_choice" | "multi_select" | "ranking";
+/**
+ * Localized text content
+ */
+export type LocalizedString = Record<DQLocaleCode, string>;
+/**
+ * Configuration for scale-type questions (slider UI)
+ */
+export interface ScaleConfig {
+    min: number;
+    max: number;
+    step: number;
+    minLabel: string;
+    maxLabel: string;
+    midLabel?: string;
+}
+/**
+ * Option for multiple choice or multi-select questions
+ */
+export interface QuestionOption {
+    optionId: string;
+    text: string;
+    imageUrl?: string;
+    displayOrder: number;
+}
+/**
+ * Item for ranking questions
+ */
+export interface RankingItem {
+    itemId: string;
+    text: string;
+}
+/**
+ * Configuration for ranking-type questions
+ */
+export interface RankingConfig {
+    items: RankingItem[];
+    requiredRankCount: number;
+}
+/**
+ * Configuration for open-ended text questions
+ */
+export interface OpenEndedConfig {
+    maxLength: number;
+    minLength: number;
+    placeholder: string;
+}
+/**
+ * Question data sent to client
+ * Contains only what's needed to render the UI
+ */
+export interface DQQuestion {
+    questionId: string;
+    sequencePosition: number;
+    title: string;
+    description?: string;
+    reflectionPrompt?: string;
+    type: QuestionType;
+    scaleConfig?: ScaleConfig;
+    options?: QuestionOption[];
+    rankingConfig?: RankingConfig;
+    openEndedConfig?: OpenEndedConfig;
+}
+/**
+ * Request for POST /dq/get-question endpoint
+ */
+export interface GetQuestionRequest {
+    /** User's preferred locale for question content (optional, defaults to sv_SE) */
+    locale?: Locale;
+}
+/**
+ * User's discovery progress (streaks, counts, etc.)
+ */
+export interface DiscoveryProgress {
+    /** Current consecutive days streak */
+    currentStreak: number;
+    /** Longest streak ever achieved */
+    longestStreak: number;
+    /** Total questions answered (not skipped) */
+    answeredCount: number;
+    /** Total questions skipped */
+    skippedCount: number;
+    /** ISO timestamp of last answered question (null if never answered) */
+    lastAnsweredAt: string | null;
+}
+/**
+ * Response for POST /dq/get-question endpoint
+ * Provides question data along with quota information
+ */
+export interface GetQuestionResponse {
+    /** The question to display, or null if quota exhausted or no more questions */
+    question: DQQuestion | null;
+    /** Whether the user has exhausted their daily quota */
+    quotaExhausted: boolean;
+    /** ISO timestamp when quota resets (next midnight UTC), only present when quota exhausted */
+    quotaResetsAt?: string;
+    /** Number of questions remaining for today */
+    questionsRemainingToday: number;
+    /** User's discovery progress (streaks, counts) */
+    progress?: DiscoveryProgress;
+}

package/dist/types/dq.types.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Discovery Questions (DQ) - Client-Facing Types
+ *
+ * IMPORTANT: Only types needed by the frontend should be here.
+ * Internal backend details (psychometrics, scoring, etc.) belong in backend only.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "./am.types";
 export * from "./assessment.types";
 export * from "./ca.types";
 export * from "./cloud-function-types";
+export * from "./dq.types";
 export * from "./error.types";
 export * from "./event.types";
 export * from "./feedback.types";

package/dist/types/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./am.types"), exports);
 __exportStar(require("./assessment.types"), exports);
 __exportStar(require("./ca.types"), exports);
 __exportStar(require("./cloud-function-types"), exports);
+__exportStar(require("./dq.types"), exports);
 __exportStar(require("./error.types"), exports);
 __exportStar(require("./event.types"), exports);
 __exportStar(require("./feedback.types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "heartraite",
-  "version": "1.0.174",
+  "version": "1.0.176",
   "description": "Heartraite npm package for common functionality",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/types/dq.types.ts

@@ -0,0 +1,153 @@
+/**
+ * Discovery Questions (DQ) - Client-Facing Types
+ *
+ * IMPORTANT: Only types needed by the frontend should be here.
+ * Internal backend details (psychometrics, scoring, etc.) belong in backend only.
+ */
+
+import { Locale } from "../enum/localization.enum";
+
+// ========== BASIC TYPES ==========
+
+/**
+ * DQ locale codes for question content
+ * Currently supports Swedish and Danish
+ */
+export type DQLocaleCode = "sv" | "da";
+
+export type QuestionType =
+  | "scale"
+  | "multiple_choice"
+  | "multi_select"
+  | "ranking";
+
+/**
+ * Localized text content
+ */
+export type LocalizedString = Record<DQLocaleCode, string>;
+
+// ========== UI CONFIGURATION TYPES ==========
+
+/**
+ * Configuration for scale-type questions (slider UI)
+ */
+export interface ScaleConfig {
+  min: number;
+  max: number;
+  step: number;
+  minLabel: string;
+  maxLabel: string;
+  midLabel?: string;
+}
+
+/**
+ * Option for multiple choice or multi-select questions
+ */
+export interface QuestionOption {
+  optionId: string;
+  text: string;
+  imageUrl?: string;
+  displayOrder: number;
+}
+
+/**
+ * Item for ranking questions
+ */
+export interface RankingItem {
+  itemId: string;
+  text: string;
+}
+
+/**
+ * Configuration for ranking-type questions
+ */
+export interface RankingConfig {
+  items: RankingItem[];
+  requiredRankCount: number;
+}
+
+/**
+ * Configuration for open-ended text questions
+ */
+export interface OpenEndedConfig {
+  maxLength: number;
+  minLength: number;
+  placeholder: string;
+}
+
+// ========== CLIENT QUESTION TYPE ==========
+
+/**
+ * Question data sent to client
+ * Contains only what's needed to render the UI
+ */
+export interface DQQuestion {
+  // Identity
+  questionId: string;
+  sequencePosition: number;
+
+  // Content (localized strings already selected by backend based on user's locale)
+  title: string;
+  description?: string;
+  reflectionPrompt?: string;
+
+  // UI Configuration (only one populated based on type)
+  type: QuestionType;
+  scaleConfig?: ScaleConfig;
+  options?: QuestionOption[];
+  rankingConfig?: RankingConfig;
+  openEndedConfig?: OpenEndedConfig;
+}
+
+// ========== API REQUEST TYPES ==========
+
+/**
+ * Request for POST /dq/get-question endpoint
+ */
+export interface GetQuestionRequest {
+  /** User's preferred locale for question content (optional, defaults to sv_SE) */
+  locale?: Locale;
+}
+
+// ========== API RESPONSE TYPES ==========
+
+/**
+ * User's discovery progress (streaks, counts, etc.)
+ */
+export interface DiscoveryProgress {
+  /** Current consecutive days streak */
+  currentStreak: number;
+
+  /** Longest streak ever achieved */
+  longestStreak: number;
+
+  /** Total questions answered (not skipped) */
+  answeredCount: number;
+
+  /** Total questions skipped */
+  skippedCount: number;
+
+  /** ISO timestamp of last answered question (null if never answered) */
+  lastAnsweredAt: string | null;
+}
+
+/**
+ * Response for POST /dq/get-question endpoint
+ * Provides question data along with quota information
+ */
+export interface GetQuestionResponse {
+  /** The question to display, or null if quota exhausted or no more questions */
+  question: DQQuestion | null;
+
+  /** Whether the user has exhausted their daily quota */
+  quotaExhausted: boolean;
+
+  /** ISO timestamp when quota resets (next midnight UTC), only present when quota exhausted */
+  quotaResetsAt?: string;
+
+  /** Number of questions remaining for today */
+  questionsRemainingToday: number;
+
+  /** User's discovery progress (streaks, counts) */
+  progress?: DiscoveryProgress;
+}

package/src/types/index.ts

@@ -2,6 +2,7 @@ export * from "./am.types";
 export * from "./assessment.types";
 export * from "./ca.types";
 export * from "./cloud-function-types";
+export * from "./dq.types";
 export * from "./error.types";
 export * from "./event.types";
 export * from "./feedback.types";