@rssa-project/study-template 1.0.0

package/dist/types/rssa.types.d.ts

@@ -0,0 +1,142 @@
+export interface RatedItem {
+    id?: string;
+    item_id: string;
+    rating: number;
+    version?: number;
+}
+export interface MovieEmotions {
+    id: string;
+    movie_id: string;
+    movielens_id: string;
+    anger: number;
+    anticipation: number;
+    disgust: number;
+    fear: number;
+    joy: number;
+    surprise: number;
+    sadness: number;
+    trust: number;
+}
+export interface MovieRecommendationText {
+    movie_id: string;
+    formal: string;
+    informal: string;
+    source: string | null;
+    model: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface Movie {
+    id: string;
+    imdb_id: string | null;
+    tmdb_id: string | null;
+    movielens_id: string;
+    title: string;
+    year: number;
+    ave_rating: number;
+    imdb_avg_rating: number | null;
+    imdb_rate_count: number | null;
+    tmdb_avg_rating: number | null;
+    tmdb_rate_count: number | null;
+    genre: string;
+    director: string | null;
+    cast: string;
+    description: string;
+    poster: string;
+    tmdb_poster: string;
+    poster_identifier: string;
+}
+export interface EmotionMovies extends Movie, MovieEmotions {
+}
+export interface MovieRecommdantions extends Movie, MovieRecommendationText {
+}
+export interface MovieDetails extends Movie {
+    emotions: MovieEmotions | null;
+    recommendations_text: MovieRecommendationText | null;
+}
+export interface Page {
+    id: string;
+    step_id: string;
+    study_id: string;
+    order_position: number;
+    next: string | null;
+    page_type?: string;
+    title?: string;
+    instructions?: string;
+    last_page: boolean;
+}
+export interface NavigationWrapper<T> {
+    data: T;
+    next_id: string | null;
+    next_path: string | null;
+}
+export interface StudyStep {
+    id: string;
+    study_id: string;
+    name: string;
+    description: string;
+    order_position: number;
+    next: string | null;
+    step_type: string;
+    path: string;
+    title: string;
+    instructions: string;
+    pages?: Page[];
+    survey_api_root?: string;
+    root_page_info?: NavigationWrapper<SurveyPageType>;
+}
+export interface SurveyConstructItem {
+    id: string;
+    survey_construct_id: string;
+    display_name: string;
+    order_position: number;
+}
+export interface ScaleLevel {
+    id: string;
+    survey_scale_id: string;
+    display_name: string;
+    value: number;
+    order_position: number;
+}
+export interface PageContent {
+    id: string;
+    study_step_page_id: string;
+    preamble: string;
+    survey_construct_id: string;
+    items: SurveyConstructItem[];
+    scale_levels: ScaleLevel[];
+    display_name: string;
+}
+export interface SurveyPageType {
+    id: string;
+    description: string;
+    order_position: number;
+    study_step_page_contents: PageContent[];
+    next: string;
+}
+export interface StudyResponseMetaFields {
+    step_id: string;
+    page_id?: string;
+    construct_id?: string;
+    construct_name?: string;
+}
+export interface SurveyItemResponse {
+    id: string;
+    survey_item_id: string;
+    survey_scale_level_id: string;
+    version?: number;
+}
+export interface ParticipantRatingPayload {
+    study_step_id: string;
+    study_step_page_id: string | null;
+    context_tag: string;
+    rated_item: RatedItem;
+}
+export interface ParticipantRatingResponse {
+    id: string;
+    study_step_id: string;
+    study_step_page_id: string | null;
+    context_tag: string;
+    rated_item: RatedItem;
+    version: number;
+}

package/dist/types/study.types.d.ts

@@ -0,0 +1,5 @@
+import { StudyStep } from './rssa.types';
+export type StudyLayoutContextType = {
+    studyStep: StudyStep;
+    resetNextButton: () => void;
+};

package/dist/utils/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const STRINGS: {
+    WINDOW_TOO_SMALL: string;
+    STUDY_ERROR: string;
+};
+export declare const customBreakpoints: {
+    xl: number;
+    xxl: number;
+    xxxl: number;
+    xl4: number;
+};
+export declare const RETRY_DELAYS_MS: number[];

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/package.json

@@ -0,0 +1,83 @@
+{
+	"name": "@rssa-project/study-template",
+	"version": "1.0.0",
+	"license": "MIT",
+	"type": "module",
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/RSSA-Project/rssa-study-template.git"
+	},
+	"files": [
+		"dist"
+	],
+	"main": "./dist/rssa-study-template.es.js",
+	"module": "./dist/rssa-study-template.es.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/rssa-study-template.es.js"
+		}
+	},
+	"scripts": {
+		"dev": "vite",
+		"build": "tsc -b && vite build",
+		"test": "vitest run",
+		"lint": "eslint .",
+		"preview": "vite preview",
+		"prepare": "npm run build"
+	},
+	"dependencies": {
+		"@headlessui/react": "^2.2.9",
+		"@heroicons/react": "^2.2.0",
+		"@tailwindcss/vite": "^4.1.17",
+		"@tanstack/query-async-storage-persister": "^5.90.9",
+		"@tanstack/react-query-persist-client": "^5.90.9",
+		"clsx": "^2.1.1",
+		"dompurify": "^3.3.0",
+		"html-react-parser": "^5.2.8"
+	},
+	"peerDependencies": {
+		"@rssa-project/api": "^1.0.1",
+		"@tanstack/react-query": "^5.90.7",
+		"react": "^19.1.1",
+		"react-dom": "^19.1.1",
+		"react-router-dom": "^7.9.5"
+	},
+	"devDependencies": {
+		"@eslint/js": "^9.36.0",
+		"@tanstack/react-query": "^5.90.12",
+		"@tanstack/react-query-devtools": "^5.90.2",
+		"@testing-library/jest-dom": "^6.9.1",
+		"@testing-library/react": "^16.3.1",
+		"@types/node": "^24.10.0",
+		"@types/react": "^19.1.16",
+		"@types/react-dom": "^19.1.9",
+		"@vitejs/plugin-react-swc": "^3.10.2",
+		"autoprefixer": "^10.4.21",
+		"eslint": "^9.36.0",
+		"eslint-plugin-react-hooks": "^5.2.0",
+		"eslint-plugin-react-refresh": "^0.4.22",
+		"globals": "^16.4.0",
+		"jsdom": "^27.4.0",
+		"lint-staged": "^16.2.7",
+		"postcss": "^8.5.6",
+		"prettier": "^3.6.2",
+		"react": "^19.2.1",
+		"react-dom": "^19.2.1",
+		"react-router-dom": "^7.10.1",
+		"tailwindcss": "^4.1.17",
+		"typescript": "~5.9.3",
+		"typescript-eslint": "^8.45.0",
+		"vite": "^7.0.4",
+		"vite-plugin-css-injected-by-js": "^3.5.2",
+		"vite-plugin-dts": "^4.5.4",
+		"vitest": "^4.0.16"
+	},
+	"lint-staged": {
+		"**/*.{js,jsx,ts,tsx,json,css,scss,md}": "prettier --write"
+	}
+}