diff --git a/.github/instructions/digital-logbook.instructions.md b/.github/instructions/digital-logbook.instructions.md new file mode 100644 index 00000000..08c529bf --- /dev/null +++ b/.github/instructions/digital-logbook.instructions.md @@ -0,0 +1,395 @@ +--- +description: "Digital Logbook project conventions. Use when working on any feature: BullMQ queues, oRPC routers, Next.js API routes, Prisma repositories, Zod schemas, TanStack Query hooks, shadcn/ui components, Redis, middleware, or any server-side or client-side code in the Digital Logbook codebase." +applyTo: "server/src/**/*.ts, server/src/**/*.tsx" +--- + +# Digital Logbook – Project Conventions + +## Tech Stack + +- **Framework**: Next.js (App Router), TypeScript strict mode +- **API layer (onboarding only)**: oRPC (`@orpc/server`, `@orpc/client`) +- **API layer (all other domains)**: Next.js folder-based API routes (`src/app/api//route.ts`) +- **Client data fetching**: TanStack Query (`@tanstack/react-query`) +- **UI components**: shadcn/ui (style: `radix-nova`, icons: `lucide-react`) +- **Notifications**: Sonner (`toast` from `sonner`) +- **Database**: PostgreSQL via Prisma ORM +- **Job queue**: BullMQ backed by Redis (ioredis) +- **Validation**: Zod (all inputs and outputs) +- **Auth**: Session-based via `getSession()` server action + +--- + +## Project Structure + +``` +src/ + app/api/ # Next.js API routes — one folder per domain (all domains except onboarding) + app/providers/ # React context providers (QueryClientProvider, etc.) + _hooks/ # TanStack Query hooks — grouped by domain subfolder + components/ui/ # shadcn/ui primitive components (never edit directly) + components/ # Feature/domain components + lib/ # Singletons and shared utilities (Redis, Prisma, queues, orpc client) + routers/ # oRPC procedure definitions (onboarding domain only) + routers/middleware/ # base context, auth/role middlewares, rate-limit, commonErrors + repositories/ # Prisma data access, one file per domain + schemas/ # Zod schemas, one file per domain + services/ # Business logic services + worker/ # Long-running BullMQ workers (separate process entry) +``` + +--- + +## BullMQ – Queues and Workers + +### Queue definition (in `src/lib/`) + +- Import Redis via `getRedis()` — **never** instantiate `new Redis()` directly. +- Always set `attempts` and exponential `backoff` in `defaultJobOptions`. +- Export both the `Queue` and `Worker` from the same file. +- Type job data with a discriminated union using a `type` field. + +```ts +import { Queue, Worker } from "bullmq"; +import { getRedis } from "./redis"; + +const redis = getRedis(); + +export const exampleQueue = new Queue("exampleQueue", { + connection: redis, + defaultJobOptions: { + attempts: 3, + backoff: { type: "exponential", delay: 5000 }, + }, +}); + +export type ExampleJobData = + | { type: "jobTypeA"; payload: string } + | { type: "jobTypeB"; id: string }; + +export const exampleWorker = new Worker( + "exampleQueue", + async (job) => { + if (job.data.type === "jobTypeA") { + /* ... */ + } + if (job.data.type === "jobTypeB") { + /* ... */ + } + }, + { connection: redis }, +); +``` + +- Use `console.log(`[queueName] …`)` for worker log messages. +- Dispatch jobs with `await queue.add("jobTypeName", data)` — job dispatch should not block the response; fire-and-forget if appropriate. + +--- + +## API Layer — Which to Use + +| Domain | API approach | +| ----------------- | ---------------------------------------------------- | +| `onboarding` | oRPC procedures (`src/routers/onboarding.ts`) | +| All other domains | Next.js API routes (`src/app/api//route.ts`) | + +Do **not** add new domains to the oRPC router — use a Next.js API route instead. + +--- + +## Next.js API Routes (`src/app/api//route.ts`) + +- Export named HTTP handlers: `GET`, `POST`, `PATCH`, `DELETE`. +- Always add `export const dynamic = "force-dynamic"` at the top. +- Authenticate with `getSession()` and return `401`/`403` immediately if invalid. +- Return `NextResponse.json(...)` with appropriate HTTP status codes. +- Catch errors in a `try/catch` and return `{ message: "..." }` with status `500`. + +```ts +import { NextRequest, NextResponse } from "next/server"; +import getSession from "@/server_actions/getSession"; +import prisma from "@/lib/prisma"; + +export const dynamic = "force-dynamic"; + +export async function GET(req: NextRequest) { + try { + const session = await getSession(); + if (!session || !session.isAuthenticated()) { + return NextResponse.json({ message: "Unauthorized" }, { status: 401 }); + } + // ... query prisma ... + return NextResponse.json(data); + } catch (error) { + console.error("Error:", error); + return NextResponse.json( + { message: "Internal server error" }, + { status: 500 }, + ); + } +} +``` + +--- + +## oRPC – Routers and Procedures (onboarding domain only) + +### Router files (`src/routers/.ts`) + +- One file per domain (e.g., `onboarding.ts`, `user.ts`). +- Register all procedures in `src/routers/index.ts` under the `router` object. +- Instantiate the repository at module level: `const repo = new DomainRepository();`. +- Call `createProcedures()` to get typed procedure builders. + +```ts +import { createProcedures } from "@/routers/middleware"; +const { + publicProcedure, + authedProcedure, + superAdminProcedure, + mentorProcedure, +} = createProcedures(); +``` + +### Procedure anatomy + +```ts +export const myProcedure = authedProcedure + .route({ + method: "POST", + path: "/domain/action", + summary: "...", + tags: ["Domain"], + }) + .errors({ CONFLICT: domainErrors.SOME_ERROR }) + .input(myInputSchema) + .output(myOutputSchema) + .handler(async ({ input, context, errors }) => { + // implementation + }); +``` + +- Always provide `.route()` with `method`, `path`, `summary`, and `tags`. +- Use `.errors()` to declare domain-specific overrides on top of `commonErrors`. +- `publicProcedure` — unauthenticated, no rate limit. +- `rateLimitedPublicProcedure` — unauthenticated, rate-limited (use for public write endpoints). +- `authedProcedure` — requires valid session. +- `superAdminProcedure` — requires `superAdmin` role. +- `mentorProcedure` — requires `mentor` role. + +### Error definitions + +- Define domain errors as `const domainErrors = { ... } as const` at the top of the router file. +- `commonErrors` (NOT_FOUND, CONFLICT, UNAUTHORIZED, FORBIDDEN, INVALID_INPUT, INTERNAL_ERROR, RATE_LIMITED) are available on every procedure via `base`. + +--- + +## Zod Schemas (`src/schemas/.schema.ts`) + +- One schema file per domain, named `.schema.ts`. +- Add `.describe("…")` to every field and to the top-level schema object. +- Export individual schemas; do not export a single object containing all schemas. + +```ts +export const createThingSchema = z + .object({ + name: z.string().min(1, "Name is required").describe("Human-readable name"), + email: z.string().email().describe("Contact email"), + }) + .describe("Create a new thing"); +``` + +--- + +## Repositories (`src/repositories/_repository_impl.ts`) + +- Filename convention: `_repository_impl.ts` (snake_case). +- Every repository extends `BaseRepository`: + +```ts +import BaseRepository from "./baseRepository"; +export class DomainRepository extends BaseRepository { + constructor() { + super(prisma.domainModel); + } +} +``` + +- `BaseRepository` provides `getAll`, `getById`, `create`, `update`, `delete`. +- Add domain-specific methods for complex queries. +- Use `type` aliases (not interfaces) for local model types; prefer `any` only until proper types are defined. +- Always `orderBy: { createdAt: "desc" }` for list queries unless the domain requires otherwise. + +--- + +## Redis (`src/lib/redis.ts`) + +- Access via the singleton: `import { getRedis } from "@/lib/redis"`. +- Always set `maxRetriesPerRequest: null` when creating a Redis connection (required by BullMQ). +- Configure host/port from env vars: `REDIS_HOST`, `REDIS_PORT`. + +--- + +## Prisma (`src/lib/prisma.ts`) + +- Import the singleton: `import prisma from "@/lib/prisma"`. +- Never instantiate `new PrismaClient()` outside of `prisma.ts`. + +--- + +## Naming Conventions + +| Layer | Convention | Example | +| --------------------- | ----------------------------------- | ---------------------------------- | +| Queue/Worker file | camelCase | `onboardingQueue.ts` | +| Repository file | snake_case `_repository_impl` | `onboarding_repository_impl.ts` | +| Schema file | camelCase `.schema.ts` | `onboarding.schema.ts` | +| oRPC router file | camelCase | `onboarding.ts` | +| oRPC router index key | camelCase domain | `onboarding: { ... }` | +| Next.js API route | folder per domain | `src/app/api/invitations/route.ts` | +| TanStack hook file | camelCase `use.ts` | `useProject.ts` | +| TanStack hook name | camelCase `use` | `useGetProjectTechnologies` | +| Component file | PascalCase | `MenteeProfileView.tsx` | +| oRPC client call | `orpcClient..()` | | + +--- + +## Client-Side oRPC Usage (onboarding only) + +- Client-side: import `orpcClient` from `@/lib/orpc`. +- Server-side (RSC): use `globalThis.$client` set up in `@/lib/orpc.server.ts`. +- Never import `orpc.server.ts` from client components. + +--- + +## TanStack Query + +### Provider + +`TaskstacktProvider` (in `src/app/providers/queryClientProvider.tsx`) wraps the root layout. It is already set up — do not add another `QueryClientProvider`. + +### Custom hooks (`src/_hooks//use.ts`) + +- All data-fetching and mutation logic lives in custom hooks under `src/_hooks/`. +- Group by domain in subfolders: `src/_hooks/admin/`, `src/_hooks/projects/`, `src/_hooks/mentee/`, etc. +- One file per domain, exporting multiple named hooks: `useInvitation.ts` exports `useInvitation`, `useRecentInvitations`, `useDeleteInvitation`, etc. +- Always add `"use client"` at the top of hook files. +- Define request/response interfaces at the top of the file, before the hooks. +- Use `const` arrow functions, not `function` declarations. + +#### File structure + +```ts +"use client"; + +import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"; +import { toast } from "sonner"; + +// ── Types ────────────────────────────────────────────────────────────────────── + +interface ThingRequest { name: string; } +interface ThingResponse { id: string; name: string; } + +// ── Hooks ────────────────────────────────────────────────────────────────────── + +export const useGetThings = () => { ... }; +export const useCreateThing = () => { ... }; +export const useDeleteThing = () => { ... }; +``` + +#### `useQuery` pattern + +```ts +export const useGetThings = (id: string | null) => { + return useQuery({ + queryKey: ["things", id], + queryFn: async () => { + const res = await fetch(`/api/things?id=${id}`); + if (!res.ok) throw new Error("Failed to fetch things"); + return res.json(); + }, + enabled: !!id, + }); +}; +``` + +- Use `enabled: !!param` to prevent queries from running when required params are absent. +- Set `staleTime` for data that rarely changes (e.g., session: `10 * 60 * 1000`). +- Use `gcTime` alongside `staleTime` for session/stable data. + +#### `useMutation` pattern + +```ts +export const useCreateThing = () => { + const queryClient = useQueryClient(); + + return useMutation({ + mutationFn: async (data) => { + const res = await fetch("/api/things", { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify(data), + }); + if (!res.ok) { + const errorData = await res.json(); + throw new Error(errorData.message || "Failed to create thing"); + } + return res.json(); + }, + onSuccess: () => { + queryClient.invalidateQueries({ queryKey: ["things"] }); + toast.success("Thing created"); + }, + onError: (error) => { + toast.error(error.message || "Something went wrong"); + }, + }); +}; +``` + +- Always type `useMutation` explicitly. +- Parse the error response body (`await res.json()`) before throwing — use `errorData.message` as the error message. +- Always use `queryClient.invalidateQueries` in `onSuccess` to keep the cache fresh. +- Always handle `onError` with a `toast.error()`. +- Use `toast.success()` for user feedback on successful mutations. + +#### Query key conventions + +| Resource | Key pattern | +| --------------- | ------------------------------- | +| All items | `["domain"]` | +| Single item | `["domain", id]` | +| Nested resource | `["domain", parentId, "child"]` | +| Session | `["session"]` (global, shared) | + +--- + +## shadcn/ui Components + +- All shadcn primitives live in `src/components/ui/` — **never modify these files directly**. Run the shadcn CLI to add or update components. +- Import from `@/components/ui/`. +- The configured style is `radix-nova` with `neutral` base color and CSS variables. +- Icon library is `lucide-react` — always use Lucide icons, not other icon libraries. + +### Available components + +`alert-dialog`, `alert`, `avatar`, `badge`, `button`, `card`, `checkbox`, `combobox`, `command`, `dialog`, `dropdown-menu`, `form`, `input`, `label`, `pagination`, `popover`, `scroll-area`, `select`, `separator`, `sheet`, `sidebar`, `skeleton`, `sonner`, `table`, `tabs`, `textarea`, `toast`, `tooltip` + +### Usage patterns + +```tsx +import { Button } from "@/components/ui/button"; +import { + Dialog, + DialogContent, + DialogHeader, + DialogTitle, +} from "@/components/ui/dialog"; +import { Badge } from "@/components/ui/badge"; +import { toast } from "sonner"; // notifications via Sonner, not the legacy toast hook +``` + +- Use `` for loading states, not spinners. +- Use `` for status tags (e.g., pending/approved/rejected). +- Use `` for confirmations and detail views; `` for side panels. +- Toast notifications: use `toast.success(...)`, `toast.error(...)` from `sonner` — not `useToast()`. diff --git a/.github/instructions/nextjs-tailwind.instructions.md b/.github/instructions/nextjs-tailwind.instructions.md new file mode 100644 index 00000000..ffc43781 --- /dev/null +++ b/.github/instructions/nextjs-tailwind.instructions.md @@ -0,0 +1,72 @@ +--- +description: 'Next.js + Tailwind development standards and instructions' +applyTo: '**/*.tsx, **/*.ts, **/*.jsx, **/*.js, **/*.css' +--- + +# Next.js + Tailwind Development Instructions + +Instructions for high-quality Next.js applications with Tailwind CSS styling and TypeScript. + +## Project Context + +- Latest Next.js (App Router) +- TypeScript for type safety +- Tailwind CSS for styling + +## Development Standards + +### Architecture +- App Router with server and client components +- Group routes by feature/domain +- Implement proper error boundaries +- Use React Server Components by default +- Leverage static optimization where possible + +### TypeScript +- Strict mode enabled +- Clear type definitions +- Proper error handling with type guards +- Zod for runtime type validation + +### Styling +- Tailwind CSS with consistent color palette +- Responsive design patterns +- Dark mode support +- Follow container queries best practices +- Maintain semantic HTML structure + +### State Management +- React Server Components for server state +- React hooks for client state +- Proper loading and error states +- Optimistic updates where appropriate + +### Data Fetching +- Server Components for direct database queries +- React Suspense for loading states +- Proper error handling and retry logic +- Cache invalidation strategies + +### Security +- Input validation and sanitization +- Proper authentication checks +- CSRF protection +- Rate limiting implementation +- Secure API route handling + +### Performance +- Image optimization with next/image +- Font optimization with next/font +- Route prefetching +- Proper code splitting +- Bundle size optimization + +## Implementation Process +1. Plan component hierarchy +2. Define types and interfaces +3. Implement server-side logic +4. Build client components +5. Add proper error handling +6. Implement responsive styling +7. Add loading states +8. Write tests diff --git a/.github/workflows/branch-naming.yml b/.github/workflows/branch-naming.yml new file mode 100644 index 00000000..375589b0 --- /dev/null +++ b/.github/workflows/branch-naming.yml @@ -0,0 +1,47 @@ +# Enforcing Branch Naming Convention + +name: Branch Naming Convention +run-name: "Evaluate new branch [${{ github.ref_name }}]" +on: + create: + branches: + - "**" + +permissions: + contents: write + +jobs: + check-branch-name: + runs-on: ubuntu-latest + steps: + - name: Check branch name + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + BRANCH="${{ github.ref_name }}" + + # Branches exempt from naming rules + EXEMPT="^(main|dev|dev-stage|staging|develop)$" + if echo "$BRANCH" | grep -Eq "$EXEMPT"; then + echo "✅ Exempt branch '$BRANCH' — skipping check" + exit 0 + fi + + # Your naming convention regex + PATTERN="^(fe|be|infra|config)\/(feat|fix|hotfix|docs|refactor|chore|release)\/[a-z0-9][a-z0-9\-]+$" + + if echo "$BRANCH" | grep -Eq "$PATTERN"; then + echo "✅ Branch name '$BRANCH' is valid" + else + echo "❌ Branch name '$BRANCH' does not match naming convention" + echo "" + echo "Expected format: //" + echo "Areas: fe | be | infra | config" + echo "Types: feat | fix | hotfix | docs | refactor | chore | release" + echo "Example: fe/feat/ed-110 or be/fix/ed-45" + echo "" + echo "Deleting invalid branch..." + ENCODED_BRANCH=$(python3 -c 'import urllib.parse, sys; print(urllib.parse.quote(sys.argv[1]))' "$BRANCH") + gh api -X DELETE "repos/${{ github.repository }}/git/refs/heads/${ENCODED_BRANCH}" + exit 1 + fi diff --git a/README.md b/README.md index b4aa6586..3dc5d09a 100644 --- a/README.md +++ b/README.md @@ -1 +1,738 @@ -# Digital-Logbook \ No newline at end of file +
+ +# 📚 Digital-Logbook + +### A Modern Mentorship & Learning Management Platform + +[![Next.js](https://img.shields.io/badge/Next.js-14.2.5-black?logo=next.js)](https://nextjs.org/) +[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue?logo=typescript)](https://www.typescriptlang.org/) +[![Prisma](https://img.shields.io/badge/Prisma-5.19.1-2D3748?logo=prisma)](https://www.prisma.io/) +[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16.3-316192?logo=postgresql)](https://www.postgresql.org/) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE) + +[Features](#-features) • [Tech Stack](#-tech-stack) • [Quick Start](#-quick-start) • [Documentation](#-documentation) • [Contributing](#-contributing) + +
+ +--- + +## 📖 Table of Contents + +- [Overview](#-overview) +- [Features](#-features) +- [Tech Stack](#-tech-stack) +- [Prerequisites](#-prerequisites) +- [Quick Start](#-quick-start) +- [Installation](#-installation) +- [Environment Variables](#-environment-variables) +- [Database Setup](#-database-setup) +- [Project Structure](#-project-structure) +- [Available Scripts](#-available-scripts) +- [API Documentation](#-api-documentation) +- [Testing](#-testing) +- [Deployment](#-deployment) +- [Troubleshooting](#-troubleshooting) +- [Documentation](#-documentation) +- [Contributing](#-contributing) +- [License](#-license) + +--- + +## 🌟 Overview + +**Digital-Logbook** is a comprehensive full-stack web application designed to facilitate structured learning relationships between mentees and mentors. It provides a robust platform for tracking learning activities, managing projects, delivering feedback, and generating performance reports. + +### What Problem Does It Solve? + +- **Activity Tracking**: Students log daily learning activities with time spent and technologies used +- **Mentor Oversight**: Mentors review student progress and provide timely, structured feedback +- **Project Management**: Organize learning across multiple domains (software, film, training, research) +- **Performance Analytics**: Generate detailed reports on mentor activities and student progress +- **User Administration**: Streamlined user management, invitations, and role-based access control +- **Gamification**: Award badges to recognize and motivate student achievements + +### Who Is It For? + +- **Students/Mentees**: Track learning progress, receive feedback, and earn recognition +- **Mentors**: Monitor mentees, provide feedback, and log mentoring activities +- **Super Admins**: Manage users, projects, invitations, and platform analytics + +--- + +## ✨ Features + +### For Students + +- 📝 **Activity Logging** - Log daily activities with time tracking and technology tags +- 📊 **Progress Dashboard** - Visualize learning progress and performance metrics +- 🏆 **Gamification** - Earn badges for achievements and milestones +- 👤 **Profile Management** - Manage personal information and learning preferences +- 📅 **Task Calendar** - Calendar view of activities and deadlines + +### For Mentors + +- 👥 **Mentee Management** - View and manage assigned students +- ✅ **Feedback System** - Approve, reject, or provide feedback on student activities +- 📈 **Bulk Reporting** - Generate comprehensive reports (PDF/Excel export) +- 📅 **Activity Calendar** - Calendar view of all mentee activities +- ⏱️ **Time Tracking** - Log mentoring hours and activities + +### For Super Admins + +- 🎯 **Project Management** - Create and manage projects across multiple domains +- 👤 **User Management** - Create, deactivate, and manage user roles +- 📧 **Bulk Invitations** - Send and track email invitations with unique tokens +- 📊 **Analytics Dashboard** - Platform-wide analytics and insights +- 🏆 **Badge Management** - Create and award achievement badges +- ⚠️ **Warning System** - Flag and monitor concerning activity patterns +- 📄 **Report Management** - View and manage generated reports + +### Cross-Platform Features + +- 🔐 **JWT Authentication** - Secure token-based authentication +- 🎨 **Modern UI** - Beautiful, responsive interface with TailwindCSS +- 🚀 **Type-Safe APIs** - End-to-end type safety with oRPC +- 📱 **Responsive Design** - Mobile-friendly interface +- 🌙 **Dark Mode Support** - Theme switching capability +- 📧 **Email Notifications** - Automated email notifications via Nodemailer +- 🔄 **Background Jobs** - Async task processing with BullMQ + +--- + +## 🛠️ Tech Stack + +### Frontend + +| Technology | Version | Purpose | +| ----------------------------------------------- | ------- | ------------------------------- | +| [Next.js](https://nextjs.org/) | 14.2.5 | React framework with SSR/SSG | +| [React](https://react.dev/) | 18.x | UI library | +| [TypeScript](https://www.typescriptlang.org/) | 5.x | Type-safe JavaScript | +| [TailwindCSS](https://tailwindcss.com/) | Latest | Utility-first CSS framework | +| [Radix UI](https://www.radix-ui.com/) | Latest | Accessible component primitives | +| [shadcn/ui](https://ui.shadcn.com/) | Latest | Re-usable component library | +| [React Hook Form](https://react-hook-form.com/) | 7.x | Form validation | +| [Zod](https://zod.dev/) | 3.x | Schema validation | +| [TanStack Query](https://tanstack.com/query) | v5 | Data fetching & caching | + +### Backend + +| Technology | Version | Purpose | +| --------------------------------------------------------------------- | ------- | ------------------------- | +| [Next.js API Routes](https://nextjs.org/docs/api-routes/introduction) | 14.2.5 | API endpoints | +| [oRPC](https://orpc.io/) | 1.13.14 | Type-safe RPC framework | +| [Prisma](https://www.prisma.io/) | 5.19.1 | ORM for database access | +| [PostgreSQL](https://www.postgresql.org/) | 16.3 | Relational database | +| [Redis](https://redis.io/) | Latest | Caching & job queue | +| [BullMQ](https://docs.bullmq.io/) | 5.x | Background job processing | +| [Jose](https://github.com/panva/jose) | 5.x | JWT token handling | +| [bcrypt](https://github.com/kelektiv/node.bcrypt.js) | 5.x | Password hashing | +| [Nodemailer](https://nodemailer.com/) | 6.x | Email sending | + +### DevOps & Tools + +| Technology | Version | Purpose | +| -------------------------------------------------- | ------- | ----------------------------- | +| [Docker](https://www.docker.com/) | 27.1.2+ | Containerization | +| [Docker Compose](https://docs.docker.com/compose/) | Latest | Multi-container orchestration | +| [Jest](https://jestjs.io/) | Latest | Testing framework | +| [ESLint](https://eslint.org/) | Latest | Code linting | +| [Prettier](https://prettier.io/) | Latest | Code formatting | + +--- + +## 📋 Prerequisites + +Before you begin, ensure you have the following installed: + +- **Node.js**: `v22.7.0` (use [nvm](https://github.com/nvm-sh/nvm) for version management) +- **npm**: `10.8.2` +- **Docker**: `27.1.2+` ([Install Docker](https://docs.docker.com/get-docker/)) +- **Docker Compose**: Latest version +- **Git**: Latest version + +> **Note**: Using the exact Node.js and npm versions is crucial for compatibility. + +--- + +## 🚀 Quick Start + +Get up and running in 5 minutes: + +```bash +# 1. Clone the repository +git clone https://github.com/tracet2t/Digital-Logbook.git +cd Digital-Logbook + +# 2. Navigate to server directory +cd server + +# 3. Use the correct Node.js version +nvm use +# If not installed, run: nvm install + +# 4. Install npm version +npm install npm@10.8.2 + +# 5. Install dependencies +npm install + +# 6. Start Docker containers (from root directory) +cd .. +docker compose up --build + +# 7. Return to server directory +cd server + +# 8. Run database migrations +npm run migrate:maindb + +# 9. Seed the database (optional) +npm run seed + +# 10. Start the development server +npm run dev + +# 11. Open your browser +# Application: http://localhost:3000 +# PgAdmin: http://localhost:8080 +``` + +--- + +## 💻 Installation + +### Step 1: Clone the Repository + +```bash +git clone https://github.com/tracet2t/Digital-Logbook.git +cd Digital-Logbook +``` + +### Step 2: Set Up Node.js Environment + +```bash +cd server + +# Install Node Version Manager (if not already installed) +# https://github.com/nvm-sh/nvm#installing-and-updating + +# Use the required Node.js version +nvm use + +# If the version is not installed +nvm install + +# Install the correct npm version +npm install npm@10.8.2 +``` + +### Step 3: Install Dependencies + +```bash +npm install +``` + +### Step 4: Configure Environment Variables + +Create a `.env` file in the `server/` directory: + +```bash +cp dotenv .env +``` + +Edit `.env` with your configuration (see [Environment Variables](#-environment-variables) section). + +--- + +## 🔐 Environment Variables + +Create a `.env` file in the `server/` directory with the following variables: + +```env +# Database Configuration +DATABASE_URL="postgresql://postgres:your-db-password@pgdb:5432/postgres?schema=public" +NEXT_PUBLIC_POSTGRES_HOST=pgdb +NEXT_PUBLIC_POSTGRES_USER=postgres +NEXT_PUBLIC_POSTGRES_PASSWORD=your-db-password + +# Redis Configuration (for job queue) +NEXT_PUBLIC_REDIS_HOST=redis +NEXT_PUBLIC_REDIS_PORT=6379 + +# Authentication +JWT_SECRET=your-super-secret-jwt-key-min-32-characters +BASE_URL=http://localhost:3000 + +# Email Configuration (SMTP) +SMTP_HOST=smtp.example.com +SMTP_PORT=587 +SMTP_USER=your-email@example.com +SMTP_PASSWORD=your-email-password +SMTP_FROM=noreply@example.com + +# Application Configuration +NODE_ENV=development +``` + +> ⚠️ **Security Warning**: Never commit your `.env` file to version control. The `.env` file is already in `.gitignore`. + +### Environment Variable Descriptions + +| Variable | Description | Example | +| --------------- | ----------------------------------------------- | ------------------------------------- | +| `DATABASE_URL` | PostgreSQL connection string | `postgresql://user:pass@host:5432/db` | +| `JWT_SECRET` | Secret key for JWT token signing (min 32 chars) | `your-super-secret-key` | +| `BASE_URL` | Application base URL | `http://localhost:3000` | +| `SMTP_HOST` | SMTP server hostname | `smtp.gmail.com` | +| `SMTP_PORT` | SMTP server port | `587` or `465` | +| `SMTP_USER` | SMTP username/email | `your-email@example.com` | +| `SMTP_PASSWORD` | SMTP password | `your-app-password` | + +--- + +## 🗄️ Database Setup + +### Using Docker (Recommended) + +The project uses Docker Compose to manage PostgreSQL, Redis, and pgAdmin: + +```bash +# From project root directory +# First time setup +docker compose up --build + +# Subsequent runs +docker compose up +``` + +This will start: + +- **PostgreSQL** on `localhost:5432` +- **Redis** on `localhost:6379` +- **pgAdmin** on `localhost:8080` (admin@example.com / admin) + +### Run Migrations + +```bash +cd server +npm run migrate:maindb +``` + +### Seed Database (Optional) + +```bash +npm run seed +``` + +### Database Tools + +```bash +# Open Prisma Studio (visual database editor) +npm run db:studio + +# Reset database (⚠️ deletes all data) +npm run db:delete +``` + +--- + +## 📁 Project Structure + +``` +Digital-Logbook/ +├── server/ # Main application directory +│ ├── src/ +│ │ ├── app/ # Next.js pages & layouts +│ │ │ ├── admin/ # Super admin pages +│ │ │ ├── mentor/ # Mentor pages +│ │ │ ├── student/ # Student pages +│ │ │ └── login/ # Authentication pages +│ │ ├── components/ # React components +│ │ │ ├── admin/ # Admin-specific components +│ │ │ ├── mentor/ # Mentor-specific components +│ │ │ └── ui/ # Shared UI components (shadcn/ui) +│ │ ├── routers/ # oRPC API routers +│ │ ├── repositories/ # Data access layer (Prisma) +│ │ ├── services/ # Business logic +│ │ ├── server_actions/ # Next.js Server Actions +│ │ ├── middlewares/ # Authentication & routing middleware +│ │ ├── schemas/ # Zod validation schemas +│ │ ├── types/ # TypeScript type definitions +│ │ ├── utils/ # Utility functions +│ │ ├── lib/ # Library configurations +│ │ └── worker/ # Background job workers (BullMQ) +│ ├── prisma/ +│ │ ├── schema.prisma # Database schema +│ │ ├── seed.mjs # Database seeding script +│ │ └── migrations/ # Database migrations +│ ├── public/ # Static assets +│ ├── test/ # Test files +│ └── package.json # Dependencies & scripts +├── docs/ # Documentation +│ ├── api/ # API documentation +│ ├── QA-Testcases/ # Test cases +│ └── schema/ # Database schema docs +├── init/ # Database initialization scripts +├── docker-compose.yml # Docker services configuration +└── README.md # This file +``` + +--- + +## 📜 Available Scripts + +Navigate to the `server/` directory and run: + +| Script | Command | Description | +| ------------------- | ------------------------ | ------------------------------------- | +| **Development** | `npm run dev` | Start development server on port 3000 | +| **Build** | `npm run build` | Build production bundle | +| **Start** | `npm start` | Start production server | +| **Lint** | `npm run lint` | Run ESLint | +| **Test** | `npm test` | Run Jest tests | +| **Prisma Generate** | `npm run generate` | Generate Prisma Client | +| **Migrate DB** | `npm run migrate:maindb` | Run database migrations | +| **Migrate Test DB** | `npm run migrate:testdb` | Run test database migrations | +| **Seed DB** | `npm run seed` | Seed database with initial data | +| **Prisma Studio** | `npm run db:studio` | Open Prisma Studio (DB GUI) | +| **Reset DB** | `npm run db:delete` | Reset database (⚠️ deletes all data) | + +--- + +## 📚 API Documentation + +### oRPC Framework + +This project uses [oRPC](https://orpc.io/) for type-safe API development. oRPC provides: + +- End-to-end type safety +- Automatic OpenAPI schema generation +- Runtime validation with Zod +- React Query integration + +### API Routes + +API routers are located in `server/src/routers/`: + +- **Authentication**: User login, registration, password reset +- **Projects**: CRUD operations for projects +- **Invitations**: Bulk invitations and invitation management +- **Activities**: Student activity logging and retrieval +- **Feedback**: Mentor feedback on student activities +- **Reports**: Report generation and management +- **Users**: User management (admin) +- **Badges**: Badge creation and awarding + +### Documentation Links + +- [API Registration & Authentication](./docs/api/API_Registration.md) +- [API Projects](./docs/api/API_PROJECTS.md) +- [API Invitations](./docs/api/API_INVITATIONS.md) +- [oRPC Beginner Guide](./server/ORPC_BEGINNER_GUIDE.md) +- [oRPC Quick Reference](./server/ORPC_QUICK_REFERENCE.md) +- [oRPC Implementation Explanation](./server/ORPC_IMPLEMENTATION_EXPLANATION.md) + +--- + +## 🧪 Testing + +The project uses **Jest** for unit and integration testing. + +### Run Tests + +```bash +cd server + +# Run all tests +npm test + +# Run tests for specific file +npm test -- invitationRepository.test.ts + +# Run tests in watch mode +npm test -- --watch +``` + +### Test Coverage + +Test files are located in `server/test/`: + +- `invitationRepository.test.ts` - Invitation repository tests +- `menteeTechnologyRepository.test.ts` - Technology repository tests +- `preliminaries.test.ts` - Preliminary setup tests +- `studentTaskTechnologiesRoute.test.ts` - Route tests + +### Test Documentation + +Comprehensive test cases are documented in [docs/QA-Testcases/](./docs/QA-Testcases/): + +- [Admin Dashboard Component](./docs/QA-Testcases/ADMIN_DASHBOARD_COMPONENT.md) +- [Project Component](./docs/QA-Testcases/PROJECT_COMPONENT.md) +- [User Component](./docs/QA-Testcases/USER_COMPONENT.md) +- [Report Component](./docs/QA-Testcases/REPORT_COMPONENT.md) +- [Invitation Repository](./docs/QA-Testcases/INVITATION_REPOSITORY.md) +- [Overall Admin Module](./docs/QA-Testcases/OVERALL_ADMIN_MODULE_TESTCASES.md) + +--- + +## 🚢 Deployment + +### Docker Deployment + +The application is containerized and can be deployed using Docker: + +```bash +# Build and start all services +docker compose up --build -d + +# View logs +docker compose logs -f nextjs-app + +# Stop services +docker compose down + +# Stop and remove volumes (⚠️ deletes data) +docker compose down -v +``` + +### Production Considerations + +1. **Environment Variables**: Use production values for all sensitive variables +2. **Database**: Use managed PostgreSQL service (e.g., AWS RDS, Supabase) +3. **Redis**: Use managed Redis service (e.g., Redis Cloud, AWS ElastiCache) +4. **Secrets Management**: Use environment variable managers (e.g., AWS Secrets Manager) +5. **SSL/TLS**: Enable HTTPS with valid SSL certificates +6. **Monitoring**: Set up logging and monitoring (e.g., Sentry, DataDog) +7. **Backups**: Configure automated database backups + +### Recommended Platforms + +- [Vercel](https://vercel.com/) - Next.js optimized deployment +- [Railway](https://railway.app/) - Full-stack deployment +- [AWS](https://aws.amazon.com/) - EC2, ECS, or App Runner +- [DigitalOcean](https://www.digitalocean.com/) - App Platform or Droplets + +--- + +## 🔧 Troubleshooting + +### Common Issues + +#### Port Already in Use + +```bash +# Find and kill process using port 3000 +lsof -ti:3000 | xargs kill -9 + +# Or change port in package.json dev script +"dev": "next dev -p 3001" +``` + +#### Docker Issues + +```bash +# Restart Docker services +docker compose down +docker compose up --build + +# Clean Docker cache +docker system prune -a +``` + +#### Database Connection Issues + +1. Ensure Docker containers are running: `docker compose ps` +2. Check `DATABASE_URL` in `.env` file +3. Verify PostgreSQL container health: `docker logs pgdb` + +#### Prisma Client Issues + +```bash +# Regenerate Prisma Client +npm run generate + +# Reset and regenerate +npm run db:delete +npm run migrate:maindb +npm run generate +``` + +#### Node Version Mismatch + +```bash +# Ensure correct Node.js version +nvm use + +# If not installed +nvm install 22.7.0 +nvm use 22.7.0 +``` + +#### Module Not Found Errors + +```bash +# Clear node_modules and reinstall +rm -rf node_modules package-lock.json +npm install +``` + +--- + +## 📖 Documentation + +Comprehensive documentation is available in the [`docs/`](./docs/) directory: + +### Setup & Installation + +- [Environment Setup Guide](./docs/README.md) + +### Feature Guides + +- [Bulk Invitation Guide](./docs/BULK_INVITATION_GUIDE.md) +- [Shared Components Guide](./docs/shared-components-guide.md) + +### API Documentation + +- [Authentication & Registration API](./docs/api/API_Registration.md) +- [Projects API](./docs/api/API_PROJECTS.md) +- [Invitations API](./docs/api/API_INVITATIONS.md) + +### Developer Guides + +- [oRPC Beginner Guide](./server/ORPC_BEGINNER_GUIDE.md) +- [oRPC Quick Reference](./server/ORPC_QUICK_REFERENCE.md) +- [oRPC Implementation Details](./server/ORPC_IMPLEMENTATION_EXPLANATION.md) + +### Database + +- [Database Schema Documentation](./docs/schema/README.md) + +### Testing + +- [QA Test Cases](./docs/QA-Testcases/) + +--- + +## 🤝 Contributing + +We welcome contributions! Here's how you can help: + +### Development Workflow + +1. **Fork the repository** +2. **Create a feature branch** + ```bash + git checkout -b feature/your-feature-name + ``` +3. **Make your changes** + - Follow existing code style + - Add tests for new features + - Update documentation as needed +4. **Run tests** + ```bash + npm test + npm run lint + ``` +5. **Commit your changes** + ```bash + git commit -m "feat: add amazing feature" + ``` +6. **Push to your fork** + ```bash + git push origin feature/your-feature-name + ``` +7. **Create a Pull Request** + +### Code Style Guidelines + +- **TypeScript**: Use strict type checking +- **Components**: Follow React best practices +- **Naming**: Use descriptive variable and function names +- **Comments**: Add JSDoc comments for complex functions +- **Formatting**: Run Prettier before committing +- **Testing**: Write tests for new features + +### Commit Message Convention + +Follow [Conventional Commits](https://www.conventionalcommits.org/): + +- `feat:` - New feature +- `fix:` - Bug fix +- `docs:` - Documentation changes +- `style:` - Code style changes (formatting, etc.) +- `refactor:` - Code refactoring +- `test:` - Adding or updating tests +- `chore:` - Maintenance tasks + +### Project Structure Conventions + +- **Components**: Place in appropriate domain folder (`admin/`, `mentor/`, `student/`) +- **Routers**: Use oRPC router pattern +- **Repositories**: Follow repository pattern for data access +- **Schemas**: Define Zod schemas for validation +- **Types**: Add TypeScript interfaces in `types/` directory + +--- + +## 📄 License + +This project is licensed under the **MIT License** - see the [LICENSE](./LICENSE) file for details. + +``` +MIT License + +Copyright (c) 2024 tracet2t + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +``` + +--- + +## 🙏 Acknowledgments + +- [Next.js](https://nextjs.org/) - The React Framework +- [Prisma](https://www.prisma.io/) - Next-generation ORM +- [oRPC](https://orpc.io/) - Type-safe RPC framework +- [shadcn/ui](https://ui.shadcn.com/) - Beautiful UI components +- [Radix UI](https://www.radix-ui.com/) - Accessible component primitives +- [TailwindCSS](https://tailwindcss.com/) - Utility-first CSS framework + +--- + +## 📞 Support + +For questions, issues, or feature requests: + +- **Issues**: [GitHub Issues](https://github.com/tracet2t/Digital-Logbook/issues) +- **Discussions**: [GitHub Discussions](https://github.com/tracet2t/Digital-Logbook/discussions) + +--- + +## © Copyright & Rights + +**All rights reserved © 2024-2026 Tracet2t** + +This project and all associated intellectual property, including but not limited to source code, documentation, design, and trademarks, are the exclusive property of **Tracet2t**. + +While this software is licensed under the MIT License (see [LICENSE](./LICENSE) file), all rights not expressly granted by the license are reserved by Tracet2t. + +--- + +
+ +Made with ❤️ by [Tracet2t](https://github.com/tracet2t) + +**© 2024-2026 Tracet2t. All Rights Reserved.** + +⭐ Star this repository if you find it helpful! + +
diff --git a/docker-compose.yml b/docker-compose.yml index 5fe5ed96..ba18d389 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,4 +1,4 @@ -version: '3.8' +version: "3.8" services: postgres: @@ -14,7 +14,7 @@ services: networks: - mynetwork healthcheck: - test: [ "CMD-SHELL", "pg_isready -U postgres" ] + test: ["CMD-SHELL", "pg_isready -U postgres"] interval: 5s timeout: 5s retries: 5 diff --git a/mk_docs/developer_docs/docs/api/auth.md b/mk_docs/developer_docs/docs/api/auth.md new file mode 100644 index 00000000..b4bdf464 --- /dev/null +++ b/mk_docs/developer_docs/docs/api/auth.md @@ -0,0 +1,131 @@ +# Authentication API + +The authentication endpoints handle user login and registration. These are the **only endpoints that don't require a JWT** — they're how users get their JWT in the first place. + +--- + +## POST `/api/(auth)/login` + +Authenticates a user with their email and password. On success, sets a JWT token in an HTTP-only cookie. + +### Request + +- **Content-Type:** `multipart/form-data` + +| Field | Type | Required | Description | +|---|---|---|---| +| `email` | string | ✅ | User's registered email address | +| `password` | string | ✅ | User's password | + +### Response + +```json +{ + "message": "Login successful", + "redirectUrl": "/admin" +} +``` + +The response also sets a **JWT cookie** (`token`) used for all subsequent authenticated requests. + +| Field | Description | +|---|---| +| `message` | Status message | +| `redirectUrl` | Where to redirect the user based on their role | + +### Error Responses + +| Status | Message | Cause | +|---|---|---| +| `400` | `"Email and password are required"` | Missing fields | +| `401` | `"Invalid email or password"` | Wrong credentials | +| `403` | `"Account is inactive"` | User's account has been deactivated | + +### Example (Fetch API) + +```javascript +const formData = new FormData(); +formData.append('email', 'admin@example.com'); +formData.append('password', 'mypassword'); + +const response = await fetch('/api/(auth)/login', { + method: 'POST', + body: formData, + credentials: 'include', // ← Important: needed to receive the cookie +}); +``` + +--- + +## POST `/api/(auth)/register` + +Registers a new user using a valid invitation token. This is how new students and mentors join the platform. + +### Request + +- **Content-Type:** `application/json` + +| Field | Type | Required | Description | +|---|---|---|---| +| `token` | string | ✅ | The invitation token from the email link | +| `firstName` | string | ✅ | User's first name | +| `lastName` | string | ✅ | User's last name | +| `password` | string | ✅ | User's chosen password | + +```json +{ + "token": "abc123...", + "firstName": "Jane", + "lastName": "Doe", + "password": "SecurePass123" +} +``` + +### Response + +```json +{ + "message": "Registration successful", + "redirectUrl": "/student/dashboard", + "user": { + "id": "uuid", + "email": "jane@example.com", + "role": "student", + "firstName": "Jane", + "lastName": "Doe" + } +} +``` + +Also sets a **JWT cookie** like the login endpoint. + +### Error Responses + +| Status | Message | Cause | +|---|---|---| +| `400` | `"Invalid or expired token"` | Token is missing, used, or expired | +| `400` | `"All fields are required"` | Missing form fields | +| `409` | `"User already registered"` | Email already has an account | + +--- + +## How the JWT Works + +After a successful login or registration: + +1. A JWT is signed using `JWT_SECRET` from `.env` +2. The token is stored in an **HTTP-only cookie** (not accessible to JavaScript) +3. The token contains the user's `id`, `role`, `email`, and expiry +4. Every subsequent request automatically sends this cookie +5. The middleware validates the cookie on each protected route + +!!! tip "Token Expiry" + Tokens expire after the duration set in `JWT_EXPIRY` (default: `1d`). After expiry, the user is redirected to the login page. + +--- + +## Related Pages + +- [Special Logic & Middleware](../special-logic.md) — How auth middleware works +- [Invitations API](invitations.md) — How invitation tokens are created +- [Environment Setup](../getting-started/environment.md) — JWT_SECRET and JWT_EXPIRY config diff --git a/mk_docs/developer_docs/docs/api/invitations.md b/mk_docs/developer_docs/docs/api/invitations.md new file mode 100644 index 00000000..9df587d1 --- /dev/null +++ b/mk_docs/developer_docs/docs/api/invitations.md @@ -0,0 +1,173 @@ +# Invitations API + +Manage user invitations. Invitations are the primary way new users join the platform. + +!!! note "Auth Required" + All endpoints (except token validation by invited users) require a valid JWT cookie. + +--- + +## POST `/api/invitations` + +Send an invitation email to a new user. + +**Auth:** Super Admin only + +### Request Body + +```json +{ + "email": "jane.doe@example.com", + "firstName": "Jane", + "lastName": "Doe", + "role": "student", + "projectId": "project-uuid" +} +``` + +| Field | Type | Required | Description | +|---|---|---|---| +| `email` | string | ✅ | Email address to invite | +| `firstName` | string | ✅ | Invitee's first name | +| `lastName` | string | ✅ | Invitee's last name | +| `role` | string | ✅ | Role to assign: `student`, `mentor`, or `superAdmin` | +| `projectId` | string | ❌ | Pre-assign the user to a project | + +### Response + +```json +{ + "id": "invitation-uuid", + "email": "jane.doe@example.com", + "role": "student", + "status": "Pending", + "expiresAt": "2026-02-15T10:00:00Z", + "createdAt": "2026-01-15T10:00:00Z" +} +``` + +!!! tip "What happens after sending?" + The system generates a secure token, stores the invitation, and sends an email to the invitee with a registration link. + +--- + +## GET `/api/invitations` + +List all invitations **or** validate an invitation token. + +### List All Invitations + +``` +GET /api/invitations +``` + +**Auth:** Super Admin only + +**Response:** Array of invitation objects: + +```json +[ + { + "id": "uuid", + "email": "jane@example.com", + "role": "student", + "status": "Pending", + "accepted": false, + "expiresAt": "2026-02-15T10:00:00Z", + "createdAt": "2026-01-15T10:00:00Z" + } +] +``` + +### Validate an Invitation Token + +``` +GET /api/invitations?token= +``` + +Used during registration — validates whether the token is still valid. + +**Auth:** Not required (public endpoint for invitees) + +**Response:** +```json +{ + "valid": true, + "email": "jane@example.com", + "role": "student", + "expiresAt": "2026-02-15T10:00:00Z" +} +``` + +--- + +## PATCH `/api/invitations` + +Update the status of an invitation manually. + +**Auth:** Super Admin only + +### Request Body + +```json +{ + "id": "invitation-uuid", + "status": "Expired" +} +``` + +| Field | Type | Required | Description | +|---|---|---|---| +| `id` | string | ✅ | The invitation ID | +| `status` | string | ✅ | New status: `Accepted`, `Pending`, or `Expired` | + +### Response + +```json +{ + "message": "Invitation status updated" +} +``` + +--- + +## DELETE `/api/invitations?id=` + +Delete an invitation and cascade-delete associated user data. + +**Auth:** Super Admin only + +``` +DELETE /api/invitations?id= +``` + +### Response + +```json +{ + "message": "Invitation deleted" +} +``` + +!!! warning "Cascade Delete" + Deleting an invitation will also remove the associated user account and all related data (activities, feedback, etc.). This action is irreversible. + +--- + +## Error Responses + +| Status | Message | Cause | +|---|---|---| +| `400` | `"Email is required"` | Missing required field | +| `400` | `"Invalid or expired token"` | Token validation failed | +| `403` | `"Access denied"` | Not a super admin | +| `404` | `"Invitation not found"` | Invalid ID | +| `409` | `"Invitation already sent to this email"` | Duplicate invitation | + +--- + +## Related Pages + +- [Invitations Feature](../features/invitations.md) — How invitations work end-to-end +- [Bulk Upload Feature](../features/bulk-upload.md) — Inviting multiple users at once +- [Authentication API](auth.md) — How users register using an invitation token diff --git a/mk_docs/developer_docs/docs/api/overview.md b/mk_docs/developer_docs/docs/api/overview.md new file mode 100644 index 00000000..c96d852c --- /dev/null +++ b/mk_docs/developer_docs/docs/api/overview.md @@ -0,0 +1,88 @@ +# API Overview + +This page gives you a high-level view of all available API endpoints in Digital Logbook. + +--- + +## Authentication + +All API endpoints (except `/api/(auth)/login` and `/api/(auth)/register`) require a valid **JWT token**. + +The token is automatically stored in an **HTTP-only cookie** after login — you don't need to manually attach it to requests from the browser. + +!!! warning "JWT Required" + Direct API calls (e.g., from Postman or scripts) must include the JWT as a cookie or `Authorization: Bearer ` header. + +--- + +## Base URL + +``` +http://localhost:3000 +``` + +In production, replace with your deployed domain. + +--- + +## Endpoint Summary + +| Method | Endpoint | Description | Auth Required | +|---|---|---|---| +| `POST` | `/api/(auth)/login` | Log in and receive a JWT cookie | ❌ No | +| `POST` | `/api/(auth)/register` | Register via invitation token | ❌ No | +| `GET` | `/api/project` | List all projects | ✅ Yes | +| `POST` | `/api/project` | Create a new project | ✅ Admin only | +| `PATCH` | `/api/project` | Assign student/mentor to project | ✅ Admin only | +| `DELETE` | `/api/project` | Remove student/mentor from project | ✅ Admin only | +| `GET` | `/api/invitations` | List invitations or validate token | ✅ Yes | +| `POST` | `/api/invitations` | Send a new invitation | ✅ Admin only | +| `PATCH` | `/api/invitations` | Update invitation status | ✅ Admin only | +| `DELETE` | `/api/invitations` | Delete an invitation (cascade) | ✅ Admin only | +| `GET` | `/api/users` | List all users | ✅ Admin only | +| `PATCH` | `/api/users` | Update user status/details | ✅ Admin only | +| `GET` | `/api/reports` | List reports | ✅ Admin/Mentor | +| `POST` | `/api/reports` | Generate a new report | ✅ Mentor only | + +--- + +## Response Format + +All API responses follow a consistent format: + +**Success:** +```json +{ + "success": true, + "message": "Operation completed successfully", + "data": { } +} +``` + +**Error:** +```json +{ + "success": false, + "message": "A human-readable error message" +} +``` + +--- + +## Roles & Permissions + +| Role | Access Level | +|---|---| +| **super_admin** | Full access — manage users, projects, invitations, reports | +| **mentor** | Read-only access to their mentees; can generate reports | +| **student** | Access to their own activities and assigned projects only | + +--- + +## Detailed Endpoint Docs + +- [Authentication API](auth.md) +- [Projects API](projects.md) +- [Invitations API](invitations.md) +- [Users API](users.md) +- [Reports API](reports.md) diff --git a/mk_docs/developer_docs/docs/api/projects.md b/mk_docs/developer_docs/docs/api/projects.md new file mode 100644 index 00000000..b9f35de2 --- /dev/null +++ b/mk_docs/developer_docs/docs/api/projects.md @@ -0,0 +1,167 @@ +# Projects API + +Manage projects on the platform. Only **Super Admins** can create, update, or delete projects. + +!!! note "Auth Required" + All endpoints require a valid JWT cookie. See [Authentication](auth.md) for details. + +--- + +## POST `/api/project` + +Create a new project. + +**Auth:** Super Admin only + +### Request Body + +```json +{ + "name": "Mobile App Development", + "description": "A project focused on building cross-platform mobile apps.", + "domain": "software" +} +``` + +| Field | Type | Required | Description | +|---|---|---|---| +| `name` | string | ✅ | Project name | +| `description` | string | ❌ | Short description of the project | +| `domain` | string | ✅ | One of: `software`, `film`, `training`, `research`, `other` | + +### Response + +```json +{ + "success": true, + "message": "Project created successfully", + "data": { + "id": "uuid", + "name": "Mobile App Development", + "domain": "software", + "createdAt": "2026-01-15T10:00:00Z" + } +} +``` + +--- + +## GET `/api/project` + +Retrieve all projects, a single project by ID, or view a project's assigned members. + +### Get All Projects + +``` +GET /api/project +``` + +**Response:** +```json +[ + { + "id": "uuid", + "name": "Mobile App Development", + "description": "...", + "domain": "software", + "createdBy": "admin-uuid", + "createdAt": "2026-01-15T10:00:00Z", + "updatedAt": "2026-01-20T08:00:00Z", + "studentCount": 5, + "mentorCount": 2 + } +] +``` + +### Get a Single Project + +``` +GET /api/project?id= +``` + +**Response:** Full project object including `students` and `mentors` arrays. + +### Get Project Members + +``` +GET /api/project?id=&view=students +GET /api/project?id=&view=mentors +``` + +| Parameter | Value | Description | +|---|---|---| +| `id` | UUID | Project ID | +| `view` | `students` or `mentors` | Which members to retrieve | + +**Response:** Array of user objects for the specified member type. + +--- + +## PATCH `/api/project` + +Assign a student or mentor to a project. + +**Auth:** Super Admin only + +### Request Body + +```json +{ + "projectId": "project-uuid", + "studentId": "student-uuid" +} +``` + +| Field | Type | Required | Description | +|---|---|---|---| +| `projectId` | string | ✅ | The project to update | +| `studentId` | string | ❌ | Student to assign (provide one of these) | +| `mentorId` | string | ❌ | Mentor to assign (provide one of these) | + +### Response + +```json +{ + "success": true, + "message": "Student assigned successfully" +} +``` + +--- + +## DELETE `/api/project` + +Remove a student or mentor from a project. + +**Auth:** Super Admin only + +### Request Body + +Same format as PATCH — provide `projectId` and either `studentId` or `mentorId`. + +### Response + +```json +{ + "success": true, + "message": "Student removed successfully" +} +``` + +--- + +## Error Responses + +| Status | Message | Cause | +|---|---|---| +| `400` | `"Project name is required"` | Missing required fields | +| `403` | `"Access denied"` | Not a super admin | +| `404` | `"Project not found"` | Invalid project ID | +| `409` | `"Student already assigned"` | Duplicate assignment | + +--- + +## Related Pages + +- [Projects Feature](../features/projects.md) — What the Projects feature does +- [Database Schema](../database.md) — Projects and ProjectAssignments models diff --git a/mk_docs/developer_docs/docs/api/reports.md b/mk_docs/developer_docs/docs/api/reports.md new file mode 100644 index 00000000..6869441f --- /dev/null +++ b/mk_docs/developer_docs/docs/api/reports.md @@ -0,0 +1,101 @@ +# Reports API + +Generate and retrieve mentor activity reports. Reports are created **asynchronously** using a background job queue. + +!!! note "Auth Required" + All endpoints require a valid JWT cookie. Mentors can only access their own reports. + +--- + +## GET `/api/reports` + +Retrieve a list of reports. + +**Auth:** Super Admin or Mentor + +### Response + +```json +[ + { + "id": "report-uuid", + "mentorId": "mentor-uuid", + "reportData": {}, + "status": "completed", + "generatedAt": "2026-01-20T09:00:00Z" + } +] +``` + +| Field | Type | Description | +|---|---|---| +| `id` | UUID | Unique report identifier | +| `mentorId` | UUID | The mentor who generated this report | +| `reportData` | JSON | The actual report content | +| `status` | string | `pending`, `wip`, `completed`, or `error` | +| `generatedAt` | ISO 8601 | When the report was created | + +### Report Status Values + +| Status | Meaning | +|---|---| +| `pending` | Report is queued but not started | +| `wip` | Report is currently being generated | +| `completed` | Report is ready and can be downloaded | +| `error` | Report generation failed | + +--- + +## POST `/api/reports` + +Request generation of a new report. + +**Auth:** Mentor only + +### Request Body + +```json +{ + "mentorId": "mentor-uuid", + "dateFrom": "2026-01-01", + "dateTo": "2026-01-31" +} +``` + +| Field | Type | Required | Description | +|---|---|---|---| +| `mentorId` | string | ✅ | The mentor's ID | +| `dateFrom` | string | ❌ | Start date filter (ISO 8601 date) | +| `dateTo` | string | ❌ | End date filter (ISO 8601 date) | + +### Response + +```json +{ + "success": true, + "message": "Report generation queued", + "reportId": "report-uuid" +} +``` + +!!! tip "Async Generation" + Reports are generated in the background via BullMQ. Poll the GET endpoint and check `status` — when it's `"completed"`, the report is ready. + See [Special Logic](../special-logic.md) for how the queue works. + +--- + +## Error Responses + +| Status | Message | Cause | +|---|---|---| +| `403` | `"Access denied"` | Not a mentor or admin | +| `404` | `"Report not found"` | Invalid report ID | +| `500` | `"Report generation failed"` | Queue or processing error | + +--- + +## Related Pages + +- [Reports Feature](../features/reports.md) — How reports work in the UI +- [Special Logic](../special-logic.md) — BullMQ and async report queue +- [Database Schema](../database.md) — Reports model definition diff --git a/mk_docs/developer_docs/docs/api/users.md b/mk_docs/developer_docs/docs/api/users.md new file mode 100644 index 00000000..210a1ad4 --- /dev/null +++ b/mk_docs/developer_docs/docs/api/users.md @@ -0,0 +1,104 @@ +# Users API + +Manage platform users. Only **Super Admins** can access most of these endpoints. + +!!! note "Auth Required" + All endpoints require a valid JWT cookie with admin privileges. + +--- + +## GET `/api/users` + +Retrieve a list of all users on the platform. + +**Auth:** Super Admin only + +### Response + +```json +[ + { + "id": "user-uuid", + "email": "jane@example.com", + "firstName": "Jane", + "lastName": "Doe", + "role": "student", + "status": "active", + "isActive": true, + "createdAt": "2026-01-15T10:00:00Z" + } +] +``` + +| Field | Type | Description | +|---|---|---| +| `id` | UUID | Unique user identifier | +| `email` | string | Login email | +| `firstName` | string | First name | +| `lastName` | string | Last name | +| `role` | string | `student`, `mentor`, or `superAdmin` | +| `status` | string | `active` or `inactive` | +| `isActive` | boolean | Whether the account is active | +| `createdAt` | ISO 8601 | Account creation timestamp | + +### Filtering (Query Parameters) + +You can filter users by adding query parameters: + +| Parameter | Example | Description | +|---|---|---| +| `role` | `?role=student` | Filter by role | +| `status` | `?status=active` | Filter by active/inactive | + +--- + +## PATCH `/api/users` + +Update a user's status or details. + +**Auth:** Super Admin only + +### Request Body + +```json +{ + "id": "user-uuid", + "isActive": false +} +``` + +| Field | Type | Required | Description | +|---|---|---|---| +| `id` | string | ✅ | The user's ID | +| `isActive` | boolean | ❌ | Set to `false` to deactivate the user | +| `role` | string | ❌ | Update the user's role | + +### Response + +```json +{ + "success": true, + "message": "User updated successfully" +} +``` + +!!! warning "Deactivating a User" + Deactivating a user (`isActive: false`) prevents them from logging in, but does **not** delete their data. They can be reactivated later. + +--- + +## Error Responses + +| Status | Message | Cause | +|---|---|---| +| `403` | `"Access denied"` | Not a super admin | +| `404` | `"User not found"` | Invalid user ID | +| `400` | `"Invalid role"` | Role value not recognized | + +--- + +## Related Pages + +- [Users Feature](../features/users.md) — User management in the admin dashboard +- [Database Schema](../database.md) — Users model definition +- [Authentication API](auth.md) — How users log in diff --git a/mk_docs/developer_docs/docs/architecture.md b/mk_docs/developer_docs/docs/architecture.md new file mode 100644 index 00000000..14e2e3af --- /dev/null +++ b/mk_docs/developer_docs/docs/architecture.md @@ -0,0 +1,135 @@ +# System Architecture + +This page explains how Digital Logbook is structured — from the folder layout to how data moves through the system. + +--- + +## Folder Structure + +The main application lives in the `server/` directory: + +``` +Digital-Logbook v2/ +└── server/ + ├── src/ + │ ├── app/ ← Next.js pages and API routes + │ │ ├── (auth)/ ← Login and register pages/routes + │ │ ├── admin/ ← Admin dashboard pages + │ │ ├── mentor/ ← Mentor dashboard pages + │ │ └── student/ ← Student dashboard pages + │ │ + │ ├── components/ ← React UI components + │ │ ├── admin/ ← Admin-specific components + │ │ ├── mentor/ ← Mentor-specific components + │ │ └── ui/ ← Shared UI primitives (shadcn/ui) + │ │ + │ ├── hooks/ ← Custom React hooks (API calls, state) + │ ├── lib/ ← Utilities (email, report generation, queue) + │ ├── middlewares/ ← Auth middleware and middleware chaining + │ ├── repositories/ ← Database access layer (Prisma queries) + │ ├── services/ ← Business logic (e.g. registration flow) + │ ├── utils/ ← Helpers and sidebar config files + │ └── public/ ← Static assets + │ + ├── prisma/ + │ ├── schema.prisma ← Database models and relationships + │ └── migrations/ ← Migration history + │ + ├── test/ ← Jest test files + ├── Dockerfile + └── docker-compose.yml +``` + +--- + +## How the Layers Work Together + +| Layer | Folder | Responsibility | +|---|---|---| +| **UI (Pages)** | `src/app/` | Renders pages, handles routing, calls hooks | +| **Components** | `src/components/` | Reusable UI elements (forms, tables, dialogs) | +| **Hooks** | `src/hooks/` | Fetches data from API, manages local state | +| **API Routes** | `src/app/api/` | Handles HTTP requests, validates input, calls services | +| **Services** | `src/services/` | Implements business rules (e.g. invitation registration) | +| **Repositories** | `src/repositories/` | Runs Prisma queries against the database | +| **Middleware** | `src/middlewares/` | Validates JWT, checks roles, redirects if unauthorized | + +--- + +## Key Modules + +### 🛠️ Admin Dashboard +- Analytics overview (user counts, project stats) +- Project management with Kanban board +- User management, invitations, reports + +### 📁 Projects +- Create, update, and delete projects +- Assign students and mentors +- View project statistics + +### 📨 Invitations +- Send invitation emails with secure tokens +- Bulk upload via Excel file +- Track invitation status (Pending, Accepted, Expired) + +### 📊 Reports +- Mentor-generated activity summaries +- Async generation via BullMQ + Redis queue +- Export as CSV + +### 👥 Users +- Role-based access (student, mentor, super_admin) +- Status management (active/inactive) +- Filtering and search + +### 📋 Activities & Feedback +- Students log their work +- Mentors approve or reject logs with notes +- Used in reporting + +### 🔐 Authentication +- JWT stored in HTTP-only cookies +- Role-based redirects after login +- Session expiry handling + +--- + +## Data Flow + +Here's how a typical request flows through the system: + +``` +1. User opens the browser and visits a page (e.g. /admin/projects) + │ + ▼ +2. Next.js middleware checks for a valid JWT cookie + → If missing/invalid: redirect to /login + → If valid: continue + │ + ▼ +3. Page component loads and calls a custom React hook + (e.g. useProjects()) + │ + ▼ +4. The hook sends a request to an API route + (e.g. GET /api/project) + │ + ▼ +5. The API route validates the request and calls a repository + (e.g. ProjectRepository.getAll()) + │ + ▼ +6. The repository runs a Prisma query against PostgreSQL + │ + ▼ +7. Data is returned up the chain → rendered in the browser +``` + +--- + +## Related Pages + +- [Database Schema](database.md) — Detailed model definitions +- [API Reference](api/overview.md) — All API endpoints +- [Special Logic & Middleware](special-logic.md) — Auth, email, and queue details diff --git a/mk_docs/developer_docs/docs/assets/logo.png b/mk_docs/developer_docs/docs/assets/logo.png new file mode 100644 index 00000000..d5699490 Binary files /dev/null and b/mk_docs/developer_docs/docs/assets/logo.png differ diff --git a/mk_docs/developer_docs/docs/components/bulk-upload-ui.md b/mk_docs/developer_docs/docs/components/bulk-upload-ui.md new file mode 100644 index 00000000..485ab5d7 --- /dev/null +++ b/mk_docs/developer_docs/docs/components/bulk-upload-ui.md @@ -0,0 +1,91 @@ +# Bulk Upload UI Component + +The Bulk Upload UI is a multi-step interface that lets admins upload an Excel file and send invitations to many users at once. + +--- + +## Overview + +This component handles the entire bulk upload workflow — from file selection to sending invitations — in a tabbed interface. + +**Used in:** Admin → Invitations page +**Component:** `server/src/components/admin/Invitations/BulkUploadTabs.tsx` + +--- + +## UI Tabs + +The component is organized into tabs that guide the admin through the process: + +| Tab | Step | Description | +|---|---|---| +| **Upload** | 1 | Select or drag-and-drop an Excel file | +| **Map** | 2 | Match Excel columns to required fields | +| **Preview** | 3 | Review the data before sending | +| **Results** | 4 | See which invitations were sent/skipped/failed | + +--- + +## Step 1: Upload + +The upload tab accepts: +- `.xlsx` files (Excel format) +- Drag-and-drop or click-to-browse + +!!! note "File Format" + Your Excel file must have the correct columns. See [Bulk Invitation Upload](../features/bulk-upload.md) for the required format. + +--- + +## Step 2: Field Mapping + +If the column names in your Excel file don't exactly match the expected names, the mapping step lets you manually match them: + +``` +Your Column → System Field +───────────────────────────────────── +"Email Address" → email +"First" → firstName +"Surname" → lastName +"User Type" → role +``` + +--- + +## Step 3: Preview + +Before anything is sent, you see a preview table of all rows that will be processed. This lets you catch mistakes early. + +- ✅ Valid rows are shown normally +- ⚠️ Rows with warnings (e.g., missing optional fields) are highlighted +- ❌ Invalid rows (missing required fields, bad email format) are flagged in red + +--- + +## Step 4: Results + +After sending, a summary shows: + +| Result | Description | +|---|---| +| ✅ Sent | Invitation was sent successfully | +| ⚠️ Skipped | Email already exists or was a duplicate | +| ❌ Failed | API error or invalid data | + +--- + +## Example Usage + +```tsx +import { BulkUploadTabs } from "@/components/admin/Invitations/BulkUploadTabs"; + + +``` + +--- + +## Related Pages + +- [Bulk Upload Feature](../features/bulk-upload.md) — End-to-end feature explanation +- [Invitations Feature](../features/invitations.md) — Single invitation workflow +- [Shared Admin Components](shared-admin.md) — Other admin UI components diff --git a/mk_docs/developer_docs/docs/components/kanban.md b/mk_docs/developer_docs/docs/components/kanban.md new file mode 100644 index 00000000..b3c00eac --- /dev/null +++ b/mk_docs/developer_docs/docs/components/kanban.md @@ -0,0 +1,108 @@ +# Kanban Board Component + +The Kanban Board provides a visual, drag-and-drop interface for managing project and student assignments in the admin dashboard. + +--- + +## Overview + +Instead of managing assignments through tables, the Kanban Board lets admins move students between projects (or between "assigned" and "bench" states) by simply dragging cards. + +**Used in:** Admin Dashboard +**Component:** `server/src/components/admin/kanban/KanbanBoard.tsx` +**Hook:** `server/src/hooks/useKanbanBoard.ts` + +--- + +## What the Kanban Board Shows + +The board is divided into **columns**, where each column represents a project (or the "Bench" — unassigned students): + +``` +┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ +│ Bench 🪑 │ │ Project Alpha │ │ Project Beta │ +│─────────────────│ │─────────────────│ │─────────────────│ +│ [Jane Doe] │ │ [Bob Smith] │ │ [Alice Lee] │ +│ [Mark Chen] │ │ [Sara Kim] │ │ │ +└─────────────────┘ └─────────────────┘ └─────────────────┘ +``` + +- **Bench** — Students not currently assigned to a project +- **Project columns** — Students currently assigned to that project + +--- + +## How to Use the Kanban Board + +### Assigning a Student to a Project + +1. Find the student's card (in the Bench or another project) +2. Drag it to the target project column +3. A confirmation dialog appears — confirm the assignment +4. The student is assigned to the project + +### Unassigning a Student (Back to Bench) + +1. Drag the student's card from a project column to the **Bench** column +2. Confirm the action in the dialog +3. The student is marked as inactive/unassigned + +!!! warning "Moving to Bench = Inactive" + Moving a student to the Bench column marks them as **inactive** on that project. This is intentional — the Bench represents students between assignments. + +### Cancelling an Action + +If you drag a card by mistake, click **"Cancel"** in the confirmation dialog. The card will snap back to its original position. + +--- + +## Drag-and-Drop Details + +The Kanban Board uses `@dnd-kit` for drag-and-drop: + +- **Within a column:** Cards can be reordered (sortable) +- **Between columns:** Cards move from one project to another (assignment change) +- **To Bench:** Triggers deactivation confirmation + +--- + +## Technical Details + +| File | Purpose | +|---|---| +| `KanbanBoard.tsx` | Main board component — renders columns and cards | +| `useKanbanBoard.ts` | Hook managing drag state, API calls, and confirmation logic | + +### Assignment Flow + +``` +User drags a card + │ + ▼ +useKanbanBoard.handleDragEnd() triggered + │ + ▼ +Confirmation dialog shown + │ + ├── User confirms → PATCH /api/project (assign) + │ or PATCH /api/project (unassign) + │ + └── User cancels → UI reverts to previous state +``` + +--- + +## Libraries Used + +- `@dnd-kit/core` — Core drag-and-drop engine +- `@dnd-kit/sortable` — Sortable list within columns +- `shadcn/ui` — Dialog, button components +- `lucide-react` — Icons + +--- + +## Related Pages + +- [Projects Feature](../features/projects.md) — What projects are +- [Projects API](../api/projects.md) — Assignment API endpoints +- [Shared Admin Components](shared-admin.md) — Other admin UI components diff --git a/mk_docs/developer_docs/docs/components/mentee.md b/mk_docs/developer_docs/docs/components/mentee.md new file mode 100644 index 00000000..39c11e3b --- /dev/null +++ b/mk_docs/developer_docs/docs/components/mentee.md @@ -0,0 +1,115 @@ +# Mentee Components + +UI components for displaying and interacting with mentee (student) information. + +--- + +## Overview + +Mentee components are used inside the mentor dashboard to show student profiles, activities, and status. Most of these components are shared with the mentor component library. + +**Import from:** `@/components/mentor` (shared with mentor components) + +--- + +## Component Reference + +### `MenteeAvatar` + +Displays a mentee's avatar image or initials, with an optional colored warning ring. + +```tsx +import { MenteeAvatar } from "@/components/mentor"; + + +``` + +**Props:** + +| Prop | Type | Description | +|---|---|---| +| `userId` | string | The student's user ID | +| `firstName` | string | Used for initials fallback | +| `lastName` | string | Used for initials fallback | +| `showWarning` | boolean | Shows an orange/red ring if `true` | + +The avatar background is always **dark blue** for consistency. + +--- + +### `MenteeProfileView` + +Renders a mentee's complete profile — useful for mentor dashboards and admin views. + +```tsx +import { MenteeProfileView } from "@/components/mentor"; + + +``` + +Includes: +- Student's basic info (name, email, role) +- Assigned projects +- Recent activities +- Mentor feedback history + +--- + +### `MenteeProfileSections` + +Renders individual profile sections separately. Use when you need to display only certain parts of a profile. + +```tsx +import { MenteeProfileSections } from "@/components/mentor"; + + +``` + +--- + +### `MenteeWarningCard` + +A callout-style card shown when a mentee needs attention (e.g., no recent activity logged). + +```tsx +import { MenteeWarningCard } from "@/components/mentor"; + + +``` + +--- + +## When to Use Each Component + +| Scenario | Component | +|---|---| +| Show a student's avatar in a list or Kanban card | `MenteeAvatar` | +| Show a student's full profile on a detail page | `MenteeProfileView` | +| Show only activities or feedback for a student | `MenteeProfileSections` | +| Alert a mentor about an at-risk student | `MenteeWarningCard` | + +--- + +## Notes + +!!! note "Shared with Mentor" + These components are defined in the `@/components/mentor` folder because they're primarily used by the mentor dashboard, but they apply to mentee data. This is a naming convention in the codebase — not a mistake. + +--- + +## Related Pages + +- [Mentor Components](mentor.md) — Mentor-side components (same library) +- [Activities & Feedback](../features/activities-feedback.md) — How mentees log activities +- [Users & Roles](../features/users.md) — How student accounts work diff --git a/mk_docs/developer_docs/docs/components/mentor.md b/mk_docs/developer_docs/docs/components/mentor.md new file mode 100644 index 00000000..8398ffe2 --- /dev/null +++ b/mk_docs/developer_docs/docs/components/mentor.md @@ -0,0 +1,121 @@ +# Mentor Components + +Reusable UI components for the mentor dashboard and mentor-related features. + +--- + +## Overview + +These components are used across all mentor pages — they display student/mentee information in a consistent way. + +**Import from:** `@/components/mentor` + +--- + +## Component Reference + +### `MenteeAvatar` + +Displays a mentee's avatar with optional warning indicators. + +```tsx +import { MenteeAvatar } from "@/components/mentor"; + + +``` + +**Props:** + +| Prop | Type | Description | +|---|---|---| +| `userId` | string | The mentee's user ID | +| `firstName` | string | First name (used for initials/alt text) | +| `lastName` | string | Last name | +| `showWarning` | boolean | If `true`, renders a warning ring around the avatar | + +!!! tip "Warning Ring" + The warning ring indicates a mentee who has missed activity logs or needs attention. It's shown consistently across all mentor views. + +--- + +### `MenteeProfileView` + +A full-page profile view for a mentee, showing their details, activity history, and feedback. + +```tsx +import { MenteeProfileView } from "@/components/mentor"; + + +``` + +--- + +### `MenteeProfileSections` + +Renders individual sections of a mentee's profile (e.g., recent activities, feedback history, project info). Used inside `MenteeProfileView`. + +```tsx +import { MenteeProfileSections } from "@/components/mentor"; + + +``` + +--- + +### `MenteeWarningCard` + +A highlighted card that summarizes warning conditions for a mentee — e.g., overdue activities or low engagement. + +```tsx +import { MenteeWarningCard } from "@/components/mentor"; + + +``` + +--- + +### `combobox` + +A searchable dropdown used for selecting mentors or mentees from a list. Useful in assignment forms. + +```tsx +import { Combobox } from "@/components/mentor"; + + +``` + +--- + +## Component Summary + +| Component | Purpose | +|---|---| +| `MenteeAvatar` | Avatar with optional warning ring indicator | +| `MenteeProfileView` | Full mentee profile page | +| `MenteeProfileSections` | Individual profile sections | +| `MenteeWarningCard` | Warning summary card for at-risk mentees | +| `Combobox` | Searchable dropdown for user selection | + +--- + +## Related Pages + +- [Mentee Components](mentee.md) — Mentee-specific display components +- [Activities & Feedback](../features/activities-feedback.md) — The workflow these components support +- [Shared Admin Components](shared-admin.md) — Admin-side shared components diff --git a/mk_docs/developer_docs/docs/components/shared-admin.md b/mk_docs/developer_docs/docs/components/shared-admin.md new file mode 100644 index 00000000..98dfe6e7 --- /dev/null +++ b/mk_docs/developer_docs/docs/components/shared-admin.md @@ -0,0 +1,172 @@ +# Shared Admin Components + +A collection of reusable UI components used across all admin pages. These components provide consistent layout, styling, and behavior — so every admin page looks and feels the same. + +--- + +## Overview + +Instead of rebuilding common UI patterns (page headers, tables, filters, etc.) on every page, Digital Logbook provides a shared component library for admin pages. + +**Import from:** `@/components/admin` + +--- + +## Component Reference + +### `AdminPageLayout` + +The top-level wrapper for any admin page. Provides consistent padding, background, and spacing. + +```tsx +import { AdminPageLayout } from "@/components/admin"; + + + {/* Your page content */} + +``` + +--- + +### `PageHeader` + +Renders a page title and optional subtitle at the top of an admin page. + +```tsx +import { PageHeader } from "@/components/admin"; + + +``` + +--- + +### `FilterBar` + +A row of filter controls (dropdowns, search inputs) for filtering table data. + +```tsx +import { FilterBar } from "@/components/admin"; + + +``` + +--- + +### `TableStateRows` + +Renders table rows for loading, empty, and error states — so you don't have to handle these cases in every page. + +```tsx +import { TableStateRows } from "@/components/admin"; + + +``` + +--- + +### `TableActionMenu` + +A dropdown action menu (⋮) for table row actions like Edit, Delete, Deactivate. + +```tsx +import { TableActionMenu } from "@/components/admin"; + + +``` + +--- + +### `AdminPagination` + +Pagination controls for navigating large data sets. + +```tsx +import { AdminPagination } from "@/components/admin"; + + +``` + +--- + +### `AdminStatusBadge` + +A colored badge showing a status value (e.g., Active, Inactive, Pending). + +```tsx +import { AdminStatusBadge } from "@/components/admin"; + + +``` + +--- + +### `RoleBadge` + +A colored badge displaying a user's role. + +```tsx +import { RoleBadge } from "@/components/admin"; + + +``` + +--- + +### `ConfirmDeleteDialog` + +A confirmation modal that appears before destructive actions like deletions. + +```tsx +import { ConfirmDeleteDialog } from "@/components/admin"; + + setShowDialog(false)} + message="Are you sure you want to delete this user? This cannot be undone." +/> +``` + +--- + +## Component Summary Table + +| Component | Purpose | +|---|---| +| `AdminPageLayout` | Page wrapper with consistent layout | +| `PageHeader` | Page title and subtitle | +| `FilterBar` | Search and filter controls | +| `TableStateRows` | Loading/empty/error table states | +| `TableActionMenu` | Row action dropdown (⋮) | +| `AdminPagination` | Page navigation for tables | +| `AdminStatusBadge` | Status indicator badge | +| `RoleBadge` | User role indicator badge | +| `ConfirmDeleteDialog` | Deletion confirmation modal | + +--- + +## Related Pages + +- [Admin Dashboard](../features/admin-dashboard.md) — Where these components are used +- [Kanban Board](kanban.md) — Specialized admin component +- [Sidebar](sidebar.md) — Navigation component diff --git a/mk_docs/developer_docs/docs/components/sidebar.md b/mk_docs/developer_docs/docs/components/sidebar.md new file mode 100644 index 00000000..15d72341 --- /dev/null +++ b/mk_docs/developer_docs/docs/components/sidebar.md @@ -0,0 +1,90 @@ +# Sidebar Component + +The Sidebar provides role-aware navigation for all users in Digital Logbook. It automatically adjusts the menu items based on the logged-in user's role. + +--- + +## Overview + +Every dashboard (Admin, Mentor, Student) uses the same Sidebar component, but renders different navigation links depending on who is logged in. + +**Component:** `server/src/components/AsideSidebar.tsx` +**Config files:** `server/src/utils/config/*SidebarConfig.tsx` + +--- + +## Role-Based Navigation + +| Role | Sidebar Links | +|---|---| +| **Super Admin** | Dashboard, Users, Projects, Invitations, Reports | +| **Mentor** | Dashboard, My Students, Activities, Reports | +| **Student** | Dashboard, My Activities, My Projects | + +Each role sees only what's relevant to them — no extra clutter. + +--- + +## Features + +### 🔗 Navigation Links +- Links are defined in role-specific config files +- Active page is highlighted automatically +- Icons from `lucide-react` for visual clarity + +### 👤 User Info Display +- Shows the logged-in user's name and role at the bottom +- Provides a **Logout** button + +### 🔐 Session Handling +- The Sidebar manages session state +- Clicking Logout clears the JWT cookie and redirects to `/login` + +--- + +## How Role Config Works + +Each role has its own sidebar config file that defines the nav items: + +```typescript +// Example: AdminSidebarConfig.tsx +export const adminSidebarItems = [ + { label: "Dashboard", href: "/admin", icon: }, + { label: "Users", href: "/admin/users", icon: }, + { label: "Projects", href: "/admin/projects", icon: }, + { label: "Invitations", href: "/admin/invitations", icon: }, + { label: "Reports", href: "/admin/reports", icon: }, +]; +``` + +The `AsideSidebar.tsx` component receives the appropriate config based on the user's role from the JWT. + +--- + +## Usage + +The Sidebar is included automatically in the layout for each role's pages — you don't need to add it manually to individual pages. + +```tsx +// Already included in admin/layout.tsx, mentor/layout.tsx, student/layout.tsx +import { AsideSidebar } from "@/components/AsideSidebar"; + + +``` + +--- + +## Testing + +The Sidebar has dedicated test coverage. See `QA-Testcases/SIDEBAR.md` for: +- Role rendering tests +- Logout behavior tests +- Active link highlighting tests + +--- + +## Related Pages + +- [Testing](../testing.md) — How the sidebar is tested +- [Shared Admin Components](shared-admin.md) — Other reusable admin UI +- [Special Logic & Middleware](../special-logic.md) — How session/JWT works diff --git a/mk_docs/developer_docs/docs/database.md b/mk_docs/developer_docs/docs/database.md new file mode 100644 index 00000000..f06ed182 --- /dev/null +++ b/mk_docs/developer_docs/docs/database.md @@ -0,0 +1,223 @@ +# Database Schema + +This page describes the database structure of Digital Logbook. The database is **PostgreSQL**, accessed via **Prisma ORM**. + +!!! note "Source of Truth" + The canonical schema definition is in `server/prisma/schema.prisma`. The schema described here reflects that file. + +--- + +## Overview + +The database has **10 main models**. Here's a quick summary: + +| Model | Purpose | +|---|---| +| **Users** | All platform users (students, mentors, admins) | +| **Activities** | Work logs submitted by students | +| **MentorFeedback** | Mentor reviews for each activity | +| **Reports** | Mentor-generated summary reports | +| **Mentorship** | Links between mentors and students | +| **Invitations** | Invitation records for new users | +| **Projects** | Projects that users work on | +| **ProjectAssignments** | Which students are on which projects | +| **Badges** | Achievement badges that can be awarded | +| **UserBadges** | Which badges each user has earned | + +--- + +## Model Definitions + +### Users + +The central model — everyone on the platform is a User. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `email` | String (unique) | Login email address | +| `passwordHash` | String (nullable) | Bcrypt-hashed password | +| `firstName` | String | First name | +| `lastName` | String | Last name | +| `emailConfirmed` | Boolean | Whether the email has been verified | +| `role` | Enum | `student`, `mentor`, or `super_admin` | +| `isActive` | Boolean | Whether the account is active | +| `isFirstTimeLogin` | Boolean | Tracks first login for password change prompts | +| `invitedBy` | String (nullable) | ID of the user who invited this person | +| `createdAt` | Timestamp | Account creation time | +| `updatedAt` | Timestamp | Last update time | + +--- + +### Activities + +Student-submitted work logs. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `studentId` | UUID (FK → Users) | The student who logged this | +| `date` | DateTime | When the activity occurred | +| `timeSpent` | Integer | Minutes spent on the activity | +| `notes` | String (nullable) | Extra notes about the activity | +| `createdAt` | Timestamp | When the log was submitted | +| `updatedAt` | Timestamp | Last update time | + +--- + +### MentorFeedback + +Mentor reviews for student activity logs. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `activityId` | UUID (FK → Activities) | The activity being reviewed | +| `mentorId` | UUID (FK → Users) | The reviewing mentor | +| `status` | Enum | `approved`, `rejected`, or `pending` | +| `feedbackNotes` | Text (nullable) | Mentor's written comments | +| `createdAt` | Timestamp | When feedback was submitted | +| `updatedAt` | Timestamp | Last update time | + +--- + +### Reports + +Mentor-generated activity summary reports. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `mentorId` | UUID (FK → Users) | The mentor who generated this | +| `reportData` | JSON | The report content/payload | +| `createdAt` | Timestamp | When the report was created | + +--- + +### Mentorship + +Links a mentor to their assigned student(s). + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `mentorId` | UUID (FK → Users) | The mentor | +| `studentId` | UUID (FK → Users) | The student | + +--- + +### Invitations + +Tracks invitations sent to new users. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `email` | String | Invited email address | +| `role` | Enum | `student`, `mentor`, or `super_admin` | +| `token` | String | Secure invitation token | +| `expiresAt` | DateTime | Expiry date of the invitation | +| `accepted` | Boolean | Whether the invitation was accepted | +| `createdAt` | Timestamp | When the invitation was created | + +--- + +### Projects + +Projects that students and mentors are assigned to. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `name` | String | Project name | +| `description` | String (nullable) | Short description | +| `domain` | Enum | `software`, `film`, `training`, `research`, or `other` | +| `createdBy` | UUID (FK → Users) | The admin who created this project | +| `createdAt` | Timestamp | Creation time | +| `updatedAt` | Timestamp | Last update time | + +--- + +### ProjectAssignments + +Tracks which students are assigned to which projects. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `projectId` | UUID (FK → Projects) | The project | +| `studentId` | UUID (FK → Users) | The assigned student | +| `assignedAt` | Timestamp | When the assignment was made | + +--- + +### Badges + +Achievement badges that can be awarded to users. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `name` | String | Badge name | +| `description` | String (nullable) | What the badge represents | +| `iconUrl` | String (nullable) | URL to the badge icon image | +| `createdAt` | Timestamp | When the badge was created | + +--- + +### UserBadges + +Records which badges each user has earned. + +| Field | Type | Description | +|---|---|---| +| `id` | UUID (PK) | Unique identifier | +| `userId` | UUID (FK → Users) | The user who earned the badge | +| `badgeId` | UUID (FK → Badges) | The badge awarded | +| `awardedAt` | Timestamp | When the badge was awarded | + +--- + +## Entity Relationship Diagram + +```mermaid +erDiagram + Users ||--o{ Activities : "logs" + Users ||--o{ MentorFeedback : "gives" + Users ||--o{ Reports : "generates" + Users ||--o{ Mentorship : "mentor in" + Users ||--o{ Mentorship : "student in" + Users ||--o{ Invitations : "invited by" + Users ||--o{ Projects : "created by" + Users ||--o{ ProjectAssignments : "assigned to" + Users ||--o{ UserBadges : "earns" + + Activities ||--o{ MentorFeedback : "reviewed by" + + Projects ||--o{ ProjectAssignments : "has" + Badges ||--o{ UserBadges : "awarded as" +``` + +--- + +## Key Relationships + +- A **User** can be a student, mentor, or super admin — determined by the `role` field. +- **Activities** belong to students; each activity can have one **MentorFeedback** entry. +- **Mentorship** is the link table between a mentor and their assigned students. +- **Projects** can have many **ProjectAssignments** (many students per project). +- **Invitations** are used for onboarding — once accepted, the user is registered. + +--- + +## Making Schema Changes + +If you change `prisma/schema.prisma`, run: + +```bash +npm run generate # Regenerate the Prisma client +npm run migrate:maindb # Apply the changes to the database +``` + +!!! warning "Don't modify migrations manually" + Always use Prisma commands to manage migrations. Manually editing migration files can break the migration history. diff --git a/mk_docs/developer_docs/docs/deployment/checklist.md b/mk_docs/developer_docs/docs/deployment/checklist.md new file mode 100644 index 00000000..39602825 --- /dev/null +++ b/mk_docs/developer_docs/docs/deployment/checklist.md @@ -0,0 +1,83 @@ +# Production Checklist + +Before deploying Digital Logbook to a production environment, go through this checklist to make sure everything is properly configured and secure. + +--- + +## ✅ Environment & Configuration + +- [ ] All `.env` variables are set for the production environment +- [ ] `JWT_SECRET` is a long, random, and unique string (not a test value) +- [ ] `JWT_EXPIRY` is set to an appropriate duration (e.g., `8h` or `1d`) +- [ ] `EMAIL_USER` and `EMAIL_PASS` are pointing to a production email account +- [ ] `NEXT_PUBLIC_BASE_URL` is set to the production domain (not `localhost`) +- [ ] `.env` file is **not** committed to version control + +--- + +## ✅ Database + +- [ ] PostgreSQL is running on a production-grade server or managed service +- [ ] Database backups are configured and tested +- [ ] All migrations have been applied (`npm run migrate:maindb`) +- [ ] Database connection string uses production credentials (not `postgres:postgres`) + +--- + +## ✅ Application Build + +- [ ] Run `npm run build` to generate the production build +- [ ] Build completes without TypeScript errors +- [ ] All tests pass (`npm run test`) +- [ ] No `console.log` statements left in production code + +--- + +## ✅ Security + +- [ ] JWT tokens are stored in **HTTP-only cookies** (already the default) +- [ ] CORS is configured correctly for your domain +- [ ] Sensitive routes are protected by middleware (already implemented) +- [ ] Error messages don't expose internal stack traces to users +- [ ] Database is not publicly accessible (only reachable from the app server) + +--- + +## ✅ Docker (if using containers) + +- [ ] Docker Compose is configured for production (separate from dev) +- [ ] Containers are set to restart on failure (`restart: always`) +- [ ] Volumes are configured for database persistence +- [ ] Redis is running if BullMQ report generation is needed + +--- + +## ✅ Performance + +- [ ] PostgreSQL connection pooling is configured +- [ ] BullMQ queue has enough Redis memory allocated +- [ ] Next.js static assets are served via a CDN or optimized hosting + +--- + +## ✅ Monitoring + +- [ ] Application logs are routed to a logging service +- [ ] Database connection errors will trigger alerts +- [ ] Uptime monitoring is set up + +--- + +!!! tip "Managed Hosting" + Consider using managed services for production: + - **Database:** Supabase, Railway, or AWS RDS for PostgreSQL + - **App:** Vercel (optimized for Next.js) or a VPS with Docker + - **Redis:** Upstash (serverless Redis) for BullMQ queues + +--- + +## Related Pages + +- [Docker Setup](docker.md) — Docker configuration details +- [Environment Setup](../getting-started/environment.md) — All environment variables +- [Special Logic](../special-logic.md) — BullMQ/Redis details diff --git a/mk_docs/developer_docs/docs/deployment/docker.md b/mk_docs/developer_docs/docs/deployment/docker.md new file mode 100644 index 00000000..774a5388 --- /dev/null +++ b/mk_docs/developer_docs/docs/deployment/docker.md @@ -0,0 +1,97 @@ +# Docker Setup + +Digital Logbook uses **Docker** to run PostgreSQL (and optionally Redis) in isolated containers. This makes setup consistent across machines — no need to install PostgreSQL locally. + +--- + +## What Docker Runs + +| Service | Image | Purpose | +|---|---|---| +| **postgres** | `postgres:16` | Main PostgreSQL database | +| **redis** *(if configured)* | `redis:alpine` | BullMQ queue for async report generation | + +--- + +## Starting Docker + +From the `server/` directory: + +```bash +# First time — builds the image +docker compose up --build + +# Subsequent starts +docker compose up -d # -d runs in background (detached) +``` + +--- + +## Stopping Docker + +```bash +docker compose down # Stops containers but keeps data +docker compose down -v # ⚠️ Also deletes volumes (all DB data) +``` + +!!! warning "Deleting Volumes" + Running `docker compose down -v` will **erase your database**. Only do this if you want a fresh start. + +--- + +## Verifying Everything is Running + +```bash +docker ps +``` + +You should see output like: + +``` +CONTAINER ID IMAGE STATUS PORTS +abc123 postgres:16 Up 2 minutes 0.0.0.0:5432->5432/tcp +``` + +--- + +## Docker Compose Configuration + +The `docker-compose.yml` file in `server/` defines the services. Key settings: + +```yaml +services: + postgres: + image: postgres:16 + environment: + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + POSTGRES_DB: digital_logbook + ports: + - "5432:5432" + volumes: + - pgdata:/var/lib/postgresql/data +``` + +!!! tip "Changing Credentials" + If you change `POSTGRES_USER` or `POSTGRES_PASSWORD` here, update `DATABASE_URL` in your `.env` file to match. + +--- + +## Connecting to the Database Directly + +To inspect the database via `psql`: + +```bash +docker exec -it psql -U postgres -d digital_logbook +``` + +Or use a GUI tool like **pgAdmin**, **TablePlus**, or **DBeaver** — connect to `localhost:5432`. + +--- + +## Related Pages + +- [Installation](../getting-started/installation.md) — Full setup walkthrough +- [Environment Setup](../getting-started/environment.md) — DATABASE_URL configuration +- [Troubleshooting](../getting-started/troubleshooting.md) — Docker connection errors +- [Production Checklist](checklist.md) — Things to do before going live diff --git a/mk_docs/developer_docs/docs/features/activities-feedback.md b/mk_docs/developer_docs/docs/features/activities-feedback.md new file mode 100644 index 00000000..aebfd38a --- /dev/null +++ b/mk_docs/developer_docs/docs/features/activities-feedback.md @@ -0,0 +1,103 @@ +# Activities & Mentor Feedback + +This feature is the heart of the mentorship workflow — students log what they've been working on, and mentors review and respond. + +--- + +## Overview + +Activities and feedback create a continuous loop of accountability and guidance: + +1. **Students** log their daily or weekly work as **Activities** +2. **Mentors** review each activity and leave **Feedback** +3. **Admins** can monitor all activity and feedback for reporting + +**Student route:** `/student/activities` +**Mentor route:** `/mentor/activities` +**Key files:** +- `server/src/app/student/` — Student activity pages +- `server/src/components/mentor/mentorFeedback.tsx` — Mentor feedback UI + +--- + +## Student: Logging Activities + +Students can log their work at any time. Each activity captures: + +| Field | Description | +|---|---| +| **Date** | When the work was done | +| **Time Spent** | Duration in minutes | +| **Notes** | What the student worked on | + +### How to Log an Activity + +1. Go to your **Student Dashboard → Activities** +2. Click **"Log Activity"** +3. Fill in the date, time spent, and a description of what you worked on +4. Click **"Submit"** + +Your mentor will be notified and can review your log. + +--- + +## Mentor: Reviewing Activities + +Mentors see all pending activity logs from their assigned students. + +### Feedback Status + +| Status | Meaning | +|---|---| +| **Pending** | Activity submitted, awaiting mentor review | +| **Approved** | Mentor reviewed and accepted the activity | +| **Rejected** | Mentor flagged the activity (with notes explaining why) | + +### How to Give Feedback + +1. Go to your **Mentor Dashboard → Student Activities** +2. Find a student's pending activity log +3. Review the details +4. Choose **"Approve"** or **"Reject"** +5. Add written feedback notes (optional but recommended for rejections) +6. Click **"Submit Feedback"** + +!!! tip "Feedback Notes" + Even when approving, leaving a short note of encouragement or guidance helps students improve. + +--- + +## Admin: Monitoring Activity + +Super Admins can view all activities and feedback across all users. This data feeds into the [Reports](reports.md) feature. + +--- + +## How It Works Technically + +``` +Student submits activity + │ + ▼ +POST /api/activity → stored in Activities table + │ + ▼ +Mentor opens activity list → GET /api/activity?mentorId=... + │ + ▼ +Mentor submits feedback → POST /api/mentorFeedback + │ + ▼ +MentorFeedback record created (status: approved/rejected) + │ + ▼ +Used in report generation +``` + +--- + +## Related Pages + +- [Reports Feature](reports.md) — How activities feed into reports +- [Database Schema](../database.md) — Activities and MentorFeedback models +- [Mentor Components](../components/mentor.md) — Feedback UI components diff --git a/mk_docs/developer_docs/docs/features/admin-dashboard.md b/mk_docs/developer_docs/docs/features/admin-dashboard.md new file mode 100644 index 00000000..9dcc2366 --- /dev/null +++ b/mk_docs/developer_docs/docs/features/admin-dashboard.md @@ -0,0 +1,89 @@ +# Admin Dashboard + +The Admin Dashboard is the control center for **Super Admins**. From here, admins can view platform-wide statistics and navigate to all management areas. + +--- + +## Overview + +The dashboard gives a bird's-eye view of the entire platform at a glance. It's the first page admins see after logging in. + +**Route:** `/admin` +**Access:** Super Admin only +**Component:** `server/src/components/admin-dashboard/SuperAdminDashboard.tsx` + +--- + +## What's on the Dashboard + +| Section | Description | +|---|---| +| **Stats Overview** | Total counts: users, active projects, pending invitations, reports | +| **Quick Navigation** | Links to Users, Projects, Invitations, Reports pages | +| **System Status** | Loading and error state indicators | + +--- + +## Key Features + +### 📊 Platform Statistics + +The dashboard shows real-time counts pulled from the database: + +- **Total Users** — Broken down by role (students, mentors, admins) +- **Active Projects** — Projects currently in progress +- **Pending Invitations** — Invitations not yet accepted +- **Recent Reports** — Latest mentor-generated reports + +### 🔗 Module Navigation + +Quick-access links to all admin modules: + +- 👥 [Users](users.md) — View and manage all users +- 📁 [Projects](projects.md) — Manage projects and assignments +- 📨 [Invitations](invitations.md) — Send and track invitations +- 📈 [Reports](reports.md) — View and generate reports + +### ⚙️ Error & Loading States + +The dashboard gracefully handles: +- **Loading states** — Shows a spinner while data loads +- **Error states** — Displays a friendly error message with retry options +- **Empty states** — Informs admin when there's no data yet + +--- + +## How Data Gets to the Dashboard + +``` +SuperAdminDashboard.tsx + │ + ├── calls useAdminStats() hook + │ │ + │ └── GET /api/stats or individual API endpoints + │ + └── renders widgets with the returned data +``` + +All data is fetched via authenticated API routes. If the JWT is expired, the user is redirected to login. + +--- + +## Notes + +!!! note "Role Gate" + This page is only accessible to users with the `super_admin` role. Attempting to access `/admin` with any other role will result in a redirect. + +!!! tip "Shared Components" + The dashboard uses shared admin components (`AdminPageLayout`, `PageHeader`, etc.) for consistent styling. + See [Shared Admin Components](../components/shared-admin.md) for details. + +--- + +## Related Pages + +- [Projects Feature](projects.md) +- [Users Feature](users.md) +- [Invitations Feature](invitations.md) +- [Reports Feature](reports.md) +- [Shared Admin Components](../components/shared-admin.md) diff --git a/mk_docs/developer_docs/docs/features/bulk-upload.md b/mk_docs/developer_docs/docs/features/bulk-upload.md new file mode 100644 index 00000000..261fb8bd --- /dev/null +++ b/mk_docs/developer_docs/docs/features/bulk-upload.md @@ -0,0 +1,80 @@ +# Bulk Invitation Upload + +Instead of inviting users one by one, admins can upload an **Excel file** to send multiple invitations at once. + +--- + +## Overview + +The Bulk Upload feature parses an Excel (`.xlsx`) file, maps columns to the required fields, previews the data, and sends invitations to all valid rows. + +**Route:** `/admin/invitations` → Bulk Upload tab +**Access:** Super Admin only +**Component:** `server/src/components/admin/Invitations/BulkUploadTabs.tsx` + +--- + +## Required Excel Format + +Your Excel file must contain these columns (column names are case-insensitive): + +| Column | Required | Description | +|---|---|---| +| `email` | ✅ | Email address to invite | +| `firstName` | ✅ | First name of the user | +| `lastName` | ✅ | Last name of the user | +| `role` | ✅ | `student`, `mentor`, or `superAdmin` | +| `projectId` | ❌ | Optional project to pre-assign | + +### Example Excel Structure + +| email | firstName | lastName | role | projectId | +|---|---|---|---|---| +| alice@example.com | Alice | Smith | student | proj-abc123 | +| bob@example.com | Bob | Jones | mentor | | +| carol@example.com | Carol | Lee | student | proj-abc123 | + +--- + +## How to Use Bulk Upload + +1. **Go to** Admin → Invitations → Bulk Upload tab +2. **Upload your file** — drag and drop or click "Browse" +3. **Map columns** — the system may ask you to match your column names to the required fields +4. **Preview** — review the rows that will be invited +5. **Send** — click "Send Invitations" to process all rows + +The system sends one invitation per valid row. Rows with invalid data are flagged and skipped. + +--- + +## Validation Rules + +Before sending, the system checks each row: + +- Email must be a valid format +- Role must be one of the allowed values +- Duplicate emails (already invited or registered) are skipped +- Rows with missing required fields are flagged with an error + +!!! warning "Duplicate Emails" + If an email already exists in the system, that row will be skipped silently. Check the summary after upload to see which rows were skipped. + +--- + +## After Upload + +You'll see a summary showing: +- ✅ **Sent** — How many invitations were sent successfully +- ⚠️ **Skipped** — Rows that were skipped (duplicates or errors) +- ❌ **Failed** — Rows that failed due to invalid data + +Each sent invitation appears in the Invitations list with a **Pending** status. + +--- + +## Related Pages + +- [Invitations Feature](invitations.md) — Single invitation flow +- [Bulk Upload UI Component](../components/bulk-upload-ui.md) — Component details +- [Invitations API](../api/invitations.md) — API used behind the scenes diff --git a/mk_docs/developer_docs/docs/features/invitations.md b/mk_docs/developer_docs/docs/features/invitations.md new file mode 100644 index 00000000..2aded946 --- /dev/null +++ b/mk_docs/developer_docs/docs/features/invitations.md @@ -0,0 +1,103 @@ +# Invitations + +Invitations are how new users join Digital Logbook. No one can self-register — everyone must be invited by a Super Admin. + +--- + +## Overview + +When an admin invites someone, the system: +1. Creates an invitation record in the database +2. Sends an email with a unique, time-limited registration link +3. Tracks the invitation status (Pending, Accepted, Expired) + +**Route:** `/admin/invitations` +**Access:** Super Admin only +**Key Components:** +- `server/src/app/admin/invitations/page.tsx` +- `server/src/components/admin/Invitations/BulkUploadTabs.tsx` + +--- + +## Invitation Flow + +``` +Admin sends invitation + │ + ▼ +System creates invitation record (status: Pending) + │ + ▼ +Email sent to user with registration link + │ + ▼ +User clicks link → goes to /register?token=... + │ + ▼ +User fills in their name and password + │ + ▼ +System validates token → creates user account + │ + ▼ +Invitation marked as Accepted + │ + ▼ +User is redirected to their dashboard +``` + +--- + +## Invitation Statuses + +| Status | Meaning | +|---|---| +| **Pending** | Email sent, user hasn't registered yet | +| **Accepted** | User has completed registration | +| **Expired** | Token has passed its expiry date | + +!!! note "Token Expiry" + Invitation tokens have a time limit (typically 7 days). After expiry, the link no longer works and the admin must resend the invitation. + +--- + +## How to Send an Invitation + +1. Go to **Admin → Invitations** +2. Click **"Invite User"** +3. Fill in: + - **Email** — The user's email address + - **First Name / Last Name** — Prepopulated in the email + - **Role** — `student`, `mentor`, or `superAdmin` + - **Project** *(optional)* — Pre-assign to a project +4. Click **"Send Invitation"** + +The user will receive an email with a link to complete registration. + +--- + +## Managing Invitations + +Admins can: +- **View all invitations** with their status, role, and expiry date +- **Delete an invitation** — also removes the associated user account if already registered +- **Update status manually** — Mark as Expired or reset to Pending + +!!! warning "Deleting Invitations" + Deleting an invitation will cascade-delete the user and all their associated data. This cannot be undone. + +--- + +## Bulk Invitations + +Need to invite many users at once? Use the **Bulk Upload** feature to upload an Excel file. + +👉 See [Bulk Invitation Upload](bulk-upload.md) + +--- + +## Related Pages + +- [Invitations API](../api/invitations.md) — API endpoints +- [Bulk Upload](bulk-upload.md) — Upload Excel for bulk invitations +- [Authentication](../api/auth.md) — Registration flow diff --git a/mk_docs/developer_docs/docs/features/projects.md b/mk_docs/developer_docs/docs/features/projects.md new file mode 100644 index 00000000..9527b0df --- /dev/null +++ b/mk_docs/developer_docs/docs/features/projects.md @@ -0,0 +1,100 @@ +# Projects + +Projects are the core units of work in Digital Logbook. Each project has a domain, assigned students, and assigned mentors. + +--- + +## Overview + +Admins create and manage projects. Students and mentors are assigned to projects, giving everyone a shared context for activities, feedback, and reporting. + +**Route:** `/admin/projects` +**Access:** Super Admin (full access), Mentor/Student (read only) +**Key Components:** +- `server/src/app/admin/projects/page.tsx` +- `server/src/components/admin/ProjectFormDialog.tsx` + +--- + +## Project Fields + +| Field | Description | +|---|---| +| **Name** | The project's display name | +| **Description** | Optional short summary of what the project is | +| **Domain** | Category: `software`, `film`, `training`, `research`, or `other` | +| **Students** | Users assigned as students on this project | +| **Mentors** | Users assigned as mentors on this project | +| **Created By** | The admin who created the project | + +--- + +## What Admins Can Do + +### ➕ Create a Project + +1. Navigate to **Admin → Projects** +2. Click **"New Project"** +3. Fill in the name, description, and domain +4. Click **"Create"** + +The project is immediately available for student and mentor assignment. + +### ✏️ Assign Students and Mentors + +1. Open a project from the list +2. Use the assignment panel to search for users +3. Click **"Assign"** next to a student or mentor + +!!! note "Kanban Board" + Project assignments can also be managed visually using the **Kanban Board** in the admin dashboard. + See [Kanban Board Component](../components/kanban.md). + +### 🗑️ Remove Assignments + +Remove a student or mentor from a project at any time without deleting their account or other data. + +### ❌ Delete a Project + +Deleting a project removes it from the system. Assignments to the project are also removed. + +--- + +## How It Works (Technical) + +``` +Admin fills project form + │ + ▼ +POST /api/project ← Creates the project + │ + ▼ +ProjectRepository.create() ← Prisma writes to Projects table + │ + ▼ +Response returned → UI refreshes +``` + +For assignment: +``` +PATCH /api/project → ProjectRepository.assignStudent/Mentor() +DELETE /api/project → ProjectRepository.removeStudent/Mentor() +``` + +--- + +## Notes + +!!! tip "Project Stats" + The projects list shows `studentCount` and `mentorCount` for each project so admins can see capacity at a glance. + +!!! warning "No Soft Delete" + Deleting a project is permanent. Make sure assignments and related data have been handled before deletion. + +--- + +## Related Pages + +- [Projects API](../api/projects.md) — API endpoints for projects +- [Kanban Board](../components/kanban.md) — Visual assignment management +- [Database Schema](../database.md) — Projects and ProjectAssignments models diff --git a/mk_docs/developer_docs/docs/features/reports.md b/mk_docs/developer_docs/docs/features/reports.md new file mode 100644 index 00000000..ebdf8705 --- /dev/null +++ b/mk_docs/developer_docs/docs/features/reports.md @@ -0,0 +1,95 @@ +# Reports + +Reports summarize mentor activity and student progress over a time period. They can be exported for record-keeping or sharing with stakeholders. + +--- + +## Overview + +Reports are generated by **mentors** and can be reviewed by **admins**. Because generating a report can take time (querying and processing data), it's done **asynchronously** in a background queue. + +**Route:** `/mentor/reports` (mentor) and `/admin/reports` (admin) +**Access:** Mentor and Super Admin +**Key Components:** +- `server/src/app/admin/reports/page.tsx` +- `server/src/components/reports/ReportsTable.tsx` + +--- + +## What's in a Report? + +A report typically includes: + +| Section | Description | +|---|---| +| **Mentor Info** | Name and ID of the mentor who generated the report | +| **Date Range** | The period the report covers | +| **Student Activity** | Summary of logged activities per student | +| **Feedback Summary** | Breakdown of approved/rejected/pending activities | +| **Time Analysis** | Total and average hours logged | + +--- + +## Report Statuses + +| Status | Meaning | +|---|---| +| `pending` | Queued, not started yet | +| `wip` | Currently being generated | +| `completed` | Ready to view/download | +| `error` | Generation failed | + +--- + +## How to Generate a Report + +1. Go to **Mentor Dashboard → Reports** (or **Admin → Reports**) +2. Click **"Generate Report"** +3. Select the **date range** (optional — defaults to the current month) +4. Click **"Generate"** + +The report will appear in the list with a `pending` or `wip` status. Refresh the page after a few moments — once the status shows `completed`, the report is ready. + +!!! tip "Reports are async" + Report generation happens in a background queue (BullMQ + Redis), so the page won't freeze while it's being built. + See [Special Logic](../special-logic.md) for technical details. + +--- + +## Export Options + +Once a report is `completed`, it can be: + +- **Viewed** in the browser +- **Downloaded** as a **CSV** file + +PDF export support is planned for future versions. + +--- + +## How It Works Technically + +``` +Mentor clicks "Generate" + │ + ▼ +POST /api/reports → job added to BullMQ queue + │ + ▼ +Background worker generates the report + │ + ▼ +Report saved in Reports table (status: completed) + │ + ▼ +Mentor/Admin sees completed report in the list +``` + +--- + +## Related Pages + +- [Reports API](../api/reports.md) — API endpoints for reports +- [Activities & Feedback](activities-feedback.md) — The data that feeds into reports +- [Special Logic](../special-logic.md) — BullMQ queue and report generation +- [Database Schema](../database.md) — Reports model definition diff --git a/mk_docs/developer_docs/docs/features/users.md b/mk_docs/developer_docs/docs/features/users.md new file mode 100644 index 00000000..477b67ce --- /dev/null +++ b/mk_docs/developer_docs/docs/features/users.md @@ -0,0 +1,90 @@ +# Users & Roles + +This page explains how users are managed in Digital Logbook — who can do what, how they're organized, and how admins manage them. + +--- + +## Overview + +Every person on the platform is a **User**. Users are categorized by **role**, which determines what they can see and do. + +**Route:** `/admin/users` +**Access:** Super Admin only +**Key Components:** +- `server/src/app/admin/users/page.tsx` +- `server/src/components/admin/users/UsersTable.tsx` + +--- + +## User Roles + +| Role | Description | Dashboard | +|---|---|---| +| **super_admin** | Full access to all features. Manages users, projects, invitations, and reports. | `/admin` | +| **mentor** | Reviews student activities, provides feedback, generates reports. | `/mentor` | +| **student** | Logs daily activities, views assigned projects, tracks feedback. | `/student` | + +!!! note "No Self-Registration" + Users cannot create their own accounts. They must be invited by a Super Admin. + +--- + +## User Status + +| Status | Meaning | +|---|---| +| **Active** | User can log in and use the platform normally | +| **Inactive** | User is blocked from logging in; data is preserved | + +Admins can toggle user status at any time without deleting the account. + +--- + +## Managing Users + +### Viewing Users + +1. Go to **Admin → Users** +2. You'll see a table of all users with their name, email, role, status, and join date + +### Filtering Users + +Use the filter bar to narrow the list: + +- Filter by **Role** (student / mentor / admin) +- Filter by **Status** (active / inactive) +- Search by **Name** or **Email** + +### Changing User Status + +1. Find the user in the table +2. Click the action menu (⋮) next to their name +3. Select **"Deactivate"** or **"Activate"** + +!!! warning "Deactivation vs Deletion" + Deactivating a user does **not** delete their data. They're simply prevented from logging in. + To permanently remove a user, delete their invitation from the Invitations page. + +--- + +## User Fields Reference + +| Field | Description | +|---|---| +| `id` | Unique UUID — never changes | +| `email` | Login email address (must be unique) | +| `firstName` / `lastName` | Display name | +| `role` | `student`, `mentor`, or `super_admin` | +| `isActive` | Whether the account is enabled | +| `emailConfirmed` | Whether the email was verified via registration | +| `isFirstTimeLogin` | Used to prompt password change on first login | +| `invitedBy` | ID of the admin who sent the invitation | +| `createdAt` | When the account was created | + +--- + +## Related Pages + +- [Users API](../api/users.md) — API endpoints for user management +- [Invitations](invitations.md) — How users are added to the platform +- [Database Schema](../database.md) — Users model definition diff --git a/mk_docs/developer_docs/docs/getting-started/environment.md b/mk_docs/developer_docs/docs/getting-started/environment.md new file mode 100644 index 00000000..261bf2e2 --- /dev/null +++ b/mk_docs/developer_docs/docs/getting-started/environment.md @@ -0,0 +1,64 @@ +# Environment Setup + +Before running the app, you need to create a `.env` file in the `server/` directory. This file holds all the configuration values the application needs. + +--- + +## Create the `.env` File + +```bash +# From inside server/ +cp .env.example .env +``` + +Then open `.env` in your editor and fill in the values. + +--- + +## Environment Variables Reference + +| Variable | Example Value | Description | +|---|---|---| +| `DATABASE_URL` | `postgresql://postgres:postgres@localhost:5432/digital_logbook` | PostgreSQL connection string | +| `JWT_SECRET` | `your_super_secret_key` | Secret key used to sign JWT tokens | +| `EMAIL_USER` | `yourapp@gmail.com` | Gmail address used to send invitation emails | +| `EMAIL_PASS` | `your_app_password` | Gmail App Password (not your regular password) | +| `NEXT_PUBLIC_BASE_URL` | `http://localhost:3000` | The base URL of the application | +| `ISSUER` | `digital-logbook` | JWT issuer claim | +| `AUDIENCE` | `digital-logbook-users` | JWT audience claim | +| `JWT_EXPIRY` | `1d` | How long a JWT token is valid (`1d` = 1 day) | + +--- + +## Full `.env` Example + +```env +DATABASE_URL=postgresql://postgres:postgres@localhost:5432/digital_logbook +JWT_SECRET=your_jwt_secret +EMAIL_USER=your_email@gmail.com +EMAIL_PASS=your_email_password +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +ISSUER=your_issuer +AUDIENCE=your_audience +JWT_EXPIRY=1d +``` + +--- + +## Important Notes + +!!! warning "Never commit `.env` to Git" + The `.env` file contains secrets. Make sure it's listed in `.gitignore` (it should be by default). + +!!! tip "Gmail App Password" + If you use Gmail for `EMAIL_USER`, you must generate an **App Password** from your Google Account settings. + Regular Gmail passwords won't work if 2FA is enabled. + +!!! tip "Changing the database password" + If you change the PostgreSQL credentials, make sure to update both `DATABASE_URL` in `.env` **and** `docker-compose.yml`. + +--- + +## What's Next? + +- [Run the development server →](running.md) diff --git a/mk_docs/developer_docs/docs/getting-started/installation.md b/mk_docs/developer_docs/docs/getting-started/installation.md new file mode 100644 index 00000000..fb16786c --- /dev/null +++ b/mk_docs/developer_docs/docs/getting-started/installation.md @@ -0,0 +1,97 @@ +# Installation + +This guide walks you through cloning the project and installing all dependencies. + +--- + +## Step 1 — Clone the Repository + +```bash +git clone +``` + +After cloning, your folder structure will look like this: + +``` +Digital-Logbook v2/ +├── server/ ← Main application code lives here +│ ├── src/ +│ ├── prisma/ +│ ├── Dockerfile +│ └── docker-compose.yml +└── docs/ ← Project documentation +``` + +--- + +## Step 2 — Navigate to the Server Folder + +All commands should be run from inside the `server/` directory: + +```bash +cd "Digital-Logbook v2/server" +``` + +--- + +## Step 3 — Set the Correct Node Version + +The project requires **Node.js v22.7.0**. If you use `nvm`: + +```bash +nvm use # Uses the version in .nvmrc +nvm install # Only needed if the version isn't installed yet +``` + +You can verify your Node version: + +```bash +node --version # Should print v22.7.0 +``` + +--- + +## Step 4 — Install Dependencies + +```bash +npm install npm@10.8.2 # Pin npm to the required version +npm install # Install all project dependencies +``` + +!!! note "Why pin npm?" + The project was developed and tested with `npm@10.8.2`. Using a different version might produce unexpected behavior with lock files. + +--- + +## Step 5 — Start the Database + +The project uses **PostgreSQL running inside Docker**. Start it with: + +```bash +# First time — builds the Docker image +docker compose up --build + +# Subsequent runs — just start it +docker compose up -d +``` + +!!! warning "Docker must be running" + Make sure Docker Desktop is open and running before executing this command. + +--- + +## Step 6 — Run Database Migrations + +Once the database is up, apply the Prisma schema: + +```bash +npm run generate # Generates Prisma client +npm run migrate:maindb # Applies migrations to the database +``` + +--- + +## What's Next? + +- [Configure environment variables →](environment.md) +- [Start the development server →](running.md) diff --git a/mk_docs/developer_docs/docs/getting-started/overview.md b/mk_docs/developer_docs/docs/getting-started/overview.md new file mode 100644 index 00000000..45a8fc54 --- /dev/null +++ b/mk_docs/developer_docs/docs/getting-started/overview.md @@ -0,0 +1,50 @@ +# Getting Started + +Welcome! This section will help you set up and run the Digital Logbook project on your local machine. + +## What You Need to Know First + +Digital Logbook is a **Next.js full-stack application** that uses: + +- **PostgreSQL** as the database (managed via Docker) +- **Prisma** as the ORM (database access layer) +- **Node.js** to run the server + +The entire backend and frontend live in one codebase — the `server/` folder inside the repository. + +--- + +## Prerequisites + +Make sure you have the following installed before you begin: + +| Tool | Required Version | Purpose | +|---|---|---| +| **Node.js** | v22.7.0 | Runtime for the app | +| **npm** | v10.8.2 | Package manager | +| **Docker** | v27.1.2+ | Runs PostgreSQL in a container | +| **nvm** *(optional)* | Any | Manages Node.js versions easily | + +!!! tip "Using nvm" + We recommend using `nvm` (Node Version Manager) to match the exact Node version required. + The project includes a `.nvmrc` file — just run `nvm use` in the project root. + +--- + +## Setup Overview + +Setting up Digital Logbook involves these steps: + +1. **Clone** the repository +2. **Install** Node dependencies +3. **Start** the PostgreSQL database via Docker +4. **Configure** environment variables +5. **Run** database migrations +6. **Start** the development server + +Follow the guides in this section in order: + +- [Installation](installation.md) — Clone and install dependencies +- [Environment Setup](environment.md) — Configure your `.env` file +- [Running the App](running.md) — Start the dev server +- [Troubleshooting](troubleshooting.md) — Common issues and fixes diff --git a/mk_docs/developer_docs/docs/getting-started/running.md b/mk_docs/developer_docs/docs/getting-started/running.md new file mode 100644 index 00000000..e730907d --- /dev/null +++ b/mk_docs/developer_docs/docs/getting-started/running.md @@ -0,0 +1,68 @@ +# Running the App + +Once you've installed dependencies and set up your environment, you're ready to start the development server. + +--- + +## Start the Development Server + +```bash +# From inside server/ +npm run dev +``` + +Or, if you use Yarn: + +```bash +yarn dev +``` + +After a few seconds, you should see output like: + +``` +▲ Next.js 14.x.x +- Local: http://localhost:3000 +- Environments: .env +``` + +Open [http://localhost:3000](http://localhost:3000) in your browser. + +--- + +## What to Expect + +When you first open the app, you'll see the **login page**. Since there are no users yet, you'll need to create a Super Admin via the database or a seed script (check the repo README for seed instructions). + +--- + +## Useful npm Scripts + +| Command | Description | +|---|---| +| `npm run dev` | Start the development server with hot reload | +| `npm run build` | Build the app for production | +| `npm run start` | Start the production build | +| `npm run test` | Run all Jest tests | +| `npm run generate` | Regenerate Prisma client after schema changes | +| `npm run migrate:maindb` | Apply new Prisma migrations to the database | + +--- + +## Keeping Docker Running + +The database must be running while the app is active. If you stopped Docker, restart it: + +```bash +docker compose up -d +``` + +You can verify the database is up: + +```bash +docker ps # Should show a postgres container running +``` + +--- + +!!! tip "Hot Reload" + The dev server uses Next.js hot reloading — changes to your code will reflect in the browser instantly without a full restart. diff --git a/mk_docs/developer_docs/docs/getting-started/troubleshooting.md b/mk_docs/developer_docs/docs/getting-started/troubleshooting.md new file mode 100644 index 00000000..7a789838 --- /dev/null +++ b/mk_docs/developer_docs/docs/getting-started/troubleshooting.md @@ -0,0 +1,115 @@ +# Troubleshooting + +This page covers the most common issues you might run into when setting up or running Digital Logbook. + +--- + +## Common Issues + +### ❌ Port 3000 Already in Use + +**Error:** +``` +Error: listen EADDRINUSE: address already in use :::3000 +``` + +**Fix:** +Find and stop the process using port 3000, or run the app on a different port: + +```bash +# Find the process using port 3000 (Windows) +netstat -ano | findstr :3000 + +# Kill it (replace with the process ID) +taskkill /PID /F + +# Or run on a different port +PORT=3001 npm run dev +``` + +--- + +### ❌ Database Connection Error + +**Error:** +``` +Can't reach database server at localhost:5432 +``` + +**Fix:** +Your Docker container isn't running. Start it: + +```bash +docker compose up -d +``` + +Then verify it's up: + +```bash +docker ps # Should show a postgres container +``` + +--- + +### ❌ Missing Environment Variables + +**Error:** +``` +Error: Environment variable not found: JWT_SECRET +``` + +**Fix:** +Check that your `.env` file exists in `server/` and has all required variables. Compare with the [Environment Setup](environment.md) page. + +--- + +### ❌ Prisma Client Not Generated + +**Error:** +``` +Cannot find module '.prisma/client' +``` + +**Fix:** +Regenerate the Prisma client: + +```bash +npm run generate +``` + +--- + +### ❌ Schema / Migration Mismatch + +**Error:** +``` +The table 'public.Users' does not exist in the current database. +``` + +**Fix:** +Run migrations to bring the database up to date: + +```bash +npm run migrate:maindb +``` + +If issues persist, check `prisma/migrations/` for pending migrations. + +--- + +### ❌ Email Not Sending + +**Symptom:** Invitations are created, but users don't receive emails. + +**Fix:** +1. Double-check `EMAIL_USER` and `EMAIL_PASS` in `.env`. +2. If using Gmail, make sure you're using an **App Password**, not your regular password. +3. Check if Gmail has blocked the sign-in attempt — look for a security alert in your Gmail inbox. + +--- + +## Still Stuck? + +- Check the [Architecture](../architecture.md) page to understand the system better. +- Look at the [API Reference](../api/overview.md) for expected request/response shapes. +- Review the test files in `server/test/` for usage examples. diff --git a/mk_docs/developer_docs/docs/index.md b/mk_docs/developer_docs/docs/index.md new file mode 100644 index 00000000..f87053fb --- /dev/null +++ b/mk_docs/developer_docs/docs/index.md @@ -0,0 +1,144 @@ +# 📚 Digital Logbook + +> **A modern mentorship management platform** built for organizations that want to track student progress, coordinate mentors, manage projects, and generate reports — all in one place. + +--- + +## 🚀 What is Digital Logbook? + +**Digital Logbook** is a full-stack web application that helps organizations run structured mentorship programs. It connects students, mentors, and administrators in a single platform where: + +- 📋 **Students** log their daily activities and track their progress +- 👨‍🏫 **Mentors** review logs, give feedback, and monitor mentee performance +- 🛠️ **Admins** manage users, projects, invitations, and generate reports + +Whether you're onboarding a new batch of students or reviewing monthly progress, Digital Logbook has you covered. + +--- + +## ✨ Key Features + +| Feature | Description | +| ------------------------- | ------------------------------------------------------------------------- | +| 🔐 **Role-Based Access** | Three roles: Student, Mentor, Super Admin — each with their own dashboard | +| 📁 **Project Management** | Create projects, assign mentors and students, track progress | +| 📨 **Invitation System** | Invite users via email with secure token-based registration | +| 📊 **Activity Logging** | Students log activities; mentors approve or reject with feedback | +| 📈 **Reports** | Generate and export CSV/PDF reports for mentor activity | +| 📤 **Bulk Upload** | Upload Excel files to invite multiple users at once | +| 🖥️ **Admin Dashboard** | Analytics, user management, kanban board, and system overview | +| 🔒 **Secure Auth** | JWT-based authentication with cookie sessions | + +--- + +## 🏗️ System Architecture (Quick Overview) + +``` +User (Browser) + │ + ▼ +Next.js App (Frontend + API Routes) + │ + ├── API Routes (/api/*) ← Handles all backend logic + ├── Middleware ← JWT auth, role-based routing + ├── Services & Repositories ← Business logic + Prisma DB queries + │ + ▼ +PostgreSQL (via Prisma ORM) + │ + ▼ +Docker (containerized environment) +``` + +> For a detailed breakdown, see the [Architecture page](architecture.md). + +--- + +## 🛠️ Tech Stack + +| Layer | Technology | +| ------------ | ------------------------------------------------------ | +| **Frontend** | Next.js 14, React, TypeScript, Tailwind CSS, shadcn/ui | +| **Backend** | Node.js, Next.js API Routes | +| **Database** | PostgreSQL 16 with Prisma ORM | +| **Auth** | JSON Web Tokens (JWT), HTTP-only cookies | +| **Queue** | BullMQ + Redis (async report generation) | +| **Email** | Nodemailer (Gmail SMTP) | +| **Testing** | Jest (unit + integration tests) | +| **DevOps** | Docker, Docker Compose | + +--- + +## ⚡ Quick Start + +Get the project running in 5 minutes: + +```bash +# 1. Clone the repository +git clone +cd "Digital-Logbook v2/server" + +# 2. Install dependencies +nvm use +npm install + +# 3. Start the database (Docker) +docker compose up -d + +# 4. Set up your environment +cp .env.example .env # Edit with your values + +# 5. Run database migrations +npm run generate +npm run migrate:maindb + +# 6. Start the development server +npm run dev +``` + +Then open [http://localhost:3000](http://localhost:3000) in your browser. + +!!! tip "First time here?" +Head to the [Installation Guide](getting-started/installation.md) for a step-by-step walkthrough with detailed explanations. + +--- + +## 📖 How to Use This Documentation + +This documentation is organized to take you from zero to productive as quickly as possible: + +| Section | What You'll Learn | +| ---------------------------------------------- | ----------------------------------------------- | +| [Getting Started](getting-started/overview.md) | How to install, configure, and run the project | +| [Architecture](architecture.md) | How the system is structured and how data flows | +| [Features](features/admin-dashboard.md) | What each feature does and how to use it | +| [Components](components/shared-admin.md) | Reusable UI components and how to use them | +| [API Reference](api/overview.md) | All available API endpoints with examples | +| [Deployment](deployment/docker.md) | How to deploy with Docker | +| [Testing](testing.md) | How to run and interpret tests | + +--- + +## 👥 User Roles at a Glance + +``` +Super Admin +├── Manages all users, projects, and invitations +├── Views system-wide analytics and reports +└── Full access to all admin features + +Mentor +├── Reviews assigned student activity logs +├── Provides feedback and approves/rejects activities +└── Generates reports for their mentees + +Student +├── Logs daily activities and progress +├── Views feedback from mentor +└── Tracks assigned projects +``` + +--- + +!!! note "Source of Truth" +This documentation is maintained alongside the codebase. If you notice anything outdated, please open an issue or submit a pull request. diff --git a/mk_docs/developer_docs/docs/schema/README.md b/mk_docs/developer_docs/docs/schema/README.md new file mode 100644 index 00000000..dc960705 --- /dev/null +++ b/mk_docs/developer_docs/docs/schema/README.md @@ -0,0 +1,161 @@ +# Database Schema Reference + +> **Source of truth:** This file mirrors the schema documentation from the main project repository. +> The canonical definition is in `server/prisma/schema.prisma`. See [Database](../database.md) for the full model documentation. + +--- + +## Main Models + +### 1. Users + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `email` | String | Unique, Not Null | Login email | +| `passwordHash` | String | Nullable | Bcrypt-hashed password | +| `firstName` | String | Not Null | First name | +| `lastName` | String | Not Null | Last name | +| `emailConfirmed` | Boolean | Default: false | Email verification status | +| `role` | Enum | Not Null | `student`, `mentor`, `super_admin` | +| `isActive` | Boolean | Default: true | Account active status | +| `isFirstTimeLogin` | Boolean | Default: true | First-login flag | +| `invitedBy` | String | Nullable | ID of inviting user | +| `createdAt` | Timestamp | Default: now() | Creation time | +| `updatedAt` | Timestamp | Auto-updated | Last update time | + +--- + +### 2. Activities + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `studentId` | UUID | FK → Users.id | The student who logged this | +| `date` | DateTime | Not Null | When the activity occurred | +| `timeSpent` | Integer | Not Null | Duration in minutes | +| `notes` | String | Nullable | Additional notes | +| `createdAt` | Timestamp | Default: now() | Submission time | +| `updatedAt` | Timestamp | Auto-updated | Last update time | + +--- + +### 3. MentorFeedback + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `activityId` | UUID | FK → Activities.id | Activity being reviewed | +| `mentorId` | UUID | FK → Users.id | Reviewing mentor | +| `status` | Enum | Not Null | `approved`, `rejected`, `pending` | +| `feedbackNotes` | Text | Nullable | Mentor comments | +| `createdAt` | Timestamp | Default: now() | Feedback submission time | +| `updatedAt` | Timestamp | Auto-updated | Last update time | + +--- + +### 4. Reports + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `mentorId` | UUID | FK → Users.id | Report author | +| `reportData` | JSON | — | Report content/payload | +| `createdAt` | Timestamp | Default: now() | Creation time | + +--- + +### 5. Mentorship + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `mentorId` | UUID | FK → Users.id | The mentor | +| `studentId` | UUID | FK → Users.id | The student | + +--- + +### 6. Invitations + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `email` | String | Not Null | Invited email | +| `role` | Enum | Not Null | `student`, `mentor`, `super_admin` | +| `token` | String | Unique | Secure invitation token | +| `expiresAt` | DateTime | Not Null | Token expiry datetime | +| `accepted` | Boolean | Default: false | Whether invitation was used | +| `createdAt` | Timestamp | Default: now() | Creation time | + +--- + +### 7. Projects + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `name` | String | Not Null | Project name | +| `description` | String | Nullable | Short description | +| `domain` | Enum | Not Null | `software`, `film`, `training`, `research`, `other` | +| `createdBy` | UUID | FK → Users.id | Admin who created it | +| `createdAt` | Timestamp | Default: now() | Creation time | +| `updatedAt` | Timestamp | Auto-updated | Last update time | + +--- + +### 8. ProjectAssignments + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `projectId` | UUID | FK → Projects.id | The project | +| `studentId` | UUID | FK → Users.id | Assigned student | +| `assignedAt` | Timestamp | Default: now() | Assignment time | + +--- + +### 9. Badges + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `name` | String | Not Null | Badge name | +| `description` | String | Nullable | What the badge represents | +| `iconUrl` | String | Nullable | Badge icon image URL | +| `createdAt` | Timestamp | Default: now() | Creation time | + +--- + +### 10. UserBadges + +| Field | Type | Constraint | Description | +|---|---|---|---| +| `id` | UUID | Primary Key | Unique identifier | +| `userId` | UUID | FK → Users.id | User who earned it | +| `badgeId` | UUID | FK → Badges.id | The badge awarded | +| `awardedAt` | Timestamp | Default: now() | Award time | + +--- + +## ER Diagram + +```mermaid +erDiagram + Users ||--o{ Activities : "logs" + Users ||--o{ MentorFeedback : "gives" + Users ||--o{ Reports : "generates" + Users ||--o{ Mentorship : "mentor in" + Users ||--o{ Mentorship : "student in" + Users ||--o{ Invitations : "invited by" + Users ||--o{ Projects : "created by" + Users ||--o{ ProjectAssignments : "assigned to" + Users ||--o{ UserBadges : "earns" + + Activities ||--o{ MentorFeedback : "reviewed by" + Projects ||--o{ ProjectAssignments : "has" + Badges ||--o{ UserBadges : "awarded as" +``` + +--- + +For the complete and up-to-date schema, see `server/prisma/schema.prisma` in the main repository. diff --git a/mk_docs/developer_docs/docs/setup.md b/mk_docs/developer_docs/docs/setup.md new file mode 100644 index 00000000..363c0dda --- /dev/null +++ b/mk_docs/developer_docs/docs/setup.md @@ -0,0 +1,77 @@ +# Setup Guide + +!!! note "This page is a quick reference" + For a full step-by-step walkthrough, see the [Getting Started](getting-started/overview.md) section. + +--- + +## Prerequisites + +| Tool | Required Version | +|---|---| +| Node.js | v22.7.0 | +| npm | v10.8.2 | +| Docker | v27.1.2+ | +| PostgreSQL | v16.3 (via Docker) | +| nvm *(optional)* | Any | + +--- + +## Quick Setup + +```bash +# Clone and navigate +git clone +cd "Digital-Logbook v2/server" + +# Set Node version +nvm use + +# Install dependencies +npm install npm@10.8.2 +npm install + +# Start database +docker compose up -d + +# Apply migrations +npm run generate +npm run migrate:maindb + +# Start dev server +npm run dev +``` + +Visit [http://localhost:3000](http://localhost:3000) + +--- + +## Environment Variables + +Create `server/.env` with: + +```env +DATABASE_URL=postgresql://postgres:postgres@localhost:5432/digital_logbook +JWT_SECRET=your_jwt_secret +EMAIL_USER=your_email@gmail.com +EMAIL_PASS=your_email_password +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +ISSUER=your_issuer +AUDIENCE=your_audience +JWT_EXPIRY=1d +``` + +See [Environment Setup](getting-started/environment.md) for a full description of each variable. + +--- + +## Troubleshooting + +| Issue | Fix | +|---|---| +| Port 3000 in use | Stop other services or change the port | +| Database not connecting | Make sure Docker is running (`docker compose up -d`) | +| Missing env vars | Check your `.env` file | +| Prisma errors | Run `npm run generate` and `npm run migrate:maindb` | + +See [Troubleshooting](getting-started/troubleshooting.md) for more details. diff --git a/mk_docs/developer_docs/docs/special-logic.md b/mk_docs/developer_docs/docs/special-logic.md new file mode 100644 index 00000000..d8237525 --- /dev/null +++ b/mk_docs/developer_docs/docs/special-logic.md @@ -0,0 +1,149 @@ +# Special Logic & Middleware + +This page documents the non-obvious, system-critical logic that holds everything together — authentication middleware, email sending, report queuing, and error handling. + +--- + +## Authentication & Middleware + +Digital Logbook uses a **chained middleware** system to protect routes and enforce role-based access. + +### How It Works + +``` +Incoming Request + │ + ▼ + middleware.ts ← Entry point, composes multiple middlewares + │ + ├── authMiddleware.ts ← Validates JWT, checks session expiry + │ → Redirects to /login if token is missing or invalid + │ → Attaches user data to the request context + │ + └── chain.ts ← Utility to compose/chain multiple middlewares +``` + +### Key Files + +| File | Location | Purpose | +|---|---|---| +| `middleware.ts` | `server/src/middleware.ts` | Main entry point, chains all middlewares | +| `authMiddleware.ts` | `server/src/middlewares/authMiddleware.ts` | JWT validation, redirects on failure | +| `chain.ts` | `server/src/middlewares/chain.ts` | Composes multiple middlewares together | + +### What `authMiddleware.ts` Does + +1. Reads the JWT from the HTTP-only cookie +2. Verifies the token signature using `JWT_SECRET` +3. Checks that the token hasn't expired +4. Extracts the user's role and attaches it to the request +5. Redirects to `/login` if any check fails + +!!! note "Role-Based Routing" + After authentication, the middleware also checks if the user is accessing the correct section of the app (e.g., students can't access `/admin/*` routes). + +--- + +## Input Validation + +All API endpoints validate incoming data before processing: + +- **Required fields** are checked and return `400 Bad Request` if missing +- **Role checks** ensure only authorized roles can access each endpoint +- **Invitation tokens** are validated for existence, expiry, and whether they've already been used +- **Password hashing** is applied during registration using bcrypt + +--- + +## Email System + +Invitation emails are sent using **Nodemailer** with a Gmail SMTP backend. + +| File | Location | Purpose | +|---|---|---| +| `email.ts` | `server/src/lib/email.ts` | Core email sending utility | + +### What Gets Sent + +When an admin invites a new user: + +1. A secure, time-limited invitation token is generated +2. An email is composed with: + - The user's temporary password (if applicable) + - A registration link containing the token +3. The email is sent via Gmail SMTP + +!!! tip "Configuring Gmail" + Set `EMAIL_USER` and `EMAIL_PASS` in your `.env` file. Use a Gmail **App Password**, not your regular account password. + See [Environment Setup](getting-started/environment.md) for details. + +--- + +## Async Report Generation (BullMQ + Redis) + +Generating reports is a potentially slow operation — it involves querying the database, processing data, and building a file. To avoid blocking the API, report generation is handled **asynchronously** using a job queue. + +| File | Location | Purpose | +|---|---|---| +| `reportGenerator.ts` | `server/src/lib/reportGenerator.ts` | Builds mentor activity CSV reports | +| `queue.ts` | `server/src/lib/queue.ts` | BullMQ queue setup and job definitions | + +### How It Works + +``` +1. Mentor clicks "Generate Report" + │ + ▼ +2. API route adds a job to the BullMQ queue + (report status = "wip") + │ + ▼ +3. Background worker picks up the job from Redis + │ + ▼ +4. Report is generated and saved to the database + (report status = "completed") + │ + ▼ +5. Mentor refreshes and downloads the report +``` + +!!! warning "Redis Required" + BullMQ requires a running Redis instance. Make sure Redis is included in your `docker-compose.yml` or configured separately. + +--- + +## Error Handling + +All API routes follow a consistent error response format: + +```json +{ + "success": false, + "message": "A human-readable error description" +} +``` + +### HTTP Status Codes Used + +| Status Code | Meaning | When Used | +|---|---|---| +| `200 OK` | Success | Successful GET/PATCH | +| `201 Created` | Created | Successful POST (new resource) | +| `400 Bad Request` | Invalid input | Missing or invalid request data | +| `401 Unauthorized` | Not authenticated | Missing or invalid JWT | +| `403 Forbidden` | Not authorized | Valid JWT but wrong role | +| `404 Not Found` | Not found | Resource doesn't exist | +| `500 Internal Server Error` | Server error | Unexpected exceptions | + +### Transactional Deletes + +When deleting a user or invitation, the system uses **database transactions** to ensure all related records are cleaned up atomically — so you never end up with orphaned data. + +--- + +## Related Pages + +- [API Reference](api/overview.md) — Full list of endpoints and their auth requirements +- [Environment Setup](getting-started/environment.md) — Setting up JWT secrets and email credentials +- [Testing](testing.md) — How middleware and edge cases are tested diff --git a/mk_docs/developer_docs/docs/stylesheets/extra.css b/mk_docs/developer_docs/docs/stylesheets/extra.css new file mode 100644 index 00000000..f9020393 --- /dev/null +++ b/mk_docs/developer_docs/docs/stylesheets/extra.css @@ -0,0 +1,47 @@ +/* ───────────────────────────────────────────── + Digital Logbook — Custom Styles + ───────────────────────────────────────────── */ + +/* Logo size — 2x the default (default: 1.2rem) */ +.md-header__button.md-logo img, +.md-header__button.md-logo svg { + height: 2.4rem; + width: auto; +} + +/* Match navbar color to logo's dark purple-navy background */ +.md-header { + background-color: #0d0f24 !important; +} + +.md-tabs { + background-color: #0d0f24 !important; +} + +/* Thin accent line under the tabs bar */ +.md-tabs { + border-bottom: 2px solid rgba(120, 100, 255, 0.25) !important; +} + +/* Active/hover tab highlight — matches logo's purple accent */ +.md-tabs__link--active, +.md-tabs__link:hover { + color: #9b7fff !important; +} + +/* Tab text — bright white for readability */ +.md-tabs__link { + color: rgba(255, 255, 255, 0.85) !important; +} + +/* Subtle right border after logo to visually separate it from site name */ +.md-header__button.md-logo { + padding-right: 0.8rem !important; + margin-right: 0.4rem !important; + border-right: 1px solid rgba(255, 255, 255, 0.15) !important; +} + +/* Search bar blend */ +.md-search__form { + background-color: rgba(255, 255, 255, 0.08) !important; +} diff --git a/mk_docs/developer_docs/docs/testing.md b/mk_docs/developer_docs/docs/testing.md new file mode 100644 index 00000000..7b5cfcda --- /dev/null +++ b/mk_docs/developer_docs/docs/testing.md @@ -0,0 +1,141 @@ +# Testing + +This page explains how Digital Logbook is tested, what's covered, and how to run the tests yourself. + +--- + +## Testing Framework + +Digital Logbook uses **Jest** for all automated tests. + +| Tool | Purpose | +|---|---| +| **Jest** | Test runner and assertion library | +| **ts-jest** | TypeScript support for Jest | + +Test files live in `server/test/`. + +--- + +## Running Tests + +From inside the `server/` directory: + +```bash +npm run test +``` + +This will run all test suites and output a summary of passed/failed tests. + +--- + +## What's Tested + +The test suite covers the following areas: + +### API Endpoints + +| Area | What's Verified | +|---|---| +| **Projects API** | CRUD operations, filtering, pagination, validation | +| **Users API** | Auth checks, deduplication, error handling | +| **Invitations API** | Token lifecycle, expiry, security, edge cases | + +### UI Components + +| Component | What's Verified | +|---|---| +| **Sidebar** | Renders correct items by role, handles logout | +| **Toolbar** | Buttons, interactions | +| **Dropdown** | Selection behavior | +| **Email Template** | Correct content and formatting | + +### Database Layer + +- **Prisma model operations** — Create, read, update, delete for core models +- **Repository methods** — Ensures database queries return expected results + +### Data Validation + +- Missing required fields return correct error responses +- Invalid data is rejected cleanly +- Edge cases (e.g., duplicate invitations, expired tokens) are handled + +--- + +## Test Results + +| Suite | Tests | Pass Rate | +|---|---|---| +| Projects Page | 63 / 63 | ✅ 100% | +| Users API | All | ✅ ~99–100% | +| Invitations | All | ✅ ~99–100% | +| Components | All | ✅ ~99–100% | + +!!! tip "Detailed Test Reports" + For full test case documentation (including manual QA scenarios), see the `QA-Testcases/` folder in the repository. + +--- + +## Troubleshooting Test Failures + +### ❌ Prisma-Related Errors + +``` +Error: @prisma/client did not initialize yet +``` + +**Fix:** Regenerate the Prisma client and apply migrations: + +```bash +npm run generate +npm run migrate:maindb +``` + +--- + +### ❌ Database Connection Errors + +**Fix:** Make sure Docker is running and PostgreSQL is up: + +```bash +docker compose up -d +docker ps # Verify the postgres container is active +``` + +--- + +### ❌ Missing Environment Variables + +**Fix:** Check that your `.env` file in `server/` has all required variables. See [Environment Setup](getting-started/environment.md). + +--- + +### ❌ Outdated Test Data + +If tests were passing before and now fail after schema changes: + +1. Run `npm run migrate:maindb` to apply the latest migrations +2. Reseed test data if a seed script exists +3. Check if any test fixtures reference outdated field names + +--- + +## Writing New Tests + +When adding new features, follow this pattern: + +```typescript +// Example: Testing a repository method +import { ProjectRepository } from '../src/repositories/ProjectRepository'; + +describe('ProjectRepository', () => { + it('should return all projects', async () => { + const projects = await ProjectRepository.getAll(); + expect(Array.isArray(projects)).toBe(true); + }); +}); +``` + +!!! note "Test Isolation" + Use a test database or mock Prisma calls to avoid affecting real data when running tests. diff --git a/mk_docs/developer_docs/mkdocs b/mk_docs/developer_docs/mkdocs new file mode 100644 index 00000000..e69de29b diff --git a/mk_docs/developer_docs/mkdocs.yml b/mk_docs/developer_docs/mkdocs.yml new file mode 100644 index 00000000..817bbf02 --- /dev/null +++ b/mk_docs/developer_docs/mkdocs.yml @@ -0,0 +1,109 @@ +site_name: Digital Logbook +site_description: >- + Documentation for the Digital Logbook — a platform for tracking + student activities, mentor feedback, project assignments, and reporting. +site_author: Digital Logbook Team +docs_dir: docs + +extra_css: + - stylesheets/extra.css + +theme: + name: material + logo: assets/logo.png + favicon: assets/logo.png + palette: + - scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: indigo + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode + features: + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - navigation.expand + - navigation.top + - search.highlight + - search.suggest + - content.code.copy + - content.code.annotate + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.tabbed: + alternate_style: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - tables + - attr_list + - md_in_html + - toc: + permalink: true + +nav: + - Home: index.md + + - Getting Started: + - Overview: getting-started/overview.md + - Installation: getting-started/installation.md + - Environment Setup: getting-started/environment.md + - Running the App: getting-started/running.md + - Troubleshooting: getting-started/troubleshooting.md + + - Architecture: + - System Overview: architecture.md + - Database Schema: database.md + - Schema Reference: schema/README.md + + - Features: + - Admin Dashboard: features/admin-dashboard.md + - Projects: features/projects.md + - Invitations: features/invitations.md + - Bulk Invitation Upload: features/bulk-upload.md + - Users & Roles: features/users.md + - Activities & Feedback: features/activities-feedback.md + - Reports: features/reports.md + + - Components: + - Admin Components: + - Shared Admin UI: components/shared-admin.md + - Kanban Board: components/kanban.md + - Bulk Upload UI: components/bulk-upload-ui.md + - Navigation: + - Sidebar: components/sidebar.md + - Mentor Components: components/mentor.md + - Mentee Components: components/mentee.md + + - API Reference: + - Overview: api/overview.md + - Authentication: api/auth.md + - Projects: api/projects.md + - Invitations: api/invitations.md + - Users: api/users.md + - Reports: api/reports.md + + - Deployment: + - Docker Setup: deployment/docker.md + - Production Checklist: deployment/checklist.md + + - Advanced: + - Special Logic & Middleware: special-logic.md + + - Testing: testing.md diff --git a/mk_docs/user_docs/docs/404.md b/mk_docs/user_docs/docs/404.md new file mode 100644 index 00000000..dee85dc8 --- /dev/null +++ b/mk_docs/user_docs/docs/404.md @@ -0,0 +1,13 @@ +# Page Not Found + +The page you are looking for does not exist or may have been moved. + +## Try This + +- Go back to [Home](index.md) +- Visit [Getting Started](getting-started.md) +- Open [Troubleshooting](troubleshooting.md) +- Contact support from [Contact & Support](contact.md) + +!!! warning "Still Stuck?" + If you reached this page from a broken link, please report it to docs@digitallogbook.example.com. diff --git a/mk_docs/user_docs/docs/about.md b/mk_docs/user_docs/docs/about.md new file mode 100644 index 00000000..ade0a5bc --- /dev/null +++ b/mk_docs/user_docs/docs/about.md @@ -0,0 +1,74 @@ +# About Digital Logbook + +Digital Logbook is a role-based project tracking platform built for training programs, mentorship workflows, and academic industry projects. + +--- + +## Mission + +Our mission is to make project supervision simple, transparent, and measurable for everyone involved: + +- **Super Admins** manage users and program operations +- **Mentors** guide learners with actionable feedback +- **Students** document progress through structured activity logs + +--- + +## Why Teams Use Digital Logbook + +
+
+
🧭
+
+**Clear ownership** +Every role has a focused workspace and responsibilities +
+
+
+
🧱
+
+**Structured reporting** +Standardized logs make progress review consistent +
+
+
+
🧠
+
+**Better mentoring** +Feedback loops help students improve faster +
+
+
+
📦
+
+**Audit-ready history** +All entries are centralized for reporting and review +
+
+
+ +--- + +## Platform Modules + +| Module | Purpose | +|---|---| +| **Users** | Invitations, role assignment, access control | +| **Projects** | Project creation and mentor/student assignment | +| **Activity Logs** | Daily updates from students | +| **Feedback** | Comments, review notes, and mentoring guidance | +| **Reports** | Filtered analytics and export-ready summaries | + +--- + +## Product Values + +- **Clarity**: dashboards and records should be easy to understand +- **Consistency**: workflows should be repeatable across projects +- **Accountability**: every update should reflect real progress +- **Growth**: feedback should drive better outcomes over time + +--- + +!!! tip "Next" + Explore role-specific workflows in [super-admin.md](super-admin.md), [mentor.md](mentor.md), and [student.md](student.md). diff --git a/mk_docs/user_docs/docs/app-screenshots.md b/mk_docs/user_docs/docs/app-screenshots.md new file mode 100644 index 00000000..c02ea5a5 --- /dev/null +++ b/mk_docs/user_docs/docs/app-screenshots.md @@ -0,0 +1,198 @@ +# UI Screenshot Gallery + +All uploaded images are organized by module with separate Web View and Mobile View blocks. + +--- + +## Brand and Authentication + +### Brand Asset + +![Digital Logbook Logo]() + +=== "Web View" + + ![Sign In Web]() + +=== "Mobile View" + + ![Sign In Mobile]() + +--- + +## Super Admin Module + +### Dashboard + +=== "Web View" + + ![Admin Super Dashboard Web]() + +=== "Mobile View" + + ![Admin Super Dashboard Mobile]() + +### User Administration + +=== "Web View" + + ![User Administration Web]() + +=== "Mobile View" + + ![User Administration Mobile]() + +### Invitations + +=== "Web View" + + ![Invitations Web]() + ![Create Invitation Web]() + +=== "Mobile View" + + ![Invitations Mobile]() + ![Create Invitation Mobile]() + +### Bulk Upload + +=== "Web View" + + ![Bulk Upload Web]() + +=== "Mobile View" + + ![Bulk Upload Mobile]() + +### Projects + +=== "Web View" + + ![Projects Web]() + ![Create New Project Web]() + +=== "Mobile View" + + ![Projects Mobile]() + ![Create New Project Mobile]() + +### Reports and Export + +=== "Web View" + + ![Reports Web]() + ![Export Dashboard Report Web]() + +=== "Mobile View" + + ![Reports Mobile]() + ![Export Dashboard Report Mobile]() + +### Onboarding Approval + +=== "Web View" + + ![Onboarding Approval Web]() + ![Onboarding Mentor Web]() + ![Onboarding Create New Project Web]() + ![Onboarding Mentee Create New Project Web]() + +=== "Mobile View" + + ![Onboarding Approval Mobile]() + ![Onboarding Mentor Mobile]() + ![Onboarding Mentee Create New Project Mobile]() + ![Onboarding Mentor Create New Project Mobile]() + +--- + +## Mentor Module + +### Dashboard + +=== "Web View" + + ![Mentor Dashboard Web]() + +=== "Mobile View" + + ![Mentor Dashboard Mobile]() + +### Mentees + +=== "Web View" + + ![Mentees Web]() + +=== "Mobile View" + + ![Mentees Mobile]() + +### Calendar and Task Review + +=== "Web View" + + ![Calendar Web]() + ![All Mentee Tasks Web]() + ![Mentor Task Review Web]() + ![Calendar Task Details Web]() + +=== "Mobile View" + + ![Calendar Mobile]() + ![All Mentee Tasks Mobile]() + ![Mentor Task Review Mobile]() + ![Mentor Task Details Modal Mobile]() + +### Navigation and Session + +=== "Web View" + + ![Logout Web]() + +=== "Mobile View" + + ![Mobile Sidebar]() + ![Logout Mobile]() + +--- + +## Student Module + +### Dashboard + +=== "Web View" + + ![Student Dashboard Web]() + +=== "Mobile View" + + ![Student Dashboard Mobile]() + +### Monthly Attendance + +=== "Web View" + + ![Student Monthly Attendance Web]() + +=== "Mobile View" + + ![Student Monthly Attendance Mobile]() + +### Task Details + +=== "Web View" + + ![Student Task Details Web]() + ![Student Task Details Modal Web]() + +=== "Mobile View" + + ![Student Task Details Modal Mobile]() + +### Profile + +=== "Web View" + + ![Student Profile View]() + ![Student Profile Activities List]() diff --git a/mk_docs/user_docs/docs/assets/admin-workspace.svg b/mk_docs/user_docs/docs/assets/admin-workspace.svg new file mode 100644 index 00000000..d56dd9d4 --- /dev/null +++ b/mk_docs/user_docs/docs/assets/admin-workspace.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/mk_docs/user_docs/docs/assets/brand-logo.svg b/mk_docs/user_docs/docs/assets/brand-logo.svg new file mode 100644 index 00000000..6e56acf4 --- /dev/null +++ b/mk_docs/user_docs/docs/assets/brand-logo.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/mk_docs/user_docs/docs/assets/favicon.svg b/mk_docs/user_docs/docs/assets/favicon.svg new file mode 100644 index 00000000..00d5e010 --- /dev/null +++ b/mk_docs/user_docs/docs/assets/favicon.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/mk_docs/user_docs/docs/assets/mentor-workspace.svg b/mk_docs/user_docs/docs/assets/mentor-workspace.svg new file mode 100644 index 00000000..5d2b7708 --- /dev/null +++ b/mk_docs/user_docs/docs/assets/mentor-workspace.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/mk_docs/user_docs/docs/assets/myproject/Admin super dashboard mobile full.png b/mk_docs/user_docs/docs/assets/myproject/Admin super dashboard mobile full.png new file mode 100644 index 00000000..6610b061 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Admin super dashboard mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Admin super dashboard web.png b/mk_docs/user_docs/docs/assets/myproject/Admin super dashboard web.png new file mode 100644 index 00000000..4e21820b Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Admin super dashboard web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Admin super dashbord mobile part1.png b/mk_docs/user_docs/docs/assets/myproject/Admin super dashbord mobile part1.png new file mode 100644 index 00000000..8c92bf96 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Admin super dashbord mobile part1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Admin super dashbord mobile part2.png b/mk_docs/user_docs/docs/assets/myproject/Admin super dashbord mobile part2.png new file mode 100644 index 00000000..ef45f8be Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Admin super dashbord mobile part2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/All mentee Tasks.png b/mk_docs/user_docs/docs/assets/myproject/All mentee Tasks.png new file mode 100644 index 00000000..612243a9 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/All mentee Tasks.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/All mentee task mobile.png b/mk_docs/user_docs/docs/assets/myproject/All mentee task mobile.png new file mode 100644 index 00000000..106b735d Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/All mentee task mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Bulk upload mobile.png b/mk_docs/user_docs/docs/assets/myproject/Bulk upload mobile.png new file mode 100644 index 00000000..90af02ee Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Bulk upload mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Bulk upload web.png b/mk_docs/user_docs/docs/assets/myproject/Bulk upload web.png new file mode 100644 index 00000000..393cce68 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Bulk upload web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Create Invitation mobile.png b/mk_docs/user_docs/docs/assets/myproject/Create Invitation mobile.png new file mode 100644 index 00000000..93532928 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Create Invitation mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Create Invitation web.png b/mk_docs/user_docs/docs/assets/myproject/Create Invitation web.png new file mode 100644 index 00000000..43fd3298 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Create Invitation web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Export Dashbord report mobile.png b/mk_docs/user_docs/docs/assets/myproject/Export Dashbord report mobile.png new file mode 100644 index 00000000..a04adc8a Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Export Dashbord report mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Export Dashbord report web.png b/mk_docs/user_docs/docs/assets/myproject/Export Dashbord report web.png new file mode 100644 index 00000000..89b84a7d Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Export Dashbord report web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Invitation Mobile.png b/mk_docs/user_docs/docs/assets/myproject/Invitation Mobile.png new file mode 100644 index 00000000..47b9d03c Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Invitation Mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Invitation web.png b/mk_docs/user_docs/docs/assets/myproject/Invitation web.png new file mode 100644 index 00000000..e1b5a3a0 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Invitation web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentees mobile full.png b/mk_docs/user_docs/docs/assets/myproject/Mentees mobile full.png new file mode 100644 index 00000000..2e4c38c4 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentees mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentees mobile part 2.png b/mk_docs/user_docs/docs/assets/myproject/Mentees mobile part 2.png new file mode 100644 index 00000000..721b44b4 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentees mobile part 2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentees web.png b/mk_docs/user_docs/docs/assets/myproject/Mentees web.png new file mode 100644 index 00000000..491c4eb3 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentees web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentor Task Review mobile.png b/mk_docs/user_docs/docs/assets/myproject/Mentor Task Review mobile.png new file mode 100644 index 00000000..3eb78435 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentor Task Review mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentor Task Review web.png b/mk_docs/user_docs/docs/assets/myproject/Mentor Task Review web.png new file mode 100644 index 00000000..1cffdca5 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentor Task Review web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentor portal dashboard mobile full.png b/mk_docs/user_docs/docs/assets/myproject/Mentor portal dashboard mobile full.png new file mode 100644 index 00000000..81aff233 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentor portal dashboard mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentor portal dashbord mobile part1.png b/mk_docs/user_docs/docs/assets/myproject/Mentor portal dashbord mobile part1.png new file mode 100644 index 00000000..fa82e40a Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentor portal dashbord mobile part1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentor protal Dashboard mobile part 2.png b/mk_docs/user_docs/docs/assets/myproject/Mentor protal Dashboard mobile part 2.png new file mode 100644 index 00000000..7c5c248d Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentor protal Dashboard mobile part 2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mentor protal Dashboard web.png b/mk_docs/user_docs/docs/assets/myproject/Mentor protal Dashboard web.png new file mode 100644 index 00000000..73bc7967 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mentor protal Dashboard web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Mobile side bar.png b/mk_docs/user_docs/docs/assets/myproject/Mobile side bar.png new file mode 100644 index 00000000..6b73314c Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Mobile side bar.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Onboarding Approval web.png b/mk_docs/user_docs/docs/assets/myproject/Onboarding Approval web.png new file mode 100644 index 00000000..be727303 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Onboarding Approval web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Project web.png b/mk_docs/user_docs/docs/assets/myproject/Project web.png new file mode 100644 index 00000000..bee90349 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Project web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Report mobile full.png b/mk_docs/user_docs/docs/assets/myproject/Report mobile full.png new file mode 100644 index 00000000..eb1e6f29 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Report mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Report mobile part1.png b/mk_docs/user_docs/docs/assets/myproject/Report mobile part1.png new file mode 100644 index 00000000..ed49e234 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Report mobile part1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Reports web.png b/mk_docs/user_docs/docs/assets/myproject/Reports web.png new file mode 100644 index 00000000..0d9e4a5e Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Reports web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Sign in Mobile.png b/mk_docs/user_docs/docs/assets/myproject/Sign in Mobile.png new file mode 100644 index 00000000..0bad8612 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Sign in Mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Sign in web.png b/mk_docs/user_docs/docs/assets/myproject/Sign in web.png new file mode 100644 index 00000000..05243652 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Sign in web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/Student Mentee Dashbord web.png b/mk_docs/user_docs/docs/assets/myproject/Student Mentee Dashbord web.png new file mode 100644 index 00000000..caddf32d Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/Student Mentee Dashbord web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/User Adminsration Mobile.png b/mk_docs/user_docs/docs/assets/myproject/User Adminsration Mobile.png new file mode 100644 index 00000000..3dd8d91d Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/User Adminsration Mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/User Adminsration web.png b/mk_docs/user_docs/docs/assets/myproject/User Adminsration web.png new file mode 100644 index 00000000..66362dec Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/User Adminsration web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/calender mobile full.png b/mk_docs/user_docs/docs/assets/myproject/calender mobile full.png new file mode 100644 index 00000000..49e9fc00 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/calender mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/calender mobile1.png b/mk_docs/user_docs/docs/assets/myproject/calender mobile1.png new file mode 100644 index 00000000..4e7acc1b Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/calender mobile1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/calender task Details web.png b/mk_docs/user_docs/docs/assets/myproject/calender task Details web.png new file mode 100644 index 00000000..1837767c Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/calender task Details web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/calender web.png b/mk_docs/user_docs/docs/assets/myproject/calender web.png new file mode 100644 index 00000000..4213c28a Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/calender web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/clander mobile2.png b/mk_docs/user_docs/docs/assets/myproject/clander mobile2.png new file mode 100644 index 00000000..ab14c597 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/clander mobile2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/create new project mobile.png b/mk_docs/user_docs/docs/assets/myproject/create new project mobile.png new file mode 100644 index 00000000..a428018b Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/create new project mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/create new project web.png b/mk_docs/user_docs/docs/assets/myproject/create new project web.png new file mode 100644 index 00000000..d28af49c Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/create new project web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/logo Digital logbook.png b/mk_docs/user_docs/docs/assets/myproject/logo Digital logbook.png new file mode 100644 index 00000000..90c8c8d4 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/logo Digital logbook.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/logout mobile.png b/mk_docs/user_docs/docs/assets/myproject/logout mobile.png new file mode 100644 index 00000000..7365a271 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/logout mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/logout web.png b/mk_docs/user_docs/docs/assets/myproject/logout web.png new file mode 100644 index 00000000..72c0749d Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/logout web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/mentees mobile par1.png b/mk_docs/user_docs/docs/assets/myproject/mentees mobile par1.png new file mode 100644 index 00000000..df9d482c Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/mentees mobile par1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mentor mobile part2.png b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mentor mobile part2.png new file mode 100644 index 00000000..e9f41932 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mentor mobile part2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile full.png b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile full.png new file mode 100644 index 00000000..cbb99845 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile part 1.png b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile part 1.png new file mode 100644 index 00000000..7e38b9ae Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile part 1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile part2.png b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile part2.png new file mode 100644 index 00000000..cc9ff8c7 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding Approval mobile part2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding cratenewproject web.png b/mk_docs/user_docs/docs/assets/myproject/onboarding cratenewproject web.png new file mode 100644 index 00000000..54c98cbc Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding cratenewproject web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding mentee create new project moble.png b/mk_docs/user_docs/docs/assets/myproject/onboarding mentee create new project moble.png new file mode 100644 index 00000000..a4e78aa2 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding mentee create new project moble.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding mentee create new project.png b/mk_docs/user_docs/docs/assets/myproject/onboarding mentee create new project.png new file mode 100644 index 00000000..a6e834cc Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding mentee create new project.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding mentor mobile full.png b/mk_docs/user_docs/docs/assets/myproject/onboarding mentor mobile full.png new file mode 100644 index 00000000..3acbb2c1 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding mentor mobile full.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding mentor mobile part1.png b/mk_docs/user_docs/docs/assets/myproject/onboarding mentor mobile part1.png new file mode 100644 index 00000000..40de2bf2 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding mentor mobile part1.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding mentor web.png b/mk_docs/user_docs/docs/assets/myproject/onboarding mentor web.png new file mode 100644 index 00000000..c55b01ba Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding mentor web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/onboarding mobile mentor crate new project.png b/mk_docs/user_docs/docs/assets/myproject/onboarding mobile mentor crate new project.png new file mode 100644 index 00000000..a70d7d13 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/onboarding mobile mentor crate new project.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/project mobile.png b/mk_docs/user_docs/docs/assets/myproject/project mobile.png new file mode 100644 index 00000000..65b43562 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/project mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/report mobile part2.png b/mk_docs/user_docs/docs/assets/myproject/report mobile part2.png new file mode 100644 index 00000000..3bdf6c12 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/report mobile part2.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student mentee Dashbord mobile.png b/mk_docs/user_docs/docs/assets/myproject/student mentee Dashbord mobile.png new file mode 100644 index 00000000..18dcec89 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student mentee Dashbord mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student monthly Attendance web.png b/mk_docs/user_docs/docs/assets/myproject/student monthly Attendance web.png new file mode 100644 index 00000000..b5701c32 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student monthly Attendance web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student monthly attendence mobile.png b/mk_docs/user_docs/docs/assets/myproject/student monthly attendence mobile.png new file mode 100644 index 00000000..ea04089a Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student monthly attendence mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student profile view.png b/mk_docs/user_docs/docs/assets/myproject/student profile view.png new file mode 100644 index 00000000..aa4e3a12 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student profile view.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student tasks Details mobile.png b/mk_docs/user_docs/docs/assets/myproject/student tasks Details mobile.png new file mode 100644 index 00000000..1ba45c43 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student tasks Details mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student tasks details web.png b/mk_docs/user_docs/docs/assets/myproject/student tasks details web.png new file mode 100644 index 00000000..2e7b157c Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student tasks details web.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/student_profile_view_activities_list.png b/mk_docs/user_docs/docs/assets/myproject/student_profile_view_activities_list.png new file mode 100644 index 00000000..e6d88277 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/student_profile_view_activities_list.png differ diff --git a/mk_docs/user_docs/docs/assets/myproject/task details mobile.png b/mk_docs/user_docs/docs/assets/myproject/task details mobile.png new file mode 100644 index 00000000..e264c229 Binary files /dev/null and b/mk_docs/user_docs/docs/assets/myproject/task details mobile.png differ diff --git a/mk_docs/user_docs/docs/assets/student-workspace.svg b/mk_docs/user_docs/docs/assets/student-workspace.svg new file mode 100644 index 00000000..1d2a3de3 --- /dev/null +++ b/mk_docs/user_docs/docs/assets/student-workspace.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/mk_docs/user_docs/docs/changelog.md b/mk_docs/user_docs/docs/changelog.md new file mode 100644 index 00000000..848e4e2a --- /dev/null +++ b/mk_docs/user_docs/docs/changelog.md @@ -0,0 +1,48 @@ +# Release Notes + +This page tracks important updates to the Digital Logbook documentation and user guidance. + +--- + +## 2026-05-03 + +### Added + +- Full screenshot gallery with 60+ screenshots across all modules ([UI Screenshot Gallery](app-screenshots.md)) +- Web View / Mobile View tabs on every screenshot section +- Merged split mobile screenshots into single seamless full-page images +- User-friendly homepage with role picker cards (Super Admin / Mentor / Student) +- Quick navigation pills and section intro boxes on all role guides +- Onboarding Approval section added to Super Admin guide with all screenshots +- Product Tour updated with real screenshots for all 3 roles +- Onboarding Checklist updated with Web/Mobile tabs + +### Improved + +- All role guides (Super Admin, Mentor, Student) now have friendly emoji headings +- Images correctly separated into Web View and Mobile View tabs throughout all pages +- Mobile images sized correctly (max 340px width) to avoid oversized display +- Glossary expanded with more platform-specific terms + +--- + +## 2026-05-02 + +### Added + +- New role-specific guides for Super Admin, Mentor, and Student workflows +- Enhanced homepage with hero section, feature cards, and quick-start flow +- Dedicated troubleshooting and FAQ coverage +- New About page and Contact & Support page + +### Improved + +- Upgraded from basic docs style to a premium Material-based website layout +- Added dark/light mode support and improved sidebar navigation +- Improved readability with structured tables and callout sections + +### Technical + +- Added custom stylesheet and frontend animations for modern presentation +- Expanded MkDocs configuration with richer navigation and UX features + diff --git a/mk_docs/user_docs/docs/contact.md b/mk_docs/user_docs/docs/contact.md new file mode 100644 index 00000000..87203090 --- /dev/null +++ b/mk_docs/user_docs/docs/contact.md @@ -0,0 +1,48 @@ +# Contact & Support + +Need help with your Digital Logbook workspace? Use the options below. + +--- + +## Support Channels + +| Channel | Best For | Response Target | +|---|---|---| +| **Email Support** | Account access, invitations, technical issues | Within 24 hours | +| **Project Admin** | Role permissions, assignment changes | Same business day | +| **Mentor Contact** | Activity feedback clarifications | Within 1-2 days | + +--- + +## Contact Details + +- **Support Email**: support@digitallogbook.example.com +- **Operations**: ops@digitallogbook.example.com +- **Documentation Team**: docs@digitallogbook.example.com + +--- + +## What to Include in a Support Request + +For faster help, include: + +1. Your role (**Super Admin**, **Mentor**, or **Student**) +2. The exact issue you faced +3. Steps you took before the issue happened +4. Any error message shown on screen +5. Screenshots if available + +--- + +## Service Priorities + +| Priority | Example Issue | Typical Handling | +|---|---|---| +| **High** | Login blocked for many users | Immediate triage | +| **Medium** | Invitation not delivered | Same-day support | +| **Low** | UI text correction | Planned update cycle | + +--- + +!!! note "Security Reminder" + Never share your password in support emails. The support team will never ask for your password. diff --git a/mk_docs/user_docs/docs/feature-comparison.md b/mk_docs/user_docs/docs/feature-comparison.md new file mode 100644 index 00000000..ff486463 --- /dev/null +++ b/mk_docs/user_docs/docs/feature-comparison.md @@ -0,0 +1,56 @@ +# Feature Comparison + +Use this page to understand how Digital Logbook capabilities are distributed across roles. + +--- + +## At a Glance + +| Capability | Super Admin | Mentor | Student | +|---|---|---|---| +| User invitations | Yes | No | No | +| Project creation | Yes | No | No | +| Project assignment | Yes | Limited view | Limited view | +| Daily activity submissions | No | No | Yes | +| Activity review | Yes | Yes | Own only | +| Feedback authoring | Yes | Yes | No | +| Report export (PDF) | Yes | Limited | No | +| Role management | Yes | No | No | + +--- + +## Recommended Workflow Ownership + +| Workflow | Primary Role | Supporting Role | +|---|---|---| +| New user onboarding | Super Admin | Mentor | +| Weekly progress review | Mentor | Student | +| Blocker escalation | Student | Mentor, Super Admin | +| Monthly reporting | Super Admin | Mentor | + +--- + +## Best Fit by Team Scenario + +### Training Program + +- Super Admin configures projects and cohorts +- Mentors run weekly review cadence +- Students log daily progress and blockers + +### Internship Tracking + +- Super Admin manages internship projects and supervisors +- Mentors validate deliverables +- Students maintain activity history for assessment + +### Multi-Project Academic Teams + +- Super Admin monitors cross-project assignments +- Mentors focus on feedback quality +- Students maintain clear next-step planning + +--- + +!!! tip + Pair this page with [role-permissions.md](role-permissions.md) for governance and [workflow-examples.md](workflow-examples.md) for operational flow. diff --git a/mk_docs/user_docs/docs/getting-started.md b/mk_docs/user_docs/docs/getting-started.md new file mode 100644 index 00000000..63bcd9a4 --- /dev/null +++ b/mk_docs/user_docs/docs/getting-started.md @@ -0,0 +1,139 @@ +# Getting Started + +This guide will help you activate your account and log in to the Digital Logbook platform for the first time. + +--- + +## First Time Account Setup + +!!! info "Before You Begin" + You must receive an invitation email from a Super Admin before you can register. Contact your Super Admin if you have not received one. + +### Step 1: Check Your Email + +You will receive an invitation email from the Digital Logbook system. Open your inbox and look for the invitation message. + +**Cannot find the email?** + +- Check your **Spam** or **Junk** folder +- Ask the Super Admin to resend the invitation + +--- + +### Step 2: Open the Invitation Link + +Click the invitation link inside the email. This link opens the registration page and activates your account setup process. + +!!! warning "Link Expiry" + Invitation links expire after a set period. If your link is no longer working, contact the Super Admin and request a new invitation. + +--- + +### Step 3: Complete Your Registration + +Fill in your details on the registration form: + +- **Full Name** +- **Email Address** (pre-filled) +- **Password** — choose a strong, memorable password + +Click **Submit** to complete your registration. + +--- + +### Step 4: Login to the System + +Once registered, you can log in: + +1. Open the login page +2. Enter your **email address** +3. Enter your **password** +4. Click **Login** + +You will be redirected to your dashboard. + +### Login Screen Preview + +=== "Web View" + + ![Sign In Screen - Web](){ .ui-shot } + +=== "Mobile View" + + ![Sign In Screen - Mobile](){ .ui-shot } + +--- + +## Daily Login Process + +For returning users, follow these steps every time you log in: + +1. Open the login page +2. Enter your **email address** +3. Enter your **password** +4. Click **Login** +5. Wait for your dashboard to load + +After logging in, use the **left sidebar menu** to navigate the system. + +--- + +## Understanding the Dashboard + +The dashboard is your main overview page. Depending on your role, it may show: + +| Element | Description | +|---|---| +| **Assigned Projects** | Projects you are linked to | +| **Recent Activities** | Latest activity log entries | +| **Progress Summary** | Overall project progress status | +| **Notifications** | System alerts and updates | + +=== "Super Admin" + + ![Admin Dashboard (Web)](){ .ui-shot } + +=== "Mentor" + + ![Mentor Dashboard (Web)](){ .ui-shot } + +=== "Student" + + ![Student Dashboard (Web)](){ .ui-shot } + +--- + +## Navigating the System + +### Sidebar Menu + +The left sidebar provides access to all system modules: + +- **Dashboard** — Main overview +- **Users** — Manage or view users (Super Admin only) +- **Projects** — View and manage projects +- **Activity Logs** — Log and review daily activities +- **Reports** — Generate and export reports +- **Feedback** — View and write feedback + +Available menu items depend on your assigned role. + +### Search and Filters + +Most listing pages include a search bar and filter options to help you quickly find: + +- Projects +- Students +- Activity logs +- Reports + +### Pagination + +When a page contains many records, they are split into multiple pages. Use the **pagination controls** at the bottom of the page to navigate between pages. + +--- + +!!! tip "Next Steps" + - **Super Admins** → [Super Admin Guide](super-admin.md) + - **Mentors** → [Mentor Guide](mentor.md) + - **Students** → [Student Guide](student.md) diff --git a/mk_docs/user_docs/docs/glossary.md b/mk_docs/user_docs/docs/glossary.md new file mode 100644 index 00000000..f5681f2e --- /dev/null +++ b/mk_docs/user_docs/docs/glossary.md @@ -0,0 +1,93 @@ +# Glossary + +Key terms used across the Digital Logbook platform. + +--- + +## Core Terms + +**Activity Log** +: A daily or periodic update submitted by a student describing tasks, results, blockers, and next actions. + +**Activity Feed** +: The list of all submitted activity logs shown on the dashboard. + +**Invitation** +: A secure email link used to activate a user account. + +**Pending Invitation** +: An invitation that has been sent but not accepted. + +**Expired Invitation** +: An invitation link that is no longer valid and must be reissued. + +**Bulk Upload** +: Inviting multiple users at once by uploading a spreadsheet file instead of sending individual invitations. + +**Project Assignment** +: Linking mentors and students to a specific project. + +**Feedback Entry** +: A mentor or admin comment attached to an activity log to guide improvement. + +**Blocker** +: A problem preventing progress (for example, dependency delay, missing access, or unresolved issue). + +**Role-Based Access** +: Permission model where each user sees only the modules and actions allowed by their role. + +**Report Export** +: Downloading filtered project/activity data as PDF or CSV for review or sharing. + +**Monthly Attendance** +: A calendar view showing which days a student logged activity. Weekends are highlighted in pink. + +**Bench** +: The list of approved users who are not yet assigned to any project. Mentor Bench and Mentee Bench are shown on the Onboarding Approval page. + +**Onboarding Approval** +: The process where a Super Admin reviews and approves incoming mentor or student applications before they can be assigned to projects. + +**Badge** +: An achievement awarded to students for consistent or high-quality activity submissions (e.g. Rising Star). + +**Profile Report** +: A full PDF summary of a student's activity history, badges, and progress. Generated from the Profile page. + +--- + +## Role Terms + +**Super Admin** +: Platform manager with full control over users, projects, invitations, onboarding, and reports. + +**Mentor** +: Reviewer and guide responsible for evaluating student updates and providing feedback. + +**Student (Mentee)** +: Contributor who logs daily progress and acts on mentor suggestions. + +--- + +## Status Terms + +**Active** +: User or project is currently in use. + +**Pending** +: Waiting for review or approval. + +**Approved** +: Reviewed and accepted by a mentor or admin. + +**Rejected** +: Reviewed and declined. The user may need to resubmit. + +--- + +## Quick References + +- Role capabilities: [Feature Comparison](feature-comparison.md) +- Permission boundaries: [Role Permissions](role-permissions.md) +- Operational examples: [Workflow Examples](workflow-examples.md) + diff --git a/mk_docs/user_docs/docs/index.md b/mk_docs/user_docs/docs/index.md new file mode 100644 index 00000000..8574b2bc --- /dev/null +++ b/mk_docs/user_docs/docs/index.md @@ -0,0 +1,451 @@ +# Home + +
+ +# 📓 Digital Logbook + +**Track your work. Get feedback. Grow every day.** +A simple platform for Super Admins, Mentors, and Students. + +
+[🚀 Get Started](getting-started.md){ .hero-btn .hero-btn-primary } +[📖 View Guides](#who-are-you){ .hero-btn .hero-btn-secondary } +
+ +
+ +--- + +## 👋 What is Digital Logbook? + +Digital Logbook is a simple online tool that helps teams work together. Here is what each person does: + +| 👤 Role | 🎯 What they do | +|---|---| +| **Super Admin** | Invites users, creates projects, sees reports | +| **Mentor** | Reviews student work and gives helpful feedback | +| **Student** | Logs daily work activities and reads feedback | + +--- + +## 🙋 Who Are You? + +Click your role below to jump straight to your guide! + +
+ + +🛡️ +Super Admin +I manage users and projects + + + +🎓 +Mentor +I review student work and give feedback + + + +📝 +Student +I log my daily work activities + + +
+ +--- + +## 🚀 How to Get Started — 4 Simple Steps + +
+ +
+
1
+
+**Check your email 📬** +

You will receive an invitation email. Look for it in your inbox (or spam folder).

+
+
+ +
+
2
+
+**Click the invitation link 🔗** +

The link in the email takes you to the registration page.

+
+
+ +
+
3
+
+**Set up your account 🔐** +

Fill in your name, choose a password, and click Register.

+
+
+ +
+
4
+
+**Log in and explore! 🎉** +

Use your email and password to log in. Your dashboard is ready to go.

+
+
+ +
+ +[Full Getting Started Guide →](getting-started.md) + +--- + +## ✨ What Can You Do? + +
+ +
+
👥
+
+**Invite Users** +Add team members easily by email +
+
+ +
+
📁
+
+**Manage Projects** +Create projects and assign people to them +
+
+ +
+
📋
+
+**Log Activities** +Students write daily work logs easily +
+
+ +
+
💬
+
+**Give Feedback** +Mentors comment directly on student work +
+
+ +
+
📊
+
+**View Reports** +Download PDF summaries of team progress +
+
+ +
+
📅
+
+**Track Attendance** +Monthly calendar shows daily activity status +
+
+ +
+ +--- + +
+
+
0
+
User Roles
+
+
+
0
+
Always Available
+
+
+
0
+
Web Based
+
+
+
0
+
Central Workspace
+
+
+ +--- + +## 📚 Explore More + +- [🚀 Getting Started](getting-started.md) — First login and account setup +- [✅ Onboarding Checklist](onboarding-checklist.md) — Step by step setup checklist +- [🖼️ UI Screenshot Gallery](app-screenshots.md) — See every screen in the app +- [🔄 Workflow Examples](workflow-examples.md) — Real usage scenarios +- [🔐 Security & Privacy](security-and-privacy.md) — How your data is protected +- [❓ Troubleshooting](troubleshooting.md) — Fix common problems +- [📞 Contact & Support](contact.md) — Get help from your admin + +--- + +!!! tip "Not sure where to start?" + If you are a **new user**, go to [Getting Started](getting-started.md) first. It will walk you through everything step by step! + + +--- + +## What is Digital Logbook? + +Digital Logbook is a centralized web platform that streamlines the full project lifecycle — from inviting users and assigning projects to tracking daily work logs and generating progress reports. Every role has a dedicated workspace tailored to their responsibilities. + +
+
+
⚡
+
+**Fast onboarding** +Invite users and activate accounts in minutes +
+
+
+
🔐
+
+**Role-based access** +Clear permission boundaries for every user type +
+
+
+
📈
+
+**Progress visibility** +Track team momentum with structured daily logs +
+
+
+ +--- + +## Platform Snapshot + +| Metric | Why it matters | +|---|---| +| **3 core user roles** | Each role has a focused workspace and responsibilities | +| **Daily activity tracking** | Encourages consistent updates and accountability | +| **End-to-end reporting** | Convert team activity into actionable summaries | +| **Feedback loop** | Mentors guide students with contextual comments | + +
+
+
0
+
Core Roles
+
+
+
0
+
Access Availability
+
+
+
0
+
Centralized Tracking
+
+
+
0
+
Unified Workspace
+
+
+ +--- + +## User Guides + +
+ +
+
🛡️
+ +### Super Admin + +Manage all users, send invitations, create and assign projects, and generate reports. + +[Read Super Admin Guide →](super-admin.md) +
+ +
+
🎓
+ +### Mentor + +Review student activity logs, monitor progress, and provide constructive feedback. + +[Read Mentor Guide →](mentor.md) +
+ +
+
📝
+ +### Student + +Log your daily activities, track project progress, and read mentor feedback. + +[Read Student Guide →](student.md) +
+ +
+ +--- + +## Key Features + +
+ +
+
👥
+
+**User Management** +Role-based access with invitation system +
+
+ +
+
📁
+
+**Project Management** +Create projects and assign team members +
+
+ +
+
📋
+
+**Activity Logs** +Daily task logging for students +
+
+ +
+
💬
+
+**Feedback System** +Mentors review and comment on work +
+
+ +
+
📊
+
+**Reports & Exports** +Generate and download PDF reports +
+
+ +
+
🔔
+
+**Notifications** +Stay updated with real-time alerts +
+
+ +
+ +--- + +## Quick Start Steps + +
+ +
+
1
+
+**Check your email** +

You will receive an invitation email from the system to activate your account.

+
+
+ +
+
2
+
+**Click the invitation link** +

The link opens the registration page where you complete your account setup.

+
+
+ +
+
3
+
+**Register and set your password** +

Fill in your details, create a strong password, and submit the form.

+
+
+ +
+
4
+
+**Log in and explore your dashboard** +

Use your credentials to log in and start using the system based on your role.

+
+
+ +
+ +[Full Getting Started Guide →](getting-started.md) + +[Take Product Tour →](product-tour.md) + +--- + +## Explore More + +- [About Digital Logbook](about.md) +- [Onboarding Checklist](onboarding-checklist.md) +- [Product Tour](product-tour.md) +- [Workflow Examples](workflow-examples.md) +- [Feature Comparison](feature-comparison.md) +- [Role Permissions Matrix](role-permissions.md) +- [Security and Privacy](security-and-privacy.md) +- [Contact & Support](contact.md) +- [Release Notes](changelog.md) +- [Glossary](glossary.md) +- [Complete User Guide](user-guide.md) + +--- + +## User Journey + +
+ +
+
1
+
+**Activate account** +

Start with invitation setup and first login from Getting Started.

+
+
+ +
+
2
+
+**Complete onboarding** +

Use the Onboarding Checklist to confirm your setup is complete.

+
+
+ +
+
3
+
+**Run real workflows** +

Follow practical scenarios in Workflow Examples.

+
+
+ +
+
4
+
+**Operate safely** +

Review access boundaries and data handling in Role Permissions and Security & Privacy.

+
+
+ +
+ +--- + +!!! tip "Need help?" + Visit the [Troubleshooting & FAQ](troubleshooting.md) page for solutions to common problems or contact your Super Admin for account assistance. diff --git a/mk_docs/user_docs/docs/javascripts/extra.js b/mk_docs/user_docs/docs/javascripts/extra.js new file mode 100644 index 00000000..3d4c260f --- /dev/null +++ b/mk_docs/user_docs/docs/javascripts/extra.js @@ -0,0 +1,68 @@ +document.addEventListener("DOMContentLoaded", () => { + const animated = document.querySelectorAll( + ".role-card, .feature-item, .step, .kpi-card" + ); + const counters = document.querySelectorAll(".kpi-value[data-counter]"); + + const animateCounter = (el) => { + const target = Number.parseInt(el.dataset.counter || "0", 10); + const prefix = el.dataset.prefix || ""; + const suffix = el.dataset.suffix || ""; + const duration = 1100; + const start = performance.now(); + + const tick = (now) => { + const progress = Math.min((now - start) / duration, 1); + const value = Math.floor(progress * target); + el.textContent = `${prefix}${value}${suffix}`; + + if (progress < 1) { + requestAnimationFrame(tick); + } else { + el.textContent = `${prefix}${target}${suffix}`; + } + }; + + requestAnimationFrame(tick); + }; + + if (!animated.length || !("IntersectionObserver" in window)) { + counters.forEach((el) => { + const prefix = el.dataset.prefix || ""; + const suffix = el.dataset.suffix || ""; + el.textContent = `${prefix}${el.dataset.counter || "0"}${suffix}`; + }); + return; + } + + animated.forEach((el, i) => { + el.classList.add("reveal"); + el.style.setProperty("--delay", `${Math.min(i * 70, 420)}ms`); + }); + + const observer = new IntersectionObserver( + (entries) => { + entries.forEach((entry) => { + if (entry.isIntersecting) { + entry.target.classList.add("is-visible"); + + if ( + entry.target.classList.contains("kpi-card") && + !entry.target.dataset.counted + ) { + const counter = entry.target.querySelector(".kpi-value[data-counter]"); + if (counter) { + animateCounter(counter); + entry.target.dataset.counted = "true"; + } + } + + observer.unobserve(entry.target); + } + }); + }, + { threshold: 0.15 } + ); + + animated.forEach((el) => observer.observe(el)); +}); diff --git a/mk_docs/user_docs/docs/mentor.md b/mk_docs/user_docs/docs/mentor.md new file mode 100644 index 00000000..d612dec9 --- /dev/null +++ b/mk_docs/user_docs/docs/mentor.md @@ -0,0 +1,162 @@ +# 🎓 Mentor Guide + +
+Welcome, Mentor! 👋 Your job is to support students. This guide shows you how to see your students' work, review their logs, and write helpful feedback — step by step. +
+ +
+[👩‍🎓 View Students](#viewing-your-assigned-students) +[📋 Review Activities](#reviewing-student-activities) +[💬 Give Feedback](#providing-feedback) +[📈 Track Progress](#monitoring-student-progress) +
+ +--- + +## 📋 What Can You Do? + +| 🎯 Task | 📝 Description | +|---|---| +| **View Students** | See all students assigned to your projects | +| **Review Activities** | Read submitted activity logs | +| **Provide Feedback** | Write comments and suggestions on student entries | +| **Monitor Progress** | Track student consistency and overall progress | + +--- + +## 🖥️ Your Dashboard + +
+This is what you will see when you log in. From here you can access all your students and their work. +
+ +![Mentor Dashboard (Web)](){ .ui-shot } +![Mentor Dashboard (Mobile)](){ .ui-shot } + +--- + +## 👩‍🎓 Viewing Your Assigned Students + +
+💡 Here you can see all the students that have been assigned to your projects. Click on any student to see their work. +
+ +1. Log in to the system +2. Open the **Students** section from the sidebar +3. Review the list of students assigned to your projects + +!!! tip + Use the search bar or filters if you have a large number of students assigned. + +![Mentees Page (Web)](){ .ui-shot } +![Mentees Page (Mobile)](){ .ui-shot } + +--- + +## 📋 Reviewing Student Activities + +
+💡 Students write a work log every day. You can read what they did, what challenges they had, and what they plan to do next. +
+ +Student activity logs show what work was completed, what challenges were faced, and what is planned next. + +### Steps to Review an Activity + +1. Open a student's **profile** or go to the **Activity Logs** section +2. Select a specific activity entry to view the full details +3. Review the following fields: + - Tasks completed + - Results achieved + - Blockers or challenges + - Planned next steps + +!!! note "Consistency Matters" + Check whether the student is submitting logs regularly. Inconsistent updates may signal that a student needs additional support. + +=== "Web View" + + ![Mentor Calendar (Web)](){ .ui-shot } + ![All Mentee Tasks (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Mentor Calendar (Mobile)](){ .ui-shot } + ![All Mentee Tasks (Mobile)](){ .ui-shot } + +--- + +## 💬 Providing Feedback + +
+💡 After reading a student's log, you can write a comment to help them improve. Your feedback will appear on their next login. +
+ +Feedback helps students improve their work and stay on track. + +### Steps to Leave Feedback + +1. Open a student's activity entry +2. Scroll to the **Feedback** section +3. Write your comments in the feedback field +4. Click **Save** to submit your feedback + +The student will be notified and can view your comments on their next login. + +=== "Web View" + + ![Mentor Task Review (Web)](){ .ui-shot } + ![Calendar Task Details (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Mentor Task Review (Mobile)](){ .ui-shot } + ![Mentor Task Details Modal (Mobile)](){ .ui-shot } + +--- + +## Writing Effective Feedback + +Good feedback should be: + +| Quality | Description | +|---|---| +| **Clear** | Easy to understand with no ambiguity | +| **Constructive** | Focused on improvement, not just criticism | +| **Specific** | Reference specific tasks or issues | +| **Actionable** | Give the student something concrete to act on | +| **Encouraging** | Acknowledge good work alongside areas for improvement | + +### Example of Good Feedback + +> "Your task breakdown is detailed and well structured. For next week, try to include the specific outcomes or results for each task rather than just listing what was done. This will help show the impact of your work more clearly." + +### Example of Poor Feedback + +> "Good job. Keep it up." + +--- + +## Monitoring Student Progress + +Regularly reviewing student progress helps you identify students who may be struggling early. + +Signs a student may need extra support: + +- Missing or infrequent activity log updates +- Consistently reporting the same blockers +- Vague or incomplete entries +- No improvement after previous feedback + +!!! tip "Be Proactive" + Reach out to students who appear to be falling behind rather than waiting for them to ask for help. + +--- + +## Best Practices for Mentors + +- Review student activity logs at least once a week +- Respond to activity entries with timely, actionable feedback +- Acknowledge progress and improvements, not just problems +- Support students who are struggling with additional guidance +- Log out after working on shared or public devices diff --git a/mk_docs/user_docs/docs/mkdocs.yml b/mk_docs/user_docs/docs/mkdocs.yml new file mode 100644 index 00000000..0e65daed --- /dev/null +++ b/mk_docs/user_docs/docs/mkdocs.yml @@ -0,0 +1,19 @@ +site_name: Digital Logbook +site_description: Complete User Guide for Digital Logbook Platform +site_author: Digital Logbook Team + +docs_dir: . + +theme: + name: readthedocs + highlightjs: true + +nav: + - Home: index.md + - User Guide: user-guide.md + +markdown_extensions: + - admonition + - toc: + permalink: true + - tables diff --git a/mk_docs/user_docs/docs/onboarding-checklist.md b/mk_docs/user_docs/docs/onboarding-checklist.md new file mode 100644 index 00000000..f38e7403 --- /dev/null +++ b/mk_docs/user_docs/docs/onboarding-checklist.md @@ -0,0 +1,81 @@ +# Onboarding Checklist + +Use this checklist to go from invited user to productive daily usage. + +--- + +## Day 0: Account Activation + +- [ ] Invitation email received +- [ ] Invitation link opened +- [ ] Registration form submitted +- [ ] First login completed +- [ ] Profile details verified + +!!! tip + If the invitation link is expired, request a new one from your Super Admin. + +--- + +## Day 1: Workspace Setup + +- [ ] Confirm your role and permissions +- [ ] Review assigned projects +- [ ] Check dashboard widgets and notifications +- [ ] Open your role guide and read required sections + +=== "Web View" + + ![Onboarding Approval (Web)](){ .ui-shot } + ![Onboarding Mentor Tab (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Onboarding Approval (Mobile)](){ .ui-shot } + ![Onboarding Mentor Tab (Mobile)](){ .ui-shot } + +Role guide links: + +- [Super Admin Guide](super-admin.md) +- [Mentor Guide](mentor.md) +- [Student Guide](student.md) + +--- + +## Day 2-3: First Workflow Completed + +- [ ] Super Admin sent at least one invitation and created one project +- [ ] Mentor reviewed at least one student activity and gave feedback +- [ ] Student submitted at least one full activity log + +### Onboarding Project Creation Example + +=== "Web View" + + ![Create New Project (Web)](){ .ui-shot } + ![Create New Project Mentee (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Create New Project - Mentee (Mobile)](){ .ui-shot } + ![Create New Project - Mentor (Mobile)](){ .ui-shot } + +--- + +## Week 1: Quality and Consistency + +- [ ] Activity logs are submitted consistently +- [ ] Feedback cycle is active between mentor and students +- [ ] Project assignment list is up to date +- [ ] Reports generated at least once + +--- + +## Done Criteria + +Your onboarding is complete when all of the following are true: + +- You can log in without issues +- You understand your role responsibilities +- You completed one full role-specific workflow +- You can find help through [Troubleshooting](troubleshooting.md) and [Contact & Support](contact.md) diff --git a/mk_docs/user_docs/docs/product-tour.md b/mk_docs/user_docs/docs/product-tour.md new file mode 100644 index 00000000..32da329a --- /dev/null +++ b/mk_docs/user_docs/docs/product-tour.md @@ -0,0 +1,119 @@ +# 🗺️ Product Tour + +This tour walks new users through the platform from first login to daily operations. Follow along with the screenshots to know exactly what to expect. + +--- + +## Tour Map + +1. [Access and Login](#1-access-and-login) +2. [Dashboard Orientation](#2-dashboard-orientation) +3. [Role-Specific Workflows](#3-role-specific-workflows) +4. [Reporting and Support](#4-reporting-and-support) + +--- + +## 1) Access and Login + +- Open the invitation email and register your account +- Sign in with your credentials +- Confirm role-specific menu visibility + +=== "Web View" + + ![Sign In Screen (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Sign In Screen (Mobile)](){ .ui-shot } + +!!! tip + If you are a new user, go to [Getting Started](getting-started.md) first. + +--- + +## 2) Dashboard Orientation + +After login, your dashboard shows everything important at a glance. + +=== "Super Admin Dashboard" + + ![Admin Dashboard (Web)](){ .ui-shot } + +=== "Mentor Dashboard" + + ![Mentor Dashboard (Web)](){ .ui-shot } + +=== "Student Dashboard" + + ![Student Dashboard (Web)](){ .ui-shot } + +!!! tip + If data appears missing, check filters and pagination first. + +--- + +## 3) Role-Specific Workflows + +=== "Super Admin" + + **Invite users and manage the team:** + + ![Invitations (Web)](){ .ui-shot } + + **Create projects and assign team members:** + + ![Projects (Web)](){ .ui-shot } + + **Approve onboarding applications:** + + ![Onboarding Approval (Web)](){ .ui-shot } + + Next: [Super Admin Guide →](super-admin.md) + +=== "Mentor" + + **View your assigned students:** + + ![Mentees Page (Web)](){ .ui-shot } + + **Review student activity logs and give feedback:** + + ![Mentor Task Review (Web)](){ .ui-shot } + + Next: [Mentor Guide →](mentor.md) + +=== "Student" + + **Log your daily activity from the calendar:** + + ![Monthly Attendance Calendar (Web)](){ .ui-shot } + + **View your profile and activity history:** + + ![Student Profile (Web)](){ .ui-shot } + + Next: [Student Guide →](student.md) + +--- + +## 4) Reporting and Support + +**Super Admins can generate and export reports:** + +![Reports (Web)](){ .ui-shot } + +- Check [Workflow Examples](workflow-examples.md) for real scenarios +- Use [Role Permissions](role-permissions.md) before requesting access changes +- Contact support via [Contact & Support](contact.md) + +--- + +## ✅ Completion Checklist + +- [ ] I can log in successfully +- [ ] I can navigate my role dashboard +- [ ] I completed at least one role workflow +- [ ] I know where to get help when blocked +- [ ] I understand access boundaries and data handling rules + diff --git a/mk_docs/user_docs/docs/role-permissions.md b/mk_docs/user_docs/docs/role-permissions.md new file mode 100644 index 00000000..f40146f9 --- /dev/null +++ b/mk_docs/user_docs/docs/role-permissions.md @@ -0,0 +1,53 @@ +# Role Permissions Matrix + +This page clarifies which role can access each core module. + +--- + +## Access Matrix + +| Module | Super Admin | Mentor | Student | +|---|---|---|---| +| Dashboard | Full | Full | Full | +| User Management | Full | No | No | +| Invitations | Full | No | No | +| Projects | Full | View Assigned | View Assigned | +| Student List | Full | View Assigned | No | +| Activity Logs | Full | Review | Create and View Own | +| Feedback | Full | Create and View | View | +| Reports | Full | Limited | No | +| Export PDF | Full | Limited | No | + +--- + +## Permission Notes + +### Super Admin + +- Controls users, roles, invitations, and projects +- Has the broadest reporting and management access + +### Mentor + +- Sees assigned project data and assigned students +- Reviews activity logs and leaves actionable feedback + +### Student + +- Focuses on daily activity updates and feedback review +- Access is intentionally limited to protect system integrity + +--- + +## Change Requests + +Need permission changes? + +1. Contact Super Admin +2. Describe module and required action +3. Include business reason for the access update + +--- + +!!! warning + Do not share one account across multiple users. Permissions are role-based and tied to individual accountability. diff --git a/mk_docs/user_docs/docs/security-and-privacy.md b/mk_docs/user_docs/docs/security-and-privacy.md new file mode 100644 index 00000000..20f08afa --- /dev/null +++ b/mk_docs/user_docs/docs/security-and-privacy.md @@ -0,0 +1,56 @@ +# Security and Privacy + +Digital Logbook uses role-based access and operational safeguards to protect user data and project records. + +--- + +## Security Principles + +- Least privilege access by role +- Individual account accountability +- Controlled invitation-based onboarding +- Operational review through reports and logs + +--- + +## Account Security Best Practices + +### All Users + +- Use strong passwords +- Do not reuse passwords across systems +- Log out on shared devices +- Do not share login credentials + +### Super Admins + +- Remove or disable unused accounts +- Review invitation status and expiration regularly +- Verify role assignments frequently + +--- + +## Data Handling Guidelines + +- Activity logs should contain project-relevant information only +- Avoid storing personal sensitive data in free-text fields +- Exported reports should be shared only with authorized stakeholders + +--- + +## Incident Response + +If you suspect unauthorized access: + +1. Notify Super Admin immediately +2. Reset affected passwords +3. Review recent activity and account assignments +4. Document the incident and actions taken + +--- + +## Privacy Note + +Each organization is responsible for local policy compliance regarding retention, processing, and sharing of project and user information. + +For support, visit [Contact & Support](contact.md). diff --git a/mk_docs/user_docs/docs/student.md b/mk_docs/user_docs/docs/student.md new file mode 100644 index 00000000..2c28f527 --- /dev/null +++ b/mk_docs/user_docs/docs/student.md @@ -0,0 +1,190 @@ +# 📝 Student Guide + +
+Welcome, Student! 👋 This guide shows you how to log your daily work, check your attendance calendar, view feedback from your mentor, and track your progress — step by step. +
+ +
+[🏠 Your Dashboard](#your-dashboard) +[✏️ Log Activities](#creating-activity-logs) +[💬 View Feedback](#viewing-mentor-feedback) +[📅 Attendance](#tracking-your-progress) +[👤 Your Profile](#profile-and-activity-timeline) +
+ +--- + +## 📋 What Can You Do? + +| 🎯 Task | 📝 Description | +|---|---| +| **Dashboard** | View assigned projects and recent activity summaries | +| **Activity Logs** | Record your daily tasks and progress | +| **Mentor Feedback** | Read comments and suggestions from your mentor | +| **Project Progress** | Track your overall project status | + +--- + +## 🖥️ Your Dashboard + +
+This is what you will see when you log in. Your dashboard shows everything at a glance — your hours, tasks, and latest activity. +
+ +![Student Dashboard (Web)](){ .ui-shot } +![Student Dashboard (Mobile)](){ .ui-shot } + +--- + +## Your Dashboard + +After logging in, your dashboard gives you a quick overview of everything important. + +The dashboard displays: + +| Section | Description | +|---|---| +| **Assigned Projects** | Projects you are currently enrolled in | +| **Recent Activity Logs** | Your latest submitted entries | +| **Progress Updates** | Summary of your overall project progress | +| **Mentor Feedback Notifications** | Alerts when your mentor has left new feedback | + +--- + +## ✏️ Creating Activity Logs + +
+💡 Every day you need to write what you worked on. This is your activity log. It takes just a few minutes and helps your mentor see your progress. +
+ +Activity logs are the core of Digital Logbook. You should update your log **every day** or after completing significant work. + +### Adding a New Activity Log + +1. Open the **Activity** or **Logbook** section from the sidebar +2. Click **Add Activity** +3. Fill in the activity form with the following details: + +| Field | What to Include | +|---|---| +| **Tasks Completed** | List what you worked on and finished | +| **Results Achieved** | Describe the outcome or output of your work | +| **Challenges or Blockers** | Note any problems or obstacles you faced | +| **Next Planned Actions** | State what you plan to work on next | + +4. Click **Save** to submit your entry + +=== "Web View" + + ![Task Details Form (Web)](){ .ui-shot } + ![Task Details Modal (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Task Details Form (Mobile)](){ .ui-shot } + +!!! tip "Write Clearly" + The more detail you include, the better feedback your mentor can give you. Avoid vague entries like "worked on project" — be specific about what you actually did. + +--- + +## Example Activity Log Entry + +**Tasks Completed:** +Completed the database schema design for the user authentication module. Created entity relationship diagrams. + +**Results Achieved:** +Schema reviewed and approved by team lead. Ready for implementation phase. + +**Challenges or Blockers:** +Uncertain about the best approach for storing session tokens securely. Need to research options. + +**Next Planned Actions:** +Research session token storage methods. Begin implementation of the login API endpoint. + +--- + +## 💬 Viewing Mentor Feedback + +Your mentor may leave feedback and suggestions on your activity entries. + +### How to View Feedback + +1. Open the **Activity Logs** section +2. Select the activity entry that has a feedback notification +3. Read your mentor's comments in the **Feedback** section + +=== "Web View" + + ![Task Details with Feedback (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Task Details with Feedback (Mobile)](){ .ui-shot } + +!!! important "Act on Feedback" + Feedback is provided to help you improve. Review it carefully and apply the suggestions in your next activity entries. + +--- + +## Responding to Feedback + +Although you may not reply directly to feedback in all cases, you can demonstrate that you have acted on it by: + +- Referencing the feedback in your next activity log entry +- Showing improvement in the areas your mentor highlighted +- Updating your planned actions based on mentor suggestions + +--- + +## 📈 Tracking Your Progress + +
+💡 You can see how consistently you are submitting work. The monthly calendar highlights the days you logged activity. Green is good! +
+ +Your project progress is updated based on your activity log submissions and mentor reviews. + +To stay on track: + +- Submit activity logs **consistently and on time** +- Keep your entries **accurate and detailed** +- Address blockers proactively — don't let the same blocker appear week after week +- Review your overall progress from the dashboard regularly + +### Monthly Attendance + +Use the monthly attendance calendar to review and update your daily entries. + +=== "Web View" + + ![Monthly Attendance (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Monthly Attendance (Mobile)](){ .ui-shot } + ![Monthly Attendance Task Details (Mobile)](){ .ui-shot } + +### Profile and Activity Timeline + +Use your profile page to review activity history, streaks, and latest tasks. + +=== "Web View" + + ![Student Profile View (Web)](){ .ui-shot } + ![Student Profile Activity Timeline (Web)](){ .ui-shot } + +--- + +## Best Practices for Students + +- Update your activity logs daily or at the end of each work session +- Be specific about what you worked on, what you achieved, and what blocked you +- Read all mentor feedback carefully before submitting your next log +- Reach out through the system if you need clarification or support +- Log out after using shared or public devices + +--- + +!!! note "Need Help?" + If you cannot see your project or your logs are not saving, visit the [Troubleshooting & FAQ](troubleshooting.md) page or contact your Super Admin. diff --git a/mk_docs/user_docs/docs/stylesheets/extra.css b/mk_docs/user_docs/docs/stylesheets/extra.css new file mode 100644 index 00000000..07d152d7 --- /dev/null +++ b/mk_docs/user_docs/docs/stylesheets/extra.css @@ -0,0 +1,602 @@ +/* ── Hero Banner ────────────────────────────────────── */ +.hero { + background: + radial-gradient(circle at 15% 20%, rgba(255, 255, 255, 0.16) 0%, rgba(255, 255, 255, 0) 36%), + radial-gradient(circle at 80% 80%, rgba(255, 255, 255, 0.14) 0%, rgba(255, 255, 255, 0) 42%), + linear-gradient(135deg, #0a1f6b 0%, #12308a 50%, #1a43b8 100%); + border-radius: 12px; + padding: 3rem 2.5rem; + margin-bottom: 2.5rem; + color: #fff; + text-align: center; + position: relative; + overflow: hidden; +} + +.hero h1 { + font-size: 2.6rem; + font-weight: 800; + margin: 0 0 0.5rem; + color: #fff !important; + border: none; +} + +.hero p { + font-size: 1.15rem; + opacity: 0.92; + margin: 0 0 1.8rem; +} + +.hero-buttons { + display: flex; + gap: 1rem; + justify-content: center; + flex-wrap: wrap; +} + +.hero-btn { + display: inline-block; + padding: 0.7rem 1.8rem; + border-radius: 6px; + font-weight: 600; + font-size: 0.95rem; + text-decoration: none !important; + transition: transform 0.15s, box-shadow 0.15s; +} + +.hero-btn:hover { + transform: translateY(-2px); + box-shadow: 0 6px 18px rgba(0,0,0,0.2); +} + +.hero-btn-primary { + background: #fff; + color: #0a1f6b !important; +} + +.hero-btn-secondary { + background: rgba(255,255,255,0.18); + color: #fff !important; + border: 2px solid rgba(255,255,255,0.6); +} + +/* ── Role Cards ─────────────────────────────────────── */ +.role-cards { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(220px, 1fr)); + gap: 1.2rem; + margin: 1.5rem 0 2.5rem; +} + +.role-card { + border-radius: 10px; + padding: 1.5rem 1.4rem; + border: 1px solid var(--md-default-fg-color--lightest); + background: var(--md-default-bg-color); + box-shadow: 0 2px 8px rgba(0,0,0,0.06); + transition: transform 0.15s, box-shadow 0.15s; +} + +.role-card:hover { + transform: translateY(-3px); + box-shadow: 0 8px 24px rgba(0,0,0,0.1); +} + +.role-card-icon { + font-size: 2rem; + margin-bottom: 0.6rem; +} + +.role-card h3 { + margin: 0 0 0.4rem; + font-size: 1.05rem; + font-weight: 700; +} + +.role-card p { + margin: 0 0 0.8rem; + font-size: 0.88rem; + opacity: 0.8; + line-height: 1.5; +} + +.role-card a { + font-size: 0.85rem; + font-weight: 600; +} + +/* ── Feature Grid ───────────────────────────────────── */ +.feature-grid { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(180px, 1fr)); + gap: 1rem; + margin: 1.5rem 0; +} + +.feature-item { + display: flex; + align-items: flex-start; + gap: 0.75rem; + padding: 1rem; + border-radius: 8px; + background: var(--md-code-bg-color); + border: 1px solid var(--md-default-fg-color--lightest); +} + +.feature-item-icon { + font-size: 1.4rem; + flex-shrink: 0; +} + +.feature-item-text strong { + display: block; + font-size: 0.9rem; + margin-bottom: 0.2rem; +} + +.feature-item-text span { + font-size: 0.82rem; + opacity: 0.75; +} + +/* ── Step Cards ─────────────────────────────────────── */ +.steps { + counter-reset: step-counter; + margin: 1.5rem 0; +} + +.step { + display: flex; + gap: 1.2rem; + margin-bottom: 1.2rem; + align-items: flex-start; +} + +.step-number { + counter-increment: step-counter; + width: 2.2rem; + height: 2.2rem; + border-radius: 50%; + background: #12308a; + color: #fff; + font-weight: 700; + font-size: 0.9rem; + display: flex; + align-items: center; + justify-content: center; + flex-shrink: 0; + margin-top: 0.1rem; +} + +.step-content strong { + display: block; + font-size: 0.95rem; + margin-bottom: 0.2rem; +} + +.step-content p { + margin: 0; + font-size: 0.88rem; + opacity: 0.8; +} + +/* ── General polish ─────────────────────────────────── */ +.md-typeset h1 { + font-weight: 800; +} + +.md-typeset table:not([class]) th { + background: var(--md-primary-fg-color); + color: var(--md-primary-bg-color); +} + +[data-md-color-scheme="slate"] .role-card { + border-color: rgba(255,255,255,0.1); +} + +.md-main__inner { + margin-top: 1rem; +} + +.md-typeset a { + font-weight: 600; +} + +.ui-shot { + display: block; + width: auto; + max-width: 1080px; + min-width: 0; + border-radius: 10px; + border: 1px solid rgba(22, 36, 72, 0.14); + box-shadow: 0 10px 24px rgba(10, 31, 107, 0.1); + background: transparent; + margin: 1rem auto 1.25rem; + image-rendering: auto; +} + +/* Screenshot gallery polish for uploaded images in assets/myproject */ +.md-typeset img[src*="assets/myproject/"] { + display: block; + width: auto; + height: auto; + max-width: min(100%, 1080px); + margin: 0.85rem auto 1.15rem; + border-radius: 14px; + border: 3px solid #111111 !important; + outline: 0 !important; + outline-offset: 0; + box-shadow: + 0 20px 46px rgba(10, 31, 107, 0.16), + 0 2px 0 rgba(255, 255, 255, 0.8) inset, + 0 -1px 0 rgba(17, 35, 82, 0.12) inset; + background: linear-gradient(180deg, #eef4ff 0%, #ffffff 100%); + padding: 0; + box-sizing: border-box; + image-rendering: auto; + transition: transform 0.18s ease, box-shadow 0.18s ease; +} + +.md-typeset img[src*="assets/myproject/"]:hover { + transform: translateY(-2px); + box-shadow: + 0 26px 52px rgba(10, 31, 107, 0.18), + 0 2px 0 rgba(255, 255, 255, 0.85) inset, + 0 -1px 0 rgba(17, 35, 82, 0.14) inset; +} + +.md-typeset img[alt*="Logo"][src*="assets/myproject/"] { + max-width: 460px; + padding: 0; + border: 0; + box-shadow: none; + background: transparent; +} + +.md-typeset img[alt*="Web"][src*="assets/myproject/"] { + max-width: min(100%, 1080px); +} + +.md-typeset img[alt*="Mobile"][src*="assets/myproject/"] { + width: auto; + max-width: 340px; + border-radius: 18px; + border: 3px solid #111111 !important; + outline: 0 !important; + outline-offset: 0; + box-shadow: + 0 16px 30px rgba(10, 31, 107, 0.12), + 0 2px 0 rgba(255, 255, 255, 0.88) inset; +} + +.md-typeset h4 { + margin-top: 0.9rem; + margin-bottom: 0.3rem; + padding: 0; + border: 0; + background: transparent; + display: block; + font-size: 0.88rem; + letter-spacing: 0.01em; + text-transform: none; +} + +/* Strong separation for Web View vs Mobile View tabs */ +.md-typeset .tabbed-set { + margin: 0.95rem 0 1.6rem; +} + +.md-typeset .tabbed-set > input + label { + font-weight: 700; + letter-spacing: 0.02em; +} + +.md-typeset .tabbed-content { + border: 1px solid var(--md-default-fg-color--lightest); + border-top: 0; + border-radius: 0 0 10px 10px; + padding: 0.85rem; + background: var(--md-default-bg-color); +} + +[data-md-color-scheme="slate"] .md-typeset .tabbed-content { + border-color: rgba(167, 186, 255, 0.25); + background: rgba(255, 255, 255, 0.03); +} + +[data-md-color-scheme="slate"] .md-typeset img[src*="assets/myproject/"] { + border-color: #111111 !important; + outline: 1px solid rgba(28, 39, 65, 0.96); + box-shadow: + 0 16px 30px rgba(0, 0, 0, 0.32), + 0 2px 0 rgba(199, 214, 255, 0.06) inset; + background: linear-gradient(180deg, #1c2540 0%, #141d33 100%); +} + +.kpi-grid { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(170px, 1fr)); + gap: 0.9rem; + margin: 1.2rem 0 0.5rem; +} + +.kpi-card { + border-radius: 12px; + border: 1px solid var(--md-default-fg-color--lightest); + background: var(--md-default-bg-color); + padding: 1rem; + text-align: center; + box-shadow: 0 8px 20px rgba(10, 31, 107, 0.08); +} + +.kpi-value { + font-size: 1.8rem; + font-weight: 800; + color: #12308a; + line-height: 1.1; +} + +.kpi-label { + margin-top: 0.35rem; + font-size: 0.82rem; + opacity: 0.78; + font-weight: 600; +} + +.reveal { + opacity: 0; + transform: translateY(12px); +} + +.reveal.is-visible { + opacity: 1; + transform: translateY(0); + transition: + opacity 0.45s ease var(--delay, 0ms), + transform 0.45s ease var(--delay, 0ms); +} + +@media (max-width: 900px) { + .hero { + padding: 2.2rem 1.2rem; + } + + .hero h1 { + font-size: 1.95rem; + } + + .hero p { + font-size: 1rem; + } + + .md-typeset img[src*="assets/myproject/"] { + width: auto; + max-width: 100%; + border-radius: 12px; + } + + .md-typeset img[alt*="Mobile"][src*="assets/myproject/"] { + max-width: 74vw; + } +} + +/* ── User-Friendly Enhancements ─────────────────────── */ + +/* Bigger, friendlier body text */ +.md-typeset { + font-size: 0.98rem; + line-height: 1.8; +} + +/* Friendly "Who are you?" role picker */ +.role-picker { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); + gap: 1.2rem; + margin: 1.5rem 0 2rem; +} + +.role-picker-card { + border-radius: 16px; + padding: 1.8rem 1.4rem; + text-align: center; + text-decoration: none !important; + transition: transform 0.18s, box-shadow 0.18s; + display: block; + font-weight: 700; + box-shadow: 0 4px 14px rgba(0,0,0,0.08); +} + +.role-picker-card:hover { + transform: translateY(-4px); + box-shadow: 0 12px 28px rgba(0,0,0,0.14); +} + +.role-picker-card.admin { + background: linear-gradient(135deg, #0a1f6b 0%, #1a43b8 100%); + color: #fff !important; + border: none; +} + +.role-picker-card.mentor { + background: linear-gradient(135deg, #6a0dad 0%, #a855f7 100%); + color: #fff !important; + border: none; +} + +.role-picker-card.student { + background: linear-gradient(135deg, #047857 0%, #34d399 100%); + color: #fff !important; + border: none; +} + +.role-picker-card .pick-icon { + font-size: 2.6rem; + display: block; + margin-bottom: 0.6rem; +} + +.role-picker-card .pick-title { + font-size: 1.15rem; + font-weight: 800; + display: block; + margin-bottom: 0.3rem; +} + +.role-picker-card .pick-desc { + font-size: 0.82rem; + opacity: 0.88; + font-weight: 400; + display: block; + line-height: 1.4; +} + +/* Bigger step numbers */ +.step-number { + width: 2.8rem !important; + height: 2.8rem !important; + font-size: 1.1rem !important; + box-shadow: 0 4px 12px rgba(18,48,138,0.3); +} + +.step-content strong { + font-size: 1.02rem !important; + color: #0a1f6b; +} + +.step-content p { + font-size: 0.92rem !important; + opacity: 0.85 !important; +} + +/* Callout highlight box */ +.highlight-box { + border-radius: 12px; + padding: 1.2rem 1.4rem; + margin: 1.2rem 0; + border-left: 5px solid #12308a; + background: #eef3ff; + font-size: 0.95rem; + line-height: 1.7; +} + +.highlight-box strong { + color: #0a1f6b; + display: block; + margin-bottom: 0.3rem; + font-size: 1rem; +} + +[data-md-color-scheme="slate"] .highlight-box { + background: rgba(18,48,138,0.18); + border-left-color: #5a80f0; +} + +[data-md-color-scheme="slate"] .highlight-box strong { + color: #a0b4ff; +} + +/* Role badge inline */ +.role-badge { + display: inline-block; + padding: 0.18rem 0.7rem; + border-radius: 99px; + font-size: 0.78rem; + font-weight: 700; + letter-spacing: 0.03em; + vertical-align: middle; + margin-left: 0.3rem; +} + +.role-badge.admin { background: #0a1f6b; color: #fff; } +.role-badge.mentor { background: #6a0dad; color: #fff; } +.role-badge.student { background: #047857; color: #fff; } + +/* Section intro text */ +.section-intro { + font-size: 1.05rem; + color: #12308a; + font-weight: 500; + background: #f0f5ff; + border-radius: 10px; + padding: 0.9rem 1.2rem; + margin: 0.5rem 0 1.5rem; + line-height: 1.65; + border-left: 4px solid #1a43b8; +} + +[data-md-color-scheme="slate"] .section-intro { + background: rgba(18,48,138,0.15); + color: #a0b4ff; + border-left-color: #5a80f0; +} + +/* Quick nav box */ +.quick-nav { + display: flex; + flex-wrap: wrap; + gap: 0.6rem; + margin: 1rem 0 1.8rem; +} + +.quick-nav a { + background: var(--md-primary-fg-color); + color: var(--md-primary-bg-color) !important; + padding: 0.38rem 0.9rem; + border-radius: 99px; + font-size: 0.82rem; + font-weight: 700; + text-decoration: none !important; + transition: opacity 0.15s; +} + +.quick-nav a:hover { + opacity: 0.82; +} + +/* Image caption style */ +.img-caption { + text-align: center; + font-size: 0.8rem; + color: #888; + margin-top: -0.7rem; + margin-bottom: 1rem; + font-style: italic; +} + +/* Admonition friendliness boost */ +.md-typeset .admonition, +.md-typeset details { + border-radius: 10px !important; + font-size: 0.92rem; +} + +.md-typeset .admonition-title, +.md-typeset summary { + font-size: 0.95rem !important; + font-weight: 700 !important; +} + +/* Checklist items bigger */ +.md-typeset .task-list-item { + font-size: 0.97rem; + line-height: 2; +} + +/* Table friendlier */ +.md-typeset table:not([class]) { + font-size: 0.9rem; + border-radius: 10px; + overflow: hidden; + box-shadow: 0 2px 10px rgba(0,0,0,0.06); +} + +.md-typeset table:not([class]) td { + padding: 0.6rem 0.9rem; +} + +.md-typeset table:not([class]) th { + padding: 0.65rem 0.9rem; + font-size: 0.88rem; +} + diff --git a/mk_docs/user_docs/docs/super-admin.md b/mk_docs/user_docs/docs/super-admin.md new file mode 100644 index 00000000..a24c07c1 --- /dev/null +++ b/mk_docs/user_docs/docs/super-admin.md @@ -0,0 +1,218 @@ +# 🛡️ Super Admin Guide + +
+Welcome, Super Admin! 👋 You are the manager of the whole system. This guide shows you exactly how to invite users, create projects, and see reports — step by step. +
+ +
+[👥 Invite Users](#user-management) +[📁 Projects](#project-management) +[📊 Reports](#reports-and-exports) +[✅ Onboarding](#onboarding-approval) +
+ +--- + +## 📋 What Can You Do? + +| 🎯 Task | 📝 Description | +|---|---| +| **User Management** | Invite, view, and manage all users | +| **Project Management** | Create and configure projects | +| **Mentor Assignment** | Assign mentors to projects | +| **Student Assignment** | Assign students to projects | +| **Reports** | Generate and export activity reports | + +--- + +## 🖥️ Your Dashboard + +
+This is what you will see when you log in. The dashboard shows you a summary of everything happening in the system. +
+ +![Admin Super Dashboard (Web)](){ .ui-shot } +![Admin Super Dashboard (Mobile)](){ .ui-shot } + +--- + +## 👥 User Management + +
+💡 This is where you invite new users to the system and manage who has access. You can add Mentors and Students by sending them an email invitation. +
+ +### Sending a Single Invitation + +1. Open the **Users** or **Invitations** page +2. Click **Invite User** +3. Enter the user's details: + - Full name + - Email address +4. Select the appropriate **role** (Super Admin / Mentor / Student) +5. Click **Send Invitation** + +The user will receive an email with a registration link. + +![Create Invitation (Web)](){ .ui-shot } +![Create Invitation (Mobile)](){ .ui-shot } + +![Invitation List (Web)](){ .ui-shot } +![Invitation List (Mobile)](){ .ui-shot } + +--- + +### Bulk User Invitation + +Use bulk invitations to add multiple users at once via a spreadsheet file. + +1. Open the **Bulk Upload** section +2. Download the spreadsheet template (if provided) +3. Fill in user details (name, email, role) for each row +4. Upload the completed file +5. Review the validation results + +!!! warning "Validation Errors" + If any rows contain errors (e.g. invalid email, missing role), correct those rows and re-upload the file. Valid rows will not be affected. + +![Bulk Upload (Web)](){ .ui-shot } +![Bulk Upload (Mobile)](){ .ui-shot } + +--- + +### Invitation Status Reference + +| Status | Meaning | +|---|---| +| **Pending** | Invitation sent — user has not registered yet | +| **Accepted** | User successfully completed registration | +| **Expired** | Invitation link has expired — resend required | + +!!! tip "Managing Expired Invitations" + Periodically review invitation statuses and resend expired invitations to ensure all users can access the system. + +![User Administration (Web)](){ .ui-shot } +![User Administration (Mobile)](){ .ui-shot } + +--- + +## 📁 Project Management + +
+💡 Projects are the heart of the system. Create a project, then assign a Mentor and Students to it. Everyone in a project can see each other's work. +
+ +### Creating a New Project + +1. Open the **Projects** page +2. Click **Create Project** +3. Fill in project details: + - Project name + - Description + - Start and end dates +4. Click **Save** + +![Projects Page (Web)](){ .ui-shot } +![Projects Page (Mobile)](){ .ui-shot } +![Create Project Modal (Web)](){ .ui-shot } +![Create Project Modal (Mobile)](){ .ui-shot } + +--- + +### Assigning a Mentor to a Project + +1. Open the project from the **Projects** page +2. Navigate to the **Mentor Assignment** section +3. Select the mentor from the list +4. Click **Save Changes** + +=== "Web View" + + ![Onboarding Mentor Assignment (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Onboarding Mentor Assignment (Mobile)](){ .ui-shot } + +--- + +### Assigning Students to a Project + +1. Open the project from the **Projects** page +2. Navigate to the **Student Assignment** section +3. Search for and select students to add +4. Click **Save Changes** + +=== "Web View" + + ![Onboarding Mentee Assignment (Web)](){ .ui-shot } + +=== "Mobile View" + + ![Onboarding Mentee Assignment (Mobile)](){ .ui-shot } + +!!! note + Assignments can be updated or removed at any time. Removing a student or mentor from a project does not delete their account. + +--- + +## 📊 Reports and Exports + +
+💡 Reports show you a summary of all team activity. You can filter by project or date, then download a PDF to share with anyone. +
+ +### Generating a Report + +1. Open the **Reports** page +2. Apply filters as needed: + - **Date range** — limit results by time period + - **Project** — filter by specific project + - **Status** — filter by activity or progress status +3. Click **Generate Report** +4. Review the results displayed on screen + +--- + +### Exporting a Report + +Once a report is generated: + +1. Click **Export** or **Download PDF** +2. The report will be saved to your device as a PDF file + +PDF reports are useful for sharing with stakeholders or keeping records offline. + +![Reports (Web)](){ .ui-shot } +![Reports (Mobile)](){ .ui-shot } + +![Export Report (Web)](){ .ui-shot } +![Export Report (Mobile)](){ .ui-shot } + +--- + +## ✅ Onboarding Approval + +
+💡 Before a Mentor or Student can start using the system, you need to approve their account here. Review their details and click Approve. +
+ +1. Navigate to the **Onboarding** page from the sidebar +2. Switch between the **Mentor** and **Mentee** tabs to review applicants +3. Check applicant details and approve or reject as needed +4. Approved users can then be assigned to projects + +![Onboarding Approval (Web)](){ .ui-shot } +![Onboarding Create New Project (Web)](){ .ui-shot } +![Onboarding Approval (Mobile)](){ .ui-shot } +![Onboarding Create New Project (Mobile)](){ .ui-shot } + +--- + +## Best Practices for Super Admins + +- Monitor invitation statuses regularly and resend expired ones +- Review project assignments to keep them accurate and current +- Periodically audit user roles to ensure correct access levels +- Export reports regularly for record keeping +- Log out after working on shared devices diff --git a/mk_docs/user_docs/docs/troubleshooting.md b/mk_docs/user_docs/docs/troubleshooting.md new file mode 100644 index 00000000..8d3780ef --- /dev/null +++ b/mk_docs/user_docs/docs/troubleshooting.md @@ -0,0 +1,187 @@ +# Troubleshooting & FAQ + +This page covers the most common issues users encounter in Digital Logbook and how to resolve them. + +--- + +## Account & Login Issues + +### I Did Not Receive the Invitation Email + +**Steps to resolve:** + +1. Check your **Spam** or **Junk** folder +2. Confirm your email address with the Super Admin +3. Ask the Super Admin to resend the invitation + +!!! note + Invitation emails are sent from the system automatically. If your email provider is blocking them, ask the Super Admin to check the sending domain. + +--- + +### My Invitation Link Is Not Working + +Invitation links expire after a set period. + +**Steps to resolve:** + +1. Contact the Super Admin and explain that your link has expired +2. Ask for a new invitation to be sent +3. Open the new email and use the new link immediately + +!!! warning + Do not share your invitation link with others. It is unique to your account registration. + +--- + +### I Forgot My Password + +**Steps to resolve:** + +1. Open the login page +2. Click **Forgot Password** (if available) +3. Enter your email address +4. Check your email for a password reset link +5. Follow the instructions to set a new password + +If no reset option is available, contact the Super Admin for assistance. + +--- + +### I Cannot Log In Even With the Correct Password + +**Possible causes and solutions:** + +| Cause | Solution | +|---|---| +| Account not yet activated | Complete registration via the invitation link | +| Account has been deactivated | Contact the Super Admin | +| Browser cache issue | Clear your browser cache and try again | +| Caps Lock is on | Check that Caps Lock is off when typing your password | + +--- + +## Navigation & Access Issues + +### I Cannot See Expected Pages or Menus + +Some pages are only accessible to specific roles. + +**Possible reasons:** + +- Your role does not have permission to access that module +- You have not been assigned to a project yet + +**Steps to resolve:** + +1. Confirm your role with the Super Admin +2. Ask the Super Admin to assign you to the relevant project +3. Log out and log back in to refresh your permissions + +--- + +### A Page Is Not Loading or Showing an Error + +**Steps to resolve:** + +1. Refresh the page using `Ctrl + R` (Windows) or `Cmd + R` (Mac) +2. Clear your browser cache and cookies +3. Try a different browser +4. Check your internet connection + +If the issue persists, contact the Super Admin with a description of the error. + +--- + +## Data & Content Issues + +### I Cannot Find My Data + +**Steps to resolve:** + +- Check if any **filters** are active and clear them +- Clear the **search field** and search again +- Check the **pagination** — your data may be on another page +- Refresh the page + +--- + +### My Activity Log Did Not Save + +**Steps to resolve:** + +1. Check your internet connection +2. Do not navigate away before clicking **Save** +3. Try submitting again +4. If the issue continues, copy your content to a text file temporarily and contact the Super Admin + +--- + +### I Cannot See My Mentor's Feedback + +**Possible reasons:** + +- Your mentor has not yet submitted feedback on that entry +- The feedback notification may not have refreshed + +**Steps to resolve:** + +1. Refresh the page +2. Open the specific activity log entry directly +3. If feedback is still not visible, check with your mentor whether it was submitted + +--- + +## Invitation & User Management Issues (Super Admins) + +### A Bulk Upload Is Showing Errors + +**Steps to resolve:** + +1. Download the error report or review the validation results +2. Identify the rows with errors (e.g. invalid email format, missing role) +3. Correct those specific rows in the spreadsheet +4. Re-upload the corrected file + +!!! tip + Rows without errors are processed successfully even if other rows fail. You only need to re-upload the rows that had issues. + +--- + +### An Invitation Is Stuck in Pending Status + +The user has not yet completed registration. + +**Steps to resolve:** + +1. Confirm that the user received the invitation email +2. Ask them to check their Spam folder +3. If needed, resend or cancel the invitation and send a new one + +--- + +## General FAQs + +**Q: Can I change my email address?** +Contact the Super Admin to update your account email address. + +**Q: Can I use Digital Logbook on a mobile device?** +Yes. The system is accessible from any device with a modern web browser. + +**Q: How often should students update their activity logs?** +Students should aim to update their logs daily or at the end of each work session. + +**Q: Can a student be assigned to more than one project?** +Yes. Super Admins can assign students to multiple projects if needed. + +**Q: What happens if I accidentally delete an entry?** +Contact the Super Admin immediately. Recovery options depend on system configuration. + +--- + +!!! info "Still Need Help?" + If none of the above solutions resolve your issue, contact your Super Admin with: + + - A description of the problem + - The steps you took before the issue occurred + - Any error messages you saw diff --git a/mk_docs/user_docs/docs/user-guide.md b/mk_docs/user_docs/docs/user-guide.md new file mode 100644 index 00000000..85fe7bb2 --- /dev/null +++ b/mk_docs/user_docs/docs/user-guide.md @@ -0,0 +1,393 @@ +# Digital Logbook: Complete User Guide + +## Welcome to Digital Logbook + +Welcome to Digital Logbook. This platform is designed to help Super Admins, Mentors, and Students manage projects, track daily activities, monitor progress, and communicate efficiently in one centralized system. + +This guide will help new users understand how to access the platform, navigate the system, and use all major features confidently. + +## Getting Started + +### First Time Account Setup + +If you are using Digital Logbook for the first time, follow these steps to activate your account. + +#### Step 1: Check Your Email + +You will receive an invitation email from the Digital Logbook system. +Open your email inbox and look for the invitation message. + +If you cannot find the email: + +- Check your Spam or Junk folder +- Contact the Super Admin and request a new invitation email + +#### Step 2: Open the Invitation Link + +Click the invitation link provided in the email. +This link is used to activate your account and complete your registration. + +#### Step 3: Complete Your Registration + +Fill in the required information and create your password. +Make sure your password is secure and easy for you to remember. +After completing the form, click the **Submit** button. + +#### Step 4: Login to the System + +Once registration is complete: + +1. Open the login page +2. Enter your email address +3. Enter your password +4. Click **Login** + +You will now be redirected to your dashboard. + +### Daily Login Process + +If your account is already activated, follow these steps each time you log in. + +1. Open the login page +2. Enter your email address +3. Enter your password +4. Click **Login** +5. Wait for your dashboard to load + +After logging in, use the left sidebar menu to navigate through the system. + +## Understanding User Roles + +Digital Logbook provides different access levels based on user roles. + +### Super Admin + +The Super Admin manages the entire platform and controls system operations. + +Main responsibilities include: + +- Managing users +- Sending invitations +- Creating projects +- Assigning mentors and students +- Monitoring reports and project activities + +### Mentor + +Mentors are responsible for guiding and monitoring students. + +Main responsibilities include: + +- Reviewing student activities +- Monitoring student progress +- Providing feedback and guidance + +### Student + +Students use the platform to record their daily work and track project progress. + +Main responsibilities include: + +- Creating activity logs +- Updating project progress +- Reviewing mentor feedback +- Improving work based on feedback + +## System Navigation + +### Dashboard + +The dashboard provides an overview of important information related to your role. +Depending on your role, the dashboard may display: + +- Assigned projects +- Recent activities +- Progress summaries +- Notifications and updates + +### Sidebar Navigation + +The left sidebar menu is used to access system modules and pages. +Available menu items may include: + +- Dashboard +- Users +- Projects +- Reports +- Activity Logs +- Feedback Sections + +The available options depend on your assigned role. + +### Search and Filters + +Some pages contain search bars and filter options. +These tools help users quickly find: + +- Projects +- Students +- Reports +- Activities +- Users + +### Pagination + +If a page contains many records, the system may divide the information into multiple pages. +Use the pagination controls at the bottom of the page to move between pages. + +## Super Admin User Guide + +### User Management + +The User Management section allows Super Admins to control user access within the system. + +### Sending Invitations + +Super Admins can invite users individually or in bulk. + +#### Single User Invitation + +Steps: + +1. Open the **Users** or **Invitations** page +2. Click **Invite User** +3. Enter user information +4. Select the correct role +5. Send the invitation + +#### Bulk User Invitation + +Bulk invitations allow multiple users to be added at once. + +Steps: + +1. Open the bulk upload section +2. Upload the required spreadsheet file +3. Verify user details +4. Submit the upload +5. Review validation results + +If errors appear, correct the invalid rows and upload the file again. + +### Invitation Status Types + +Each invitation will display a status. + +#### Pending + +The invitation has been sent but the user has not accepted it yet. + +#### Accepted + +The user successfully completed registration. + +#### Expired + +The invitation link is no longer valid. +If the link has expired, send a new invitation. + +### Project Management + +Super Admins can create and manage projects within the system. + +#### Creating a Project + +Steps: + +1. Open the **Projects** page +2. Click **Create Project** +3. Enter project details +4. Save the project + +#### Assigning Mentors to Projects + +Steps: + +1. Open the selected project +2. Choose mentor assignment +3. Select the mentor +4. Save changes + +#### Assigning Students to Projects + +Steps: + +1. Open the selected project +2. Choose student assignment +3. Add students +4. Save changes + +Assignments can be updated or removed later if necessary. + +### Reports and Exports + +The Reports section helps generate reports for monitoring and analysis. + +#### Generating Reports + +Steps: + +1. Open the **Reports** page +2. Select filters such as: + - Date range + - Project + - Status +3. Click generate report +4. Review the generated results + +#### Exporting Reports + +Reports can be downloaded as PDF documents for sharing or record keeping. + +## Mentor User Guide + +### Viewing Assigned Students + +Mentors can access students assigned to their projects. + +Steps: + +1. Login to the system +2. Open the **Students** section +3. Review the assigned student list + +Use filters if the student list is large. + +### Reviewing Student Activities + +Mentors can monitor student work and progress. + +Steps: + +1. Open a student profile or activity page +2. Review submitted activity logs +3. Monitor consistency and progress + +### Providing Feedback + +Mentors can leave feedback on student activities. + +Steps: + +1. Open a student activity entry +2. Write feedback comments +3. Save the feedback + +Good feedback should be: + +- Clear +- Constructive +- Helpful +- Action oriented + +Mentors should review student progress regularly. + +## Student User Guide + +### Viewing the Dashboard + +Students can use the dashboard to view assigned projects and activity summaries. +The dashboard may include: + +- Project details +- Recent activity logs +- Progress updates +- Mentor feedback notifications + +### Creating Activity Logs + +Students should update their activity logs regularly. + +#### Adding a New Activity Log + +Steps: + +1. Open the **Activity** or **Logbook** section +2. Click **Add Activity** +3. Enter activity information + +Include: + +- Tasks completed +- Results achieved +- Challenges or blockers faced +- Next planned actions + +4. Save the activity entry + +### Viewing Mentor Feedback + +Mentors may leave comments and suggestions on activity logs. +Students should: + +- Review feedback carefully +- Improve future work using mentor suggestions +- Maintain regular updates + +## Common Problems and Solutions + +### I Did Not Receive the Invitation Email + +Try the following steps: + +- Check your Spam or Junk folder +- Confirm your email address with the Super Admin +- Request the invitation to be sent again + +### Invitation Link Is Not Working + +Do not worry. +The invitation link may have expired. +Contact the Super Admin and request a new invitation link. +Open the new email invitation and try again. + +### I Cannot See Expected Pages or Menus + +Possible reasons include: + +- Your role does not have permission to access the module +- You are not assigned to a project yet + +Contact the Super Admin for assistance. + +### I Cannot Find My Data + +Try the following steps: + +- Check active filters +- Clear search fields +- Review pagination pages +- Refresh the page + +## Best Practices + +### For All Users + +- Review your dashboard regularly +- Keep information accurate and updated +- Save updates carefully +- Logout after using shared devices + +### For Super Admins + +- Monitor invitation statuses regularly +- Remove expired invitations when necessary +- Review project assignments frequently + +### For Mentors + +- Review student activity consistently +- Provide useful and actionable feedback +- Support students who require additional guidance + +### For Students + +- Update activity logs daily +- Clearly explain blockers and challenges +- Read mentor feedback carefully +- Stay consistent with project updates + +## Final Note + +Digital Logbook is designed to improve collaboration, activity tracking, and project management for all users. +Regular updates, clear communication, and consistent feedback help ensure successful project progress and better learning outcomes for everyone using the platform. diff --git a/mk_docs/user_docs/docs/workflow-examples.md b/mk_docs/user_docs/docs/workflow-examples.md new file mode 100644 index 00000000..6e4e3557 --- /dev/null +++ b/mk_docs/user_docs/docs/workflow-examples.md @@ -0,0 +1,86 @@ +# Real Workflow Examples + +These examples show how the platform is used in real day-to-day scenarios. + +--- + +## Example 1: New Cohort Setup (Super Admin) + +### Goal + +Prepare a new project batch with mentors and students. + +### Flow + +1. Create project +2. Send invitations to mentors and students +3. Monitor invitation statuses +4. Assign mentors to project +5. Assign students to project +6. Verify dashboard and reporting visibility + +### Success Outcome + +All users are active and projects are ready for daily activity tracking. + +--- + +## Example 2: Weekly Mentoring Review (Mentor) + +### Goal + +Review student activity quality and unblock progress. + +### Flow + +1. Open assigned students list +2. Filter by latest activity date +3. Review each submitted activity log +4. Add feedback comments with next action +5. Flag repeated blockers for follow-up + +### Success Outcome + +Students receive clear, prioritized feedback and maintain momentum. + +--- + +## Example 3: Daily Progress Update (Student) + +### Goal + +Record meaningful daily progress and keep mentor informed. + +### Flow + +1. Open Activity or Logbook section +2. Add tasks completed +3. Add measurable results +4. Note blockers and risks +5. Define next planned actions +6. Submit log and review mentor feedback later + +### Success Outcome + +Progress history becomes clear, measurable, and easy to evaluate. + +--- + +## Example 4: Monthly Report Export (Super Admin) + +### Goal + +Prepare summary report for management review. + +### Flow + +1. Open Reports page +2. Set filters (project, date range, status) +3. Generate report +4. Validate key metrics +5. Export PDF +6. Share with stakeholders + +### Success Outcome + +Decision-makers receive reliable project progress snapshots. diff --git a/mk_docs/user_docs/mkdocs.yml b/mk_docs/user_docs/mkdocs.yml new file mode 100644 index 00000000..13ac5a31 --- /dev/null +++ b/mk_docs/user_docs/mkdocs.yml @@ -0,0 +1,111 @@ +site_name: Digital Logbook +site_description: A centralized platform for managing projects, tracking activities, and enabling collaboration between Admins, Mentors, and Students. +site_author: Digital Logbook Team +site_url: https://digitallogbook.example.com +repo_url: https://github.com/digitallogbook/platform-docs +repo_name: Digital Logbook Docs +edit_uri: edit/main/docs/ +copyright: Copyright © 2026 Digital Logbook Team + +theme: + name: material + palette: + - scheme: default + primary: indigo + accent: blue + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: indigo + accent: blue + toggle: + icon: material/brightness-4 + name: Switch to light mode + font: + text: Inter + code: JetBrains Mono + features: + - navigation.instant + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - navigation.expand + - navigation.top + - navigation.footer + - announce.dismiss + - search.highlight + - search.suggest + - search.share + - content.code.copy + - content.action.edit + - content.tooltips + - toc.follow + icon: + repo: fontawesome/brands/github + logo: assets/myproject/logo Digital logbook.png + favicon: assets/favicon.svg + +nav: + - Home: index.md + - About: about.md + - Getting Started: getting-started.md + - Product Tour: product-tour.md + - UI Screenshot Gallery: app-screenshots.md + - Onboarding Checklist: onboarding-checklist.md + - Workflow Examples: workflow-examples.md + - Feature Comparison: feature-comparison.md + - Role Permissions: role-permissions.md + - Security & Privacy: security-and-privacy.md + - User Guides: + - Super Admin: super-admin.md + - Mentor: mentor.md + - Student: student.md + - Troubleshooting: troubleshooting.md + - Contact & Support: contact.md + - Release Notes: changelog.md + - Glossary: glossary.md + - Complete Guide: user-guide.md + +plugins: + - search: + lang: en + +validation: + nav: + omitted_files: ignore + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - attr_list + - def_list + - tables + - toc: + permalink: true + - md_in_html + +extra: + homepage: /index.md + announcement: "New release: improved navigation, modern UI polish, and richer role-based guidance." + social: + - icon: fontawesome/solid/envelope + link: mailto:support@digitallogbook.example.com + name: Contact Support + generator: false + +extra_css: + - stylesheets/extra.css + +extra_javascript: + - javascripts/extra.js diff --git a/mk_docs/user_docs/site/404.html b/mk_docs/user_docs/site/404.html new file mode 100644 index 00000000..581f8b2b --- /dev/null +++ b/mk_docs/user_docs/site/404.html @@ -0,0 +1,1216 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Digital Logbook + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ +

404 - Not found

+ +
+
+ + + +
+ + + +
+ +
+ + + +
+
+
+ +
+ Copyright © 2026 Digital Logbook Team +
+ + +
+ + +
+ + + + + + + + + +
+ +
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mk_docs/user_docs/site/404/index.html b/mk_docs/user_docs/site/404/index.html new file mode 100644 index 00000000..6f32b3ba --- /dev/null +++ b/mk_docs/user_docs/site/404/index.html @@ -0,0 +1,1280 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Page Not Found - Digital Logbook + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + + + + + + + + + + + +

Page Not Found

+

The page you are looking for does not exist or may have been moved.

+

Try This

+ +
+

Still Stuck?

+

If you reached this page from a broken link, please report it to docs@digitallogbook.example.com.

+
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ +
+ + + +
+
+
+ +
+ Copyright © 2026 Digital Logbook Team +
+ + +
+ + +
+ + + + + + + + + +
+ +
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mk_docs/user_docs/site/about/index.html b/mk_docs/user_docs/site/about/index.html new file mode 100644 index 00000000..a2e3de2e --- /dev/null +++ b/mk_docs/user_docs/site/about/index.html @@ -0,0 +1,1522 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + About - Digital Logbook + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + + + + + + + + + + + +

About Digital Logbook

+

Digital Logbook is a role-based project tracking platform built for training programs, mentorship workflows, and academic industry projects.

+
+

Mission

+

Our mission is to make project supervision simple, transparent, and measurable for everyone involved:

+
    +
  • Super Admins manage users and program operations
    • +
  • Mentors guide learners with actionable feedback
    • +
  • Students document progress through structured activity logs
    • +
+
+

Why Teams Use Digital Logbook

+
+
+
🧭
+
+

Clear ownership +Every role has a focused workspace and responsibilities

+
+
+
+
🧱
+
+

Structured reporting +Standardized logs make progress review consistent

+
+
+
+
🧠
+
+

Better mentoring +Feedback loops help students improve faster

+
+
+
+
📦
+
+

Audit-ready history +All entries are centralized for reporting and review

+
+
+
+
+

Platform Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModulePurpose
UsersInvitations, role assignment, access control
ProjectsProject creation and mentor/student assignment
Activity LogsDaily updates from students
FeedbackComments, review notes, and mentoring guidance
ReportsFiltered analytics and export-ready summaries
+
+

Product Values

+
    +
  • Clarity: dashboards and records should be easy to understand
    • +
  • Consistency: workflows should be repeatable across projects
    • +
  • Accountability: every update should reflect real progress
    • +
  • Growth: feedback should drive better outcomes over time
    • +
+
+
+

Next

+

Explore role-specific workflows in super-admin.md, mentor.md, and student.md.

+
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mk_docs/user_docs/site/app-screenshots/index.html b/mk_docs/user_docs/site/app-screenshots/index.html new file mode 100644 index 00000000..b61854c6 --- /dev/null +++ b/mk_docs/user_docs/site/app-screenshots/index.html @@ -0,0 +1,2040 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + UI Screenshot Gallery - Digital Logbook + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + + + + + + + + + + + +

UI Screenshot Gallery

+

All uploaded images are organized by module with separate Web View and Mobile View blocks.

+
+

Brand and Authentication

+

Brand Asset

+

Digital Logbook Logo

+
+
+
+

Sign In Web

+
+
+

Sign In Mobile

+
+
+
+
+

Super Admin Module

+

Dashboard

+
+
+
+

Admin Super Dashboard Web

+
+
+

Admin Super Dashboard Mobile

+
+
+
+

User Administration

+
+
+
+

User Administration Web

+
+
+

User Administration Mobile

+
+
+
+

Invitations

+
+
+
+

Invitations Web +Create Invitation Web

+
+
+

Invitations Mobile +Create Invitation Mobile

+
+
+
+

Bulk Upload

+
+
+
+

Bulk Upload Web

+
+
+

Bulk Upload Mobile

+
+
+
+

Projects

+
+
+
+

Projects Web +Create New Project Web

+
+
+

Projects Mobile +Create New Project Mobile

+
+
+
+

Reports and Export

+
+
+
+

Reports Web +Export Dashboard Report Web

+
+
+

Reports Mobile +Export Dashboard Report Mobile

+
+
+
+

Onboarding Approval

+
+
+
+

Onboarding Approval Web +Onboarding Mentor Web +Onboarding Create New Project Web +Onboarding Mentee Create New Project Web

+
+
+

Onboarding Approval Mobile +Onboarding Mentor Mobile +Onboarding Mentee Create New Project Mobile +Onboarding Mentor Create New Project Mobile

+
+
+
+
+

Mentor Module

+

Dashboard

+
+
+
+

Mentor Dashboard Web

+
+
+

Mentor Dashboard Mobile

+
+
+
+

Mentees

+
+
+
+

Mentees Web

+
+
+

Mentees Mobile

+
+
+
+

Calendar and Task Review

+
+
+
+

Calendar Web +All Mentee Tasks Web +Mentor Task Review Web +Calendar Task Details Web

+
+
+

Calendar Mobile +All Mentee Tasks Mobile +Mentor Task Review Mobile +Mentor Task Details Modal Mobile

+
+
+
+ +
+
+
+

Logout Web

+
+
+

Mobile Sidebar +Logout Mobile

+
+
+
+
+

Student Module

+

Dashboard

+
+
+
+

Student Dashboard Web

+
+
+

Student Dashboard Mobile

+
+
+
+

Monthly Attendance

+
+
+
+

Student Monthly Attendance Web

+
+
+

Student Monthly Attendance Mobile

+
+
+
+

Task Details

+
+
+
+

Student Task Details Web +Student Task Details Modal Web

+
+
+

Student Task Details Modal Mobile

+
+
+
+

Profile

+
+
+
+

Student Profile View +Student Profile Activities List

+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mk_docs/user_docs/site/assets/admin-workspace.svg b/mk_docs/user_docs/site/assets/admin-workspace.svg new file mode 100644 index 00000000..d56dd9d4 --- /dev/null +++ b/mk_docs/user_docs/site/assets/admin-workspace.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/mk_docs/user_docs/site/assets/brand-logo.svg b/mk_docs/user_docs/site/assets/brand-logo.svg new file mode 100644 index 00000000..6e56acf4 --- /dev/null +++ b/mk_docs/user_docs/site/assets/brand-logo.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/mk_docs/user_docs/site/assets/favicon.svg b/mk_docs/user_docs/site/assets/favicon.svg new file mode 100644 index 00000000..00d5e010 --- /dev/null +++ b/mk_docs/user_docs/site/assets/favicon.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/mk_docs/user_docs/site/assets/images/favicon.png b/mk_docs/user_docs/site/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/mk_docs/user_docs/site/assets/images/favicon.png differ diff --git a/mk_docs/user_docs/site/assets/javascripts/bundle.79ae519e.min.js b/mk_docs/user_docs/site/assets/javascripts/bundle.79ae519e.min.js new file mode 100644 index 00000000..3df3e5e6 --- /dev/null +++ b/mk_docs/user_docs/site/assets/javascripts/bundle.79ae519e.min.js @@ -0,0 +1,16 @@ +"use strict";(()=>{var Zi=Object.create;var _r=Object.defineProperty;var ea=Object.getOwnPropertyDescriptor;var ta=Object.getOwnPropertyNames,Bt=Object.getOwnPropertySymbols,ra=Object.getPrototypeOf,Ar=Object.prototype.hasOwnProperty,bo=Object.prototype.propertyIsEnumerable;var ho=(e,t,r)=>t in e?_r(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))Ar.call(t,r)&&ho(e,r,t[r]);if(Bt)for(var r of Bt(t))bo.call(t,r)&&ho(e,r,t[r]);return e};var vo=(e,t)=>{var r={};for(var o in e)Ar.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Bt)for(var o of Bt(e))t.indexOf(o)<0&&bo.call(e,o)&&(r[o]=e[o]);return r};var Cr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var oa=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of ta(t))!Ar.call(e,n)&&n!==r&&_r(e,n,{get:()=>t[n],enumerable:!(o=ea(t,n))||o.enumerable});return e};var $t=(e,t,r)=>(r=e!=null?Zi(ra(e)):{},oa(t||!e||!e.__esModule?_r(r,"default",{value:e,enumerable:!0}):r,e));var go=(e,t,r)=>new Promise((o,n)=>{var i=c=>{try{a(r.next(c))}catch(p){n(p)}},s=c=>{try{a(r.throw(c))}catch(p){n(p)}},a=c=>c.done?o(c.value):Promise.resolve(c.value).then(i,s);a((r=r.apply(e,t)).next())});var xo=Cr((kr,yo)=>{(function(e,t){typeof kr=="object"&&typeof yo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(kr,(function(){"use strict";function e(r){var o=!0,n=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function c(k){var ut=k.type,je=k.tagName;return!!(je==="INPUT"&&s[ut]&&!k.readOnly||je==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function p(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(a(r.activeElement)&&p(r.activeElement),o=!0)}function u(k){o=!1}function d(k){a(k.target)&&(o||c(k.target))&&p(k.target)}function v(k){a(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function S(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",ee),document.addEventListener("mousedown",ee),document.addEventListener("mouseup",ee),document.addEventListener("pointermove",ee),document.addEventListener("pointerdown",ee),document.addEventListener("pointerup",ee),document.addEventListener("touchmove",ee),document.addEventListener("touchstart",ee),document.addEventListener("touchend",ee)}function re(){document.removeEventListener("mousemove",ee),document.removeEventListener("mousedown",ee),document.removeEventListener("mouseup",ee),document.removeEventListener("pointermove",ee),document.removeEventListener("pointerdown",ee),document.removeEventListener("pointerup",ee),document.removeEventListener("touchmove",ee),document.removeEventListener("touchstart",ee),document.removeEventListener("touchend",ee)}function ee(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,re())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",S,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",v,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)}))});var ro=Cr((jy,Rn)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var qa=/["'&<>]/;Rn.exports=Ka;function Ka(e){var t=""+e,r=qa.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Nt=="object"&&typeof io=="object"?io.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Nt=="object"?Nt.ClipboardJS=r():t.ClipboardJS=r()})(Nt,function(){return(function(){var e={686:(function(o,n,i){"use strict";i.d(n,{default:function(){return Xi}});var s=i(279),a=i.n(s),c=i(370),p=i.n(c),l=i(817),f=i.n(l);function u(q){try{return document.execCommand(q)}catch(C){return!1}}var d=function(C){var _=f()(C);return u("cut"),_},v=d;function S(q){var C=document.documentElement.getAttribute("dir")==="rtl",_=document.createElement("textarea");_.style.fontSize="12pt",_.style.border="0",_.style.padding="0",_.style.margin="0",_.style.position="absolute",_.style[C?"right":"left"]="-9999px";var D=window.pageYOffset||document.documentElement.scrollTop;return _.style.top="".concat(D,"px"),_.setAttribute("readonly",""),_.value=q,_}var X=function(C,_){var D=S(C);_.container.appendChild(D);var N=f()(D);return u("copy"),D.remove(),N},re=function(C){var _=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},D="";return typeof C=="string"?D=X(C,_):C instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(C==null?void 0:C.type)?D=X(C.value,_):(D=f()(C),u("copy")),D},ee=re;function k(q){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(_){return typeof _}:k=function(_){return _&&typeof Symbol=="function"&&_.constructor===Symbol&&_!==Symbol.prototype?"symbol":typeof _},k(q)}var ut=function(){var C=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},_=C.action,D=_===void 0?"copy":_,N=C.container,G=C.target,We=C.text;if(D!=="copy"&&D!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(G!==void 0)if(G&&k(G)==="object"&&G.nodeType===1){if(D==="copy"&&G.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(D==="cut"&&(G.hasAttribute("readonly")||G.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(We)return ee(We,{container:N});if(G)return D==="cut"?v(G):ee(G,{container:N})},je=ut;function R(q){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?R=function(_){return typeof _}:R=function(_){return _&&typeof Symbol=="function"&&_.constructor===Symbol&&_!==Symbol.prototype?"symbol":typeof _},R(q)}function se(q,C){if(!(q instanceof C))throw new TypeError("Cannot call a class as a function")}function ce(q,C){for(var _=0;_0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof N.action=="function"?N.action:this.defaultAction,this.target=typeof N.target=="function"?N.target:this.defaultTarget,this.text=typeof N.text=="function"?N.text:this.defaultText,this.container=R(N.container)==="object"?N.container:document.body}},{key:"listenClick",value:function(N){var G=this;this.listener=p()(N,"click",function(We){return G.onClick(We)})}},{key:"onClick",value:function(N){var G=N.delegateTarget||N.currentTarget,We=this.action(G)||"copy",Yt=je({action:We,container:this.container,target:this.target(G),text:this.text(G)});this.emit(Yt?"success":"error",{action:We,text:Yt,trigger:G,clearSelection:function(){G&&G.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(N){return Mr("action",N)}},{key:"defaultTarget",value:function(N){var G=Mr("target",N);if(G)return document.querySelector(G)}},{key:"defaultText",value:function(N){return Mr("text",N)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(N){var G=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return ee(N,G)}},{key:"cut",value:function(N){return v(N)}},{key:"isSupported",value:function(){var N=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],G=typeof N=="string"?[N]:N,We=!!document.queryCommandSupported;return G.forEach(function(Yt){We=We&&!!document.queryCommandSupported(Yt)}),We}}]),_})(a()),Xi=Ji}),828:(function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,c){for(;a&&a.nodeType!==n;){if(typeof a.matches=="function"&&a.matches(c))return a;a=a.parentNode}}o.exports=s}),438:(function(o,n,i){var s=i(828);function a(l,f,u,d,v){var S=p.apply(this,arguments);return l.addEventListener(u,S,v),{destroy:function(){l.removeEventListener(u,S,v)}}}function c(l,f,u,d,v){return typeof l.addEventListener=="function"?a.apply(null,arguments):typeof u=="function"?a.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(S){return a(S,f,u,d,v)}))}function p(l,f,u,d){return function(v){v.delegateTarget=s(v.target,f),v.delegateTarget&&d.call(l,v)}}o.exports=c}),879:(function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}}),370:(function(o,n,i){var s=i(879),a=i(438);function c(u,d,v){if(!u&&!d&&!v)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(v))throw new TypeError("Third argument must be a Function");if(s.node(u))return p(u,d,v);if(s.nodeList(u))return l(u,d,v);if(s.string(u))return f(u,d,v);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function p(u,d,v){return u.addEventListener(d,v),{destroy:function(){u.removeEventListener(d,v)}}}function l(u,d,v){return Array.prototype.forEach.call(u,function(S){S.addEventListener(d,v)}),{destroy:function(){Array.prototype.forEach.call(u,function(S){S.removeEventListener(d,v)})}}}function f(u,d,v){return a(document.body,u,d,v)}o.exports=c}),817:(function(o){function n(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),p=document.createRange();p.selectNodeContents(i),c.removeAllRanges(),c.addRange(p),s=c.toString()}return s}o.exports=n}),279:(function(o){function n(){}n.prototype={on:function(i,s,a){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var c=this;function p(){c.off(i,p),s.apply(a,arguments)}return p._=s,this.on(i,p,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),c=0,p=a.length;for(c;c0&&i[i.length-1])&&(p[0]===6||p[0]===2)){r=0;continue}if(p[0]===3&&(!i||p[1]>i[0]&&p[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function K(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],s;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(a){s={error:a}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(s)throw s.error}}return i}function B(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||c(d,S)})},v&&(n[d]=v(n[d])))}function c(d,v){try{p(o[d](v))}catch(S){u(i[0][3],S)}}function p(d){d.value instanceof dt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){c("next",d)}function f(d){c("throw",d)}function u(d,v){d(v),i.shift(),i.length&&c(i[0][0],i[0][1])}}function To(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Oe=="function"?Oe(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(s){return new Promise(function(a,c){s=e[i](s),n(a,c,s.done,s.value)})}}function n(i,s,a,c){Promise.resolve(c).then(function(p){i({value:p,done:a})},s)}}function I(e){return typeof e=="function"}function yt(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Jt=yt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Ze(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var qe=(function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Oe(s),c=a.next();!c.done;c=a.next()){var p=c.value;p.remove(this)}}catch(S){t={error:S}}finally{try{c&&!c.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var l=this.initialTeardown;if(I(l))try{l()}catch(S){i=S instanceof Jt?S.errors:[S]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=Oe(f),d=u.next();!d.done;d=u.next()){var v=d.value;try{So(v)}catch(S){i=i!=null?i:[],S instanceof Jt?i=B(B([],K(i)),K(S.errors)):i.push(S)}}}catch(S){o={error:S}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new Jt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)So(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ze(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ze(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=(function(){var t=new e;return t.closed=!0,t})(),e})();var $r=qe.EMPTY;function Xt(e){return e instanceof qe||e&&"closed"in e&&I(e.remove)&&I(e.add)&&I(e.unsubscribe)}function So(e){I(e)?e():e.unsubscribe()}var De={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var xt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,s=n.isStopped,a=n.observers;return i||s?$r:(this.currentObservers=null,a.push(r),new qe(function(){o.currentObservers=null,Ze(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,s=o.isStopped;n?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Ho(r,o)},t})(F);var Ho=(function(e){ie(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:$r},t})(T);var jr=(function(e){ie(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t})(T);var Rt={now:function(){return(Rt.delegate||Date).now()},delegate:void 0};var It=(function(e){ie(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Rt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,s=o._infiniteTimeWindow,a=o._timestampProvider,c=o._windowTime;n||(i.push(r),!s&&i.push(a.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,s=n._buffer,a=s.slice(),c=0;c0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t})(St);var Ro=(function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t})(Ot);var Dr=new Ro(Po);var Io=(function(e){ie(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=Tt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var s=r.actions;o!=null&&o===r._scheduled&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==o&&(Tt.cancelAnimationFrame(o),r._scheduled=void 0)},t})(St);var Fo=(function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o;r?o=r.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t})(Ot);var ye=new Fo(Io);var y=new F(function(e){return e.complete()});function tr(e){return e&&I(e.schedule)}function Vr(e){return e[e.length-1]}function pt(e){return I(Vr(e))?e.pop():void 0}function Fe(e){return tr(Vr(e))?e.pop():void 0}function rr(e,t){return typeof Vr(e)=="number"?e.pop():t}var Lt=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function or(e){return I(e==null?void 0:e.then)}function nr(e){return I(e[wt])}function ir(e){return Symbol.asyncIterator&&I(e==null?void 0:e[Symbol.asyncIterator])}function ar(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function fa(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var sr=fa();function cr(e){return I(e==null?void 0:e[sr])}function pr(e){return wo(this,arguments,function(){var r,o,n,i;return Gt(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,dt(r.read())];case 3:return o=s.sent(),n=o.value,i=o.done,i?[4,dt(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,dt(n)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function lr(e){return I(e==null?void 0:e.getReader)}function U(e){if(e instanceof F)return e;if(e!=null){if(nr(e))return ua(e);if(Lt(e))return da(e);if(or(e))return ha(e);if(ir(e))return jo(e);if(cr(e))return ba(e);if(lr(e))return va(e)}throw ar(e)}function ua(e){return new F(function(t){var r=e[wt]();if(I(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function da(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?g(function(n,i){return e(n,i,o)}):be,Ee(1),r?Qe(t):tn(function(){return new fr}))}}function Yr(e){return e<=0?function(){return y}:E(function(t,r){var o=[];t.subscribe(w(r,function(n){o.push(n),e=2,!0))}function le(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new T}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,c=a===void 0?!0:a;return function(p){var l,f,u,d=0,v=!1,S=!1,X=function(){f==null||f.unsubscribe(),f=void 0},re=function(){X(),l=u=void 0,v=S=!1},ee=function(){var k=l;re(),k==null||k.unsubscribe()};return E(function(k,ut){d++,!S&&!v&&X();var je=u=u!=null?u:r();ut.add(function(){d--,d===0&&!S&&!v&&(f=Br(ee,c))}),je.subscribe(ut),!l&&d>0&&(l=new bt({next:function(R){return je.next(R)},error:function(R){S=!0,X(),f=Br(re,n,R),je.error(R)},complete:function(){v=!0,X(),f=Br(re,s),je.complete()}}),U(k).subscribe(l))})(p)}}function Br(e,t){for(var r=[],o=2;oe.next(document)),e}function M(e,t=document){return Array.from(t.querySelectorAll(e))}function j(e,t=document){let r=ue(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ue(e,t=document){return t.querySelector(e)||void 0}function Ne(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var Ra=L(h(document.body,"focusin"),h(document.body,"focusout")).pipe(Ae(1),Q(void 0),m(()=>Ne()||document.body),Z(1));function Ye(e){return Ra.pipe(m(t=>e.contains(t)),Y())}function it(e,t){return H(()=>L(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?jt(r=>He(+!r*t)):be,Q(e.matches(":hover"))))}function sn(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)sn(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)sn(o,n);return o}function br(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function _t(e){let t=x("script",{src:e});return H(()=>(document.head.appendChild(t),L(h(t,"load"),h(t,"error").pipe(b(()=>Nr(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),A(()=>document.head.removeChild(t)),Ee(1))))}var cn=new T,Ia=H(()=>typeof ResizeObserver=="undefined"?_t("https://unpkg.com/resize-observer-polyfill"):$(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>cn.next(t)))),b(e=>L(tt,$(e)).pipe(A(()=>e.disconnect()))),Z(1));function de(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Le(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ia.pipe(O(r=>r.observe(t)),b(r=>cn.pipe(g(o=>o.target===t),A(()=>r.unobserve(t)))),m(()=>de(e)),Q(de(e)))}function At(e){return{width:e.scrollWidth,height:e.scrollHeight}}function vr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function pn(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Be(e){return{x:e.offsetLeft,y:e.offsetTop}}function ln(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function mn(e){return L(h(window,"load"),h(window,"resize")).pipe($e(0,ye),m(()=>Be(e)),Q(Be(e)))}function gr(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ge(e){return L(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe($e(0,ye),m(()=>gr(e)),Q(gr(e)))}var fn=new T,Fa=H(()=>$(new IntersectionObserver(e=>{for(let t of e)fn.next(t)},{threshold:0}))).pipe(b(e=>L(tt,$(e)).pipe(A(()=>e.disconnect()))),Z(1));function mt(e){return Fa.pipe(O(t=>t.observe(e)),b(t=>fn.pipe(g(({target:r})=>r===e),A(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function un(e,t=16){return Ge(e).pipe(m(({y:r})=>{let o=de(e),n=At(e);return r>=n.height-o.height-t}),Y())}var yr={drawer:j("[data-md-toggle=drawer]"),search:j("[data-md-toggle=search]")};function dn(e){return yr[e].checked}function at(e,t){yr[e].checked!==t&&yr[e].click()}function Je(e){let t=yr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function ja(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ua(){return L(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function hn(){let e=h(window,"keydown").pipe(g(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:dn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),g(({mode:t,type:r})=>{if(t==="global"){let o=Ne();if(typeof o!="undefined")return!ja(o,r)}return!0}),le());return Ua().pipe(b(t=>t?y:e))}function we(){return new URL(location.href)}function st(e,t=!1){if(V("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function bn(){return new T}function vn(){return location.hash.slice(1)}function gn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Zr(e){return L(h(window,"hashchange"),e).pipe(m(vn),Q(vn()),g(t=>t.length>0),Z(1))}function yn(e){return Zr(e).pipe(m(t=>ue(`[id="${t}"]`)),g(t=>typeof t!="undefined"))}function Wt(e){let t=matchMedia(e);return ur(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function xn(){let e=matchMedia("print");return L(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function eo(e,t){return e.pipe(b(r=>r?t():y))}function to(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let s=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+s*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function ze(e,t){return to(e,t).pipe(b(r=>r.text()),m(r=>JSON.parse(r)),Z(1))}function xr(e,t){let r=new DOMParser;return to(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),Z(1))}function En(e,t){let r=new DOMParser;return to(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),Z(1))}function wn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function Tn(){return L(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(wn),Q(wn()))}function Sn(){return{width:innerWidth,height:innerHeight}}function On(){return h(window,"resize",{passive:!0}).pipe(m(Sn),Q(Sn()))}function Ln(){return z([Tn(),On()]).pipe(m(([e,t])=>({offset:e,size:t})),Z(1))}function Er(e,{viewport$:t,header$:r}){let o=t.pipe(ne("size")),n=z([o,r]).pipe(m(()=>Be(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:s,size:a},{x:c,y:p}])=>({offset:{x:s.x-c,y:s.y-p+i},size:a})))}function Wa(e){return h(e,"message",t=>t.data)}function Da(e){let t=new T;return t.subscribe(r=>e.postMessage(r)),t}function Mn(e,t=new Worker(e)){let r=Wa(t),o=Da(t),n=new T;n.subscribe(o);let i=o.pipe(oe(),ae(!0));return n.pipe(oe(),Ve(r.pipe(W(i))),le())}var Va=j("#__config"),Ct=JSON.parse(Va.textContent);Ct.base=`${new URL(Ct.base,we())}`;function Te(){return Ct}function V(e){return Ct.features.includes(e)}function Me(e,t){return typeof t!="undefined"?Ct.translations[e].replace("#",t.toString()):Ct.translations[e]}function Ce(e,t=document){return j(`[data-md-component=${e}]`,t)}function me(e,t=document){return M(`[data-md-component=${e}]`,t)}function Na(e){let t=j(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>j(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function _n(e){if(!V("announce.dismiss")||!e.childElementCount)return y;if(!e.hidden){let t=j(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return H(()=>{let t=new T;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),Na(e).pipe(O(r=>t.next(r)),A(()=>t.complete()),m(r=>P({ref:e},r)))})}function za(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function An(e,t){let r=new T;return r.subscribe(({hidden:o})=>{e.hidden=o}),za(e,t).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))}function Dt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wr(...e){return x("div",{class:"md-tooltip2",role:"dialog"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Cn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function kn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Dt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Dt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Hn(e){return x("button",{class:"md-code__button",title:Me("clipboard.copy"),"data-clipboard-target":`#${e} > code`,"data-md-type":"copy"})}function $n(){return x("button",{class:"md-code__button",title:"Toggle line selection","data-md-type":"select"})}function Pn(){return x("nav",{class:"md-code__nav"})}var In=$t(ro());function oo(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(c=>!e.terms[c]).reduce((c,p)=>[...c,x("del",null,(0,In.default)(p))," "],[]).slice(0,-1),i=Te(),s=new URL(e.location,i.base);V("search.highlight")&&s.searchParams.set("h",Object.entries(e.terms).filter(([,c])=>c).reduce((c,[p])=>`${c} ${p}`.trim(),""));let{tags:a}=Te();return x("a",{href:`${s}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(c=>{let p=a?c in a?`md-tag-icon md-tag--${a[c]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${p}`},c)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Me("search.result.term.missing"),": ",...n)))}function Fn(e){let t=e[0].score,r=[...e],o=Te(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),s=r.findIndex(l=>l.scoreoo(l,1)),...c.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,c.length>0&&c.length===1?Me("search.result.more.one"):Me("search.result.more.other",c.length))),...c.map(l=>oo(l,1)))]:[]];return x("li",{class:"md-search-result__item"},p)}function jn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?br(r):r)))}function no(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function Un(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Qa(e){var o;let t=Te(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Wn(e,t){var o;let r=Te();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Me("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Qa)))}var Ya=0;function Ba(e,t=250){let r=z([Ye(e),it(e,t)]).pipe(m(([n,i])=>n||i),Y()),o=H(()=>pn(e)).pipe(J(Ge),gt(1),Pe(r),m(()=>ln(e)));return r.pipe(Re(n=>n),b(()=>z([r,o])),m(([n,i])=>({active:n,offset:i})),le())}function Vt(e,t,r=250){let{content$:o,viewport$:n}=t,i=`__tooltip2_${Ya++}`;return H(()=>{let s=new T,a=new jr(!1);s.pipe(oe(),ae(!1)).subscribe(a);let c=a.pipe(jt(l=>He(+!l*250,Dr)),Y(),b(l=>l?o:y),O(l=>l.id=i),le());z([s.pipe(m(({active:l})=>l)),c.pipe(b(l=>it(l,250)),Q(!1))]).pipe(m(l=>l.some(f=>f))).subscribe(a);let p=a.pipe(g(l=>l),te(c,n),m(([l,f,{size:u}])=>{let d=e.getBoundingClientRect(),v=d.width/2;if(f.role==="tooltip")return{x:v,y:8+d.height};if(d.y>=u.height/2){let{height:S}=de(f);return{x:v,y:-16-S}}else return{x:v,y:16+d.height}}));return z([c,s,p]).subscribe(([l,{offset:f},u])=>{l.style.setProperty("--md-tooltip-host-x",`${f.x}px`),l.style.setProperty("--md-tooltip-host-y",`${f.y}px`),l.style.setProperty("--md-tooltip-x",`${u.x}px`),l.style.setProperty("--md-tooltip-y",`${u.y}px`),l.classList.toggle("md-tooltip2--top",u.y<0),l.classList.toggle("md-tooltip2--bottom",u.y>=0)}),a.pipe(g(l=>l),te(c,(l,f)=>f),g(l=>l.role==="tooltip")).subscribe(l=>{let f=de(j(":scope > *",l));l.style.setProperty("--md-tooltip-width",`${f.width}px`),l.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(Y(),xe(ye),te(c)).subscribe(([l,f])=>{f.classList.toggle("md-tooltip2--active",l)}),z([a.pipe(g(l=>l)),c]).subscribe(([l,f])=>{f.role==="dialog"?(e.setAttribute("aria-controls",i),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",i)}),a.pipe(g(l=>!l)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),Ba(e,r).pipe(O(l=>s.next(l)),A(()=>s.complete()),m(l=>P({ref:e},l)))})}function Xe(e,{viewport$:t},r=document.body){return Vt(e,{content$:new F(o=>{let n=e.title,i=Cn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t},0)}function Ga(e,t){let r=H(()=>z([mn(e),Ge(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:s,height:a}=de(e);return{x:o-i.x+s/2,y:n-i.y+a/2}}));return Ye(e).pipe(b(o=>r.pipe(m(n=>({active:o,offset:n})),Ee(+!o||1/0))))}function Dn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return H(()=>{let i=new T,s=i.pipe(oe(),ae(!0));return i.subscribe({next({offset:a}){e.style.setProperty("--md-tooltip-x",`${a.x}px`),e.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),mt(e).pipe(W(s)).subscribe(a=>{e.toggleAttribute("data-md-visible",a)}),L(i.pipe(g(({active:a})=>a)),i.pipe(Ae(250),g(({active:a})=>!a))).subscribe({next({active:a}){a?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe($e(16,ye)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(gt(125,ye),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?e.style.setProperty("--md-tooltip-0",`${-a}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(s),g(a=>!(a.metaKey||a.ctrlKey))).subscribe(a=>{a.stopPropagation(),a.preventDefault()}),h(n,"mousedown").pipe(W(s),te(i)).subscribe(([a,{active:c}])=>{var p;if(a.button!==0||a.metaKey||a.ctrlKey)a.preventDefault();else if(c){a.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(p=Ne())==null||p.blur()}}),r.pipe(W(s),g(a=>a===o),nt(125)).subscribe(()=>e.focus()),Ga(e,t).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))})}function Ja(e){let t=Te();if(e.tagName!=="CODE")return[e];let r=[".c",".c1",".cm"];if(t.annotate&&typeof t.annotate=="object"){let o=e.closest("[class|=language]");if(o)for(let n of Array.from(o.classList)){if(!n.startsWith("language-"))continue;let[,i]=n.split("-");i in t.annotate&&r.push(...t.annotate[i])}}return M(r.join(", "),e)}function Xa(e){let t=[];for(let r of Ja(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let s;for(;s=/(\(\d+\))(!)?/.exec(i.textContent);){let[,a,c]=s;if(typeof c=="undefined"){let p=i.splitText(s.index);i=p.splitText(a.length),t.push(p)}else{i.textContent=a,t.push(i);break}}}}return t}function Vn(e,t){t.append(...Array.from(e.childNodes))}function Tr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,s=new Map;for(let a of Xa(t)){let[,c]=a.textContent.match(/\((\d+)\)/);ue(`:scope > li:nth-child(${c})`,e)&&(s.set(c,kn(c,i)),a.replaceWith(s.get(c)))}return s.size===0?y:H(()=>{let a=new T,c=a.pipe(oe(),ae(!0)),p=[];for(let[l,f]of s)p.push([j(".md-typeset",f),j(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(c)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of p)l?Vn(f,u):Vn(u,f)}),L(...[...s].map(([,l])=>Dn(l,t,{target$:r}))).pipe(A(()=>a.complete()),le())})}function Nn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Nn(t)}}function zn(e,t){return H(()=>{let r=Nn(e);return typeof r!="undefined"?Tr(r,e,t):y})}var Kn=$t(ao());var Za=0,qn=L(h(window,"keydown").pipe(m(()=>!0)),L(h(window,"keyup"),h(window,"contextmenu")).pipe(m(()=>!1))).pipe(Q(!1),Z(1));function Qn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Qn(t)}}function es(e){return Le(e).pipe(m(({width:t})=>({scrollable:At(e).width>t})),ne("scrollable"))}function Yn(e,t){let{matches:r}=matchMedia("(hover)"),o=H(()=>{let n=new T,i=n.pipe(Yr(1));n.subscribe(({scrollable:d})=>{d&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let s=[],a=e.closest("pre"),c=a.closest("[id]"),p=c?c.id:Za++;a.id=`__code_${p}`;let l=[],f=e.closest(".highlight");if(f instanceof HTMLElement){let d=Qn(f);if(typeof d!="undefined"&&(f.classList.contains("annotate")||V("content.code.annotate"))){let v=Tr(d,e,t);l.push(Le(f).pipe(W(i),m(({width:S,height:X})=>S&&X),Y(),b(S=>S?v:y)))}}let u=M(":scope > span[id]",e);if(u.length&&(e.classList.add("md-code__content"),e.closest(".select")||V("content.code.select")&&!e.closest(".no-select"))){let d=+u[0].id.split("-").pop(),v=$n();s.push(v),V("content.tooltips")&&l.push(Xe(v,{viewport$}));let S=h(v,"click").pipe(Ut(R=>!R,!1),O(()=>v.blur()),le());S.subscribe(R=>{v.classList.toggle("md-code__button--active",R)});let X=fe(u).pipe(J(R=>it(R).pipe(m(se=>[R,se]))));S.pipe(b(R=>R?X:y)).subscribe(([R,se])=>{let ce=ue(".hll.select",R);if(ce&&!se)ce.replaceWith(...Array.from(ce.childNodes));else if(!ce&&se){let he=document.createElement("span");he.className="hll select",he.append(...Array.from(R.childNodes).slice(1)),R.append(he)}});let re=fe(u).pipe(J(R=>h(R,"mousedown").pipe(O(se=>se.preventDefault()),m(()=>R)))),ee=S.pipe(b(R=>R?re:y),te(qn),m(([R,se])=>{var he;let ce=u.indexOf(R)+d;if(se===!1)return[ce,ce];{let Se=M(".hll",e).map(Ue=>u.indexOf(Ue.parentElement)+d);return(he=window.getSelection())==null||he.removeAllRanges(),[Math.min(ce,...Se),Math.max(ce,...Se)]}})),k=Zr(y).pipe(g(R=>R.startsWith(`__codelineno-${p}-`)));k.subscribe(R=>{let[,,se]=R.split("-"),ce=se.split(":").map(Se=>+Se-d+1);ce.length===1&&ce.push(ce[0]);for(let Se of M(".hll:not(.select)",e))Se.replaceWith(...Array.from(Se.childNodes));let he=u.slice(ce[0]-1,ce[1]);for(let Se of he){let Ue=document.createElement("span");Ue.className="hll",Ue.append(...Array.from(Se.childNodes).slice(1)),Se.append(Ue)}}),k.pipe(Ee(1),xe(pe)).subscribe(R=>{if(R.includes(":")){let se=document.getElementById(R.split(":")[0]);se&&setTimeout(()=>{let ce=se,he=-64;for(;ce!==document.body;)he+=ce.offsetTop,ce=ce.offsetParent;window.scrollTo({top:he})},1)}});let je=fe(M('a[href^="#__codelineno"]',f)).pipe(J(R=>h(R,"click").pipe(O(se=>se.preventDefault()),m(()=>R)))).pipe(W(i),te(qn),m(([R,se])=>{let he=+j(`[id="${R.hash.slice(1)}"]`).parentElement.id.split("-").pop();if(se===!1)return[he,he];{let Se=M(".hll",e).map(Ue=>+Ue.parentElement.id.split("-").pop());return[Math.min(he,...Se),Math.max(he,...Se)]}}));L(ee,je).subscribe(R=>{let se=`#__codelineno-${p}-`;R[0]===R[1]?se+=R[0]:se+=`${R[0]}:${R[1]}`,history.replaceState({},"",se),window.dispatchEvent(new HashChangeEvent("hashchange",{newURL:window.location.origin+window.location.pathname+se,oldURL:window.location.href}))})}if(Kn.default.isSupported()&&(e.closest(".copy")||V("content.code.copy")&&!e.closest(".no-copy"))){let d=Hn(a.id);s.push(d),V("content.tooltips")&&l.push(Xe(d,{viewport$}))}if(s.length){let d=Pn();d.append(...s),a.insertBefore(d,e)}return es(e).pipe(O(d=>n.next(d)),A(()=>n.complete()),m(d=>P({ref:e},d)),Ve(L(...l).pipe(W(i))))});return V("content.lazy")?mt(e).pipe(g(n=>n),Ee(1),b(()=>o)):o}function ts(e,{target$:t,print$:r}){let o=!0;return L(t.pipe(m(n=>n.closest("details:not([open])")),g(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(g(n=>n||!o),O(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Bn(e,t){return H(()=>{let r=new T;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),ts(e,t).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}var Gn=0;function rs(e){let t=document.createElement("h3");t.innerHTML=e.innerHTML;let r=[t],o=e.nextElementSibling;for(;o&&!(o instanceof HTMLHeadingElement);)r.push(o),o=o.nextElementSibling;return r}function os(e,t){for(let r of M("[href], [src]",e))for(let o of["href","src"]){let n=r.getAttribute(o);if(n&&!/^(?:[a-z]+:)?\/\//i.test(n)){r[o]=new URL(r.getAttribute(o),t).toString();break}}for(let r of M("[name^=__], [for]",e))for(let o of["id","for","name"]){let n=r.getAttribute(o);n&&r.setAttribute(o,`${n}$preview_${Gn}`)}return Gn++,$(e)}function Jn(e,t){let{sitemap$:r}=t;if(!(e instanceof HTMLAnchorElement))return y;if(!(V("navigation.instant.preview")||e.hasAttribute("data-preview")))return y;e.removeAttribute("title");let o=z([Ye(e),it(e)]).pipe(m(([i,s])=>i||s),Y(),g(i=>i));return rt([r,o]).pipe(b(([i])=>{let s=new URL(e.href);return s.search=s.hash="",i.has(`${s}`)?$(s):y}),b(i=>xr(i).pipe(b(s=>os(s,i)))),b(i=>{let s=e.hash?`article [id="${e.hash.slice(1)}"]`:"article h1",a=ue(s,i);return typeof a=="undefined"?y:$(rs(a))})).pipe(b(i=>{let s=new F(a=>{let c=wr(...i);return a.next(c),document.body.append(c),()=>c.remove()});return Vt(e,P({content$:s},t))}))}var Xn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color)}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var so,is=0;function as(){return typeof mermaid=="undefined"||mermaid instanceof Element?_t("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):$(void 0)}function Zn(e){return e.classList.remove("mermaid"),so||(so=as().pipe(O(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Xn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),Z(1))),so.subscribe(()=>go(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${is++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),s=r.attachShadow({mode:"closed"});s.innerHTML=n,e.replaceWith(r),i==null||i(s)})),so.pipe(m(()=>({ref:e})))}var ei=x("table");function ti(e){return e.replaceWith(ei),ei.replaceWith(Un(e)),$({ref:e})}function ss(e){let t=e.find(r=>r.checked)||e[0];return L(...e.map(r=>h(r,"change").pipe(m(()=>j(`label[for="${r.id}"]`))))).pipe(Q(j(`label[for="${t.id}"]`)),m(r=>({active:r})))}function ri(e,{viewport$:t,target$:r}){let o=j(".tabbed-labels",e),n=M(":scope > input",e),i=no("prev");e.append(i);let s=no("next");return e.append(s),H(()=>{let a=new T,c=a.pipe(oe(),ae(!0));z([a,Le(e),mt(e)]).pipe(W(c),$e(1,ye)).subscribe({next([{active:p},l]){let f=Be(p),{width:u}=de(p);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=gr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([Ge(o),Le(o)]).pipe(W(c)).subscribe(([p,l])=>{let f=At(o);i.hidden=p.x<16,s.hidden=p.x>f.width-l.width-16}),L(h(i,"click").pipe(m(()=>-1)),h(s,"click").pipe(m(()=>1))).pipe(W(c)).subscribe(p=>{let{width:l}=de(o);o.scrollBy({left:l*p,behavior:"smooth"})}),r.pipe(W(c),g(p=>n.includes(p))).subscribe(p=>p.click()),o.classList.add("tabbed-labels--linked");for(let p of n){let l=j(`label[for="${p.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(c),g(f=>!(f.metaKey||f.ctrlKey)),O(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return V("content.tabs.link")&&a.pipe(Ie(1),te(t)).subscribe(([{active:p},{offset:l}])=>{let f=p.innerText.trim();if(p.hasAttribute("data-md-switching"))p.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let v of M("[data-tabs]"))for(let S of M(":scope > input",v)){let X=j(`label[for="${S.id}"]`);if(X!==p&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),S.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),a.pipe(W(c)).subscribe(()=>{for(let p of M("audio, video",e))p.offsetWidth&&p.autoplay?p.play().catch(()=>{}):p.pause()}),ss(n).pipe(O(p=>a.next(p)),A(()=>a.complete()),m(p=>P({ref:e},p)))}).pipe(et(pe))}function oi(e,t){let{viewport$:r,target$:o,print$:n}=t;return L(...M(".annotate:not(.highlight)",e).map(i=>zn(i,{target$:o,print$:n})),...M("pre:not(.mermaid) > code",e).map(i=>Yn(i,{target$:o,print$:n})),...M("a",e).map(i=>Jn(i,t)),...M("pre.mermaid",e).map(i=>Zn(i)),...M("table:not([class])",e).map(i=>ti(i)),...M("details",e).map(i=>Bn(i,{target$:o,print$:n})),...M("[data-tabs]",e).map(i=>ri(i,{viewport$:r,target$:o})),...M("[title]:not([data-preview])",e).filter(()=>V("content.tooltips")).map(i=>Xe(i,{viewport$:r})),...M(".footnote-ref",e).filter(()=>V("content.footnote.tooltips")).map(i=>Vt(i,{content$:new F(s=>{let a=new URL(i.href).hash.slice(1),c=Array.from(document.getElementById(a).cloneNode(!0).children),p=wr(...c);return s.next(p),document.body.append(p),()=>p.remove()}),viewport$:r})))}function cs(e,{alert$:t}){return t.pipe(b(r=>L($(!0),$(!1).pipe(nt(2e3))).pipe(m(o=>({message:r,active:o})))))}function ni(e,t){let r=j(".md-typeset",e);return H(()=>{let o=new T;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),cs(e,t).pipe(O(n=>o.next(n)),A(()=>o.complete()),m(n=>P({ref:e},n)))})}var ps=0;function ls(e,t){document.body.append(e);let{width:r}=de(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=vr(t),n=typeof o!="undefined"?Ge(o):$({x:0,y:0}),i=L(Ye(t),it(t)).pipe(Y());return z([i,n]).pipe(m(([s,a])=>{let{x:c,y:p}=Be(t),l=de(t),f=t.closest("table");return f&&t.parentElement&&(c+=f.offsetLeft+t.parentElement.offsetLeft,p+=f.offsetTop+t.parentElement.offsetTop),{active:s,offset:{x:c-a.x+l.width/2-r/2,y:p-a.y+l.height+8}}}))}function ii(e){let t=e.title;if(!t.length)return y;let r=`__tooltip_${ps++}`,o=Dt(r,"inline"),n=j(".md-typeset",o);return n.innerHTML=t,H(()=>{let i=new T;return i.subscribe({next({offset:s}){o.style.setProperty("--md-tooltip-x",`${s.x}px`),o.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),L(i.pipe(g(({active:s})=>s)),i.pipe(Ae(250),g(({active:s})=>!s))).subscribe({next({active:s}){s?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe($e(16,ye)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(gt(125,ye),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?o.style.setProperty("--md-tooltip-0",`${-s}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),ls(o,e).pipe(O(s=>i.next(s)),A(()=>i.complete()),m(s=>P({ref:e},s)))}).pipe(et(pe))}function ms({viewport$:e}){if(!V("header.autohide"))return $(!1);let t=e.pipe(m(({offset:{y:n}})=>n),ot(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),Y()),o=Je("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),Y(),b(n=>n?r:$(!1)),Q(!1))}function ai(e,t){return H(()=>z([Le(e),ms(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),Y((r,o)=>r.height===o.height&&r.hidden===o.hidden),Z(1))}function si(e,{header$:t,main$:r}){return H(()=>{let o=new T,n=o.pipe(oe(),ae(!0));o.pipe(ne("active"),Pe(t)).subscribe(([{active:s},{hidden:a}])=>{e.classList.toggle("md-header--shadow",s&&!a),e.hidden=a});let i=fe(M("[title]",e)).pipe(g(()=>V("content.tooltips")),J(s=>ii(s)));return r.subscribe(o),t.pipe(W(n),m(s=>P({ref:e},s)),Ve(i.pipe(W(n))))})}function fs(e,{viewport$:t,header$:r}){return Er(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=de(e);return{active:n>0&&o>=n}}),ne("active"))}function ci(e,t){return H(()=>{let r=new T;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=ue(".md-content h1");return typeof o=="undefined"?y:fs(o,t).pipe(O(n=>r.next(n)),A(()=>r.complete()),m(n=>P({ref:e},n)))})}function pi(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),Y()),n=o.pipe(b(()=>Le(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),ne("bottom"))));return z([o,n,t]).pipe(m(([i,{top:s,bottom:a},{offset:{y:c},size:{height:p}}])=>(p=Math.max(0,p-Math.max(0,s-c,i)-Math.max(0,p+c-a)),{offset:s-i,height:p,active:s-i<=c})),Y((i,s)=>i.offset===s.offset&&i.height===s.height&&i.active===s.active))}function us(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return $(...e).pipe(J(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),Z(1))}function li(e){let t=M("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=Wt("(prefers-color-scheme: light)");return H(()=>{let i=new T;return i.subscribe(s=>{if(document.body.setAttribute("data-md-color-switching",""),s.color.media==="(prefers-color-scheme)"){let a=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(a.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");s.color.scheme=c.getAttribute("data-md-color-scheme"),s.color.primary=c.getAttribute("data-md-color-primary"),s.color.accent=c.getAttribute("data-md-color-accent")}for(let[a,c]of Object.entries(s.color))document.body.setAttribute(`data-md-color-${a}`,c);for(let a=0;as.key==="Enter"),te(i,(s,a)=>a)).subscribe(({index:s})=>{s=(s+1)%t.length,t[s].click(),t[s].focus()}),i.pipe(m(()=>{let s=Ce("header"),a=window.getComputedStyle(s);return o.content=a.colorScheme,a.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(s=>r.content=`#${s}`),i.pipe(xe(pe)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),us(t).pipe(W(n.pipe(Ie(1))),vt(),O(s=>i.next(s)),A(()=>i.complete()),m(s=>P({ref:e},s)))})}function mi(e,{progress$:t}){return H(()=>{let r=new T;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(O(o=>r.next({value:o})),A(()=>r.complete()),m(o=>({ref:e,value:o})))})}function fi(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function ds(e,t){let r=new Map;for(let o of M("url",e)){let n=j("loc",o),i=[fi(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let s of M("[rel=alternate]",o)){let a=s.getAttribute("href");a!=null&&i.push(fi(new URL(a),t))}}return r}function kt(e){return En(new URL("sitemap.xml",e)).pipe(m(t=>ds(t,new URL(e))),ve(()=>$(new Map)),le())}function ui({document$:e}){let t=new Map;e.pipe(b(()=>M("link[rel=alternate]")),m(r=>new URL(r.href)),g(r=>!t.has(r.toString())),J(r=>kt(r).pipe(m(o=>[r,o]),ve(()=>y)))).subscribe(([r,o])=>{t.set(r.toString().replace(/\/$/,""),o)}),h(document.body,"click").pipe(g(r=>!r.metaKey&&!r.ctrlKey),b(r=>{if(r.target instanceof Element){let o=r.target.closest("a");if(o&&!o.target){let n=[...t].find(([f])=>o.href.startsWith(`${f}/`));if(typeof n=="undefined")return y;let[i,s]=n,a=we();if(a.href.startsWith(i))return y;let c=Te(),p=a.href.replace(c.base,"");p=`${i}/${p}`;let l=s.has(p.split("#")[0])?new URL(p,c.base):new URL(i);return r.preventDefault(),$(l)}}return y})).subscribe(r=>st(r,!0))}var co=$t(ao());function hs(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function di({alert$:e}){co.default.isSupported()&&new F(t=>{new co.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||hs(j(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(O(t=>{t.trigger.focus()}),m(()=>Me("clipboard.copied"))).subscribe(e)}function hi(e,t){if(!(e.target instanceof Element))return y;let r=e.target.closest("a");if(r===null)return y;if(r.target||e.metaKey||e.ctrlKey)return y;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),$(r)):y}function bi(e){let t=new Map;for(let r of M(":scope > *",e.head))t.set(r.outerHTML,r);return t}function vi(e){for(let t of M("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return $(e)}function bs(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...V("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=ue(o),i=ue(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=bi(document);for(let[o,n]of bi(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Ce("container");return Ke(M("script",r)).pipe(b(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),y}),oe(),ae(document))}function gi({sitemap$:e,location$:t,viewport$:r,progress$:o}){if(location.protocol==="file:")return y;$(document).subscribe(vi);let n=h(document.body,"click").pipe(Pe(e),b(([a,c])=>hi(a,c)),m(({href:a})=>new URL(a)),le()),i=h(window,"popstate").pipe(m(we),le());n.pipe(te(r)).subscribe(([a,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",a)}),L(n,i).subscribe(t);let s=t.pipe(ne("pathname"),b(a=>xr(a,{progress$:o}).pipe(ve(()=>(st(a,!0),y)))),b(vi),b(bs),le());return L(s.pipe(te(t,(a,c)=>c)),s.pipe(b(()=>t),ne("hash")),t.pipe(Y((a,c)=>a.pathname===c.pathname&&a.hash===c.hash),b(()=>n),O(()=>history.back()))).subscribe(a=>{var c,p;history.state!==null||!a.hash?window.scrollTo(0,(p=(c=history.state)==null?void 0:c.y)!=null?p:0):(history.scrollRestoration="auto",gn(a.hash),history.scrollRestoration="manual")}),t.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),r.pipe(ne("offset"),Ae(100)).subscribe(({offset:a})=>{history.replaceState(a,"")}),V("navigation.instant.prefetch")&&L(h(document.body,"mousemove"),h(document.body,"focusin")).pipe(Pe(e),b(([a,c])=>hi(a,c)),Ae(25),Qr(({href:a})=>a),hr(a=>{let c=document.createElement("link");return c.rel="prefetch",c.href=a.toString(),document.head.appendChild(c),h(c,"load").pipe(m(()=>c),Ee(1))})).subscribe(a=>a.remove()),s}var yi=$t(ro());function xi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,s)=>`${i}${s}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").replace(/&/g,"&").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return s=>(0,yi.default)(s).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function zt(e){return e.type===1}function Sr(e){return e.type===3}function Ei(e,t){let r=Mn(e);return L($(location.protocol!=="file:"),Je("search")).pipe(Re(o=>o),b(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:V("search.suggest")}}})),r}function wi(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=po(n))==null?void 0:l.pathname;if(i===void 0)return;let s=ys(o.pathname,i);if(s===void 0)return;let a=Es(t.keys());if(!t.has(a))return;let c=po(s,a);if(!c||!t.has(c.href))return;let p=po(s,r);if(p)return p.hash=o.hash,p.search=o.search,p}function po(e,t){try{return new URL(e,t)}catch(r){return}}function ys(e,t){if(e.startsWith(t))return e.slice(t.length)}function xs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oy)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:s,aliases:a})=>s===i||a.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),b(n=>h(document.body,"click").pipe(g(i=>!i.metaKey&&!i.ctrlKey),te(o),b(([i,s])=>{if(i.target instanceof Element){let a=i.target.closest("a");if(a&&!a.target&&n.has(a.href)){let c=a.href;return!i.target.closest(".md-version")&&n.get(c)===s?y:(i.preventDefault(),$(new URL(c)))}}return y}),b(i=>kt(i).pipe(m(s=>{var a;return(a=wi({selectedVersionSitemap:s,selectedVersionBaseURL:i,currentLocation:we(),currentBaseURL:t.base}))!=null?a:i})))))).subscribe(n=>st(n,!0)),z([r,o]).subscribe(([n,i])=>{j(".md-header__topic").appendChild(Wn(n,i))}),e.pipe(b(()=>o)).subscribe(n=>{var a;let i=new URL(t.base),s=__md_get("__outdated",sessionStorage,i);if(s===null){s=!0;let c=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(c)||(c=[c]);e:for(let p of c)for(let l of n.aliases.concat(n.version))if(new RegExp(p,"i").test(l)){s=!1;break e}__md_set("__outdated",s,sessionStorage,i)}if(s)for(let c of me("outdated"))c.hidden=!1})}function ws(e,{worker$:t}){let{searchParams:r}=we();r.has("q")&&(at("search",!0),e.value=r.get("q"),e.focus(),Je("search").pipe(Re(i=>!i)).subscribe(()=>{let i=we();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=Ye(e),n=L(t.pipe(Re(zt)),h(e,"keyup"),o).pipe(m(()=>e.value),Y());return z([n,o]).pipe(m(([i,s])=>({value:i,focus:s})),Z(1))}function Si(e,{worker$:t}){let r=new T,o=r.pipe(oe(),ae(!0));z([t.pipe(Re(zt)),r],(i,s)=>s).pipe(ne("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(ne("focus")).subscribe(({focus:i})=>{i&&at("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=j("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ws(e,{worker$:t}).pipe(O(i=>r.next(i)),A(()=>r.complete()),m(i=>P({ref:e},i)),Z(1))}function Oi(e,{worker$:t,query$:r}){let o=new T,n=un(e.parentElement).pipe(g(Boolean)),i=e.parentElement,s=j(":scope > :first-child",e),a=j(":scope > :last-child",e);Je("search").subscribe(l=>{a.setAttribute("role",l?"list":"presentation"),a.hidden=!l}),o.pipe(te(r),Gr(t.pipe(Re(zt)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:s.textContent=f.length?Me("search.result.none"):Me("search.result.placeholder");break;case 1:s.textContent=Me("search.result.one");break;default:let u=br(l.length);s.textContent=Me("search.result.other",u)}});let c=o.pipe(O(()=>a.innerHTML=""),b(({items:l})=>L($(...l.slice(0,10)),$(...l.slice(10)).pipe(ot(4),Xr(n),b(([f])=>f)))),m(Fn),le());return c.subscribe(l=>a.appendChild(l)),c.pipe(J(l=>{let f=ue("details",l);return typeof f=="undefined"?y:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(g(Sr),m(({data:l})=>l)).pipe(O(l=>o.next(l)),A(()=>o.complete()),m(l=>P({ref:e},l)))}function Ts(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=we();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function Li(e,t){let r=new T,o=r.pipe(oe(),ae(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),Ts(e,t).pipe(O(n=>r.next(n)),A(()=>r.complete()),m(n=>P({ref:e},n)))}function Mi(e,{worker$:t,keyboard$:r}){let o=new T,n=Ce("search-query"),i=L(h(n,"keydown"),h(n,"focus")).pipe(xe(pe),m(()=>n.value),Y());return o.pipe(Pe(i),m(([{suggest:a},c])=>{let p=c.split(/([\s-]+)/);if(a!=null&&a.length&&p[p.length-1]){let l=a[a.length-1];l.startsWith(p[p.length-1])&&(p[p.length-1]=l)}else p.length=0;return p})).subscribe(a=>e.innerHTML=a.join("").replace(/\s/g," ")),r.pipe(g(({mode:a})=>a==="search")).subscribe(a=>{a.type==="ArrowRight"&&e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText)}),t.pipe(g(Sr),m(({data:a})=>a)).pipe(O(a=>o.next(a)),A(()=>o.complete()),m(()=>({ref:e})))}function _i(e,{index$:t,keyboard$:r}){let o=Te();try{let n=Ei(o.search,t),i=Ce("search-query",e),s=Ce("search-result",e);h(e,"click").pipe(g(({target:c})=>c instanceof Element&&!!c.closest("a"))).subscribe(()=>at("search",!1)),r.pipe(g(({mode:c})=>c==="search")).subscribe(c=>{let p=Ne();switch(c.type){case"Enter":if(p===i){let l=new Map;for(let f of M(":first-child [href]",s)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}c.claim()}break;case"Escape":case"Tab":at("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof p=="undefined")i.focus();else{let l=[i,...M(":not(details) > [href], summary, details[open] [href]",s)],f=Math.max(0,(Math.max(0,l.indexOf(p))+l.length+(c.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}c.claim();break;default:i!==Ne()&&i.focus()}}),r.pipe(g(({mode:c})=>c==="global")).subscribe(c=>{switch(c.type){case"f":case"s":case"/":i.focus(),i.select(),c.claim();break}});let a=Si(i,{worker$:n});return L(a,Oi(s,{worker$:n,query$:a})).pipe(Ve(...me("search-share",e).map(c=>Li(c,{query$:a})),...me("search-suggest",e).map(c=>Mi(c,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,tt}}function Ai(e,{index$:t,location$:r}){return z([t,r.pipe(Q(we()),g(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>xi(o.config)(n.searchParams.get("h"))),m(o=>{var s;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let a=i.nextNode();a;a=i.nextNode())if((s=a.parentElement)!=null&&s.offsetHeight){let c=a.textContent,p=o(c);p.length>c.length&&n.set(a,p)}for(let[a,c]of n){let{childNodes:p}=x("span",null,c);a.replaceWith(...Array.from(p))}return{ref:e,nodes:n}}))}function Ss(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:s},{offset:{y:a}}])=>(s=s+Math.min(n,Math.max(0,a-i))-n,{height:s,locked:a>=i+n})),Y((i,s)=>i.height===s.height&&i.locked===s.locked))}function lo(e,o){var n=o,{header$:t}=n,r=vo(n,["header$"]);let i=j(".md-sidebar__scrollwrap",e),{y:s}=Be(i);return H(()=>{let a=new T,c=a.pipe(oe(),ae(!0)),p=a.pipe($e(0,ye));return p.pipe(te(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*s}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),p.pipe(Re()).subscribe(()=>{for(let l of M(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=de(f);f.scrollTo({top:u-d/2})}}}),fe(M("label[tabindex]",e)).pipe(J(l=>h(l,"click").pipe(xe(pe),m(()=>l),W(c)))).subscribe(l=>{let f=j(`[id="${l.htmlFor}"]`);j(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),V("content.tooltips")&&fe(M("abbr[title]",e)).pipe(J(l=>Xe(l,{viewport$})),W(c)).subscribe(),Ss(e,r).pipe(O(l=>a.next(l)),A(()=>a.complete()),m(l=>P({ref:e},l)))})}function Ci(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return rt(ze(`${r}/releases/latest`).pipe(ve(()=>y),m(o=>({version:o.tag_name})),Qe({})),ze(r).pipe(ve(()=>y),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Qe({}))).pipe(m(([o,n])=>P(P({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return ze(r).pipe(m(o=>({repositories:o.public_repos})),Qe({}))}}function ki(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return rt(ze(`${r}/releases/permalink/latest`).pipe(ve(()=>y),m(({tag_name:o})=>({version:o})),Qe({})),ze(r).pipe(ve(()=>y),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Qe({}))).pipe(m(([o,n])=>P(P({},o),n)))}function Hi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return Ci(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ki(r,o)}return y}var Os;function Ls(e){return Os||(Os=H(()=>{let t=__md_get("__source",sessionStorage);if(t)return $(t);if(me("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return y}return Hi(e.href).pipe(O(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>y),g(t=>Object.keys(t).length>0),m(t=>({facts:t})),Z(1)))}function $i(e){let t=j(":scope > :last-child",e);return H(()=>{let r=new T;return r.subscribe(({facts:o})=>{t.appendChild(jn(o)),t.classList.add("md-source__repository--active")}),Ls(e).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}function Ms(e,{viewport$:t,header$:r}){return Le(document.body).pipe(b(()=>Er(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),ne("hidden"))}function Pi(e,t){return H(()=>{let r=new T;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(V("navigation.tabs.sticky")?$({hidden:!1}):Ms(e,t)).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}function _s(e,{viewport$:t,header$:r}){let o=new Map,n=M(".md-nav__link",e);for(let a of n){let c=decodeURIComponent(a.hash.substring(1)),p=ue(`[id="${c}"]`);typeof p!="undefined"&&o.set(a,p)}let i=r.pipe(ne("height"),m(({height:a})=>{let c=Ce("main"),p=j(":scope > :first-child",c);return a+.8*(p.offsetTop-c.offsetTop)}),le());return Le(document.body).pipe(ne("height"),b(a=>H(()=>{let c=[];return $([...o].reduce((p,[l,f])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=f.tagName;)c.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return p.set([...c=[...c,l]].reverse(),u)},new Map))}).pipe(m(c=>new Map([...c].sort(([,p],[,l])=>p-l))),Pe(i),b(([c,p])=>t.pipe(Ut(([l,f],{offset:{y:u},size:d})=>{let v=u+d.height>=Math.floor(a.height);for(;f.length;){let[,S]=f[0];if(S-p=u&&!v)f=[l.pop(),...f];else break}return[l,f]},[[],[...c]]),Y((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([a,c])=>({prev:a.map(([p])=>p),next:c.map(([p])=>p)})),Q({prev:[],next:[]}),ot(2,1),m(([a,c])=>a.prev.length{let i=new T,s=i.pipe(oe(),ae(!0));if(i.subscribe(({prev:a,next:c})=>{for(let[p]of c)p.classList.remove("md-nav__link--passed"),p.classList.remove("md-nav__link--active");for(let[p,[l]]of a.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",p===a.length-1)}),V("toc.follow")){let a=L(t.pipe(Ae(1),m(()=>{})),t.pipe(Ae(250),m(()=>"smooth")));i.pipe(g(({prev:c})=>c.length>0),Pe(o.pipe(xe(pe))),te(a)).subscribe(([[{prev:c}],p])=>{let[l]=c[c.length-1];if(l.offsetHeight){let f=vr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=de(f);f.scrollTo({top:u-d/2,behavior:p})}}})}return V("navigation.tracking")&&t.pipe(W(s),ne("offset"),Ae(250),Ie(1),W(n.pipe(Ie(1))),vt({delay:250}),te(i)).subscribe(([,{prev:a}])=>{let c=we(),p=a[a.length-1];if(p&&p.length){let[l]=p,{hash:f}=new URL(l.href);c.hash!==f&&(c.hash=f,history.replaceState({},"",`${c}`))}else c.hash="",history.replaceState({},"",`${c}`)}),_s(e,{viewport$:t,header$:r}).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))})}function As(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:s}})=>s),ot(2,1),m(([s,a])=>s>a&&a>0),Y()),i=r.pipe(m(({active:s})=>s));return z([i,n]).pipe(m(([s,a])=>!(s&&a)),Y(),W(o.pipe(Ie(1))),ae(!0),vt({delay:250}),m(s=>({hidden:s})))}function Ii(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new T,s=i.pipe(oe(),ae(!0));return i.subscribe({next({hidden:a}){e.hidden=a,a?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(s),ne("height")).subscribe(({height:a})=>{e.style.top=`${a+16}px`}),h(e,"click").subscribe(a=>{a.preventDefault(),window.scrollTo({top:0})}),As(e,{viewport$:t,main$:o,target$:n}).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))}function Fi({document$:e,viewport$:t}){e.pipe(b(()=>M(".md-ellipsis")),J(r=>mt(r).pipe(W(e.pipe(Ie(1))),g(o=>o),m(()=>r),Ee(1))),g(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,V("content.tooltips")?Xe(n,{viewport$:t}).pipe(W(e.pipe(Ie(1))),A(()=>n.removeAttribute("title"))):y})).subscribe(),V("content.tooltips")&&e.pipe(b(()=>M(".md-status")),J(r=>Xe(r,{viewport$:t}))).subscribe()}function ji({document$:e,tablet$:t}){e.pipe(b(()=>M(".md-toggle--indeterminate")),O(r=>{r.indeterminate=!0,r.checked=!1}),J(r=>h(r,"change").pipe(Jr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),te(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function Cs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ui({document$:e}){e.pipe(b(()=>M("[data-md-scrollfix]")),O(t=>t.removeAttribute("data-md-scrollfix")),g(Cs),J(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Wi({viewport$:e,tablet$:t}){z([Je("search"),t]).pipe(m(([r,o])=>r&&!o),b(r=>$(r).pipe(nt(r?400:100))),te(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ks(){return location.protocol==="file:"?_t(`${new URL("search/search_index.js",Or.base)}`).pipe(m(()=>__index),Z(1)):ze(new URL("search/search_index.json",Or.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ct=an(),Kt=bn(),Ht=yn(Kt),mo=hn(),ke=Ln(),Lr=Wt("(min-width: 60em)"),Vi=Wt("(min-width: 76.25em)"),Ni=xn(),Or=Te(),zi=document.forms.namedItem("search")?ks():tt,fo=new T;di({alert$:fo});ui({document$:ct});var uo=new T,qi=kt(Or.base);V("navigation.instant")&&gi({sitemap$:qi,location$:Kt,viewport$:ke,progress$:uo}).subscribe(ct);var Di;((Di=Or.version)==null?void 0:Di.provider)==="mike"&&Ti({document$:ct});L(Kt,Ht).pipe(nt(125)).subscribe(()=>{at("drawer",!1),at("search",!1)});mo.pipe(g(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=ue("link[rel=prev]");typeof t!="undefined"&&st(t);break;case"n":case".":let r=ue("link[rel=next]");typeof r!="undefined"&&st(r);break;case"Enter":let o=Ne();o instanceof HTMLLabelElement&&o.click()}});Fi({viewport$:ke,document$:ct});ji({document$:ct,tablet$:Lr});Ui({document$:ct});Wi({viewport$:ke,tablet$:Lr});var ft=ai(Ce("header"),{viewport$:ke}),qt=ct.pipe(m(()=>Ce("main")),b(e=>pi(e,{viewport$:ke,header$:ft})),Z(1)),Hs=L(...me("consent").map(e=>An(e,{target$:Ht})),...me("dialog").map(e=>ni(e,{alert$:fo})),...me("palette").map(e=>li(e)),...me("progress").map(e=>mi(e,{progress$:uo})),...me("search").map(e=>_i(e,{index$:zi,keyboard$:mo})),...me("source").map(e=>$i(e))),$s=H(()=>L(...me("announce").map(e=>_n(e)),...me("content").map(e=>oi(e,{sitemap$:qi,viewport$:ke,target$:Ht,print$:Ni})),...me("content").map(e=>V("search.highlight")?Ai(e,{index$:zi,location$:Kt}):y),...me("header").map(e=>si(e,{viewport$:ke,header$:ft,main$:qt})),...me("header-title").map(e=>ci(e,{viewport$:ke,header$:ft})),...me("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?eo(Vi,()=>lo(e,{viewport$:ke,header$:ft,main$:qt})):eo(Lr,()=>lo(e,{viewport$:ke,header$:ft,main$:qt}))),...me("tabs").map(e=>Pi(e,{viewport$:ke,header$:ft})),...me("toc").map(e=>Ri(e,{viewport$:ke,header$:ft,main$:qt,target$:Ht})),...me("top").map(e=>Ii(e,{viewport$:ke,header$:ft,main$:qt,target$:Ht})))),Ki=ct.pipe(b(()=>$s),Ve(Hs),Z(1));Ki.subscribe();window.document$=ct;window.location$=Kt;window.target$=Ht;window.keyboard$=mo;window.viewport$=ke;window.tablet$=Lr;window.screen$=Vi;window.print$=Ni;window.alert$=fo;window.progress$=uo;window.component$=Ki;})(); +//# sourceMappingURL=bundle.79ae519e.min.js.map + diff --git a/mk_docs/user_docs/site/assets/javascripts/bundle.79ae519e.min.js.map b/mk_docs/user_docs/site/assets/javascripts/bundle.79ae519e.min.js.map new file mode 100644 index 00000000..5cf02892 --- /dev/null +++ b/mk_docs/user_docs/site/assets/javascripts/bundle.79ae519e.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinct.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/exhaustMap.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/link/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/alternate/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2025 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n fetchSitemap,\n setupAlternate,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 60em)\")\nconst screen$ = watchMedia(\"(min-width: 76.25em)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up language selector */\nsetupAlternate({ document$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up sitemap for instant navigation and previews */\nconst sitemap$ = fetchSitemap(config.base)\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ sitemap$, location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { sitemap$, viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n */\nexport class Subscription implements SubscriptionLike {\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param value The `next` value.\n */\n next(value: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param err The `error` exception.\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as ((value: T) => void) | undefined,\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent.\n * @param subscriber The stopped subscriber.\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @param subscribe The function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @param subscribe the subscriber function to be passed to the Observable constructor\n * @return A new observable.\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @param operator the operator defining the operation to take on the observable\n * @return A new observable with the Operator applied.\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param observerOrNext Either an {@link Observer} with some or all callback methods,\n * or the `next` handler that is called for each value emitted from the subscribed Observable.\n * @param error A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param complete A handler for a terminal event resulting from successful completion.\n * @return A subscription reference to the registered handlers.\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next A handler for each value emitted by the observable.\n * @return A promise that either resolves on observable completion or\n * rejects with the handled error.\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @return This instance of the observable.\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n *\n * @return The Observable result of all the operators having been called\n * in the order they were passed in.\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return Observable that this Subject casts to.\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param _bufferSize The size of the buffer to replay on subscription\n * @param _windowTime The amount of time the buffered items will stay buffered\n * @param _timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param state Some contextual data that the `work` function uses when called by the\n * Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is implicit\n * and defined by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param work A function representing a task, or some unit of work to be\n * executed by the Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is\n * implicit and defined by the Scheduler itself.\n * @param state Some contextual data that the `work` function uses when called\n * by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && id === scheduler._scheduled && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n let flushId;\n if (action) {\n flushId = action.id;\n } else {\n flushId = this._scheduled;\n this._scheduled = undefined;\n }\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an