@adminide-stack/clock-tik-browser 12.0.22-alpha.0 → 12.0.22-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/lib/templates/content/content-manifest.json +1075 -64
  2. package/lib/templates/content/docs/books/books-overview.md +93 -0
  3. package/lib/templates/content/docs/books/dashboard.md +133 -0
  4. package/lib/templates/content/docs/books/expenses.md +151 -0
  5. package/lib/templates/content/docs/books/notes.md +102 -0
  6. package/lib/templates/content/docs/books/purchase-orders.md +142 -0
  7. package/lib/templates/content/docs/books/quotes.md +152 -0
  8. package/lib/templates/content/docs/books/sales-orders.md +142 -0
  9. package/lib/templates/content/docs/books/vendor-credits.md +135 -0
  10. package/lib/templates/content/docs/books/vendors.md +142 -0
  11. package/lib/templates/content/docs/gettingstarted.md +1 -1
  12. package/lib/templates/content/docs/hrm/dashboard.md +162 -0
  13. package/lib/templates/content/docs/hrm/hr-letters.md +66 -0
  14. package/lib/templates/content/docs/hrm/hrm-overview.md +50 -0
  15. package/lib/templates/content/docs/hrm/leave.md +85 -0
  16. package/lib/templates/content/docs/hrm/members.md +79 -0
  17. package/lib/templates/content/docs/hrm/my-space.md +173 -0
  18. package/lib/templates/content/docs/hrm/offboarding.md +63 -0
  19. package/lib/templates/content/docs/hrm/onboarding.md +115 -0
  20. package/lib/templates/content/docs/hrm/settings.md +158 -0
  21. package/lib/templates/content/docs/hrm/travel.md +94 -0
  22. package/lib/templates/content/docs/{timetracking-main.md → timer/timetracking-main.md} +1 -1
  23. package/lib/templates/content/docs/{timetracking.md → timer/timetracking.md} +8 -8
  24. package/lib/templates/static/img/hrm/dashboard-candidates-employees.png +0 -0
  25. package/lib/templates/static/img/hrm/dashboard-overview.png +0 -0
  26. package/lib/templates/static/img/hrm/dashboard-pending-approvals.png +0 -0
  27. package/lib/templates/static/img/hrm/dashboard-pending-letters.png +0 -0
  28. package/lib/templates/static/img/hrm/dashboard-pending-offboarding.png +0 -0
  29. package/lib/templates/static/img/hrm/dashboard-pending-travels.png +0 -0
  30. package/lib/templates/static/img/hrm/dashboard-trends-analytics.png +0 -0
  31. package/lib/templates/static/img/hrm/hr-letters-add-request.png +0 -0
  32. package/lib/templates/static/img/hrm/hr-letters-main.png +0 -0
  33. package/lib/templates/static/img/hrm/hrm-dashboard.png +0 -0
  34. package/lib/templates/static/img/hrm/hrm-offboarding.png +0 -0
  35. package/lib/templates/static/img/hrm/hrm-onboarding.png +0 -0
  36. package/lib/templates/static/img/hrm/hrm-overview-time-logs.png +0 -0
  37. package/lib/templates/static/img/hrm/hrm-overview.png +0 -0
  38. package/lib/templates/static/img/hrm/hrm-settings.png +0 -0
  39. package/lib/templates/static/img/hrm/hrm-sidebar-expanded.png +0 -0
  40. package/lib/templates/static/img/hrm/hrm-travel.png +0 -0
  41. package/lib/templates/static/img/hrm/inv-members.png +0 -0
  42. package/lib/templates/static/img/hrm/letter-hr-letters.png +0 -0
  43. package/lib/templates/static/img/hrm/members-invites.png +0 -0
  44. package/lib/templates/static/img/hrm/members-list.png +0 -0
  45. package/lib/templates/static/img/hrm/myspace-attendance.png +0 -0
  46. package/lib/templates/static/img/hrm/offboarding-full.png +0 -0
  47. package/lib/templates/static/img/hrm/onboarding-candidates.png +0 -0
  48. package/lib/templates/static/img/hrm/onboarding-instances.png +0 -0
  49. package/lib/templates/static/img/hrm/onboarding-main.png +0 -0
  50. package/lib/templates/static/img/hrm/onboarding-tasks.png +0 -0
  51. package/lib/templates/static/img/hrm/org-overview-hierarchy.png +0 -0
  52. package/lib/templates/static/img/hrm/settings-main.png +0 -0
  53. package/lib/templates/static/img/hrm/settings-permissions-full.png +0 -0
  54. package/lib/templates/static/img/hrm/settings-permissions.png +0 -0
  55. package/lib/templates/static/img/hrm/settings-user-access.png +0 -0
  56. package/lib/templates/static/img/hrm/timeoff-balance.png +0 -0
  57. package/lib/templates/static/img/hrm/timeoff-requests.png +0 -0
  58. package/lib/templates/static/img/hrm/timeoff-timeline.png +0 -0
  59. package/lib/templates/static/img/hrm/timeoff-timeoff.png +0 -0
  60. package/lib/templates/static/img/hrm/travel-new-request-menu.png +0 -0
  61. package/lib/templates/static/img/hrm/travel-request-form.png +0 -0
  62. package/lib/templates/static/img/timer/timer-mode-new2.jpg +0 -0
  63. package/package.json +2 -2
  64. /package/lib/templates/static/img/{timer-billable-toggle.png → timer/timer-billable-toggle.png} +0 -0
  65. /package/lib/templates/static/img/{timer-dashboard.png → timer/timer-dashboard.png} +0 -0
  66. /package/lib/templates/static/img/{timer-entries-list.png → timer/timer-entries-list.png} +0 -0
  67. /package/lib/templates/static/img/{timer-page-overview.png → timer/timer-page-overview.png} +0 -0
  68. /package/lib/templates/static/img/{timer-paused.png → timer/timer-paused.png} +0 -0
  69. /package/lib/templates/static/img/{timer-project-dropdown.png → timer/timer-project-dropdown.png} +0 -0
  70. /package/lib/templates/static/img/{timer-running-controls.png → timer/timer-running-controls.png} +0 -0
  71. /package/lib/templates/static/img/{timer-tags-dropdown.png → timer/timer-tags-dropdown.png} +0 -0
  72. /package/lib/templates/static/img/{timer-with-description.png → timer/timer-with-description.png} +0 -0
