@sparkerp/plugin-sdk 0.1.0 → 1.1.0

package/bundle/docs/applications/hcm/employee-directory.md

@@ -0,0 +1,55 @@
+---
+title: Employee Directory & Rosters
+audience: tenant
+---
+
+# Employee Directory & Rosters (HCM)
+
+This page documents the shipped **Employee Directory** and its filtered
+roster views (`hcm-employee`) — the main list of everyone in your company.
+Not for plugin developers.
+
+**Who this is for:** anyone with access to employee records — HR staff day
+to day, managers for their own teams.
+
+## The Employee Directory
+
+The full list of employees, with:
+
+- **KPI cards** at the top with real counts.
+- **Search and filter** — free-text search plus Department, Status, and
+  Employment Type filters, all backed by real, fast server-side
+  search/filter/sort.
+- **Saved Views** — save a search/filter combination you use often so you
+  don't have to re-set it every time.
+- **Bulk actions** — select multiple employees and Change Department,
+  Change Manager, Deactivate, or Email them all at once.
+- A rich grid with photo avatars, colored status chips, per-row quick
+  actions, and export to CSV, Excel, or PDF.
+
+Click any row to open that employee's [profile](./employee-profile.md).
+
+## The roster views
+
+Eight more screens in the HCM menu are the exact same Employee Directory,
+just pre-filtered and locked to one slice, so you land straight on the
+group you want without setting filters yourself:
+
+| Screen | Shows |
+|---|---|
+| **Active Employees** | Everyone currently active |
+| **Consultants** | Active, employment type = Consultant |
+| **Contract Employees** | Active, employment type = Contract |
+| **Interns** | Active, employment type = Intern |
+| **Probation Employees** | Active employees still on probation |
+| **Remote Employees** | Active, work mode = Remote |
+| **Ex Employees** | Everyone terminated |
+
+Everything else — the grid, the row actions, bulk actions, export — works
+identically to the main Directory; only the starting filter is different,
+and you can't remove that locked filter (that's the point of using the
+dedicated roster screen instead of the main Directory with a manual filter).
+
+## Related
+
+- [Employee Profile](./employee-profile.md)

package/bundle/docs/applications/hcm/employee-documents.md

@@ -0,0 +1,51 @@
+---
+title: Employee Documents
+audience: tenant
+---
+
+# Employee Documents (HCM)
+
+This page documents the shipped **Employee Documents** screen
+(`hcm-employee`) — a company-wide view of employee documents and their
+verification status, across everyone, not just one person's profile. Not
+for plugin developers.
+
+**Who this is for:** HR admins reviewing documents across the company.
+
+## What you see
+
+- **KPI row**: Total, Verified, Pending, Expiring Soon.
+- **Filters**: search, employee, category, status, classification,
+  expiring-soon.
+- A grid of every document across every employee, with its category,
+  classification, expiry date, whether it's mandatory, status, and when it
+  was requested.
+- A **Missing Mandatory Documents** panel — flags employees who are missing
+  a document category your tenant has marked mandatory.
+
+## Verifying a document
+
+Approving or rejecting a document doesn't happen directly on this screen —
+it routes through the standard HCM Approval Inbox, the same place every
+other approval in HCM shows up. This page shows you the state, not a
+shortcut around the approval process.
+
+## Uploading
+
+Requesting a document upload here creates a real record and submits it
+through the same approval flow used elsewhere in HCM. There's one real
+limitation: the actual file picker isn't wired up yet anywhere in HCM (not
+just this page) — so an upload submits a placeholder rather than your
+actual selected file. This is disclosed on the page itself, not silently
+faked.
+
+## Known gaps
+
+- **No document preview** — there's no way to view the file's contents
+  from this screen yet; the detail view says so rather than showing a
+  broken link.
+- **The actual file upload picker isn't wired up** — see above.
+
+## Related
+
+- [Employee Profile](./employee-profile.md)

package/bundle/docs/applications/hcm/employee-info-background.md

