eat-js-sdk 2.0.33 → 2.0.34

package/README.md

@@ -1,129 +1,67 @@
-# EAT UI
+# eat-js-sdk
 
-A Svelte-based UI component library for educational assessment tools (EAT). This library provides interactive components for multiple choice questions (MCQ), type-in interactions, categorisation, and dropdown interactions.
+Education Authoring Tool SDK built with SvelteKit
 
-## Features
+## Requirements
 
-- 🎯 **Multiple Interaction Types**: MCQ, Type-in, Categorise, and Dropdown interactions
-- 📱 **Responsive Design**: Mobile-first approach with desktop optimizations
-- 🎨 **Customizable Templates**: Flexible template system with two-column and single-column layouts
-- 🖼️ **Rich Media Support**: Images, videos, and audio with captions and accessibility features
-- ♿ **Accessible**: Built with accessibility in mind
-- 🎭 **Feedback System**: Comprehensive feedback with comparison tables and result displays
-- 💅 **Styled with Tailwind CSS**: Easily customizable styling
+- Bun (recommended package manager for development)
+- Node 20 (for deployment)
 
 ## Installation
 
-```sh
-# Install dependencies using bun
-bun install
-```
-
-## Developing
+Use the package manager [bun](https://bun.sh/) for development or [npm](https://www.npmjs.com/) to install.
 
-Start the development server:
-
-```sh
-bun run dev
+```bash
+#install dependencies
+bun install
 
-# or start the server and open the app in a new browser tab
-bun run dev --open
+#or using npm
+npm install
 ```
 
-## Building
-
-To create a production version of the library:
+## Usage
 
-```sh
+```bash
+#convert tailwind css to native css and build JS app
 bun run build
-```
-
-Preview the production build:
 
-```sh
-bun run preview
+#or using npm
+npm run build
 ```
 
-## Testing
-
-Run tests with Vitest:
+## Test in local
 
-```sh
-bun run test
-```
-
-## Project Structure
+```html
+#add script
+<script src="<path/dist/interaction-builder.mjs>" type="module"></script>
 
-```
-src/
-├── lib/
-│   ├── components/        # Reusable UI components
-│   │   ├── common/        # Common components (Media, Modal, Skeleton, etc.)
-│   │   ├── interaction/   # Interaction-specific components (MCQ, etc.)
-│   │   └── template/      # Template components (PromptContainer, Feedback, etc.)
-│   ├── composables/       # Composition functions for shared logic
-│   ├── constants/         # Application constants and enums
-│   ├── core/             # Core functionality (factory, registry, data loading)
-│   ├── stores/           # Svelte stores for state management
-│   └── types/            # TypeScript type definitions
+#add the component
+<interaction-builder />
 ```
 
-## Usage Example
+## Development
 
-```svelte
-<script>
-  import { InteractionBuilder } from 'eat-ui'
+```bash
+#start dev server from consuming platform and then,
 
-  const interactionData = {
-    interactionType: 'multipleChoiceInteraction',
-    rubric: 'Select the correct answer',
-    prompt: 'What is 2 + 2?',
-    // ... other interaction properties
-  }
-</script>
-
-<InteractionBuilder {...interactionData} />
+#start development server
+bun run build
 ```
 
-## Key Components
-
-### PromptContainer
-
-Orchestrates template sections with clean separation of concerns. Handles rubric, prompt, stimulus (text/media), and interaction layout.
-
-### InteractionBuilder
-
-Main entry point for building interactions. Automatically selects the appropriate interaction type based on configuration.
+## Publish
 
-### Composables
+```bash
+#publish app
+npm publish
 
-- `useMCQ` - MCQ interaction logic
-- `useStimulusData` - Stimulus data processing
-- `useFeedbackData` - Feedback display logic
-- `usePrompt` - Prompt state management
-
-## TypeScript Support
-
-This project is fully typed with TypeScript. Key types include:
-
-- `InteractionType` - Supported interaction types
-- `Stimulus` - Media and text stimulus configuration
-- `FeedbackData` - Feedback structure
-- `ViewTemplate` - Template configuration
-
-## Contributing
-
-1. Follow the existing code structure and patterns
-2. Maintain type safety with TypeScript
-3. Write tests for new features
-4. Keep components focused and composable
-5. Document complex logic with comments
+#Package url
+https://unpkg.com/eat-js-sdk@<version>/dist/interaction-builder.mjs
+```
 
 ## Tech Stack
 
-- **Framework**: SvelteKit
-- **Language**: TypeScript
-- **Styling**: Tailwind CSS + SCSS
-- **Testing**: Vitest + Playwright
-- **Package Manager**: Bun
-- **Linting**: ESLint
+- SvelteKit 2 with Svelte 5
+- TypeScript
+- Tailwind CSS 3
+- Vitest + Playwright
+- svelte-dnd-action (custom fork)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eat-js-sdk",
-  "version": "2.0.33",
+  "version": "2.0.34",
   "change version": "2.0.0",
   "description": "Authoring tool frontend SDK",
   "contributors": [