@@ -0,0 +1,115 @@
1
+ ---
2
+ id: hrm-onboarding
3
+ title: Onboarding
4
+ sidebar_label: Onboarding
5
+ ---
6
+
7
+ ## Onboarding
8
+
9
+ The **Onboarding** module (`HRM > Onboarding`) lets you create structured onboarding workflows for both candidates and employees. Navigate to `/hrm/onboarding` to access it.
10
+
11
+ ![Onboarding Flows](/static/img/hrm/onboarding-main.png)
12
+
13
+ ---
14
+
15
+ ### Onboarding Flows
16
+
17
+ The main Onboarding page displays two flow types:
18
+
19
+ #### Candidate Onboarding
20
+
21
+ For new hires who have not yet officially joined the organization:
22
+
23
+ - **Flow** — Define the step-by-step onboarding flow (e.g., document collection, background checks, offer letter acceptance)
24
+ - **Preferences** — Configure onboarding settings and preferences for the candidate workflow
25
+
26
+ #### Employee Onboarding
27
+
28
+ For existing employees joining new teams or roles:
29
+
30
+ - **Flow** — Define the onboarding steps (e.g., team introductions, system access setup, training schedule)
31
+ - **Preferences** — Configure onboarding preferences for the employee workflow
32
+
33
+ ---
34
+
35
+ ### Onboarding Sub-menus
36
+
37
+ When expanded, the Onboarding section in the sidebar reveals three additional pages:
38
+
39
+ ---
40
+
41
+ ### Candidates
42
+
43
+ ![Candidates Page](/static/img/hrm/onboarding-candidates.png)
44
+
45
+ Manage your organization's candidates in one place.
46
+
47
+ **Adding a Candidate:**
48
+
49
+ 1. Navigate to **HRM > Onboarding > Candidates**
50
+ 2. Click **Add Candidate**
51
+ 3. Fill in the candidate's details
52
+
53
+ **Filter candidates by status:**
54
+
55
+ | Status | Description |
56
+ |--------|-------------|
57
+ | All Candidates | View all candidates regardless of status |
58
+ | Pending | Candidates awaiting initial processing |
59
+ | In Progress | Candidates currently going through onboarding |
60
+ | Completed Onboarding | Candidates who finished the onboarding process |
61
+ | Converted to Employee | Candidates who have been officially hired |
62
+
63
+ The page shows a count (e.g., "0 of 0 candidates") and provides an empty-state prompt to add your first candidate.
64
+
65
+ ---
66
+
67
+ ### Onboarding Instances
68
+
69
+ ![Onboarding Instances](/static/img/hrm/onboarding-instances.png)
70
+
71
+ Track and manage active onboarding processes.
72
+
73
+ **Starting an Onboarding:**
74
+
75
+ 1. Navigate to **HRM > Onboarding > Onboarding Instances**
76
+ 2. Click **Start Onboarding**
77
+ 3. Select the candidate/employee and the onboarding flow to use
78
+
79
+ **Filter by status:**
80
+
81
+ | Status | Description |
82
+ |--------|-------------|
83
+ | All Statuses | View all onboarding instances |
84
+ | Pending Offer | Offer letter sent, awaiting acceptance |
85
+ | Pending Contract | Contract pending signature |
86
+ | In Progress | Onboarding actively underway |
87
+ | Completed | Onboarding finished successfully |
88
+ | Cancelled | Onboarding was cancelled |
89
+
90
+ ---
91
+
92
+ ### Onboarding Tasks
93
+
94
+ ![Onboarding Tasks](/static/img/hrm/onboarding-tasks.png)
95
+
96
+ Manage individual tasks within onboarding flows across all instances.
97
+
98
+ **Creating a Task:**
99
+
100
+ 1. Navigate to **HRM > Onboarding > Onboarding Tasks**
101
+ 2. Click **Create Task**
102
+ 3. Define the task details, assignments, and due dates
103
+
104
+ **Task Statistics:**
105
+
106
+ | Metric | Description |
107
+ |--------|-------------|
108
+ | Total Tasks | All onboarding tasks created |
109
+ | Pending | Tasks not yet started |
110
+ | In Progress | Tasks currently being worked on |
111
+ | Completed | Tasks finished |
112
+ | Blocked | Tasks blocked by dependencies or issues |
113
+ | Overdue | Tasks past their due date |
114
+
115
+ Use **Filters** to narrow down the task list by status, assignee, or onboarding instance.
@@ -0,0 +1,158 @@
1
+ ---
2
+ id: hrm-settings
3
+ title: HRM Settings
4
+ sidebar_label: Settings
5
+ ---
6
+
7
+ ## HRM Settings
8
+
9
+ **HRM Settings** (`HRM > Settings`) allows administrators to configure module-level permissions and access controls for the entire HRM module. Navigate to `/hrm/settings` to access it.
10
+
11
+ The Settings section has two sub-items in the sidebar:
12
+
13
+ - **Permissions** — Role-based permission configuration
14
+ - **User Access Control** — Individual user access management
15
+
16
+ ---
17
+
18
+ ## Permissions
19
+
20
+ Navigate to **HRM > Settings > Permissions** (`/hrm/settings/permissions`) for the full role-based permission configuration.
21
+
22
+ ![HRM Permissions](/static/img/hrm/settings-permissions.png)
23
+
24
+ ### Role Selection
25
+
26
+ Select a role from the dropdown to configure its permissions. Available roles include:
27
+
28
+ | Role | Description |
29
+ |------|-------------|
30
+ | **HR Director** | Full HR management access with strategic oversight |
31
+ | **HR Manager** | Day-to-day HR operations and team management |
32
+ | **Tech Lead** | Technical team leadership with limited HR access |
33
+ | **Team Manager** | Direct team management and performance oversight |
34
+ | **Department Head** | Department-level management and budgeting |
35
+ | **Vice President** | Executive-level access with strategic HR oversight |
36
+ | **Recruiter** | Recruitment and candidate management access |
37
+ | **Payroll Admin** | Payroll processing and compensation management |
38
+ | **Training Coordinator** | Training programs and employee development |
39
+ | **Compliance Officer** | HR compliance, audits, and policy enforcement |
40
+
41
+ ### Permission Categories
42
+
43
+ Each role has toggleable permissions organized into these categories:
44
+
45
+ #### Employee Management
46
+
47
+ Control what the selected role can do with employee records:
48
+
49
+ - View other employees
50
+ - Create employees
51
+ - Edit other employees
52
+ - Delete employees
53
+ - Manage employees
54
+ - View own profile
55
+ - Edit own profile
56
+
57
+ #### Recruitment & Candidates
58
+
59
+ Manage the recruitment pipeline:
60
+
61
+ - View / Create / Edit / Delete candidates
62
+ - View / Create / Edit / Publish job postings
63
+
64
+ #### Departments
65
+
66
+ Manage organizational departments:
67
+
68
+ - View / Create / Edit / Delete departments
69
+ - Manage departments
70
+
71
+ #### Onboarding
72
+
73
+ Manage employee onboarding:
74
+
75
+ - View / Create / Edit / Delete onboarding flows
76
+ - View others' onboarding
77
+ - Start onboarding for others
78
+ - View / Create / Assign onboarding tasks
79
+
80
+ #### Performance Management
81
+
82
+ Manage reviews and goals:
83
+
84
+ - View / Create / Edit / Approve others' performance reviews
85
+ - View own performance / Submit self-assessment
86
+ - View / Create / Approve others' goals
87
+ - View / Create own goals
88
+
89
+ #### Training & Learning
90
+
91
+ Manage training programs:
92
+
93
+ - View / Create / Edit training courses
94
+ - View / Enroll others in training
95
+ - View own enrollments
96
+
97
+ #### Attendance & Schedule
98
+
99
+ Manage attendance:
100
+
101
+ - View / Edit / Approve others' attendance
102
+ - View / Mark own attendance
103
+ - View / Create others' schedules
104
+ - View own schedule
105
+
106
+ #### Payroll & Compensation
107
+
108
+ Access payroll data:
109
+
110
+ - View / Edit / Process / Approve others' payroll
111
+ - View own payroll
112
+ - View / Edit others' compensation
113
+ - View own compensation
114
+
115
+ #### Documents
116
+
117
+ Manage employee documents:
118
+
119
+ - View / Upload / Delete others' documents
120
+ - View / Upload own documents
121
+
122
+ #### Agreements & Contracts
123
+
124
+ Manage employment agreements:
125
+
126
+ - View / Create / Edit / Delete agreements
127
+ - Send for signature
128
+ - Sign agreements
129
+
130
+ #### Travel
131
+
132
+ Manage travel workflows:
133
+
134
+ - View / Create others' travel
135
+ - Approve travel requests
136
+ - View own travel / Request travel
137
+
138
+ #### Settings & Administration
139
+
140
+ Access HRM settings:
141
+
142
+ - View / Edit / Manage HRM settings
143
+ - View / Export HRM reports
144
+ - View / Create / Edit workflows
145
+
146
+ ---
147
+
148
+ ## User Access Control
149
+
150
+ Navigate to **HRM > Settings > User Access Control** to manage access at the individual user level.
151
+
152
+ ![User Access Control](/static/img/hrm/settings-user-access.png)
153
+
154
+ User Access Control allows you to:
155
+
156
+ - Grant or restrict specific users' access to HRM features beyond their role defaults
157
+ - Override role-based permissions for individual users when needed
158
+ - Manage access to sensitive HR data on a per-user basis
@@ -0,0 +1,94 @@
1
+ ---
2
+ id: hrm-travel
3
+ title: Travel Management
4
+ sidebar_label: Travel
5
+ ---
6
+
7
+ ## Travel Management
8
+
9
+ The **Travel Management** module (`HRM > Travel`) handles business travel requests and expense claims. Navigate to `/hrm/travel` to access it.
10
+
11
+ ![Travel Management](/static/img/hrm/hrm-travel.png)
12
+
13
+ ---
14
+
15
+ ### Overview
16
+
17
+ The Travel Management page lets employees submit travel requests and expenses, and gives managers visibility into team travel.
18
+
19
+ **Description:** Manage travel requests and expenses for your organization.
20
+
21
+ ---
22
+
23
+ ### Request Statistics
24
+
25
+ The page displays summary cards at the top:
26
+
27
+ | Stat | Description |
28
+ |------|-------------|
29
+ | **Total Requests** | All travel requests submitted |
30
+ | **Pending Approval** | Requests awaiting manager / HR approval |
31
+ | **Approved** | Requests that have been approved |
32
+ | **Rejected** | Requests that have been denied |
33
+
34
+ ---
35
+
36
+ ### Search & Filter
37
+
38
+ Use the search bar to find requests by:
39
+ - Request ID
40
+ - Employee name
41
+ - Purpose of visit
42
+ - Location / destination
43
+
44
+ ---
45
+
46
+ ### Creating a Travel Request
47
+
48
+ Click **New Request** to open the dropdown with two options:
49
+
50
+ #### Travel Request
51
+
52
+ ![Travel Request Form](/static/img/hrm/travel-request-form.png)
53
+
54
+ Submit a request for business travel with these fields:
55
+
56
+ | Field | Required | Description |
57
+ |-------|----------|-------------|
58
+ | Employee ID | Yes | Select the employee (from dropdown) |
59
+ | Employee Department | Auto | Auto-filled based on selected employee |
60
+ | Purpose of Visit | Yes | Why the travel is needed (e.g., "Client Meeting", "Conference") |
61
+ | Place of Visit | Yes | Destination (e.g., "New York", "London") |
62
+ | Departure Date | Yes | Travel start date |
63
+ | Arrival Date | Yes | Travel end date |
64
+ | Expected duration in days | No | Estimated number of days |
65
+ | Mode of Travel | No | Transportation mode (e.g., "Flight", "Train", "Car") |
66
+ | Billable to Customer | No | Checkbox — whether travel costs are billed to a customer |
67
+ | Description / Notes | No | Additional context or details |
68
+
69
+ **To submit:**
70
+ 1. Navigate to **HRM > Travel**
71
+ 2. Click **New Request > Travel Request**
72
+ 3. Fill in the required fields
73
+ 4. Click **Submit Request**
74
+
75
+ #### Travel Expense
76
+
77
+ Submit expenses incurred during approved travel:
78
+
79
+ 1. Click **New Request > Travel Expense**
80
+ 2. Link to an existing approved travel request
81
+ 3. Add expense details (amount, category, receipts)
82
+ 4. Submit for reimbursement
83
+
84
+ ---
85
+
86
+ ### Approval Workflow
87
+
88
+ 1. **Employee** submits a travel request
89
+ 2. **Reporting Manager** reviews and approves/rejects
90
+ 3. **HR / Admin** provides final approval if required
91
+ 4. Employee is notified of the decision
92
+ 5. After travel, employee submits **Travel Expense** for reimbursement
93
+
94
+ > Pending travel requests appear in the **HR Dashboard > Pending Travels** tab for administrators.
@@ -10,7 +10,7 @@ In Clockbook, there are two main ways you can add time entries: automatic (use a
10
10
 
11
11
  The Timer page features a full control bar with **START**, **PAUSE**, **STOP**, and **Discard** buttons, along with project selection, tags, and billable toggles. You can also filter entries by date range and view your **Current Week** summary.
12
12
 
13
- ![Timer Page](/static/img/timer-page-overview.png)
13
+ ![Timer Page](/static/img/timer/timer-page-overview.png)
14
14
 
15
15
  [ _Read More_ ](/docs/timetracking)
16
16
 
@@ -20,7 +20,7 @@ You can track using any app and all data is synced online, so all your tracked d
20
20
 
21
21
  The Timer page is the main place for time tracking. Navigate to **Time Tracker > Timer** in the sidebar to access it.
22
22
 
23
- ![Timer Page Overview](/static/img/timer-page-overview.png)
23
+ ![Timer Page Overview](/static/img/timer/timer-page-overview.png)
24
24
 
25
25
  The timer bar at the top contains the following elements:
26
26
 
@@ -37,7 +37,7 @@ To track time:
37
37
  2. Optionally, mark time as billable, select a project/task, and add tags.
38
38
  3. Click the **START** button to begin tracking.
39
39
 
40
- ![Timer with description](/static/img/timer-with-description.png)
40
+ ![Timer with description](/static/img/timer/timer-with-description.png)
41
41
 
42
42
  Once the timer is running, the following controls become available:
43
43
 
@@ -45,7 +45,7 @@ Once the timer is running, the following controls become available:
45
45
  - **STOP** — Stop the timer and save the time entry to your timesheet.
46
46
  - **Discard** — Cancel and discard the running timer without saving.
47
47
 
48
- ![Timer running with controls](/static/img/timer-running-controls.png)
48
+ ![Timer running with controls](/static/img/timer/timer-running-controls.png)
49
49
 
50
50
  Note that once you start the timer, it will keep running until you stop it; it will keep running even if you leave the page or close the browser (unless you use the extension and have the option to stop it automatically).
51
51
 
@@ -55,7 +55,7 @@ When the timer is running, the favicon in the browser will change from black to
55
55
 
56
56
  If you need to take a break but don't want to stop the timer entirely, use the **PAUSE** button. The timer will stop counting, and you can resume it later by clicking **PAUSE** again or clicking the resume control.
57
57
 
58
- ![Timer paused](/static/img/timer-paused.png)
58
+ ![Timer paused](/static/img/timer/timer-paused.png)
59
59
 
60
60
  This is especially useful when:
61
61
  - You're taking a short break but will continue the same task
@@ -89,7 +89,7 @@ Below the timer bar and weekly summary, your time entries are displayed grouped
89
89
  - **Start and end times** — When you started and stopped (e.g., 08:11:50 AM — 08:11:59 AM)
90
90
  - **Daily total** — The total time tracked for each day
91
91
 
92
- ![Timer entries list](/static/img/timer-entries-list.png)
92
+ ![Timer entries list](/static/img/timer/timer-entries-list.png)
93
93
 
94
94
  ### Selecting a project
95
95
 
@@ -99,7 +99,7 @@ Click the **Projects** button in the timer bar to open the project dropdown. You
99
99
  - Select a project from the list to assign it to the current time entry
100
100
  - Change the project on an existing entry by clicking the project name
101
101
 
102
- ![Project dropdown](/static/img/timer-project-dropdown.png)
102
+ ![Project dropdown](/static/img/timer/timer-project-dropdown.png)
103
103
 
104
104
  If no projects have been created yet, the dropdown will show "No projects available". To create projects, go to **Projects** in the sidebar.
105
105
 
@@ -107,7 +107,7 @@ If no projects have been created yet, the dropdown will show "No projects availa
107
107
 
108
108
  Click the **tag icon** (Toggle Tags button) next to the Projects button to add tags to your time entry.
109
109
 
110
- ![Tags dropdown](/static/img/timer-tags-dropdown.png)
110
+ ![Tags dropdown](/static/img/timer/timer-tags-dropdown.png)
111
111
 
112
112
  Tags help you further categorize time entries beyond projects and tasks. If no tags are available, go to **Tags** in the sidebar to create them first.
113
113
 
@@ -119,7 +119,7 @@ Click the **$** (dollar sign) icon to toggle the billable status of a time entry
119
119
  - Generating accurate invoices based on tracked billable time
120
120
  - Analyzing your billable vs non-billable time ratio in Reports
121
121
 
122
- ![Billable toggle](/static/img/timer-billable-toggle.png)
122
+ ![Billable toggle](/static/img/timer/timer-billable-toggle.png)
123
123
 
124
124
  ### Continuing time entries
125
125
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adminide-stack/clock-tik-browser",
3
- "version": "12.0.22-alpha.0",
3
+ "version": "12.0.22-alpha.2",
4
4
  "description": "Sample core for higher packages to depend on",
5
5
  "license": "ISC",
6
6
  "author": "CDMBase LLC",
@@ -69,5 +69,5 @@
69
69
  "typescript": {
70
70
  "definition": "lib/index.d.ts"
71
71
  },
72
- "gitHead": "bdacb84399b8faa6dba2442e4a1919b66ffd9345"
72
+ "gitHead": "dad05023f0cc9398d497b9e3469a6f86e2c51d0e"
73
73
  }