@@ -0,0 +1,41 @@
+---
+title: Education, Work Experience, Certifications, Skills & Family Information
+audience: tenant
+---
+
+# Education, Work Experience, Certifications, Skills & Family Information (HCM)
+
+This page documents five shipped **Employee Information** screens
+(`hcm-employee-information`) covering an employee's background — each
+supports multiple entries per employee (add/edit/delete). Not for plugin
+developers.
+
+## Education
+
+An employee's academic history — degrees, institutions, years.
+
+## Work Experience
+
+An employee's prior employment history before joining your company.
+
+## Certifications
+
+Certifications an employee holds, recorded here as part of their broader
+personal record (a separate, narrower Skills & Competencies catalog also
+exists in the Employee module — see
+[Employee Categories, Employment Types & Skills](./employee-reference-data.md)
+if you're looking for the structured skill taxonomy instead of a
+free-form personal record).
+
+## Skills
+
+Same note as Certifications above — this is the employee's own
+self-recorded skill list, not the structured company-wide skill catalog.
+
+## Family Information
+
+An employee's dependents and family members on file.
+
+## Related
+
+- [Personal Information, Employment Details & Bank Accounts](./employee-info-core.md)

package/bundle/docs/applications/hcm/employee-info-core.md

@@ -0,0 +1,32 @@
+---
+title: Personal Information, Employment Details & Bank Accounts
+audience: tenant
+---
+
+# Personal Information, Employment Details & Bank Accounts (HCM)
+
+This page documents three shipped **Employee Information** screens
+(`hcm-employee-information`). Not for plugin developers.
+
+## Personal Information
+
+One record per employee — their personal details. Citizenship and
+disability information are kept as separate, dedicated fields rather than
+folded into one general-purpose form, reflecting how sensitive/distinct
+those fields are.
+
+## Employment Details
+
+One active record per employee, flattening what could otherwise be
+several separate employment-history tables into a single current-state
+view.
+
+## Bank Accounts
+
+Multiple accounts per employee (add/edit/delete) — for splitting pay
+across accounts or tracking a change in banking details over time.
+
+## Related
+
+- [Employee Profile](./employee-profile.md)
+- [Identity Documents, Passport, Visa, Driving License & Document Management](./employee-info-documents.md)

package/bundle/docs/applications/hcm/employee-info-documents.md

@@ -0,0 +1,31 @@
+---
+title: Identity Documents, Passport, Visa, Driving License & Document Management
+audience: tenant
+---
+
+# Identity Documents, Passport, Visa, Driving License & Document Management (HCM)
+
+This page documents five shipped **Employee Information** screens
+(`hcm-employee-information`) covering an employee's official documents.
+Not for plugin developers.
+
+## Identity Documents
+
+Track every official ID document an employee has on file (add, edit,
+delete — multiple documents per employee).
+
+## Passport, Visa & Driving License
+
+Three dedicated screens, one per document type, each with its own
+add/edit/delete over multiple records per employee (e.g. more than one
+passport over time, or visas for multiple countries).
+
+## Document Management
+
+The general document storage and tracking screen for anything not
+covered by the dedicated document types above.
+
+## Related
+
+- [Personal Information, Employment Details & Bank Accounts](./employee-info-core.md)
+- [Employee Documents](./employee-documents.md)

package/bundle/docs/applications/hcm/employee-info-other.md

@@ -0,0 +1,21 @@
+---
+title: Emergency Contacts & Tax Information
+audience: tenant
+---
+
+# Emergency Contacts & Tax Information (HCM)
+
+This page documents two shipped **Employee Information** screens
+(`hcm-employee-information`). Not for plugin developers.
+
+## Emergency Contacts
+
+Multiple emergency contacts per employee (add/edit/delete).
+
+## Tax Information
+
+An employee's tax-related details on file.
+
+## Related
+
+- [Personal Information, Employment Details & Bank Accounts](./employee-info-core.md)

package/bundle/docs/applications/hcm/employee-movements.md

@@ -0,0 +1,46 @@
+---
+title: Promotions, Demotions, Transfers & Internal Movement
+audience: tenant
+---
+
+# Promotions, Demotions, Transfers & Internal Movement (HCM)
+
+This page documents four shipped screens (`hcm-employee`) covering how an
+employee moves within your company — up, down, across, or otherwise. Not
+for plugin developers.
+
+## Promotions
+
+A full dedicated screen: KPI/filter/grid, a **Create** dialog, and a
+detail view covering the career change, compensation impact (if you have
+access to compensation data), eligibility (with an override option),
+checklist, and supporting documents.
+
+## Transfers
+
+Same shape as Promotions — KPI/filter/grid, Create, and a detail view with
+a change summary, checklist, and a live indicator of exactly which
+approval stage a transfer request is currently at (Manager → HR →
+Finance/IT, where those last two apply). There's no separate manual
+approve/reject action on this page — approvals happen through the normal
+approval flow.
+
+## Internal Movement
+
+A more general "moved within the company" screen — same KPI/filter/grid/
+create/detail shape as Promotions, for movement types that aren't strictly
+a promotion or transfer (including a manager change, if you're using this
+instead of the org chart's drag-and-drop — see
+[Reporting Structure & Organization Structure](./org-structure.md)).
+
+## Demotions
+
+A simpler, read-focused screen — a filtered list of demotion requests.
+Clicking a row opens the general workflow request detail view (with its
+approval stepper, timeline, and comments) rather than a demotion-specific
+detail dialog like the other three screens have.
+
+## Related
+
+- [Reporting Structure & Organization Structure](./org-structure.md)
+- [HCM Navigation & Approvals](./navigation-and-approvals.md)

package/bundle/docs/applications/hcm/employee-reference-data.md

@@ -0,0 +1,40 @@
+---
+title: Employee Categories, Employment Types & Skills
+audience: tenant
+---
+
+# Employee Categories, Employment Types & Skills (HCM)
+
+This page documents four small shipped **master data** screens
+(`hcm-employee`) — the setup screens behind dropdowns you see elsewhere in
+HCM. Not for plugin developers.
+
+**Who this is for:** HR administrators setting up reference data, usually
+once, before day-to-day use.
+
+## Employee Categories
+
+Define the categories employees can be grouped into (with an optional
+parent category, a category type, and an effective date range). Standard
+CRUD: KPI row, search/filter, create/edit/list.
+
+## Employment Types
+
+Define the employment types available elsewhere in HCM (e.g. Full-time,
+Part-time, Contract) — tenant-configurable rather than a fixed list.
+
+## Skill Categories & Skills
+
+Two related screens that together form a real skills taxonomy:
+
+- **Skill Categories** — top-level groupings (e.g. "Technical",
+  "Leadership").
+- **Skills** — the actual skill catalog (e.g. "Python", "Project
+  Management"), each belonging to a category. This is what powers the
+  **Skills & Expertise** section on an [Employee Profile](./employee-profile.md)
+  — before this, skills were free-text only; now they're picked from this
+  real, structured catalog.
+
+## Related
+
+- [Employee Profile](./employee-profile.md)

package/bundle/docs/applications/hcm/employee-relations-analytics.md

@@ -0,0 +1,23 @@
+---
+title: Employee Relations Dashboard & Case Reports
+audience: tenant
+---
+
+# Employee Relations Dashboard & Case Reports (HCM)
+
+This page documents two shipped **Employee Relations** analytics screens
+(`hcm-employee-relations`). Not for plugin developers.
+
+## Employee Relations Dashboard
+
+Real counts across every case type in the module in one place: Employee
+Cases, Grievances, Complaints, Disciplinary actions, Workplace Conflicts,
+Employee Feedback, and Investigations.
+
+## Case Reports
+
+The same real counts, presented as a reporting view for closer review.
+
+## Related
+
+- [Employee Cases & Investigations](./employee-relations-cases.md)

package/bundle/docs/applications/hcm/employee-relations-cases.md

@@ -0,0 +1,26 @@
+---
+title: Employee Cases & Investigations
+audience: tenant
+---
+
+# Employee Cases & Investigations (HCM)
+
+This page documents two shipped **Employee Relations** screens
+(`hcm-employee-relations`). Not for plugin developers.
+
+## Employee Cases
+
+**New Case** — Employee, Case Type, Subject, Incident Date, Priority,
+Severity, and Due Date. Each case gets a real Case Number. KPIs: Total,
+Open, Investigation, Resolved.
+
+## Investigations
+
+**New Investigation** — Subject, Investigation Type, Priority, Risk
+Level, Start/Due Date, with its own real Investigation Number. Doesn't
+have to be tied to an Employee Case, but often follows from one. KPIs:
+Total, Open, In Progress, Completed.
+
+## Related
+
+- [Grievances, Complaints & Disciplinary Actions](./employee-relations-processes.md)

package/bundle/docs/applications/hcm/employee-relations-conflicts-feedback.md

@@ -0,0 +1,25 @@
+---
+title: Workplace Conflicts & Employee Feedback
+audience: tenant
+---
+
+# Workplace Conflicts & Employee Feedback (HCM)
+
+This page documents two shipped **Employee Relations** screens
+(`hcm-employee-relations`). Not for plugin developers.
+
+## Workplace Conflicts
+
+**New Workplace Conflict** — Employee, Subject, Conflict Type, Priority,
+Risk Level, Incident Date, and a **Target Resolution Date**. KPIs: Total,
+Open, Mediation (actively being mediated), Resolved.
+
+## Employee Feedback
+
+**New Employee Feedback** — Employee, Subject, Feedback Type, Mode (how
+it was submitted), Priority, Target Date. KPIs: Total, New, Action
+Required, Resolved.
+
+## Related
+
+- [Employee Cases & Investigations](./employee-relations-cases.md)

package/bundle/docs/applications/hcm/employee-relations-processes.md

@@ -0,0 +1,34 @@
+---
+title: Grievances, Complaints & Disciplinary Actions
+audience: tenant
+---
+
+# Grievances, Complaints & Disciplinary Actions (HCM)
+
+This page documents three shipped **Employee Relations** screens
+(`hcm-employee-relations`) covering formal HR processes. Not for plugin
+developers.
+
+## Grievances
+
+**New Grievance** — Employee, Subject, Category, Severity, Incident Date,
+Reported Date, Due Date, with a real Grievance Number. KPIs: Total,
+Submitted, Investigation, Resolved.
+
+## Complaints
+
+**New Complaint** — Employee, Subject, Category, Severity, Risk Level,
+Incident Date, Due Date, with a real Complaint Number. Same KPI shape
+(Total, Submitted, Investigation, Resolved).
+
+## Disciplinary Actions
+
+**New Disciplinary Action** — Employee, Subject, Case Type, Severity,
+Incident Date, Due Date, and a real **Policy Reference** — the specific
+policy the action is grounded in, not just a free-text note. KPIs: Total,
+Open, Investigation, Action Active (a disciplinary action currently in
+effect).
+
+## Related
+
+- [Employee Cases & Investigations](./employee-relations-cases.md)

package/bundle/docs/applications/hcm/employee-services-daily.md

@@ -0,0 +1,32 @@
+---
+title: My Attendance, My Timesheet, My Leave & My Payslips
+audience: tenant
+---
+
+# My Attendance, My Timesheet, My Leave & My Payslips (HCM)
+
+This page documents four **Employee Self Service** screens
+(`hcm-employee-services`) for day-to-day self-service. Not for plugin
+developers. See
+[Employee Self Service — Overview](./employee-services-overview.md) for
+how this portal relates to each domain module's own self-service screens.
+
+## My Attendance
+
+Your own real attendance records.
+
+## My Timesheet
+
+Your own real timesheet entries.
+
+## My Leave
+
+Your own real leave balances and leave requests, both on one page.
+
+## My Payslips
+
+Your own real payslips.
+
+## Related
+
+- [Employee Self Service — Overview, Requests & My Profile](./employee-services-overview.md)

package/bundle/docs/applications/hcm/employee-services-manager.md

@@ -0,0 +1,21 @@
+---
+title: Manager Self Service
+audience: tenant
+---
+
+# Manager Self Service (HCM)
+
+This page documents the shipped **Manager Self Service** screen
+(`hcm-employee-services`) — team-scoped versions of the self-service
+views, for managers looking at their own direct reports rather than
+themselves. Not for plugin developers.
+
+## What it does
+
+The same kind of self-service views as the rest of this module, but
+scoped to your real direct reports (resolved server-side from the
+reporting-manager relationship), not just yourself.
+
+## Related
+
+- [Employee Self Service — Overview, Requests & My Profile](./employee-services-overview.md)

package/bundle/docs/applications/hcm/employee-services-more.md

@@ -0,0 +1,41 @@
+---
+title: My Benefits, Documents, Expenses, Goals, Training & Performance
+audience: tenant
+---
+
+# My Benefits, Documents, Expenses, Goals, Training & Performance (HCM)
+
+This page documents six **Employee Self Service** screens
+(`hcm-employee-services`). Not for plugin developers. See
+[Employee Self Service — Overview](./employee-services-overview.md) for
+how this portal relates to each domain module's own self-service screens.
+
+## My Benefits
+
+Your own real benefit enrollments.
+
+## My Documents
+
+Your own real documents on file.
+
+## My Expenses
+
+Your own real expense claims.
+
+## My Goals
+
+Your own real performance goals.
+
+## My Training
+
+Your own real assigned/enrolled/completed learning, and any
+certifications you've earned.
+
+## My Performance
+
+Your own appraisal history, self-assessment status, and latest rating, in
+one place.
+
+## Related
+
+- [Employee Self Service — Overview, Requests & My Profile](./employee-services-overview.md)

package/bundle/docs/applications/hcm/employee-services-overview.md

@@ -0,0 +1,43 @@
+---
+title: Employee Self Service — Overview, Requests & My Profile
+audience: tenant
+---
+
+# Employee Self Service — Overview, Requests & My Profile (HCM)
+
+This page documents three shipped screens (`hcm-employee-services`) that
+form the landing experience of HCM's unified **Employee Self Service**
+portal. Not for plugin developers.
+
+> **What this module is:** a single "everything about me" hub, pulling
+> together the *same real records* from other HCM modules (Attendance,
+> Leave, Benefits, Payroll, Performance, Expenses, Documents, Timesheets,
+> Learning), filtered to you, in one place — not a separate, duplicate copy
+> of your data. Several of those modules also have their own "My ..."
+> self-service screen (e.g. [My Leave Requests](./leave-requests.md)) — if
+> you find what looks like two versions of the same screen, that's why:
+> one lives inside its own module for people who work in that module
+> directly, and this portal brings the same real data together for
+> everyone else.
+
+## Overview
+
+The self-service landing page — real KPI counts (attendance records on
+file, active leave balance types, pending leave requests, and more) and a
+snapshot of what needs your attention.
+
+## Requests
+
+A consolidated, read-only view of your own pending and recent requests,
+pulled together from four already-shipped per-employee request types in
+one place.
+
+## My Profile
+
+Your own employee record — the same real data as
+[Employee Profile](./employee-profile.md), viewed for yourself.
+
+## Related
+
+- [My Day-to-Day Self Service](./employee-services-daily.md)
+- [My Benefits, Documents, Expenses, Goals, Training & Performance](./employee-services-more.md)

package/bundle/docs/applications/hcm/expenses-analytics.md

@@ -0,0 +1,26 @@
+---
+title: Expense Dashboard & Reports
+audience: tenant
+---
+
+# Expense Dashboard & Reports (HCM)
+
+This page documents two shipped **Expenses** analytics screens
+(`hcm-expenses`). Not for plugin developers.
+
+## Expense Dashboard
+
+A quick operational view: Total, Pending, Approved, Rejected, Paid — real
+counts across every claim.
+
+## Expense Reports
+
+A deeper financial view: Total Expense, Approved/Pending/Rejected
+Expenses, Reimbursed Amount, Outstanding Reimbursement, Advance Amount,
+Advance Outstanding, and — genuinely useful for spotting a policy that's
+too strict or too loose — **Policy Exceptions**, a real count of claims
+that violated your active expense policy.
+
+## Related
+
+- [Expense Claims & Advances](./expenses-claims.md)

package/bundle/docs/applications/hcm/expenses-claims.md

@@ -0,0 +1,47 @@
+---
+title: Expense Claims & Advances
+audience: tenant
+---
+
+# Expense Claims & Advances (HCM)
+
+This page documents two shipped **Expenses** screens (`hcm-expenses`).
+Not for plugin developers.
+
+## Expense Claims
+
+A claim starts with the Employee, Claim Date, Business Purpose, Cost
+Center, and Project, then you **Add an Expense Item** per line and
+**Attach a Receipt** to each. The Total Amount is calculated for you as
+you add lines, and each line's **Policy Status** shows whether it's within
+your active [Expense Policy](./expenses-setup.md) as you go — not
+something you find out only after submitting.
+
+Once submitted, it's a real two-stage approval: **Approve (Manager)**,
+then **Approve (Finance)** — a manager approving doesn't finalize it on
+its own. At any stage a reviewer can **Reject** (with a reason) or
+**Return to Employee** (also with a reason, for "fix this and resubmit"
+rather than an outright rejection). Once fully approved: **Mark Ready for
+Payment**, then **Mark Paid** with a real Payment Reference. KPIs: Total,
+Draft, Pending, Approved, Rejected, Paid.
+
+## Advances
+
+Request a cash advance ahead of spending: Advance Type, Purpose,
+Requested Amount, Currency, Cost Center, Project, Required Date, and
+Notes — attach supporting documents if needed. Once **Approved**, the
+record tracks Approved Amount, Paid Amount, Outstanding Amount, and
+Reimbursement Amount separately, so you always know how much of the
+advance is still unaccounted for.
+
+**Settle Advance** is the key feature here: match some or all of an
+advance against a real Expense Claim Number, entering the Amount to
+Settle — this is how an advance actually gets reconciled against what was
+really spent, not just marked "done" by hand. **Withdraw** cancels a
+request you no longer need. KPIs: Total, Draft, Pending, Approved, Paid,
+Settled.
+
+## Related
+
+- [Expense Categories & Expense Policies](./expenses-setup.md)
+- [My Expenses, Team Expenses & Approvals](./expenses-self-service.md)